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