@getlatedev/node 0.2.375 → 0.2.377
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/dist/index.d.mts +93 -24
- package/dist/index.d.ts +93 -24
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +12 -4
- package/src/generated/types.gen.ts +84 -15
package/dist/index.d.mts
CHANGED
|
@@ -166,7 +166,7 @@ declare class Zernio {
|
|
|
166
166
|
listProfiles: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListProfilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfilesListResponse, ListProfilesError, ThrowOnError>;
|
|
167
167
|
createProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileCreateResponse, unknown, ThrowOnError>;
|
|
168
168
|
getProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileGetResponse, GetProfileError, ThrowOnError>;
|
|
169
|
-
updateProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileUpdateResponse,
|
|
169
|
+
updateProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileUpdateResponse, unknown, ThrowOnError>;
|
|
170
170
|
deleteProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileDeleteResponse, unknown, ThrowOnError>;
|
|
171
171
|
};
|
|
172
172
|
/**
|
|
@@ -692,16 +692,16 @@ declare class Zernio {
|
|
|
692
692
|
* sequences API
|
|
693
693
|
*/
|
|
694
694
|
sequences: {
|
|
695
|
-
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse,
|
|
696
|
-
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse,
|
|
697
|
-
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse,
|
|
698
|
-
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse,
|
|
699
|
-
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
695
|
+
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse, unknown, ThrowOnError>;
|
|
696
|
+
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse, unknown, ThrowOnError>;
|
|
697
|
+
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse, unknown, ThrowOnError>;
|
|
698
|
+
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse, unknown, ThrowOnError>;
|
|
699
|
+
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
700
700
|
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateSequenceResponse, unknown, ThrowOnError>;
|
|
701
701
|
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseSequenceResponse, unknown, ThrowOnError>;
|
|
702
|
-
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse,
|
|
703
|
-
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
704
|
-
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse,
|
|
702
|
+
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse, unknown, ThrowOnError>;
|
|
703
|
+
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
704
|
+
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse, unknown, ThrowOnError>;
|
|
705
705
|
};
|
|
706
706
|
/**
|
|
707
707
|
* commentautomations API
|
|
@@ -9509,7 +9509,7 @@ type UpdateProfileData = {
|
|
|
9509
9509
|
};
|
|
9510
9510
|
};
|
|
9511
9511
|
type UpdateProfileResponse = (ProfileUpdateResponse);
|
|
9512
|
-
type UpdateProfileError = ({
|
|
9512
|
+
type UpdateProfileError = (unknown | {
|
|
9513
9513
|
error?: string;
|
|
9514
9514
|
});
|
|
9515
9515
|
type DeleteProfileData = {
|
|
@@ -13667,7 +13667,7 @@ type ListQueueSlotsData = {
|
|
|
13667
13667
|
/**
|
|
13668
13668
|
* Set to 'true' to list all queues for the profile
|
|
13669
13669
|
*/
|
|
13670
|
-
all?: 'true';
|
|
13670
|
+
all?: 'true' | 'false';
|
|
13671
13671
|
/**
|
|
13672
13672
|
* Profile ID to get queues for
|
|
13673
13673
|
*/
|
|
@@ -13743,9 +13743,9 @@ type DeleteQueueSlotData = {
|
|
|
13743
13743
|
query: {
|
|
13744
13744
|
profileId: string;
|
|
13745
13745
|
/**
|
|
13746
|
-
* Queue ID to delete
|
|
13746
|
+
* Queue ID to delete. Omit to delete all queues for the profile
|
|
13747
13747
|
*/
|
|
13748
|
-
queueId
|
|
13748
|
+
queueId?: string;
|
|
13749
13749
|
};
|
|
13750
13750
|
};
|
|
13751
13751
|
type DeleteQueueSlotResponse = (QueueDeleteResponse);
|
|
@@ -21709,7 +21709,7 @@ type ListSequencesResponse = ({
|
|
|
21709
21709
|
hasMore?: boolean;
|
|
21710
21710
|
};
|
|
21711
21711
|
});
|
|
21712
|
-
type ListSequencesError = ({
|
|
21712
|
+
type ListSequencesError = (unknown | {
|
|
21713
21713
|
error?: string;
|
|
21714
21714
|
});
|
|
21715
21715
|
type CreateSequenceData = {
|
|
@@ -21758,7 +21758,7 @@ type CreateSequenceResponse = ({
|
|
|
21758
21758
|
createdAt?: string;
|
|
21759
21759
|
};
|
|
21760
21760
|
});
|
|
21761
|
-
type CreateSequenceError = ({
|
|
21761
|
+
type CreateSequenceError = (unknown | {
|
|
21762
21762
|
error?: string;
|
|
21763
21763
|
});
|
|
21764
21764
|
type GetSequenceData = {
|
|
@@ -21798,7 +21798,7 @@ type GetSequenceResponse = ({
|
|
|
21798
21798
|
updatedAt?: string;
|
|
21799
21799
|
};
|
|
21800
21800
|
});
|
|
21801
|
-
type GetSequenceError = ({
|
|
21801
|
+
type GetSequenceError = (unknown | {
|
|
21802
21802
|
error?: string;
|
|
21803
21803
|
});
|
|
21804
21804
|
type UpdateSequenceData = {
|
|
@@ -21847,7 +21847,7 @@ type UpdateSequenceResponse = ({
|
|
|
21847
21847
|
updatedAt?: string;
|
|
21848
21848
|
};
|
|
21849
21849
|
});
|
|
21850
|
-
type UpdateSequenceError = ({
|
|
21850
|
+
type UpdateSequenceError = (unknown | {
|
|
21851
21851
|
error?: string;
|
|
21852
21852
|
});
|
|
21853
21853
|
type DeleteSequenceData = {
|
|
@@ -21856,7 +21856,7 @@ type DeleteSequenceData = {
|
|
|
21856
21856
|
};
|
|
21857
21857
|
};
|
|
21858
21858
|
type DeleteSequenceResponse = (unknown);
|
|
21859
|
-
type DeleteSequenceError = ({
|
|
21859
|
+
type DeleteSequenceError = (unknown | {
|
|
21860
21860
|
error?: string;
|
|
21861
21861
|
});
|
|
21862
21862
|
type ActivateSequenceData = {
|
|
@@ -21908,11 +21908,22 @@ type EnrollContactsResponse = ({
|
|
|
21908
21908
|
*/
|
|
21909
21909
|
enrolled?: number;
|
|
21910
21910
|
/**
|
|
21911
|
-
* Number
|
|
21911
|
+
* Number that failed (already enrolled, or no subscribed channel on the sequence platform)
|
|
21912
21912
|
*/
|
|
21913
|
-
|
|
21913
|
+
failed?: number;
|
|
21914
|
+
/**
|
|
21915
|
+
* Per-contact outcome
|
|
21916
|
+
*/
|
|
21917
|
+
results?: Array<{
|
|
21918
|
+
contactId?: string;
|
|
21919
|
+
success?: boolean;
|
|
21920
|
+
/**
|
|
21921
|
+
* Present when success is false
|
|
21922
|
+
*/
|
|
21923
|
+
error?: string;
|
|
21924
|
+
}>;
|
|
21914
21925
|
});
|
|
21915
|
-
type EnrollContactsError = ({
|
|
21926
|
+
type EnrollContactsError = (unknown | {
|
|
21916
21927
|
error?: string;
|
|
21917
21928
|
});
|
|
21918
21929
|
type UnenrollContactData = {
|
|
@@ -21922,7 +21933,7 @@ type UnenrollContactData = {
|
|
|
21922
21933
|
};
|
|
21923
21934
|
};
|
|
21924
21935
|
type UnenrollContactResponse = (unknown);
|
|
21925
|
-
type UnenrollContactError = ({
|
|
21936
|
+
type UnenrollContactError = (unknown | {
|
|
21926
21937
|
error?: string;
|
|
21927
21938
|
});
|
|
21928
21939
|
type ListSequenceEnrollmentsData = {
|
|
@@ -21958,7 +21969,7 @@ type ListSequenceEnrollmentsResponse = ({
|
|
|
21958
21969
|
hasMore?: boolean;
|
|
21959
21970
|
};
|
|
21960
21971
|
});
|
|
21961
|
-
type ListSequenceEnrollmentsError = ({
|
|
21972
|
+
type ListSequenceEnrollmentsError = (unknown | {
|
|
21962
21973
|
error?: string;
|
|
21963
21974
|
});
|
|
21964
21975
|
type ListCommentAutomationsData = {
|
|
@@ -22478,9 +22489,21 @@ type UpdateAdCampaignData = {
|
|
|
22478
22489
|
*/
|
|
22479
22490
|
bidStrategy?: (BidStrategy);
|
|
22480
22491
|
/**
|
|
22481
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22492
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22482
22493
|
*/
|
|
22483
22494
|
name?: string;
|
|
22495
|
+
/**
|
|
22496
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22497
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22498
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22499
|
+
*
|
|
22500
|
+
*/
|
|
22501
|
+
platformSpecificData?: {
|
|
22502
|
+
/**
|
|
22503
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22504
|
+
*/
|
|
22505
|
+
spendCap?: (number) | null;
|
|
22506
|
+
};
|
|
22484
22507
|
};
|
|
22485
22508
|
path: {
|
|
22486
22509
|
/**
|
|
@@ -22494,6 +22517,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22494
22517
|
budget?: AdBudget;
|
|
22495
22518
|
budgetLevel?: 'campaign';
|
|
22496
22519
|
bidStrategy?: BidStrategy;
|
|
22520
|
+
platformSpecificData?: {
|
|
22521
|
+
[key: string]: unknown;
|
|
22522
|
+
};
|
|
22497
22523
|
});
|
|
22498
22524
|
type UpdateAdCampaignError = (unknown | {
|
|
22499
22525
|
error?: string;
|
|
@@ -22634,6 +22660,42 @@ type UpdateAdSetData = {
|
|
|
22634
22660
|
*
|
|
22635
22661
|
*/
|
|
22636
22662
|
roasAverageFloor?: number;
|
|
22663
|
+
/**
|
|
22664
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22665
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22666
|
+
*
|
|
22667
|
+
*/
|
|
22668
|
+
platformSpecificData?: {
|
|
22669
|
+
/**
|
|
22670
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22671
|
+
*/
|
|
22672
|
+
optimizationGoal?: string;
|
|
22673
|
+
/**
|
|
22674
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22675
|
+
*/
|
|
22676
|
+
billingEvent?: string;
|
|
22677
|
+
/**
|
|
22678
|
+
* Ad set start_time (ISO 8601).
|
|
22679
|
+
*/
|
|
22680
|
+
startDate?: string;
|
|
22681
|
+
/**
|
|
22682
|
+
* Ad set end_time (ISO 8601).
|
|
22683
|
+
*/
|
|
22684
|
+
endDate?: string;
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22687
|
+
*/
|
|
22688
|
+
promotedObject?: {
|
|
22689
|
+
pixelId?: string;
|
|
22690
|
+
customEventType?: string;
|
|
22691
|
+
pageId?: string;
|
|
22692
|
+
applicationId?: string;
|
|
22693
|
+
objectStoreUrl?: string;
|
|
22694
|
+
customConversionId?: string;
|
|
22695
|
+
productCatalogId?: string;
|
|
22696
|
+
productSetId?: string;
|
|
22697
|
+
};
|
|
22698
|
+
};
|
|
22637
22699
|
};
|
|
22638
22700
|
path: {
|
|
22639
22701
|
/**
|
|
@@ -22651,6 +22713,9 @@ type UpdateAdSetResponse = ({
|
|
|
22651
22713
|
bidStrategy?: BidStrategy;
|
|
22652
22714
|
bidAmount?: (number) | null;
|
|
22653
22715
|
roasAverageFloor?: (number) | null;
|
|
22716
|
+
platformSpecificData?: {
|
|
22717
|
+
[key: string]: unknown;
|
|
22718
|
+
};
|
|
22654
22719
|
});
|
|
22655
22720
|
type UpdateAdSetError = (unknown | {
|
|
22656
22721
|
error?: string;
|
|
@@ -23657,6 +23722,10 @@ type CreateStandaloneAdData = {
|
|
|
23657
23722
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23658
23723
|
*/
|
|
23659
23724
|
optimizationGoal?: string;
|
|
23725
|
+
/**
|
|
23726
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23727
|
+
*/
|
|
23728
|
+
billingEvent?: string;
|
|
23660
23729
|
/**
|
|
23661
23730
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23662
23731
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -166,7 +166,7 @@ declare class Zernio {
|
|
|
166
166
|
listProfiles: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListProfilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfilesListResponse, ListProfilesError, ThrowOnError>;
|
|
167
167
|
createProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileCreateResponse, unknown, ThrowOnError>;
|
|
168
168
|
getProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileGetResponse, GetProfileError, ThrowOnError>;
|
|
169
|
-
updateProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileUpdateResponse,
|
|
169
|
+
updateProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileUpdateResponse, unknown, ThrowOnError>;
|
|
170
170
|
deleteProfile: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteProfileData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProfileDeleteResponse, unknown, ThrowOnError>;
|
|
171
171
|
};
|
|
172
172
|
/**
|
|
@@ -692,16 +692,16 @@ declare class Zernio {
|
|
|
692
692
|
* sequences API
|
|
693
693
|
*/
|
|
694
694
|
sequences: {
|
|
695
|
-
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse,
|
|
696
|
-
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse,
|
|
697
|
-
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse,
|
|
698
|
-
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse,
|
|
699
|
-
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
695
|
+
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse, unknown, ThrowOnError>;
|
|
696
|
+
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse, unknown, ThrowOnError>;
|
|
697
|
+
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse, unknown, ThrowOnError>;
|
|
698
|
+
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse, unknown, ThrowOnError>;
|
|
699
|
+
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
700
700
|
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateSequenceResponse, unknown, ThrowOnError>;
|
|
701
701
|
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseSequenceResponse, unknown, ThrowOnError>;
|
|
702
|
-
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse,
|
|
703
|
-
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
704
|
-
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse,
|
|
702
|
+
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse, unknown, ThrowOnError>;
|
|
703
|
+
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
704
|
+
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse, unknown, ThrowOnError>;
|
|
705
705
|
};
|
|
706
706
|
/**
|
|
707
707
|
* commentautomations API
|
|
@@ -9509,7 +9509,7 @@ type UpdateProfileData = {
|
|
|
9509
9509
|
};
|
|
9510
9510
|
};
|
|
9511
9511
|
type UpdateProfileResponse = (ProfileUpdateResponse);
|
|
9512
|
-
type UpdateProfileError = ({
|
|
9512
|
+
type UpdateProfileError = (unknown | {
|
|
9513
9513
|
error?: string;
|
|
9514
9514
|
});
|
|
9515
9515
|
type DeleteProfileData = {
|
|
@@ -13667,7 +13667,7 @@ type ListQueueSlotsData = {
|
|
|
13667
13667
|
/**
|
|
13668
13668
|
* Set to 'true' to list all queues for the profile
|
|
13669
13669
|
*/
|
|
13670
|
-
all?: 'true';
|
|
13670
|
+
all?: 'true' | 'false';
|
|
13671
13671
|
/**
|
|
13672
13672
|
* Profile ID to get queues for
|
|
13673
13673
|
*/
|
|
@@ -13743,9 +13743,9 @@ type DeleteQueueSlotData = {
|
|
|
13743
13743
|
query: {
|
|
13744
13744
|
profileId: string;
|
|
13745
13745
|
/**
|
|
13746
|
-
* Queue ID to delete
|
|
13746
|
+
* Queue ID to delete. Omit to delete all queues for the profile
|
|
13747
13747
|
*/
|
|
13748
|
-
queueId
|
|
13748
|
+
queueId?: string;
|
|
13749
13749
|
};
|
|
13750
13750
|
};
|
|
13751
13751
|
type DeleteQueueSlotResponse = (QueueDeleteResponse);
|
|
@@ -21709,7 +21709,7 @@ type ListSequencesResponse = ({
|
|
|
21709
21709
|
hasMore?: boolean;
|
|
21710
21710
|
};
|
|
21711
21711
|
});
|
|
21712
|
-
type ListSequencesError = ({
|
|
21712
|
+
type ListSequencesError = (unknown | {
|
|
21713
21713
|
error?: string;
|
|
21714
21714
|
});
|
|
21715
21715
|
type CreateSequenceData = {
|
|
@@ -21758,7 +21758,7 @@ type CreateSequenceResponse = ({
|
|
|
21758
21758
|
createdAt?: string;
|
|
21759
21759
|
};
|
|
21760
21760
|
});
|
|
21761
|
-
type CreateSequenceError = ({
|
|
21761
|
+
type CreateSequenceError = (unknown | {
|
|
21762
21762
|
error?: string;
|
|
21763
21763
|
});
|
|
21764
21764
|
type GetSequenceData = {
|
|
@@ -21798,7 +21798,7 @@ type GetSequenceResponse = ({
|
|
|
21798
21798
|
updatedAt?: string;
|
|
21799
21799
|
};
|
|
21800
21800
|
});
|
|
21801
|
-
type GetSequenceError = ({
|
|
21801
|
+
type GetSequenceError = (unknown | {
|
|
21802
21802
|
error?: string;
|
|
21803
21803
|
});
|
|
21804
21804
|
type UpdateSequenceData = {
|
|
@@ -21847,7 +21847,7 @@ type UpdateSequenceResponse = ({
|
|
|
21847
21847
|
updatedAt?: string;
|
|
21848
21848
|
};
|
|
21849
21849
|
});
|
|
21850
|
-
type UpdateSequenceError = ({
|
|
21850
|
+
type UpdateSequenceError = (unknown | {
|
|
21851
21851
|
error?: string;
|
|
21852
21852
|
});
|
|
21853
21853
|
type DeleteSequenceData = {
|
|
@@ -21856,7 +21856,7 @@ type DeleteSequenceData = {
|
|
|
21856
21856
|
};
|
|
21857
21857
|
};
|
|
21858
21858
|
type DeleteSequenceResponse = (unknown);
|
|
21859
|
-
type DeleteSequenceError = ({
|
|
21859
|
+
type DeleteSequenceError = (unknown | {
|
|
21860
21860
|
error?: string;
|
|
21861
21861
|
});
|
|
21862
21862
|
type ActivateSequenceData = {
|
|
@@ -21908,11 +21908,22 @@ type EnrollContactsResponse = ({
|
|
|
21908
21908
|
*/
|
|
21909
21909
|
enrolled?: number;
|
|
21910
21910
|
/**
|
|
21911
|
-
* Number
|
|
21911
|
+
* Number that failed (already enrolled, or no subscribed channel on the sequence platform)
|
|
21912
21912
|
*/
|
|
21913
|
-
|
|
21913
|
+
failed?: number;
|
|
21914
|
+
/**
|
|
21915
|
+
* Per-contact outcome
|
|
21916
|
+
*/
|
|
21917
|
+
results?: Array<{
|
|
21918
|
+
contactId?: string;
|
|
21919
|
+
success?: boolean;
|
|
21920
|
+
/**
|
|
21921
|
+
* Present when success is false
|
|
21922
|
+
*/
|
|
21923
|
+
error?: string;
|
|
21924
|
+
}>;
|
|
21914
21925
|
});
|
|
21915
|
-
type EnrollContactsError = ({
|
|
21926
|
+
type EnrollContactsError = (unknown | {
|
|
21916
21927
|
error?: string;
|
|
21917
21928
|
});
|
|
21918
21929
|
type UnenrollContactData = {
|
|
@@ -21922,7 +21933,7 @@ type UnenrollContactData = {
|
|
|
21922
21933
|
};
|
|
21923
21934
|
};
|
|
21924
21935
|
type UnenrollContactResponse = (unknown);
|
|
21925
|
-
type UnenrollContactError = ({
|
|
21936
|
+
type UnenrollContactError = (unknown | {
|
|
21926
21937
|
error?: string;
|
|
21927
21938
|
});
|
|
21928
21939
|
type ListSequenceEnrollmentsData = {
|
|
@@ -21958,7 +21969,7 @@ type ListSequenceEnrollmentsResponse = ({
|
|
|
21958
21969
|
hasMore?: boolean;
|
|
21959
21970
|
};
|
|
21960
21971
|
});
|
|
21961
|
-
type ListSequenceEnrollmentsError = ({
|
|
21972
|
+
type ListSequenceEnrollmentsError = (unknown | {
|
|
21962
21973
|
error?: string;
|
|
21963
21974
|
});
|
|
21964
21975
|
type ListCommentAutomationsData = {
|
|
@@ -22478,9 +22489,21 @@ type UpdateAdCampaignData = {
|
|
|
22478
22489
|
*/
|
|
22479
22490
|
bidStrategy?: (BidStrategy);
|
|
22480
22491
|
/**
|
|
22481
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22492
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22482
22493
|
*/
|
|
22483
22494
|
name?: string;
|
|
22495
|
+
/**
|
|
22496
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22497
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22498
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22499
|
+
*
|
|
22500
|
+
*/
|
|
22501
|
+
platformSpecificData?: {
|
|
22502
|
+
/**
|
|
22503
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22504
|
+
*/
|
|
22505
|
+
spendCap?: (number) | null;
|
|
22506
|
+
};
|
|
22484
22507
|
};
|
|
22485
22508
|
path: {
|
|
22486
22509
|
/**
|
|
@@ -22494,6 +22517,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22494
22517
|
budget?: AdBudget;
|
|
22495
22518
|
budgetLevel?: 'campaign';
|
|
22496
22519
|
bidStrategy?: BidStrategy;
|
|
22520
|
+
platformSpecificData?: {
|
|
22521
|
+
[key: string]: unknown;
|
|
22522
|
+
};
|
|
22497
22523
|
});
|
|
22498
22524
|
type UpdateAdCampaignError = (unknown | {
|
|
22499
22525
|
error?: string;
|
|
@@ -22634,6 +22660,42 @@ type UpdateAdSetData = {
|
|
|
22634
22660
|
*
|
|
22635
22661
|
*/
|
|
22636
22662
|
roasAverageFloor?: number;
|
|
22663
|
+
/**
|
|
22664
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22665
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22666
|
+
*
|
|
22667
|
+
*/
|
|
22668
|
+
platformSpecificData?: {
|
|
22669
|
+
/**
|
|
22670
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22671
|
+
*/
|
|
22672
|
+
optimizationGoal?: string;
|
|
22673
|
+
/**
|
|
22674
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22675
|
+
*/
|
|
22676
|
+
billingEvent?: string;
|
|
22677
|
+
/**
|
|
22678
|
+
* Ad set start_time (ISO 8601).
|
|
22679
|
+
*/
|
|
22680
|
+
startDate?: string;
|
|
22681
|
+
/**
|
|
22682
|
+
* Ad set end_time (ISO 8601).
|
|
22683
|
+
*/
|
|
22684
|
+
endDate?: string;
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22687
|
+
*/
|
|
22688
|
+
promotedObject?: {
|
|
22689
|
+
pixelId?: string;
|
|
22690
|
+
customEventType?: string;
|
|
22691
|
+
pageId?: string;
|
|
22692
|
+
applicationId?: string;
|
|
22693
|
+
objectStoreUrl?: string;
|
|
22694
|
+
customConversionId?: string;
|
|
22695
|
+
productCatalogId?: string;
|
|
22696
|
+
productSetId?: string;
|
|
22697
|
+
};
|
|
22698
|
+
};
|
|
22637
22699
|
};
|
|
22638
22700
|
path: {
|
|
22639
22701
|
/**
|
|
@@ -22651,6 +22713,9 @@ type UpdateAdSetResponse = ({
|
|
|
22651
22713
|
bidStrategy?: BidStrategy;
|
|
22652
22714
|
bidAmount?: (number) | null;
|
|
22653
22715
|
roasAverageFloor?: (number) | null;
|
|
22716
|
+
platformSpecificData?: {
|
|
22717
|
+
[key: string]: unknown;
|
|
22718
|
+
};
|
|
22654
22719
|
});
|
|
22655
22720
|
type UpdateAdSetError = (unknown | {
|
|
22656
22721
|
error?: string;
|
|
@@ -23657,6 +23722,10 @@ type CreateStandaloneAdData = {
|
|
|
23657
23722
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23658
23723
|
*/
|
|
23659
23724
|
optimizationGoal?: string;
|
|
23725
|
+
/**
|
|
23726
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23727
|
+
*/
|
|
23728
|
+
billingEvent?: string;
|
|
23660
23729
|
/**
|
|
23661
23730
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23662
23731
|
*/
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.377",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.377",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -2567,7 +2567,8 @@ export const updateQueueSlot = <ThrowOnError extends boolean = false>(options: O
|
|
|
2567
2567
|
|
|
2568
2568
|
/**
|
|
2569
2569
|
* Delete schedule
|
|
2570
|
-
* Delete a queue from a profile.
|
|
2570
|
+
* Delete a queue from a profile. Pass queueId to delete a specific queue;
|
|
2571
|
+
* omit it to delete all queues for the profile.
|
|
2571
2572
|
* If deleting the default queue, another queue will be promoted to default.
|
|
2572
2573
|
*
|
|
2573
2574
|
*/
|
|
@@ -6197,13 +6198,15 @@ export const updateAdCampaignStatus = <ThrowOnError extends boolean = false>(opt
|
|
|
6197
6198
|
|
|
6198
6199
|
/**
|
|
6199
6200
|
* Update a campaign
|
|
6200
|
-
* Campaign-level edits. At least one of `budget` or `
|
|
6201
|
+
* Campaign-level edits. At least one of `budget`, `bidStrategy`, `name` or `platformSpecificData` is required.
|
|
6201
6202
|
*
|
|
6202
6203
|
* - `budget` updates the CBO (Campaign Budget Optimization) budget. For ABO campaigns
|
|
6203
6204
|
* (where the budget lives on the ad set), use PUT /v1/ads/ad-sets/{adSetId} instead — this endpoint
|
|
6204
6205
|
* will return 409 with code BUDGET_LEVEL_MISMATCH.
|
|
6205
6206
|
* - `bidStrategy` sets the campaign-level default bid strategy. Per Meta's spec, `bid_amount` and
|
|
6206
6207
|
* `bid_constraints` do NOT exist at the campaign level — pass them via PUT /v1/ads/ad-sets/{adSetId}.
|
|
6208
|
+
* - `platformSpecificData.spendCap` (Meta only) sets the campaign's lifetime spend cap, in the ad
|
|
6209
|
+
* account's currency.
|
|
6207
6210
|
*
|
|
6208
6211
|
* Meta-only for now. Other platforms return 501 Not Implemented.
|
|
6209
6212
|
*
|
|
@@ -6289,14 +6292,19 @@ export const duplicateAdCampaign = <ThrowOnError extends boolean = false>(option
|
|
|
6289
6292
|
/**
|
|
6290
6293
|
* Update an ad set
|
|
6291
6294
|
* Ad-set-level writes. Use this for ABO budget updates, ad-set-scoped
|
|
6292
|
-
* pause/resume,
|
|
6293
|
-
*
|
|
6295
|
+
* pause/resume, bid-strategy edits, and Meta-only post-launch delivery
|
|
6296
|
+
* settings via `platformSpecificData`. At least one updatable field
|
|
6297
|
+
* is required.
|
|
6294
6298
|
*
|
|
6295
6299
|
* Bid strategy compatibility (per Meta's spec):
|
|
6296
6300
|
* - `LOWEST_COST_WITHOUT_CAP`: no `bidAmount`, no `roasAverageFloor`.
|
|
6297
6301
|
* - `LOWEST_COST_WITH_BID_CAP` / `COST_CAP`: `bidAmount` REQUIRED (whole currency units).
|
|
6298
6302
|
* - `LOWEST_COST_WITH_MIN_ROAS`: `roasAverageFloor` REQUIRED (decimal multiplier, e.g. 2.0 = 2.0x ROAS).
|
|
6299
6303
|
*
|
|
6304
|
+
* Delivery settings are validated by Meta against the campaign objective;
|
|
6305
|
+
* incompatible combinations (e.g. a billingEvent the optimization goal
|
|
6306
|
+
* doesn't allow) surface as 400s from Meta.
|
|
6307
|
+
*
|
|
6300
6308
|
* When updating `budget` on an ABO campaign: if the parent campaign is
|
|
6301
6309
|
* CBO, the response is 409 with code BUDGET_LEVEL_MISMATCH — route to
|
|
6302
6310
|
* PUT /v1/ads/campaigns/{campaignId} instead.
|
|
@@ -9067,7 +9067,7 @@ export type UpdateProfileData = {
|
|
|
9067
9067
|
|
|
9068
9068
|
export type UpdateProfileResponse = (ProfileUpdateResponse);
|
|
9069
9069
|
|
|
9070
|
-
export type UpdateProfileError = ({
|
|
9070
|
+
export type UpdateProfileError = (unknown | {
|
|
9071
9071
|
error?: string;
|
|
9072
9072
|
});
|
|
9073
9073
|
|
|
@@ -13543,7 +13543,7 @@ export type ListQueueSlotsData = {
|
|
|
13543
13543
|
/**
|
|
13544
13544
|
* Set to 'true' to list all queues for the profile
|
|
13545
13545
|
*/
|
|
13546
|
-
all?: 'true';
|
|
13546
|
+
all?: 'true' | 'false';
|
|
13547
13547
|
/**
|
|
13548
13548
|
* Profile ID to get queues for
|
|
13549
13549
|
*/
|
|
@@ -13628,9 +13628,9 @@ export type DeleteQueueSlotData = {
|
|
|
13628
13628
|
query: {
|
|
13629
13629
|
profileId: string;
|
|
13630
13630
|
/**
|
|
13631
|
-
* Queue ID to delete
|
|
13631
|
+
* Queue ID to delete. Omit to delete all queues for the profile
|
|
13632
13632
|
*/
|
|
13633
|
-
queueId
|
|
13633
|
+
queueId?: string;
|
|
13634
13634
|
};
|
|
13635
13635
|
};
|
|
13636
13636
|
|
|
@@ -22247,7 +22247,7 @@ export type ListSequencesResponse = ({
|
|
|
22247
22247
|
};
|
|
22248
22248
|
});
|
|
22249
22249
|
|
|
22250
|
-
export type ListSequencesError = ({
|
|
22250
|
+
export type ListSequencesError = (unknown | {
|
|
22251
22251
|
error?: string;
|
|
22252
22252
|
});
|
|
22253
22253
|
|
|
@@ -22299,7 +22299,7 @@ export type CreateSequenceResponse = ({
|
|
|
22299
22299
|
};
|
|
22300
22300
|
});
|
|
22301
22301
|
|
|
22302
|
-
export type CreateSequenceError = ({
|
|
22302
|
+
export type CreateSequenceError = (unknown | {
|
|
22303
22303
|
error?: string;
|
|
22304
22304
|
});
|
|
22305
22305
|
|
|
@@ -22342,7 +22342,7 @@ export type GetSequenceResponse = ({
|
|
|
22342
22342
|
};
|
|
22343
22343
|
});
|
|
22344
22344
|
|
|
22345
|
-
export type GetSequenceError = ({
|
|
22345
|
+
export type GetSequenceError = (unknown | {
|
|
22346
22346
|
error?: string;
|
|
22347
22347
|
});
|
|
22348
22348
|
|
|
@@ -22394,7 +22394,7 @@ export type UpdateSequenceResponse = ({
|
|
|
22394
22394
|
};
|
|
22395
22395
|
});
|
|
22396
22396
|
|
|
22397
|
-
export type UpdateSequenceError = ({
|
|
22397
|
+
export type UpdateSequenceError = (unknown | {
|
|
22398
22398
|
error?: string;
|
|
22399
22399
|
});
|
|
22400
22400
|
|
|
@@ -22406,7 +22406,7 @@ export type DeleteSequenceData = {
|
|
|
22406
22406
|
|
|
22407
22407
|
export type DeleteSequenceResponse = (unknown);
|
|
22408
22408
|
|
|
22409
|
-
export type DeleteSequenceError = ({
|
|
22409
|
+
export type DeleteSequenceError = (unknown | {
|
|
22410
22410
|
error?: string;
|
|
22411
22411
|
});
|
|
22412
22412
|
|
|
@@ -22466,12 +22466,23 @@ export type EnrollContactsResponse = ({
|
|
|
22466
22466
|
*/
|
|
22467
22467
|
enrolled?: number;
|
|
22468
22468
|
/**
|
|
22469
|
-
* Number
|
|
22469
|
+
* Number that failed (already enrolled, or no subscribed channel on the sequence platform)
|
|
22470
22470
|
*/
|
|
22471
|
-
|
|
22471
|
+
failed?: number;
|
|
22472
|
+
/**
|
|
22473
|
+
* Per-contact outcome
|
|
22474
|
+
*/
|
|
22475
|
+
results?: Array<{
|
|
22476
|
+
contactId?: string;
|
|
22477
|
+
success?: boolean;
|
|
22478
|
+
/**
|
|
22479
|
+
* Present when success is false
|
|
22480
|
+
*/
|
|
22481
|
+
error?: string;
|
|
22482
|
+
}>;
|
|
22472
22483
|
});
|
|
22473
22484
|
|
|
22474
|
-
export type EnrollContactsError = ({
|
|
22485
|
+
export type EnrollContactsError = (unknown | {
|
|
22475
22486
|
error?: string;
|
|
22476
22487
|
});
|
|
22477
22488
|
|
|
@@ -22484,7 +22495,7 @@ export type UnenrollContactData = {
|
|
|
22484
22495
|
|
|
22485
22496
|
export type UnenrollContactResponse = (unknown);
|
|
22486
22497
|
|
|
22487
|
-
export type UnenrollContactError = ({
|
|
22498
|
+
export type UnenrollContactError = (unknown | {
|
|
22488
22499
|
error?: string;
|
|
22489
22500
|
});
|
|
22490
22501
|
|
|
@@ -22523,7 +22534,7 @@ export type ListSequenceEnrollmentsResponse = ({
|
|
|
22523
22534
|
};
|
|
22524
22535
|
});
|
|
22525
22536
|
|
|
22526
|
-
export type ListSequenceEnrollmentsError = ({
|
|
22537
|
+
export type ListSequenceEnrollmentsError = (unknown | {
|
|
22527
22538
|
error?: string;
|
|
22528
22539
|
});
|
|
22529
22540
|
|
|
@@ -23071,9 +23082,21 @@ export type UpdateAdCampaignData = {
|
|
|
23071
23082
|
*/
|
|
23072
23083
|
bidStrategy?: (BidStrategy);
|
|
23073
23084
|
/**
|
|
23074
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
23085
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
23075
23086
|
*/
|
|
23076
23087
|
name?: string;
|
|
23088
|
+
/**
|
|
23089
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
23090
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
23091
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
23092
|
+
*
|
|
23093
|
+
*/
|
|
23094
|
+
platformSpecificData?: {
|
|
23095
|
+
/**
|
|
23096
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
23097
|
+
*/
|
|
23098
|
+
spendCap?: (number) | null;
|
|
23099
|
+
};
|
|
23077
23100
|
};
|
|
23078
23101
|
path: {
|
|
23079
23102
|
/**
|
|
@@ -23088,6 +23111,9 @@ export type UpdateAdCampaignResponse = ({
|
|
|
23088
23111
|
budget?: AdBudget;
|
|
23089
23112
|
budgetLevel?: 'campaign';
|
|
23090
23113
|
bidStrategy?: BidStrategy;
|
|
23114
|
+
platformSpecificData?: {
|
|
23115
|
+
[key: string]: unknown;
|
|
23116
|
+
};
|
|
23091
23117
|
});
|
|
23092
23118
|
|
|
23093
23119
|
export type UpdateAdCampaignError = (unknown | {
|
|
@@ -23239,6 +23265,42 @@ export type UpdateAdSetData = {
|
|
|
23239
23265
|
*
|
|
23240
23266
|
*/
|
|
23241
23267
|
roasAverageFloor?: number;
|
|
23268
|
+
/**
|
|
23269
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
23270
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
23271
|
+
*
|
|
23272
|
+
*/
|
|
23273
|
+
platformSpecificData?: {
|
|
23274
|
+
/**
|
|
23275
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
23276
|
+
*/
|
|
23277
|
+
optimizationGoal?: string;
|
|
23278
|
+
/**
|
|
23279
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
23280
|
+
*/
|
|
23281
|
+
billingEvent?: string;
|
|
23282
|
+
/**
|
|
23283
|
+
* Ad set start_time (ISO 8601).
|
|
23284
|
+
*/
|
|
23285
|
+
startDate?: string;
|
|
23286
|
+
/**
|
|
23287
|
+
* Ad set end_time (ISO 8601).
|
|
23288
|
+
*/
|
|
23289
|
+
endDate?: string;
|
|
23290
|
+
/**
|
|
23291
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
23292
|
+
*/
|
|
23293
|
+
promotedObject?: {
|
|
23294
|
+
pixelId?: string;
|
|
23295
|
+
customEventType?: string;
|
|
23296
|
+
pageId?: string;
|
|
23297
|
+
applicationId?: string;
|
|
23298
|
+
objectStoreUrl?: string;
|
|
23299
|
+
customConversionId?: string;
|
|
23300
|
+
productCatalogId?: string;
|
|
23301
|
+
productSetId?: string;
|
|
23302
|
+
};
|
|
23303
|
+
};
|
|
23242
23304
|
};
|
|
23243
23305
|
path: {
|
|
23244
23306
|
/**
|
|
@@ -23257,6 +23319,9 @@ export type UpdateAdSetResponse = ({
|
|
|
23257
23319
|
bidStrategy?: BidStrategy;
|
|
23258
23320
|
bidAmount?: (number) | null;
|
|
23259
23321
|
roasAverageFloor?: (number) | null;
|
|
23322
|
+
platformSpecificData?: {
|
|
23323
|
+
[key: string]: unknown;
|
|
23324
|
+
};
|
|
23260
23325
|
});
|
|
23261
23326
|
|
|
23262
23327
|
export type UpdateAdSetError = (unknown | {
|
|
@@ -24319,6 +24384,10 @@ export type CreateStandaloneAdData = {
|
|
|
24319
24384
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
24320
24385
|
*/
|
|
24321
24386
|
optimizationGoal?: string;
|
|
24387
|
+
/**
|
|
24388
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
24389
|
+
*/
|
|
24390
|
+
billingEvent?: string;
|
|
24322
24391
|
/**
|
|
24323
24392
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
24324
24393
|
*/
|