@getlatedev/node 0.2.394 → 0.2.396
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 +19 -1
- package/dist/index.d.mts +500 -9
- package/dist/index.d.ts +500 -9
- package/dist/index.js +104 -1
- package/dist/index.mjs +104 -1
- package/package.json +1 -1
- package/src/client.ts +34 -0
- package/src/generated/sdk.gen.ts +216 -6
- package/src/generated/types.gen.ts +526 -9
|
@@ -4853,6 +4853,33 @@ export type UsersListResponse = {
|
|
|
4853
4853
|
users?: Array<User>;
|
|
4854
4854
|
};
|
|
4855
4855
|
|
|
4856
|
+
/**
|
|
4857
|
+
* A managed OTP verification. The code itself is never returned or stored (hash only).
|
|
4858
|
+
*/
|
|
4859
|
+
export type Verification = {
|
|
4860
|
+
id?: string;
|
|
4861
|
+
status?: 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
4862
|
+
channel?: 'sms';
|
|
4863
|
+
to?: string;
|
|
4864
|
+
expiresAt?: string;
|
|
4865
|
+
attempts?: number;
|
|
4866
|
+
maxAttempts?: number;
|
|
4867
|
+
/**
|
|
4868
|
+
* Accepted deliveries (initial send + resends); each bills one verification fee.
|
|
4869
|
+
*/
|
|
4870
|
+
sendCount?: number;
|
|
4871
|
+
lastSentAt?: (string) | null;
|
|
4872
|
+
createdAt?: string;
|
|
4873
|
+
/**
|
|
4874
|
+
* Present on create responses: true when an active verification was resent instead of created.
|
|
4875
|
+
*/
|
|
4876
|
+
resend?: boolean;
|
|
4877
|
+
};
|
|
4878
|
+
|
|
4879
|
+
export type status9 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
4880
|
+
|
|
4881
|
+
export type channel2 = 'sms';
|
|
4882
|
+
|
|
4856
4883
|
/**
|
|
4857
4884
|
* Individual webhook configuration for receiving real-time notifications
|
|
4858
4885
|
*/
|
|
@@ -4876,7 +4903,7 @@ export type Webhook = {
|
|
|
4876
4903
|
/**
|
|
4877
4904
|
* Events subscribed to
|
|
4878
4905
|
*/
|
|
4879
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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')>;
|
|
4906
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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' | 'verification.approved' | 'verification.failed')>;
|
|
4880
4907
|
/**
|
|
4881
4908
|
* Whether webhook delivery is enabled
|
|
4882
4909
|
*/
|
|
@@ -4964,7 +4991,7 @@ export type WebhookLog = {
|
|
|
4964
4991
|
/**
|
|
4965
4992
|
* Delivery outcome
|
|
4966
4993
|
*/
|
|
4967
|
-
export type
|
|
4994
|
+
export type status10 = 'success' | 'failed';
|
|
4968
4995
|
|
|
4969
4996
|
/**
|
|
4970
4997
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
@@ -5073,7 +5100,7 @@ export type event = 'account.ads.initial_sync_completed';
|
|
|
5073
5100
|
/**
|
|
5074
5101
|
* Overall outcome of the initial sync.
|
|
5075
5102
|
*/
|
|
5076
|
-
export type
|
|
5103
|
+
export type status11 = 'success' | 'failure';
|
|
5077
5104
|
|
|
5078
5105
|
/**
|
|
5079
5106
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
@@ -6509,7 +6536,7 @@ export type platform10 = 'whatsapp';
|
|
|
6509
6536
|
* request before the template is actually removed.
|
|
6510
6537
|
*
|
|
6511
6538
|
*/
|
|
6512
|
-
export type
|
|
6539
|
+
export type status12 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
6513
6540
|
|
|
6514
6541
|
export type WhatsAppBodyComponent = {
|
|
6515
6542
|
type: 'body';
|
|
@@ -6610,7 +6637,7 @@ export type WhatsAppSandboxSession = {
|
|
|
6610
6637
|
* list responses.
|
|
6611
6638
|
*
|
|
6612
6639
|
*/
|
|
6613
|
-
export type
|
|
6640
|
+
export type status13 = 'pending' | 'active';
|
|
6614
6641
|
|
|
6615
6642
|
export type WhatsAppTemplateButton = {
|
|
6616
6643
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
@@ -6729,7 +6756,7 @@ export type WorkflowExecutionEvent = {
|
|
|
6729
6756
|
|
|
6730
6757
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
6731
6758
|
|
|
6732
|
-
export type
|
|
6759
|
+
export type status14 = 'success' | 'failed' | 'pending';
|
|
6733
6760
|
|
|
6734
6761
|
/**
|
|
6735
6762
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -14146,7 +14173,7 @@ export type CreateWebhookSettingsData = {
|
|
|
14146
14173
|
/**
|
|
14147
14174
|
* Events to subscribe to (at least one required)
|
|
14148
14175
|
*/
|
|
14149
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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')>;
|
|
14176
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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' | 'verification.approved' | 'verification.failed')>;
|
|
14150
14177
|
/**
|
|
14151
14178
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
14152
14179
|
*/
|
|
@@ -14190,7 +14217,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
14190
14217
|
/**
|
|
14191
14218
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
14192
14219
|
*/
|
|
14193
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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')>;
|
|
14220
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'message.received' | 'conversation.started' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.failed' | 'reaction.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'whatsapp.template.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' | 'verification.approved' | 'verification.failed')>;
|
|
14194
14221
|
/**
|
|
14195
14222
|
* Enable or disable webhook delivery
|
|
14196
14223
|
*/
|
|
@@ -23758,6 +23785,48 @@ export type ListAdCampaignsError = ({
|
|
|
23758
23785
|
error?: string;
|
|
23759
23786
|
} | unknown);
|
|
23760
23787
|
|
|
23788
|
+
export type CreateAdCampaignData = {
|
|
23789
|
+
body: {
|
|
23790
|
+
/**
|
|
23791
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
23792
|
+
*/
|
|
23793
|
+
accountId: string;
|
|
23794
|
+
/**
|
|
23795
|
+
* Meta ad account id (act_<n>).
|
|
23796
|
+
*/
|
|
23797
|
+
adAccountId: string;
|
|
23798
|
+
name: string;
|
|
23799
|
+
/**
|
|
23800
|
+
* Mapped to the ODAX objective (same mapping as POST /v1/ads/create).
|
|
23801
|
+
*/
|
|
23802
|
+
goal: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'job_applicants' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
23803
|
+
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'ISSUES_ELECTIONS_POLITICS' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
23804
|
+
/**
|
|
23805
|
+
* Campaign-level (CBO) budget in whole currency units. Requires budgetType.
|
|
23806
|
+
*/
|
|
23807
|
+
budgetAmount?: number;
|
|
23808
|
+
budgetType?: 'daily' | 'lifetime';
|
|
23809
|
+
status?: 'ACTIVE' | 'PAUSED';
|
|
23810
|
+
};
|
|
23811
|
+
};
|
|
23812
|
+
|
|
23813
|
+
export type CreateAdCampaignResponse = ({
|
|
23814
|
+
adAccountId?: string;
|
|
23815
|
+
/**
|
|
23816
|
+
* Platform id of the new campaign
|
|
23817
|
+
*/
|
|
23818
|
+
campaignId?: string;
|
|
23819
|
+
/**
|
|
23820
|
+
* Resolved ODAX objective (e.g. OUTCOME_SALES).
|
|
23821
|
+
*/
|
|
23822
|
+
objective?: string;
|
|
23823
|
+
status?: 'ACTIVE' | 'PAUSED';
|
|
23824
|
+
});
|
|
23825
|
+
|
|
23826
|
+
export type CreateAdCampaignError = (unknown | {
|
|
23827
|
+
error?: string;
|
|
23828
|
+
});
|
|
23829
|
+
|
|
23761
23830
|
export type UpdateAdCampaignStatusData = {
|
|
23762
23831
|
body: {
|
|
23763
23832
|
status: 'active' | 'paused';
|
|
@@ -23949,6 +24018,89 @@ export type DuplicateAdCampaignError = (unknown | {
|
|
|
23949
24018
|
error?: string;
|
|
23950
24019
|
});
|
|
23951
24020
|
|
|
24021
|
+
export type DuplicateAdSetData = {
|
|
24022
|
+
body: {
|
|
24023
|
+
platform: 'facebook' | 'instagram';
|
|
24024
|
+
/**
|
|
24025
|
+
* Destination platform campaign id (defaults to the source's campaign)
|
|
24026
|
+
*/
|
|
24027
|
+
campaignId?: string;
|
|
24028
|
+
/**
|
|
24029
|
+
* Copy child ads + creatives
|
|
24030
|
+
*/
|
|
24031
|
+
deepCopy?: boolean;
|
|
24032
|
+
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
24033
|
+
/**
|
|
24034
|
+
* Reschedule the copy's start time
|
|
24035
|
+
*/
|
|
24036
|
+
startTime?: string;
|
|
24037
|
+
endTime?: string;
|
|
24038
|
+
renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
|
|
24039
|
+
renamePrefix?: string;
|
|
24040
|
+
renameSuffix?: string;
|
|
24041
|
+
syncAfter?: boolean;
|
|
24042
|
+
};
|
|
24043
|
+
path: {
|
|
24044
|
+
/**
|
|
24045
|
+
* Source platform ad set ID
|
|
24046
|
+
*/
|
|
24047
|
+
adSetId: string;
|
|
24048
|
+
};
|
|
24049
|
+
};
|
|
24050
|
+
|
|
24051
|
+
export type DuplicateAdSetResponse = ({
|
|
24052
|
+
/**
|
|
24053
|
+
* Platform ID of the new ad set
|
|
24054
|
+
*/
|
|
24055
|
+
copiedAdSetId?: string;
|
|
24056
|
+
discovery?: 'triggered' | 'skipped' | 'failed';
|
|
24057
|
+
/**
|
|
24058
|
+
* Meta's native copy response (includes ad_object_ids for child copies)
|
|
24059
|
+
*/
|
|
24060
|
+
raw?: {
|
|
24061
|
+
[key: string]: unknown;
|
|
24062
|
+
};
|
|
24063
|
+
});
|
|
24064
|
+
|
|
24065
|
+
export type DuplicateAdSetError = (unknown | {
|
|
24066
|
+
error?: string;
|
|
24067
|
+
});
|
|
24068
|
+
|
|
24069
|
+
export type DuplicateAdData = {
|
|
24070
|
+
body?: {
|
|
24071
|
+
/**
|
|
24072
|
+
* Destination platform ad set id (defaults to the source's ad set)
|
|
24073
|
+
*/
|
|
24074
|
+
adSetId?: string;
|
|
24075
|
+
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
24076
|
+
renameStrategy?: 'DEEP_RENAME' | 'ONLY_TOP_LEVEL_RENAME' | 'NO_RENAME';
|
|
24077
|
+
renamePrefix?: string;
|
|
24078
|
+
renameSuffix?: string;
|
|
24079
|
+
syncAfter?: boolean;
|
|
24080
|
+
};
|
|
24081
|
+
path: {
|
|
24082
|
+
/**
|
|
24083
|
+
* Zernio ad ID or platform ad ID
|
|
24084
|
+
*/
|
|
24085
|
+
adId: string;
|
|
24086
|
+
};
|
|
24087
|
+
};
|
|
24088
|
+
|
|
24089
|
+
export type DuplicateAdResponse = ({
|
|
24090
|
+
/**
|
|
24091
|
+
* Platform ID of the new ad
|
|
24092
|
+
*/
|
|
24093
|
+
copiedAdId?: string;
|
|
24094
|
+
discovery?: 'triggered' | 'skipped' | 'failed';
|
|
24095
|
+
raw?: {
|
|
24096
|
+
[key: string]: unknown;
|
|
24097
|
+
};
|
|
24098
|
+
});
|
|
24099
|
+
|
|
24100
|
+
export type DuplicateAdError = (unknown | {
|
|
24101
|
+
error?: string;
|
|
24102
|
+
});
|
|
24103
|
+
|
|
23952
24104
|
export type GetAdSetDetailsData = {
|
|
23953
24105
|
path: {
|
|
23954
24106
|
/**
|
|
@@ -25180,6 +25332,271 @@ export type ListAdStudiesError = (unknown | {
|
|
|
25180
25332
|
error?: string;
|
|
25181
25333
|
});
|
|
25182
25334
|
|
|
25335
|
+
export type ListAdLabelsData = {
|
|
25336
|
+
query: {
|
|
25337
|
+
/**
|
|
25338
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25339
|
+
*/
|
|
25340
|
+
accountId: string;
|
|
25341
|
+
/**
|
|
25342
|
+
* Meta ad account id (act_<n>).
|
|
25343
|
+
*/
|
|
25344
|
+
adAccountId: string;
|
|
25345
|
+
/**
|
|
25346
|
+
* Cursor from paging.after of the previous page.
|
|
25347
|
+
*/
|
|
25348
|
+
after?: string;
|
|
25349
|
+
/**
|
|
25350
|
+
* Rows per page
|
|
25351
|
+
*/
|
|
25352
|
+
limit?: number;
|
|
25353
|
+
};
|
|
25354
|
+
};
|
|
25355
|
+
|
|
25356
|
+
export type ListAdLabelsResponse = ({
|
|
25357
|
+
adAccountId?: string;
|
|
25358
|
+
data?: Array<{
|
|
25359
|
+
[key: string]: unknown;
|
|
25360
|
+
}>;
|
|
25361
|
+
paging?: {
|
|
25362
|
+
/**
|
|
25363
|
+
* Cursor for the next page; null when exhausted.
|
|
25364
|
+
*/
|
|
25365
|
+
after?: (string) | null;
|
|
25366
|
+
};
|
|
25367
|
+
});
|
|
25368
|
+
|
|
25369
|
+
export type ListAdLabelsError = (unknown | {
|
|
25370
|
+
error?: string;
|
|
25371
|
+
});
|
|
25372
|
+
|
|
25373
|
+
export type ListHighDemandPeriodsData = {
|
|
25374
|
+
query: {
|
|
25375
|
+
/**
|
|
25376
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25377
|
+
*/
|
|
25378
|
+
accountId: string;
|
|
25379
|
+
/**
|
|
25380
|
+
* Platform ad set id. Exactly one of campaignId / adSetId.
|
|
25381
|
+
*/
|
|
25382
|
+
adSetId?: string;
|
|
25383
|
+
/**
|
|
25384
|
+
* Cursor from paging.after of the previous page.
|
|
25385
|
+
*/
|
|
25386
|
+
after?: string;
|
|
25387
|
+
/**
|
|
25388
|
+
* Platform campaign id. Exactly one of campaignId / adSetId.
|
|
25389
|
+
*/
|
|
25390
|
+
campaignId?: string;
|
|
25391
|
+
/**
|
|
25392
|
+
* Rows per page
|
|
25393
|
+
*/
|
|
25394
|
+
limit?: number;
|
|
25395
|
+
};
|
|
25396
|
+
};
|
|
25397
|
+
|
|
25398
|
+
export type ListHighDemandPeriodsResponse = ({
|
|
25399
|
+
/**
|
|
25400
|
+
* The campaign / ad set id the schedules belong to.
|
|
25401
|
+
*/
|
|
25402
|
+
objectId?: string;
|
|
25403
|
+
data?: Array<{
|
|
25404
|
+
[key: string]: unknown;
|
|
25405
|
+
}>;
|
|
25406
|
+
paging?: {
|
|
25407
|
+
/**
|
|
25408
|
+
* Cursor for the next page; null when exhausted.
|
|
25409
|
+
*/
|
|
25410
|
+
after?: (string) | null;
|
|
25411
|
+
};
|
|
25412
|
+
});
|
|
25413
|
+
|
|
25414
|
+
export type ListHighDemandPeriodsError = (unknown | {
|
|
25415
|
+
error?: string;
|
|
25416
|
+
});
|
|
25417
|
+
|
|
25418
|
+
export type ListAdCreativesData = {
|
|
25419
|
+
query: {
|
|
25420
|
+
/**
|
|
25421
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25422
|
+
*/
|
|
25423
|
+
accountId: string;
|
|
25424
|
+
/**
|
|
25425
|
+
* Meta ad account id (act_<n>).
|
|
25426
|
+
*/
|
|
25427
|
+
adAccountId: string;
|
|
25428
|
+
/**
|
|
25429
|
+
* Cursor from paging.after of the previous page.
|
|
25430
|
+
*/
|
|
25431
|
+
after?: string;
|
|
25432
|
+
/**
|
|
25433
|
+
* Comma-separated Graph field override (supports nested {} projections).
|
|
25434
|
+
*/
|
|
25435
|
+
fields?: string;
|
|
25436
|
+
/**
|
|
25437
|
+
* Rows per page
|
|
25438
|
+
*/
|
|
25439
|
+
limit?: number;
|
|
25440
|
+
};
|
|
25441
|
+
};
|
|
25442
|
+
|
|
25443
|
+
export type ListAdCreativesResponse = ({
|
|
25444
|
+
adAccountId?: string;
|
|
25445
|
+
data?: Array<{
|
|
25446
|
+
[key: string]: unknown;
|
|
25447
|
+
}>;
|
|
25448
|
+
paging?: {
|
|
25449
|
+
/**
|
|
25450
|
+
* Cursor for the next page; null when exhausted.
|
|
25451
|
+
*/
|
|
25452
|
+
after?: (string) | null;
|
|
25453
|
+
};
|
|
25454
|
+
});
|
|
25455
|
+
|
|
25456
|
+
export type ListAdCreativesError = (unknown | {
|
|
25457
|
+
error?: string;
|
|
25458
|
+
});
|
|
25459
|
+
|
|
25460
|
+
export type CreateAdCreativeData = {
|
|
25461
|
+
body: {
|
|
25462
|
+
/**
|
|
25463
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token and Page.
|
|
25464
|
+
*/
|
|
25465
|
+
accountId: string;
|
|
25466
|
+
/**
|
|
25467
|
+
* Meta ad account id (act_<n>).
|
|
25468
|
+
*/
|
|
25469
|
+
adAccountId: string;
|
|
25470
|
+
headline: string;
|
|
25471
|
+
/**
|
|
25472
|
+
* Primary text
|
|
25473
|
+
*/
|
|
25474
|
+
body: string;
|
|
25475
|
+
/**
|
|
25476
|
+
* Link description below the headline; omitted = Meta scrapes the destination's OG description.
|
|
25477
|
+
*/
|
|
25478
|
+
description?: string;
|
|
25479
|
+
/**
|
|
25480
|
+
* CTA type (same whitelist as POST /v1/ads/create).
|
|
25481
|
+
*/
|
|
25482
|
+
callToAction?: string;
|
|
25483
|
+
linkUrl: string;
|
|
25484
|
+
/**
|
|
25485
|
+
* Publicly reachable image; uploaded to the account's library server-side.
|
|
25486
|
+
*/
|
|
25487
|
+
imageUrl?: string;
|
|
25488
|
+
/**
|
|
25489
|
+
* Existing library image hash (POST /v1/ads/images or GET /v1/ads/images).
|
|
25490
|
+
*/
|
|
25491
|
+
imageHash?: string;
|
|
25492
|
+
carouselCards?: Array<{
|
|
25493
|
+
imageUrl: string;
|
|
25494
|
+
linkUrl: string;
|
|
25495
|
+
headline?: string;
|
|
25496
|
+
description?: string;
|
|
25497
|
+
callToAction?: string;
|
|
25498
|
+
}>;
|
|
25499
|
+
/**
|
|
25500
|
+
* Appended to every outbound URL (e.g. utm_source=fb).
|
|
25501
|
+
*/
|
|
25502
|
+
urlTags?: string;
|
|
25503
|
+
};
|
|
25504
|
+
};
|
|
25505
|
+
|
|
25506
|
+
export type CreateAdCreativeResponse = ({
|
|
25507
|
+
adAccountId?: string;
|
|
25508
|
+
/**
|
|
25509
|
+
* Platform creative id, reusable via existingCreativeId.
|
|
25510
|
+
*/
|
|
25511
|
+
creativeId?: string;
|
|
25512
|
+
});
|
|
25513
|
+
|
|
25514
|
+
export type CreateAdCreativeError = (unknown | {
|
|
25515
|
+
error?: string;
|
|
25516
|
+
});
|
|
25517
|
+
|
|
25518
|
+
export type GetAdCreativeData = {
|
|
25519
|
+
path: {
|
|
25520
|
+
/**
|
|
25521
|
+
* Platform creative id
|
|
25522
|
+
*/
|
|
25523
|
+
creativeId: string;
|
|
25524
|
+
};
|
|
25525
|
+
query: {
|
|
25526
|
+
/**
|
|
25527
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25528
|
+
*/
|
|
25529
|
+
accountId: string;
|
|
25530
|
+
/**
|
|
25531
|
+
* Comma-separated Graph field override (supports nested {} projections).
|
|
25532
|
+
*/
|
|
25533
|
+
fields?: string;
|
|
25534
|
+
};
|
|
25535
|
+
};
|
|
25536
|
+
|
|
25537
|
+
export type GetAdCreativeResponse = ({
|
|
25538
|
+
/**
|
|
25539
|
+
* Raw Meta creative node
|
|
25540
|
+
*/
|
|
25541
|
+
creative?: {
|
|
25542
|
+
[key: string]: unknown;
|
|
25543
|
+
};
|
|
25544
|
+
});
|
|
25545
|
+
|
|
25546
|
+
export type GetAdCreativeError = (unknown | {
|
|
25547
|
+
error?: string;
|
|
25548
|
+
});
|
|
25549
|
+
|
|
25550
|
+
export type UpdateAdCreativeData = {
|
|
25551
|
+
body: {
|
|
25552
|
+
/**
|
|
25553
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25554
|
+
*/
|
|
25555
|
+
accountId: string;
|
|
25556
|
+
name: string;
|
|
25557
|
+
};
|
|
25558
|
+
path: {
|
|
25559
|
+
/**
|
|
25560
|
+
* Platform creative id
|
|
25561
|
+
*/
|
|
25562
|
+
creativeId: string;
|
|
25563
|
+
};
|
|
25564
|
+
};
|
|
25565
|
+
|
|
25566
|
+
export type UpdateAdCreativeResponse = ({
|
|
25567
|
+
creativeId?: string;
|
|
25568
|
+
name?: string;
|
|
25569
|
+
message?: string;
|
|
25570
|
+
});
|
|
25571
|
+
|
|
25572
|
+
export type UpdateAdCreativeError = (unknown | {
|
|
25573
|
+
error?: string;
|
|
25574
|
+
});
|
|
25575
|
+
|
|
25576
|
+
export type DeleteAdCreativeData = {
|
|
25577
|
+
path: {
|
|
25578
|
+
/**
|
|
25579
|
+
* Platform creative id
|
|
25580
|
+
*/
|
|
25581
|
+
creativeId: string;
|
|
25582
|
+
};
|
|
25583
|
+
query: {
|
|
25584
|
+
/**
|
|
25585
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
25586
|
+
*/
|
|
25587
|
+
accountId: string;
|
|
25588
|
+
};
|
|
25589
|
+
};
|
|
25590
|
+
|
|
25591
|
+
export type DeleteAdCreativeResponse = ({
|
|
25592
|
+
creativeId?: string;
|
|
25593
|
+
message?: string;
|
|
25594
|
+
});
|
|
25595
|
+
|
|
25596
|
+
export type DeleteAdCreativeError = (unknown | {
|
|
25597
|
+
error?: string;
|
|
25598
|
+
});
|
|
25599
|
+
|
|
25183
25600
|
export type GetAdAccountFinanceData = {
|
|
25184
25601
|
query: {
|
|
25185
25602
|
/**
|
|
@@ -26660,6 +27077,48 @@ export type UploadAdImageError = (unknown | {
|
|
|
26660
27077
|
error?: string;
|
|
26661
27078
|
});
|
|
26662
27079
|
|
|
27080
|
+
export type ListAdImagesData = {
|
|
27081
|
+
query: {
|
|
27082
|
+
/**
|
|
27083
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the Meta token.
|
|
27084
|
+
*/
|
|
27085
|
+
accountId: string;
|
|
27086
|
+
/**
|
|
27087
|
+
* Meta ad account id (act_<n>).
|
|
27088
|
+
*/
|
|
27089
|
+
adAccountId: string;
|
|
27090
|
+
/**
|
|
27091
|
+
* Cursor from paging.after of the previous page.
|
|
27092
|
+
*/
|
|
27093
|
+
after?: string;
|
|
27094
|
+
/**
|
|
27095
|
+
* Comma-separated Graph field override (supports nested {} projections).
|
|
27096
|
+
*/
|
|
27097
|
+
fields?: string;
|
|
27098
|
+
/**
|
|
27099
|
+
* Rows per page
|
|
27100
|
+
*/
|
|
27101
|
+
limit?: number;
|
|
27102
|
+
};
|
|
27103
|
+
};
|
|
27104
|
+
|
|
27105
|
+
export type ListAdImagesResponse = ({
|
|
27106
|
+
adAccountId?: string;
|
|
27107
|
+
data?: Array<{
|
|
27108
|
+
[key: string]: unknown;
|
|
27109
|
+
}>;
|
|
27110
|
+
paging?: {
|
|
27111
|
+
/**
|
|
27112
|
+
* Cursor for the next page; null when exhausted.
|
|
27113
|
+
*/
|
|
27114
|
+
after?: (string) | null;
|
|
27115
|
+
};
|
|
27116
|
+
});
|
|
27117
|
+
|
|
27118
|
+
export type ListAdImagesError = (unknown | {
|
|
27119
|
+
error?: string;
|
|
27120
|
+
});
|
|
27121
|
+
|
|
26663
27122
|
export type SearchAdInterestsData = {
|
|
26664
27123
|
query: {
|
|
26665
27124
|
/**
|
|
@@ -28215,4 +28674,62 @@ export type GetTrackingTagStatsResponse = ({
|
|
|
28215
28674
|
|
|
28216
28675
|
export type GetTrackingTagStatsError = (unknown | {
|
|
28217
28676
|
error?: string;
|
|
28218
|
-
});
|
|
28677
|
+
});
|
|
28678
|
+
|
|
28679
|
+
export type CreateVerificationData = {
|
|
28680
|
+
body: {
|
|
28681
|
+
/**
|
|
28682
|
+
* SMS-only for now.
|
|
28683
|
+
*/
|
|
28684
|
+
channel: 'sms';
|
|
28685
|
+
/**
|
|
28686
|
+
* E.164 phone number.
|
|
28687
|
+
*/
|
|
28688
|
+
to: string;
|
|
28689
|
+
/**
|
|
28690
|
+
* The SMS-enabled number on your account to send from. Defaults to your only SMS number.
|
|
28691
|
+
*/
|
|
28692
|
+
from?: string;
|
|
28693
|
+
/**
|
|
28694
|
+
* Your app or business name, rendered in the message. Defaults to your account name. Letters, numbers, and basic punctuation only.
|
|
28695
|
+
*/
|
|
28696
|
+
brandName?: string;
|
|
28697
|
+
codeLength?: number;
|
|
28698
|
+
ttlMinutes?: number;
|
|
28699
|
+
};
|
|
28700
|
+
};
|
|
28701
|
+
|
|
28702
|
+
export type CreateVerificationResponse = (Verification);
|
|
28703
|
+
|
|
28704
|
+
export type CreateVerificationError = (ErrorResponse | {
|
|
28705
|
+
error?: string;
|
|
28706
|
+
} | unknown);
|
|
28707
|
+
|
|
28708
|
+
export type GetVerificationData = {
|
|
28709
|
+
path: {
|
|
28710
|
+
verificationId: string;
|
|
28711
|
+
};
|
|
28712
|
+
};
|
|
28713
|
+
|
|
28714
|
+
export type GetVerificationResponse = (Verification);
|
|
28715
|
+
|
|
28716
|
+
export type GetVerificationError = (ErrorResponse | {
|
|
28717
|
+
error?: string;
|
|
28718
|
+
} | unknown);
|
|
28719
|
+
|
|
28720
|
+
export type CheckVerificationData = {
|
|
28721
|
+
body: {
|
|
28722
|
+
code: string;
|
|
28723
|
+
};
|
|
28724
|
+
path: {
|
|
28725
|
+
verificationId: string;
|
|
28726
|
+
};
|
|
28727
|
+
};
|
|
28728
|
+
|
|
28729
|
+
export type CheckVerificationResponse = ((Verification & {
|
|
28730
|
+
valid?: boolean;
|
|
28731
|
+
}));
|
|
28732
|
+
|
|
28733
|
+
export type CheckVerificationError = (ErrorResponse | {
|
|
28734
|
+
error?: string;
|
|
28735
|
+
} | unknown);
|