@zernio/node 0.2.817 → 0.2.818
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 +28 -2
- package/dist/index.d.mts +764 -23
- package/dist/index.d.ts +764 -23
- package/dist/index.js +162 -7
- package/dist/index.mjs +162 -7
- package/package.json +1 -1
- package/src/client.ts +52 -6
- package/src/generated/sdk.gen.ts +235 -3
- package/src/generated/types.gen.ts +815 -16
|
@@ -5958,6 +5958,111 @@ export type MetaAdsPlatformData = {
|
|
|
5958
5958
|
lifetimeMinSpendTarget?: number;
|
|
5959
5959
|
};
|
|
5960
5960
|
|
|
5961
|
+
export type MetaCatalogProduct = {
|
|
5962
|
+
/**
|
|
5963
|
+
* Meta product item ID (use in the product endpoints)
|
|
5964
|
+
*/
|
|
5965
|
+
id?: string;
|
|
5966
|
+
retailerId?: (string) | null;
|
|
5967
|
+
name?: string;
|
|
5968
|
+
description?: (string) | null;
|
|
5969
|
+
url?: (string) | null;
|
|
5970
|
+
imageUrl?: (string) | null;
|
|
5971
|
+
additionalImageUrls?: Array<(string)>;
|
|
5972
|
+
/**
|
|
5973
|
+
* Formatted by Meta, e.g. "€49.90"
|
|
5974
|
+
*/
|
|
5975
|
+
price?: (string) | null;
|
|
5976
|
+
salePrice?: (string) | null;
|
|
5977
|
+
currency?: (string) | null;
|
|
5978
|
+
availability?: (string) | null;
|
|
5979
|
+
condition?: (string) | null;
|
|
5980
|
+
brand?: (string) | null;
|
|
5981
|
+
category?: (string) | null;
|
|
5982
|
+
productType?: (string) | null;
|
|
5983
|
+
gtin?: (string) | null;
|
|
5984
|
+
mpn?: (string) | null;
|
|
5985
|
+
inventory?: (number) | null;
|
|
5986
|
+
visibility?: (string) | null;
|
|
5987
|
+
color?: (string) | null;
|
|
5988
|
+
size?: (string) | null;
|
|
5989
|
+
gender?: (string) | null;
|
|
5990
|
+
material?: (string) | null;
|
|
5991
|
+
pattern?: (string) | null;
|
|
5992
|
+
/**
|
|
5993
|
+
* custom_label_0 to custom_label_4
|
|
5994
|
+
*/
|
|
5995
|
+
customLabels?: Array<((string) | null)>;
|
|
5996
|
+
/**
|
|
5997
|
+
* Meta's commerce review status (approved, rejected, pending, ...)
|
|
5998
|
+
*/
|
|
5999
|
+
reviewStatus?: (string) | null;
|
|
6000
|
+
reviewRejectionReasons?: Array<(string)>;
|
|
6001
|
+
};
|
|
6002
|
+
|
|
6003
|
+
/**
|
|
6004
|
+
* One product shape for single and bulk calls. Money is in major units (12.99); Zernio converts to what Meta wants.
|
|
6005
|
+
*/
|
|
6006
|
+
export type MetaCatalogProductInput = {
|
|
6007
|
+
/**
|
|
6008
|
+
* Your SKU; unique inside the catalog
|
|
6009
|
+
*/
|
|
6010
|
+
retailerId?: string;
|
|
6011
|
+
name?: string;
|
|
6012
|
+
description?: string;
|
|
6013
|
+
/**
|
|
6014
|
+
* Product page
|
|
6015
|
+
*/
|
|
6016
|
+
url?: string;
|
|
6017
|
+
imageUrl?: string;
|
|
6018
|
+
additionalImageUrls?: Array<(string)>;
|
|
6019
|
+
/**
|
|
6020
|
+
* Major units, e.g. 12.99
|
|
6021
|
+
*/
|
|
6022
|
+
price?: number;
|
|
6023
|
+
/**
|
|
6024
|
+
* ISO 4217, e.g. EUR
|
|
6025
|
+
*/
|
|
6026
|
+
currency?: string;
|
|
6027
|
+
salePrice?: number;
|
|
6028
|
+
/**
|
|
6029
|
+
* ISO 8601
|
|
6030
|
+
*/
|
|
6031
|
+
salePriceStartDate?: string;
|
|
6032
|
+
/**
|
|
6033
|
+
* ISO 8601
|
|
6034
|
+
*/
|
|
6035
|
+
salePriceEndDate?: string;
|
|
6036
|
+
availability?: 'in stock' | 'out of stock' | 'preorder' | 'available for order' | 'discontinued' | 'pending';
|
|
6037
|
+
condition?: 'new' | 'refurbished' | 'used';
|
|
6038
|
+
brand?: string;
|
|
6039
|
+
category?: string;
|
|
6040
|
+
googleProductCategory?: string;
|
|
6041
|
+
productType?: string;
|
|
6042
|
+
gtin?: string;
|
|
6043
|
+
mpn?: string;
|
|
6044
|
+
inventory?: number;
|
|
6045
|
+
visibility?: 'published' | 'staging';
|
|
6046
|
+
color?: string;
|
|
6047
|
+
size?: string;
|
|
6048
|
+
gender?: 'female' | 'male' | 'unisex';
|
|
6049
|
+
material?: string;
|
|
6050
|
+
pattern?: string;
|
|
6051
|
+
customLabel0?: string;
|
|
6052
|
+
customLabel1?: string;
|
|
6053
|
+
customLabel2?: string;
|
|
6054
|
+
customLabel3?: string;
|
|
6055
|
+
customLabel4?: string;
|
|
6056
|
+
};
|
|
6057
|
+
|
|
6058
|
+
export type availability = 'in stock' | 'out of stock' | 'preorder' | 'available for order' | 'discontinued' | 'pending';
|
|
6059
|
+
|
|
6060
|
+
export type condition = 'new' | 'refurbished' | 'used';
|
|
6061
|
+
|
|
6062
|
+
export type visibility = 'published' | 'staging';
|
|
6063
|
+
|
|
6064
|
+
export type gender = 'female' | 'male' | 'unisex';
|
|
6065
|
+
|
|
5961
6066
|
/**
|
|
5962
6067
|
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle is rejected by Meta.
|
|
5963
6068
|
*/
|
|
@@ -5965,6 +6070,17 @@ export type MetaCreativeFeatures = {
|
|
|
5965
6070
|
[key: string]: ('OPT_IN' | 'OPT_OUT');
|
|
5966
6071
|
};
|
|
5967
6072
|
|
|
6073
|
+
export type MetaFeedUpload = {
|
|
6074
|
+
id?: string;
|
|
6075
|
+
url?: (string) | null;
|
|
6076
|
+
startTime?: (string) | null;
|
|
6077
|
+
endTime?: (string) | null;
|
|
6078
|
+
errorCount?: number;
|
|
6079
|
+
warningCount?: number;
|
|
6080
|
+
itemsDetected?: number;
|
|
6081
|
+
itemsDeleted?: number;
|
|
6082
|
+
};
|
|
6083
|
+
|
|
5968
6084
|
export type MetaInstagramIdentityRef = {
|
|
5969
6085
|
/**
|
|
5970
6086
|
* Instagram identity ID.
|
|
@@ -6097,6 +6213,40 @@ export type MetaLeadForm = {
|
|
|
6097
6213
|
|
|
6098
6214
|
export type style = 'LIST_STYLE' | 'PARAGRAPH_STYLE';
|
|
6099
6215
|
|
|
6216
|
+
export type MetaProductCatalog = {
|
|
6217
|
+
id?: string;
|
|
6218
|
+
name?: string;
|
|
6219
|
+
/**
|
|
6220
|
+
* Catalog vertical (e.g. commerce, vehicles, hotels)
|
|
6221
|
+
*/
|
|
6222
|
+
vertical?: (string) | null;
|
|
6223
|
+
productCount?: number;
|
|
6224
|
+
businessId?: (string) | null;
|
|
6225
|
+
};
|
|
6226
|
+
|
|
6227
|
+
export type MetaProductFeed = {
|
|
6228
|
+
id?: string;
|
|
6229
|
+
name?: string;
|
|
6230
|
+
productCount?: number;
|
|
6231
|
+
schedule?: {
|
|
6232
|
+
interval?: string;
|
|
6233
|
+
url?: string;
|
|
6234
|
+
hour?: (number) | null;
|
|
6235
|
+
dayOfWeek?: (string) | null;
|
|
6236
|
+
} | null;
|
|
6237
|
+
createdTime?: (string) | null;
|
|
6238
|
+
latestUpload?: (MetaFeedUpload | null);
|
|
6239
|
+
};
|
|
6240
|
+
|
|
6241
|
+
export type MetaProductSet = {
|
|
6242
|
+
id?: string;
|
|
6243
|
+
name?: string;
|
|
6244
|
+
productCount?: number;
|
|
6245
|
+
filter?: {
|
|
6246
|
+
[key: string]: unknown;
|
|
6247
|
+
} | null;
|
|
6248
|
+
};
|
|
6249
|
+
|
|
6100
6250
|
/**
|
|
6101
6251
|
* Not supported. Meta validates creative_sourcing_spec.promotion_metadata_spec on the create call and then discards it, so a Promotion set through the Marketing API never reaches the creative. Any object is rejected with 400 invalid_field_value. Send null or omit the field, and set the Promotion on the ad in Ads Manager. Verified on 2026-09-11 across Graph v19.0 to v25.0 and every write path.
|
|
6102
6252
|
*/
|
|
@@ -6146,6 +6296,26 @@ export type ParameterBusinessAgentConnectorId = string;
|
|
|
6146
6296
|
|
|
6147
6297
|
export type ParameterBusinessAgentToolId = string;
|
|
6148
6298
|
|
|
6299
|
+
/**
|
|
6300
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
6301
|
+
*/
|
|
6302
|
+
export type ParameterCatalogAccountId = string;
|
|
6303
|
+
|
|
6304
|
+
/**
|
|
6305
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
6306
|
+
*/
|
|
6307
|
+
export type ParameterCatalogId = string;
|
|
6308
|
+
|
|
6309
|
+
/**
|
|
6310
|
+
* Meta product item ID (from the products list; not the retailer id)
|
|
6311
|
+
*/
|
|
6312
|
+
export type ParameterCatalogProductId = string;
|
|
6313
|
+
|
|
6314
|
+
/**
|
|
6315
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
6316
|
+
*/
|
|
6317
|
+
export type ParameterCatalogTokenAccountId = string;
|
|
6318
|
+
|
|
6149
6319
|
/**
|
|
6150
6320
|
* Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
6151
6321
|
*/
|
|
@@ -6415,7 +6585,7 @@ export type Post = {
|
|
|
6415
6585
|
*/
|
|
6416
6586
|
export type status13 = 'draft' | 'scheduled' | 'publishing' | 'published' | 'partial' | 'failed' | 'cancelled';
|
|
6417
6587
|
|
|
6418
|
-
export type
|
|
6588
|
+
export type visibility2 = 'public' | 'private' | 'unlisted';
|
|
6419
6589
|
|
|
6420
6590
|
export type PostAnalytics = {
|
|
6421
6591
|
impressions?: number;
|
|
@@ -7450,7 +7620,7 @@ export type TargetingSpec = {
|
|
|
7450
7620
|
/**
|
|
7451
7621
|
* Restrict by gender. 'all' (default) targets everyone. Applied on Meta, TikTok and Pinterest. Ignored on Google, LinkedIn and X.
|
|
7452
7622
|
*/
|
|
7453
|
-
export type
|
|
7623
|
+
export type gender2 = 'all' | 'male' | 'female';
|
|
7454
7624
|
|
|
7455
7625
|
/**
|
|
7456
7626
|
* Normalized household-income tier (ZIP/percentile based). Meta and TikTok
|
|
@@ -10899,6 +11069,11 @@ export type WhatsAppCarouselComponent = {
|
|
|
10899
11069
|
}>;
|
|
10900
11070
|
};
|
|
10901
11071
|
|
|
11072
|
+
export type WhatsAppCommerceSettings = {
|
|
11073
|
+
isCartEnabled?: boolean;
|
|
11074
|
+
isCatalogVisible?: boolean;
|
|
11075
|
+
};
|
|
11076
|
+
|
|
10902
11077
|
export type WhatsAppFooterComponent = {
|
|
10903
11078
|
type: 'footer';
|
|
10904
11079
|
/**
|
|
@@ -26654,6 +26829,128 @@ export type GetWhatsAppLibraryTemplateError = (unknown | {
|
|
|
26654
26829
|
error?: string;
|
|
26655
26830
|
});
|
|
26656
26831
|
|
|
26832
|
+
export type ListWhatsAppCatalogsData = {
|
|
26833
|
+
query: {
|
|
26834
|
+
/**
|
|
26835
|
+
* WhatsApp account ID
|
|
26836
|
+
*/
|
|
26837
|
+
accountId: string;
|
|
26838
|
+
/**
|
|
26839
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
26840
|
+
*/
|
|
26841
|
+
catalogAccountId?: string;
|
|
26842
|
+
};
|
|
26843
|
+
};
|
|
26844
|
+
|
|
26845
|
+
export type ListWhatsAppCatalogsResponse = ({
|
|
26846
|
+
wabaId?: string;
|
|
26847
|
+
catalogs?: Array<{
|
|
26848
|
+
id?: string;
|
|
26849
|
+
name?: string;
|
|
26850
|
+
}>;
|
|
26851
|
+
});
|
|
26852
|
+
|
|
26853
|
+
export type ListWhatsAppCatalogsError = (ErrorResponse | {
|
|
26854
|
+
error?: string;
|
|
26855
|
+
});
|
|
26856
|
+
|
|
26857
|
+
export type LinkWhatsAppCatalogData = {
|
|
26858
|
+
body: {
|
|
26859
|
+
/**
|
|
26860
|
+
* WhatsApp account ID
|
|
26861
|
+
*/
|
|
26862
|
+
accountId: string;
|
|
26863
|
+
/**
|
|
26864
|
+
* Account whose Meta login token performs the call
|
|
26865
|
+
*/
|
|
26866
|
+
catalogAccountId?: string;
|
|
26867
|
+
/**
|
|
26868
|
+
* Meta catalog ID
|
|
26869
|
+
*/
|
|
26870
|
+
catalogId: string;
|
|
26871
|
+
};
|
|
26872
|
+
};
|
|
26873
|
+
|
|
26874
|
+
export type LinkWhatsAppCatalogResponse = ({
|
|
26875
|
+
wabaId?: string;
|
|
26876
|
+
catalogs?: Array<{
|
|
26877
|
+
id?: string;
|
|
26878
|
+
name?: string;
|
|
26879
|
+
}>;
|
|
26880
|
+
});
|
|
26881
|
+
|
|
26882
|
+
export type LinkWhatsAppCatalogError = (ErrorResponse | {
|
|
26883
|
+
error?: string;
|
|
26884
|
+
});
|
|
26885
|
+
|
|
26886
|
+
export type UnlinkWhatsAppCatalogData = {
|
|
26887
|
+
query: {
|
|
26888
|
+
/**
|
|
26889
|
+
* WhatsApp account ID
|
|
26890
|
+
*/
|
|
26891
|
+
accountId: string;
|
|
26892
|
+
/**
|
|
26893
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
26894
|
+
*/
|
|
26895
|
+
catalogAccountId?: string;
|
|
26896
|
+
/**
|
|
26897
|
+
* Meta catalog ID
|
|
26898
|
+
*/
|
|
26899
|
+
catalogId: string;
|
|
26900
|
+
};
|
|
26901
|
+
};
|
|
26902
|
+
|
|
26903
|
+
export type UnlinkWhatsAppCatalogResponse = ({
|
|
26904
|
+
success?: boolean;
|
|
26905
|
+
wabaId?: string;
|
|
26906
|
+
catalogId?: string;
|
|
26907
|
+
});
|
|
26908
|
+
|
|
26909
|
+
export type UnlinkWhatsAppCatalogError = (ErrorResponse | {
|
|
26910
|
+
error?: string;
|
|
26911
|
+
});
|
|
26912
|
+
|
|
26913
|
+
export type GetWhatsAppCommerceSettingsData = {
|
|
26914
|
+
query: {
|
|
26915
|
+
/**
|
|
26916
|
+
* WhatsApp account ID
|
|
26917
|
+
*/
|
|
26918
|
+
accountId: string;
|
|
26919
|
+
/**
|
|
26920
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
26921
|
+
*/
|
|
26922
|
+
catalogAccountId?: string;
|
|
26923
|
+
};
|
|
26924
|
+
};
|
|
26925
|
+
|
|
26926
|
+
export type GetWhatsAppCommerceSettingsResponse = ({
|
|
26927
|
+
settings?: WhatsAppCommerceSettings;
|
|
26928
|
+
});
|
|
26929
|
+
|
|
26930
|
+
export type GetWhatsAppCommerceSettingsError = (ErrorResponse | {
|
|
26931
|
+
error?: string;
|
|
26932
|
+
});
|
|
26933
|
+
|
|
26934
|
+
export type UpdateWhatsAppCommerceSettingsData = {
|
|
26935
|
+
body: {
|
|
26936
|
+
/**
|
|
26937
|
+
* WhatsApp account ID
|
|
26938
|
+
*/
|
|
26939
|
+
accountId: string;
|
|
26940
|
+
catalogAccountId?: string;
|
|
26941
|
+
isCartEnabled?: boolean;
|
|
26942
|
+
isCatalogVisible?: boolean;
|
|
26943
|
+
};
|
|
26944
|
+
};
|
|
26945
|
+
|
|
26946
|
+
export type UpdateWhatsAppCommerceSettingsResponse = ({
|
|
26947
|
+
settings?: WhatsAppCommerceSettings;
|
|
26948
|
+
});
|
|
26949
|
+
|
|
26950
|
+
export type UpdateWhatsAppCommerceSettingsError = (ErrorResponse | {
|
|
26951
|
+
error?: string;
|
|
26952
|
+
});
|
|
26953
|
+
|
|
26657
26954
|
export type GetWhatsAppBusinessProfileData = {
|
|
26658
26955
|
query: {
|
|
26659
26956
|
/**
|
|
@@ -40669,31 +40966,446 @@ export type GetLinkedInSupplyForecastError = (unknown | {
|
|
|
40669
40966
|
export type ListAdCatalogsData = {
|
|
40670
40967
|
query: {
|
|
40671
40968
|
/**
|
|
40672
|
-
* A facebook, instagram, or
|
|
40969
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
40673
40970
|
*/
|
|
40674
40971
|
accountId: string;
|
|
40675
40972
|
/**
|
|
40676
|
-
* Meta ad account ID (act_...)
|
|
40973
|
+
* Meta ad account ID (act_...) whose owner business to list
|
|
40677
40974
|
*/
|
|
40678
|
-
adAccountId
|
|
40975
|
+
adAccountId?: string;
|
|
40976
|
+
/**
|
|
40977
|
+
* Meta business portfolio ID to list
|
|
40978
|
+
*/
|
|
40979
|
+
businessId?: string;
|
|
40980
|
+
/**
|
|
40981
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token is used instead of the account's own (needed for WhatsApp connections, whose token cannot manage catalogs).
|
|
40982
|
+
*/
|
|
40983
|
+
catalogAccountId?: string;
|
|
40679
40984
|
};
|
|
40680
40985
|
};
|
|
40681
40986
|
|
|
40682
40987
|
export type ListAdCatalogsResponse = ({
|
|
40683
|
-
|
|
40684
|
-
|
|
40685
|
-
|
|
40988
|
+
businessId?: string;
|
|
40989
|
+
catalogs?: Array<MetaProductCatalog>;
|
|
40990
|
+
});
|
|
40991
|
+
|
|
40992
|
+
export type ListAdCatalogsError = (ErrorResponse | {
|
|
40993
|
+
error?: string;
|
|
40994
|
+
});
|
|
40995
|
+
|
|
40996
|
+
export type CreateAdCatalogData = {
|
|
40997
|
+
body: {
|
|
40686
40998
|
/**
|
|
40687
|
-
*
|
|
40999
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
40688
41000
|
*/
|
|
40689
|
-
|
|
40690
|
-
|
|
40691
|
-
|
|
41001
|
+
accountId: string;
|
|
41002
|
+
/**
|
|
41003
|
+
* Account whose Meta login token performs the call (see GET)
|
|
41004
|
+
*/
|
|
41005
|
+
catalogAccountId?: string;
|
|
41006
|
+
/**
|
|
41007
|
+
* Ad account whose owner business creates the catalog
|
|
41008
|
+
*/
|
|
41009
|
+
adAccountId?: string;
|
|
41010
|
+
/**
|
|
41011
|
+
* Business portfolio that owns the catalog
|
|
41012
|
+
*/
|
|
41013
|
+
businessId?: string;
|
|
41014
|
+
name: string;
|
|
41015
|
+
vertical?: 'commerce' | 'vehicles' | 'hotels' | 'flights' | 'destinations' | 'home_listings' | 'local_service_business' | 'offline_commerce' | 'ticketed_experiences' | 'transactable_items';
|
|
41016
|
+
};
|
|
41017
|
+
};
|
|
41018
|
+
|
|
41019
|
+
export type CreateAdCatalogResponse = ({
|
|
41020
|
+
catalog?: MetaProductCatalog;
|
|
40692
41021
|
});
|
|
40693
41022
|
|
|
40694
|
-
export type
|
|
41023
|
+
export type CreateAdCatalogError = (ErrorResponse | {
|
|
40695
41024
|
error?: string;
|
|
40696
|
-
}
|
|
41025
|
+
});
|
|
41026
|
+
|
|
41027
|
+
export type GetAdCatalogData = {
|
|
41028
|
+
path: {
|
|
41029
|
+
/**
|
|
41030
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41031
|
+
*/
|
|
41032
|
+
catalogId: string;
|
|
41033
|
+
};
|
|
41034
|
+
query: {
|
|
41035
|
+
/**
|
|
41036
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41037
|
+
*/
|
|
41038
|
+
accountId: string;
|
|
41039
|
+
/**
|
|
41040
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41041
|
+
*/
|
|
41042
|
+
catalogAccountId?: string;
|
|
41043
|
+
};
|
|
41044
|
+
};
|
|
41045
|
+
|
|
41046
|
+
export type GetAdCatalogResponse = ({
|
|
41047
|
+
catalog?: MetaProductCatalog;
|
|
41048
|
+
});
|
|
41049
|
+
|
|
41050
|
+
export type GetAdCatalogError = (ErrorResponse | {
|
|
41051
|
+
error?: string;
|
|
41052
|
+
});
|
|
41053
|
+
|
|
41054
|
+
export type DeleteAdCatalogData = {
|
|
41055
|
+
path: {
|
|
41056
|
+
/**
|
|
41057
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41058
|
+
*/
|
|
41059
|
+
catalogId: string;
|
|
41060
|
+
};
|
|
41061
|
+
query: {
|
|
41062
|
+
/**
|
|
41063
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41064
|
+
*/
|
|
41065
|
+
accountId: string;
|
|
41066
|
+
/**
|
|
41067
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41068
|
+
*/
|
|
41069
|
+
catalogAccountId?: string;
|
|
41070
|
+
};
|
|
41071
|
+
};
|
|
41072
|
+
|
|
41073
|
+
export type DeleteAdCatalogResponse = ({
|
|
41074
|
+
success?: boolean;
|
|
41075
|
+
catalogId?: string;
|
|
41076
|
+
});
|
|
41077
|
+
|
|
41078
|
+
export type DeleteAdCatalogError = (ErrorResponse | {
|
|
41079
|
+
error?: string;
|
|
41080
|
+
});
|
|
41081
|
+
|
|
41082
|
+
export type ListAdCatalogProductsData = {
|
|
41083
|
+
path: {
|
|
41084
|
+
/**
|
|
41085
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41086
|
+
*/
|
|
41087
|
+
catalogId: string;
|
|
41088
|
+
};
|
|
41089
|
+
query: {
|
|
41090
|
+
/**
|
|
41091
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41092
|
+
*/
|
|
41093
|
+
accountId: string;
|
|
41094
|
+
/**
|
|
41095
|
+
* Cursor from the previous page's `nextCursor`
|
|
41096
|
+
*/
|
|
41097
|
+
after?: string;
|
|
41098
|
+
/**
|
|
41099
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41100
|
+
*/
|
|
41101
|
+
catalogAccountId?: string;
|
|
41102
|
+
limit?: number;
|
|
41103
|
+
/**
|
|
41104
|
+
* Only the product with this retailer id (your SKU)
|
|
41105
|
+
*/
|
|
41106
|
+
retailerId?: string;
|
|
41107
|
+
};
|
|
41108
|
+
};
|
|
41109
|
+
|
|
41110
|
+
export type ListAdCatalogProductsResponse = ({
|
|
41111
|
+
products?: Array<MetaCatalogProduct>;
|
|
41112
|
+
nextCursor?: (string) | null;
|
|
41113
|
+
});
|
|
41114
|
+
|
|
41115
|
+
export type ListAdCatalogProductsError = (ErrorResponse | {
|
|
41116
|
+
error?: string;
|
|
41117
|
+
});
|
|
41118
|
+
|
|
41119
|
+
export type CreateAdCatalogProductData = {
|
|
41120
|
+
body: {
|
|
41121
|
+
accountId: string;
|
|
41122
|
+
catalogAccountId?: string;
|
|
41123
|
+
product: (MetaCatalogProductInput & {
|
|
41124
|
+
[key: string]: unknown;
|
|
41125
|
+
});
|
|
41126
|
+
};
|
|
41127
|
+
path: {
|
|
41128
|
+
/**
|
|
41129
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41130
|
+
*/
|
|
41131
|
+
catalogId: string;
|
|
41132
|
+
};
|
|
41133
|
+
};
|
|
41134
|
+
|
|
41135
|
+
export type CreateAdCatalogProductResponse = ({
|
|
41136
|
+
product?: MetaCatalogProduct;
|
|
41137
|
+
});
|
|
41138
|
+
|
|
41139
|
+
export type CreateAdCatalogProductError = (ErrorResponse | {
|
|
41140
|
+
error?: string;
|
|
41141
|
+
});
|
|
41142
|
+
|
|
41143
|
+
export type BatchAdCatalogProductsData = {
|
|
41144
|
+
body: {
|
|
41145
|
+
accountId: string;
|
|
41146
|
+
catalogAccountId?: string;
|
|
41147
|
+
requests: Array<{
|
|
41148
|
+
method: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
41149
|
+
product: (MetaCatalogProductInput & {
|
|
41150
|
+
[key: string]: unknown;
|
|
41151
|
+
});
|
|
41152
|
+
}>;
|
|
41153
|
+
};
|
|
41154
|
+
path: {
|
|
41155
|
+
/**
|
|
41156
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41157
|
+
*/
|
|
41158
|
+
catalogId: string;
|
|
41159
|
+
};
|
|
41160
|
+
};
|
|
41161
|
+
|
|
41162
|
+
export type BatchAdCatalogProductsResponse = ({
|
|
41163
|
+
handles?: Array<(string)>;
|
|
41164
|
+
statusUrl?: string;
|
|
41165
|
+
});
|
|
41166
|
+
|
|
41167
|
+
export type BatchAdCatalogProductsError = (ErrorResponse | {
|
|
41168
|
+
error?: string;
|
|
41169
|
+
});
|
|
41170
|
+
|
|
41171
|
+
export type GetAdCatalogBatchData = {
|
|
41172
|
+
path: {
|
|
41173
|
+
/**
|
|
41174
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41175
|
+
*/
|
|
41176
|
+
catalogId: string;
|
|
41177
|
+
/**
|
|
41178
|
+
* Handle returned by the batch call
|
|
41179
|
+
*/
|
|
41180
|
+
handle: string;
|
|
41181
|
+
};
|
|
41182
|
+
query: {
|
|
41183
|
+
/**
|
|
41184
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41185
|
+
*/
|
|
41186
|
+
accountId: string;
|
|
41187
|
+
/**
|
|
41188
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41189
|
+
*/
|
|
41190
|
+
catalogAccountId?: string;
|
|
41191
|
+
};
|
|
41192
|
+
};
|
|
41193
|
+
|
|
41194
|
+
export type GetAdCatalogBatchResponse = ({
|
|
41195
|
+
batch?: {
|
|
41196
|
+
handle?: string;
|
|
41197
|
+
/**
|
|
41198
|
+
* Meta's status, e.g. initial, in_progress, finished
|
|
41199
|
+
*/
|
|
41200
|
+
status?: string;
|
|
41201
|
+
errorsTotalCount?: number;
|
|
41202
|
+
errors?: Array<{
|
|
41203
|
+
retailerId?: (string) | null;
|
|
41204
|
+
message?: string;
|
|
41205
|
+
}>;
|
|
41206
|
+
};
|
|
41207
|
+
});
|
|
41208
|
+
|
|
41209
|
+
export type GetAdCatalogBatchError = (ErrorResponse | {
|
|
41210
|
+
error?: string;
|
|
41211
|
+
});
|
|
41212
|
+
|
|
41213
|
+
export type GetAdCatalogProductData = {
|
|
41214
|
+
path: {
|
|
41215
|
+
/**
|
|
41216
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41217
|
+
*/
|
|
41218
|
+
catalogId: string;
|
|
41219
|
+
/**
|
|
41220
|
+
* Meta product item ID (from the products list; not the retailer id)
|
|
41221
|
+
*/
|
|
41222
|
+
productId: string;
|
|
41223
|
+
};
|
|
41224
|
+
query: {
|
|
41225
|
+
/**
|
|
41226
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41227
|
+
*/
|
|
41228
|
+
accountId: string;
|
|
41229
|
+
/**
|
|
41230
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41231
|
+
*/
|
|
41232
|
+
catalogAccountId?: string;
|
|
41233
|
+
};
|
|
41234
|
+
};
|
|
41235
|
+
|
|
41236
|
+
export type GetAdCatalogProductResponse = ({
|
|
41237
|
+
product?: MetaCatalogProduct;
|
|
41238
|
+
});
|
|
41239
|
+
|
|
41240
|
+
export type GetAdCatalogProductError = (ErrorResponse | {
|
|
41241
|
+
error?: string;
|
|
41242
|
+
});
|
|
41243
|
+
|
|
41244
|
+
export type UpdateAdCatalogProductData = {
|
|
41245
|
+
body: {
|
|
41246
|
+
accountId: string;
|
|
41247
|
+
catalogAccountId?: string;
|
|
41248
|
+
product: MetaCatalogProductInput;
|
|
41249
|
+
};
|
|
41250
|
+
path: {
|
|
41251
|
+
/**
|
|
41252
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41253
|
+
*/
|
|
41254
|
+
catalogId: string;
|
|
41255
|
+
/**
|
|
41256
|
+
* Meta product item ID (from the products list; not the retailer id)
|
|
41257
|
+
*/
|
|
41258
|
+
productId: string;
|
|
41259
|
+
};
|
|
41260
|
+
};
|
|
41261
|
+
|
|
41262
|
+
export type UpdateAdCatalogProductResponse = ({
|
|
41263
|
+
product?: MetaCatalogProduct;
|
|
41264
|
+
});
|
|
41265
|
+
|
|
41266
|
+
export type UpdateAdCatalogProductError = (ErrorResponse | {
|
|
41267
|
+
error?: string;
|
|
41268
|
+
});
|
|
41269
|
+
|
|
41270
|
+
export type DeleteAdCatalogProductData = {
|
|
41271
|
+
path: {
|
|
41272
|
+
/**
|
|
41273
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41274
|
+
*/
|
|
41275
|
+
catalogId: string;
|
|
41276
|
+
/**
|
|
41277
|
+
* Meta product item ID (from the products list; not the retailer id)
|
|
41278
|
+
*/
|
|
41279
|
+
productId: string;
|
|
41280
|
+
};
|
|
41281
|
+
query: {
|
|
41282
|
+
/**
|
|
41283
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41284
|
+
*/
|
|
41285
|
+
accountId: string;
|
|
41286
|
+
/**
|
|
41287
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41288
|
+
*/
|
|
41289
|
+
catalogAccountId?: string;
|
|
41290
|
+
};
|
|
41291
|
+
};
|
|
41292
|
+
|
|
41293
|
+
export type DeleteAdCatalogProductResponse = ({
|
|
41294
|
+
success?: boolean;
|
|
41295
|
+
productId?: string;
|
|
41296
|
+
});
|
|
41297
|
+
|
|
41298
|
+
export type DeleteAdCatalogProductError = (ErrorResponse | {
|
|
41299
|
+
error?: string;
|
|
41300
|
+
});
|
|
41301
|
+
|
|
41302
|
+
export type ListAdCatalogFeedsData = {
|
|
41303
|
+
path: {
|
|
41304
|
+
/**
|
|
41305
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41306
|
+
*/
|
|
41307
|
+
catalogId: string;
|
|
41308
|
+
};
|
|
41309
|
+
query: {
|
|
41310
|
+
/**
|
|
41311
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41312
|
+
*/
|
|
41313
|
+
accountId: string;
|
|
41314
|
+
/**
|
|
41315
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41316
|
+
*/
|
|
41317
|
+
catalogAccountId?: string;
|
|
41318
|
+
};
|
|
41319
|
+
};
|
|
41320
|
+
|
|
41321
|
+
export type ListAdCatalogFeedsResponse = ({
|
|
41322
|
+
feeds?: Array<MetaProductFeed>;
|
|
41323
|
+
});
|
|
41324
|
+
|
|
41325
|
+
export type ListAdCatalogFeedsError = (ErrorResponse | {
|
|
41326
|
+
error?: string;
|
|
41327
|
+
});
|
|
41328
|
+
|
|
41329
|
+
export type CreateAdCatalogFeedData = {
|
|
41330
|
+
body: {
|
|
41331
|
+
accountId: string;
|
|
41332
|
+
catalogAccountId?: string;
|
|
41333
|
+
name: string;
|
|
41334
|
+
schedule?: {
|
|
41335
|
+
interval: 'HOURLY' | 'DAILY' | 'WEEKLY';
|
|
41336
|
+
url: string;
|
|
41337
|
+
hour?: number;
|
|
41338
|
+
dayOfWeek?: 'SUNDAY' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY';
|
|
41339
|
+
};
|
|
41340
|
+
};
|
|
41341
|
+
path: {
|
|
41342
|
+
/**
|
|
41343
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41344
|
+
*/
|
|
41345
|
+
catalogId: string;
|
|
41346
|
+
};
|
|
41347
|
+
};
|
|
41348
|
+
|
|
41349
|
+
export type CreateAdCatalogFeedResponse = ({
|
|
41350
|
+
feed?: MetaProductFeed;
|
|
41351
|
+
});
|
|
41352
|
+
|
|
41353
|
+
export type CreateAdCatalogFeedError = (ErrorResponse | {
|
|
41354
|
+
error?: string;
|
|
41355
|
+
});
|
|
41356
|
+
|
|
41357
|
+
export type ListAdCatalogFeedUploadsData = {
|
|
41358
|
+
path: {
|
|
41359
|
+
/**
|
|
41360
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41361
|
+
*/
|
|
41362
|
+
catalogId: string;
|
|
41363
|
+
feedId: string;
|
|
41364
|
+
};
|
|
41365
|
+
query: {
|
|
41366
|
+
/**
|
|
41367
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41368
|
+
*/
|
|
41369
|
+
accountId: string;
|
|
41370
|
+
/**
|
|
41371
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41372
|
+
*/
|
|
41373
|
+
catalogAccountId?: string;
|
|
41374
|
+
};
|
|
41375
|
+
};
|
|
41376
|
+
|
|
41377
|
+
export type ListAdCatalogFeedUploadsResponse = ({
|
|
41378
|
+
uploads?: Array<MetaFeedUpload>;
|
|
41379
|
+
});
|
|
41380
|
+
|
|
41381
|
+
export type ListAdCatalogFeedUploadsError = (ErrorResponse | {
|
|
41382
|
+
error?: string;
|
|
41383
|
+
});
|
|
41384
|
+
|
|
41385
|
+
export type CreateAdCatalogFeedUploadData = {
|
|
41386
|
+
body: {
|
|
41387
|
+
accountId: string;
|
|
41388
|
+
catalogAccountId?: string;
|
|
41389
|
+
url: string;
|
|
41390
|
+
};
|
|
41391
|
+
path: {
|
|
41392
|
+
/**
|
|
41393
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41394
|
+
*/
|
|
41395
|
+
catalogId: string;
|
|
41396
|
+
feedId: string;
|
|
41397
|
+
};
|
|
41398
|
+
};
|
|
41399
|
+
|
|
41400
|
+
export type CreateAdCatalogFeedUploadResponse = ({
|
|
41401
|
+
upload?: {
|
|
41402
|
+
id?: string;
|
|
41403
|
+
};
|
|
41404
|
+
});
|
|
41405
|
+
|
|
41406
|
+
export type CreateAdCatalogFeedUploadError = (ErrorResponse | {
|
|
41407
|
+
error?: string;
|
|
41408
|
+
});
|
|
40697
41409
|
|
|
40698
41410
|
export type ListAdCatalogProductSetsData = {
|
|
40699
41411
|
path: {
|
|
@@ -40704,9 +41416,13 @@ export type ListAdCatalogProductSetsData = {
|
|
|
40704
41416
|
};
|
|
40705
41417
|
query: {
|
|
40706
41418
|
/**
|
|
40707
|
-
* A facebook, instagram, or
|
|
41419
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
40708
41420
|
*/
|
|
40709
41421
|
accountId: string;
|
|
41422
|
+
/**
|
|
41423
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41424
|
+
*/
|
|
41425
|
+
catalogAccountId?: string;
|
|
40710
41426
|
};
|
|
40711
41427
|
};
|
|
40712
41428
|
|
|
@@ -40720,7 +41436,90 @@ export type ListAdCatalogProductSetsResponse = ({
|
|
|
40720
41436
|
|
|
40721
41437
|
export type ListAdCatalogProductSetsError = (ErrorResponse | {
|
|
40722
41438
|
error?: string;
|
|
40723
|
-
}
|
|
41439
|
+
});
|
|
41440
|
+
|
|
41441
|
+
export type CreateAdCatalogProductSetData = {
|
|
41442
|
+
body: {
|
|
41443
|
+
accountId: string;
|
|
41444
|
+
catalogAccountId?: string;
|
|
41445
|
+
name: string;
|
|
41446
|
+
/**
|
|
41447
|
+
* Meta product set filter
|
|
41448
|
+
*/
|
|
41449
|
+
filter: {
|
|
41450
|
+
[key: string]: unknown;
|
|
41451
|
+
};
|
|
41452
|
+
};
|
|
41453
|
+
path: {
|
|
41454
|
+
/**
|
|
41455
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41456
|
+
*/
|
|
41457
|
+
catalogId: string;
|
|
41458
|
+
};
|
|
41459
|
+
};
|
|
41460
|
+
|
|
41461
|
+
export type CreateAdCatalogProductSetResponse = ({
|
|
41462
|
+
productSet?: MetaProductSet;
|
|
41463
|
+
});
|
|
41464
|
+
|
|
41465
|
+
export type CreateAdCatalogProductSetError = (ErrorResponse | {
|
|
41466
|
+
error?: string;
|
|
41467
|
+
});
|
|
41468
|
+
|
|
41469
|
+
export type UpdateAdCatalogProductSetData = {
|
|
41470
|
+
body: {
|
|
41471
|
+
accountId: string;
|
|
41472
|
+
catalogAccountId?: string;
|
|
41473
|
+
name?: string;
|
|
41474
|
+
filter?: {
|
|
41475
|
+
[key: string]: unknown;
|
|
41476
|
+
};
|
|
41477
|
+
};
|
|
41478
|
+
path: {
|
|
41479
|
+
/**
|
|
41480
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41481
|
+
*/
|
|
41482
|
+
catalogId: string;
|
|
41483
|
+
productSetId: string;
|
|
41484
|
+
};
|
|
41485
|
+
};
|
|
41486
|
+
|
|
41487
|
+
export type UpdateAdCatalogProductSetResponse = ({
|
|
41488
|
+
productSet?: MetaProductSet;
|
|
41489
|
+
});
|
|
41490
|
+
|
|
41491
|
+
export type UpdateAdCatalogProductSetError = (ErrorResponse | {
|
|
41492
|
+
error?: string;
|
|
41493
|
+
});
|
|
41494
|
+
|
|
41495
|
+
export type DeleteAdCatalogProductSetData = {
|
|
41496
|
+
path: {
|
|
41497
|
+
/**
|
|
41498
|
+
* Meta product catalog ID (from GET /v1/ads/catalogs)
|
|
41499
|
+
*/
|
|
41500
|
+
catalogId: string;
|
|
41501
|
+
productSetId: string;
|
|
41502
|
+
};
|
|
41503
|
+
query: {
|
|
41504
|
+
/**
|
|
41505
|
+
* A facebook, instagram, metaads or whatsapp account ID
|
|
41506
|
+
*/
|
|
41507
|
+
accountId: string;
|
|
41508
|
+
/**
|
|
41509
|
+
* A facebook, instagram or metaads account whose Meta login carries catalog_management; its token performs the call instead of the account's own
|
|
41510
|
+
*/
|
|
41511
|
+
catalogAccountId?: string;
|
|
41512
|
+
};
|
|
41513
|
+
};
|
|
41514
|
+
|
|
41515
|
+
export type DeleteAdCatalogProductSetResponse = ({
|
|
41516
|
+
success?: boolean;
|
|
41517
|
+
productSetId?: string;
|
|
41518
|
+
});
|
|
41519
|
+
|
|
41520
|
+
export type DeleteAdCatalogProductSetError = (ErrorResponse | {
|
|
41521
|
+
error?: string;
|
|
41522
|
+
});
|
|
40724
41523
|
|
|
40725
41524
|
export type ListAdAudiencesData = {
|
|
40726
41525
|
query: {
|