@getlatedev/node 0.2.370 → 0.2.372
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 +58 -45
- package/dist/index.d.ts +58 -45
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +11 -0
- package/src/generated/types.gen.ts +46 -33
package/dist/index.d.mts
CHANGED
|
@@ -111,7 +111,7 @@ declare class Zernio {
|
|
|
111
111
|
listAccountGroups: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAccountGroupsResponse, ListAccountGroupsError, ThrowOnError>;
|
|
112
112
|
createAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountGroupResponse, unknown, ThrowOnError>;
|
|
113
113
|
updateAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAccountGroupResponse, unknown, ThrowOnError>;
|
|
114
|
-
deleteAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountGroupResponse,
|
|
114
|
+
deleteAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountGroupResponse, unknown, ThrowOnError>;
|
|
115
115
|
};
|
|
116
116
|
/**
|
|
117
117
|
* Media API - Upload and manage media files
|
|
@@ -635,13 +635,13 @@ declare class Zernio {
|
|
|
635
635
|
* contacts API
|
|
636
636
|
*/
|
|
637
637
|
contacts: {
|
|
638
|
-
listContacts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListContactsResponse,
|
|
638
|
+
listContacts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListContactsResponse, unknown, ThrowOnError>;
|
|
639
639
|
createContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateContactResponse, unknown, ThrowOnError>;
|
|
640
|
-
getContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactResponse,
|
|
641
|
-
updateContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateContactResponse,
|
|
642
|
-
deleteContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
643
|
-
getContactChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactChannelsResponse,
|
|
644
|
-
bulkCreateContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkCreateContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkCreateContactsResponse,
|
|
640
|
+
getContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactResponse, unknown, ThrowOnError>;
|
|
641
|
+
updateContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateContactResponse, unknown, ThrowOnError>;
|
|
642
|
+
deleteContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
643
|
+
getContactChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactChannelsResponse, unknown, ThrowOnError>;
|
|
644
|
+
bulkCreateContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkCreateContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkCreateContactsResponse, unknown, ThrowOnError>;
|
|
645
645
|
};
|
|
646
646
|
/**
|
|
647
647
|
* customfields API
|
|
@@ -658,16 +658,16 @@ declare class Zernio {
|
|
|
658
658
|
* broadcasts API
|
|
659
659
|
*/
|
|
660
660
|
broadcasts: {
|
|
661
|
-
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse,
|
|
662
|
-
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse,
|
|
661
|
+
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse, unknown, ThrowOnError>;
|
|
662
|
+
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse, unknown, ThrowOnError>;
|
|
663
663
|
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBroadcastResponse, GetBroadcastError, ThrowOnError>;
|
|
664
664
|
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBroadcastResponse, UpdateBroadcastError, ThrowOnError>;
|
|
665
665
|
deleteBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteBroadcastError, ThrowOnError>;
|
|
666
666
|
sendBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendBroadcastResponse, unknown, ThrowOnError>;
|
|
667
667
|
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ScheduleBroadcastResponse, unknown, ThrowOnError>;
|
|
668
668
|
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelBroadcastResponse, unknown, ThrowOnError>;
|
|
669
|
-
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse,
|
|
670
|
-
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse,
|
|
669
|
+
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse, unknown, ThrowOnError>;
|
|
670
|
+
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse, unknown, ThrowOnError>;
|
|
671
671
|
};
|
|
672
672
|
/**
|
|
673
673
|
* workflows API
|
|
@@ -707,7 +707,7 @@ declare class Zernio {
|
|
|
707
707
|
* commentautomations API
|
|
708
708
|
*/
|
|
709
709
|
commentautomations: {
|
|
710
|
-
listCommentAutomations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationsResponse,
|
|
710
|
+
listCommentAutomations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationsResponse, unknown, ThrowOnError>;
|
|
711
711
|
createCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCommentAutomationResponse, unknown, ThrowOnError>;
|
|
712
712
|
getCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCommentAutomationResponse, GetCommentAutomationError, ThrowOnError>;
|
|
713
713
|
updateCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateCommentAutomationResponse, UpdateCommentAutomationError, ThrowOnError>;
|
|
@@ -5007,15 +5007,15 @@ type UsageMetering = {
|
|
|
5007
5007
|
*/
|
|
5008
5008
|
tax?: {
|
|
5009
5009
|
/**
|
|
5010
|
-
* Estimated tax in USD
|
|
5010
|
+
* Estimated tax in USD, added on top of `totals.total`.
|
|
5011
5011
|
*/
|
|
5012
5012
|
taxUsd?: number;
|
|
5013
5013
|
/**
|
|
5014
|
-
* Combined rate percentage
|
|
5014
|
+
* Combined rate percentage, e.g. 21.
|
|
5015
5015
|
*/
|
|
5016
5016
|
ratePercent?: (number) | null;
|
|
5017
5017
|
/**
|
|
5018
|
-
* Human jurisdiction label
|
|
5018
|
+
* Human jurisdiction label, e.g. "ES VAT" or "WA sales tax".
|
|
5019
5019
|
*/
|
|
5020
5020
|
jurisdictionLabel?: (string) | null;
|
|
5021
5021
|
/**
|
|
@@ -8700,9 +8700,9 @@ type UpdateAccountGroupResponse = ({
|
|
|
8700
8700
|
[key: string]: unknown;
|
|
8701
8701
|
};
|
|
8702
8702
|
});
|
|
8703
|
-
type UpdateAccountGroupError = ({
|
|
8703
|
+
type UpdateAccountGroupError = (unknown | {
|
|
8704
8704
|
error?: string;
|
|
8705
|
-
}
|
|
8705
|
+
});
|
|
8706
8706
|
type DeleteAccountGroupData = {
|
|
8707
8707
|
path: {
|
|
8708
8708
|
groupId: string;
|
|
@@ -8711,7 +8711,7 @@ type DeleteAccountGroupData = {
|
|
|
8711
8711
|
type DeleteAccountGroupResponse = ({
|
|
8712
8712
|
message?: string;
|
|
8713
8713
|
});
|
|
8714
|
-
type DeleteAccountGroupError = ({
|
|
8714
|
+
type DeleteAccountGroupError = (unknown | {
|
|
8715
8715
|
error?: string;
|
|
8716
8716
|
});
|
|
8717
8717
|
type GetMediaPresignedUrlData = {
|
|
@@ -17314,7 +17314,7 @@ type StartSmsRegistrationData = {
|
|
|
17314
17314
|
messageFlow: string;
|
|
17315
17315
|
sample1: string;
|
|
17316
17316
|
/**
|
|
17317
|
-
* Second example message; carriers require two distinct samples
|
|
17317
|
+
* Second example message; carriers require two distinct samples, so it must differ from sample1.
|
|
17318
17318
|
*/
|
|
17319
17319
|
sample2: string;
|
|
17320
17320
|
helpMessage?: string;
|
|
@@ -20604,7 +20604,7 @@ type ListContactsResponse = ({
|
|
|
20604
20604
|
hasMore?: boolean;
|
|
20605
20605
|
};
|
|
20606
20606
|
});
|
|
20607
|
-
type ListContactsError = ({
|
|
20607
|
+
type ListContactsError = (unknown | {
|
|
20608
20608
|
error?: string;
|
|
20609
20609
|
});
|
|
20610
20610
|
type CreateContactData = {
|
|
@@ -20652,9 +20652,9 @@ type CreateContactResponse = ({
|
|
|
20652
20652
|
};
|
|
20653
20653
|
warning?: string;
|
|
20654
20654
|
});
|
|
20655
|
-
type CreateContactError = ({
|
|
20655
|
+
type CreateContactError = (unknown | {
|
|
20656
20656
|
error?: string;
|
|
20657
|
-
}
|
|
20657
|
+
});
|
|
20658
20658
|
type GetContactData = {
|
|
20659
20659
|
path: {
|
|
20660
20660
|
contactId: string;
|
|
@@ -20710,7 +20710,7 @@ type GetContactResponse = ({
|
|
|
20710
20710
|
createdAt?: string;
|
|
20711
20711
|
}>;
|
|
20712
20712
|
});
|
|
20713
|
-
type GetContactError = ({
|
|
20713
|
+
type GetContactError = (unknown | {
|
|
20714
20714
|
error?: string;
|
|
20715
20715
|
});
|
|
20716
20716
|
type UpdateContactData = {
|
|
@@ -20743,7 +20743,7 @@ type UpdateContactResponse = ({
|
|
|
20743
20743
|
updatedAt?: string;
|
|
20744
20744
|
};
|
|
20745
20745
|
});
|
|
20746
|
-
type UpdateContactError = ({
|
|
20746
|
+
type UpdateContactError = (unknown | {
|
|
20747
20747
|
error?: string;
|
|
20748
20748
|
});
|
|
20749
20749
|
type DeleteContactData = {
|
|
@@ -20752,7 +20752,7 @@ type DeleteContactData = {
|
|
|
20752
20752
|
};
|
|
20753
20753
|
};
|
|
20754
20754
|
type DeleteContactResponse = (unknown);
|
|
20755
|
-
type DeleteContactError = ({
|
|
20755
|
+
type DeleteContactError = (unknown | {
|
|
20756
20756
|
error?: string;
|
|
20757
20757
|
});
|
|
20758
20758
|
type GetContactChannelsData = {
|
|
@@ -20776,7 +20776,7 @@ type GetContactChannelsResponse = ({
|
|
|
20776
20776
|
createdAt?: string;
|
|
20777
20777
|
}>;
|
|
20778
20778
|
});
|
|
20779
|
-
type GetContactChannelsError = ({
|
|
20779
|
+
type GetContactChannelsError = (unknown | {
|
|
20780
20780
|
error?: string;
|
|
20781
20781
|
});
|
|
20782
20782
|
type BulkCreateContactsData = {
|
|
@@ -20803,7 +20803,7 @@ type BulkCreateContactsResponse = ({
|
|
|
20803
20803
|
}>;
|
|
20804
20804
|
total?: number;
|
|
20805
20805
|
});
|
|
20806
|
-
type BulkCreateContactsError = ({
|
|
20806
|
+
type BulkCreateContactsError = (unknown | {
|
|
20807
20807
|
error?: string;
|
|
20808
20808
|
});
|
|
20809
20809
|
type SetContactFieldValueData = {
|
|
@@ -20960,7 +20960,7 @@ type ListBroadcastsResponse = ({
|
|
|
20960
20960
|
hasMore?: boolean;
|
|
20961
20961
|
};
|
|
20962
20962
|
});
|
|
20963
|
-
type ListBroadcastsError = ({
|
|
20963
|
+
type ListBroadcastsError = (unknown | {
|
|
20964
20964
|
error?: string;
|
|
20965
20965
|
});
|
|
20966
20966
|
type CreateBroadcastData = {
|
|
@@ -21018,7 +21018,7 @@ type CreateBroadcastResponse = ({
|
|
|
21018
21018
|
createdAt?: string;
|
|
21019
21019
|
};
|
|
21020
21020
|
});
|
|
21021
|
-
type CreateBroadcastError = ({
|
|
21021
|
+
type CreateBroadcastError = (unknown | {
|
|
21022
21022
|
error?: string;
|
|
21023
21023
|
});
|
|
21024
21024
|
type GetBroadcastData = {
|
|
@@ -21220,7 +21220,7 @@ type ListBroadcastRecipientsResponse = ({
|
|
|
21220
21220
|
hasMore?: boolean;
|
|
21221
21221
|
};
|
|
21222
21222
|
});
|
|
21223
|
-
type ListBroadcastRecipientsError = ({
|
|
21223
|
+
type ListBroadcastRecipientsError = (unknown | {
|
|
21224
21224
|
error?: string;
|
|
21225
21225
|
});
|
|
21226
21226
|
type AddBroadcastRecipientsData = {
|
|
@@ -21253,7 +21253,7 @@ type AddBroadcastRecipientsResponse = ({
|
|
|
21253
21253
|
*/
|
|
21254
21254
|
skipped?: number;
|
|
21255
21255
|
});
|
|
21256
|
-
type AddBroadcastRecipientsError = ({
|
|
21256
|
+
type AddBroadcastRecipientsError = (unknown | {
|
|
21257
21257
|
error?: string;
|
|
21258
21258
|
});
|
|
21259
21259
|
type ListWorkflowsData = {
|
|
@@ -21999,7 +21999,7 @@ type ListCommentAutomationsResponse = ({
|
|
|
21999
21999
|
createdAt?: string;
|
|
22000
22000
|
}>;
|
|
22001
22001
|
});
|
|
22002
|
-
type ListCommentAutomationsError = ({
|
|
22002
|
+
type ListCommentAutomationsError = (unknown | {
|
|
22003
22003
|
error?: string;
|
|
22004
22004
|
});
|
|
22005
22005
|
type CreateCommentAutomationData = {
|
|
@@ -22514,11 +22514,15 @@ type BulkUpdateAdCampaignStatusError = (unknown | {
|
|
|
22514
22514
|
});
|
|
22515
22515
|
type DuplicateAdCampaignData = {
|
|
22516
22516
|
body: {
|
|
22517
|
-
platform: 'facebook' | 'instagram' | 'tiktok';
|
|
22517
|
+
platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin';
|
|
22518
22518
|
/**
|
|
22519
22519
|
* Copy child ad sets + ads + creatives + targeting
|
|
22520
22520
|
*/
|
|
22521
22521
|
deepCopy?: boolean;
|
|
22522
|
+
/**
|
|
22523
|
+
* ACTIVE = launch the clone immediately (spends the moment LinkedIn approves it). PAUSED = clone stays DRAFT, safe default. INHERITED_FROM_SOURCE = mirror each entity's source status per-entity. Duplicating an ACTIVE campaign this way starts a second front of spend.
|
|
22524
|
+
*
|
|
22525
|
+
*/
|
|
22522
22526
|
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
22523
22527
|
/**
|
|
22524
22528
|
* Reschedule the copied hierarchy's start time
|
|
@@ -23753,22 +23757,31 @@ type CreateStandaloneAdData = {
|
|
|
23753
23757
|
* to build N full ads sharing one ad set: create the first ad
|
|
23754
23758
|
* via the normal shape, then attach the rest one call each.
|
|
23755
23759
|
*
|
|
23756
|
-
* Supported on Meta (facebook, instagram)
|
|
23757
|
-
* the `adSetId` is the ad group ID; the
|
|
23758
|
-
* ad group's bid + budget + targeting.
|
|
23760
|
+
* Supported on Meta (facebook, instagram), TikTok, and
|
|
23761
|
+
* LinkedIn. On TikTok the `adSetId` is the ad group ID; the
|
|
23762
|
+
* new ad inherits the ad group's bid + budget + targeting.
|
|
23763
|
+
* On LinkedIn the `adSetId` is the LinkedIn Campaign ID
|
|
23764
|
+
* (numeric); we attach a new Creative to that Campaign, so
|
|
23765
|
+
* the Campaign's `platformSpecificData` bidding, targeting,
|
|
23766
|
+
* budget and schedule are inherited (passing those fields
|
|
23767
|
+
* returns 400).
|
|
23759
23768
|
*
|
|
23760
23769
|
*/
|
|
23761
23770
|
adSetId?: string;
|
|
23762
23771
|
/**
|
|
23763
|
-
* Meta
|
|
23764
|
-
* instead of creating a new one
|
|
23765
|
-
* The new ad set's budget
|
|
23766
|
-
*
|
|
23767
|
-
*
|
|
23768
|
-
*
|
|
23769
|
-
*
|
|
23770
|
-
*
|
|
23771
|
-
*
|
|
23772
|
+
* Meta + LinkedIn. On Meta: add the new ad set under this
|
|
23773
|
+
* EXISTING campaign instead of creating a new one
|
|
23774
|
+
* (multi-ad-set audience testing). The new ad set's budget
|
|
23775
|
+
* is matched to the campaign's mode automatically: for a
|
|
23776
|
+
* CBO campaign (campaign-level budget) omit
|
|
23777
|
+
* `budgetAmount`/`budgetType` — the campaign owns the
|
|
23778
|
+
* budget; for an ABO campaign pass them (they go on the new
|
|
23779
|
+
* ad set). On LinkedIn: create a new Campaign (and its
|
|
23780
|
+
* Creative) under this EXISTING CampaignGroup. On failure
|
|
23781
|
+
* only the entities we authored are cleaned up; the
|
|
23782
|
+
* pre-existing parent is left untouched and is never
|
|
23783
|
+
* (re)activated. Mutually exclusive with `adSetId` and
|
|
23784
|
+
* `creatives[]`.
|
|
23772
23785
|
*
|
|
23773
23786
|
*/
|
|
23774
23787
|
existingCampaignId?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -111,7 +111,7 @@ declare class Zernio {
|
|
|
111
111
|
listAccountGroups: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<unknown, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListAccountGroupsResponse, ListAccountGroupsError, ThrowOnError>;
|
|
112
112
|
createAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateAccountGroupResponse, unknown, ThrowOnError>;
|
|
113
113
|
updateAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateAccountGroupResponse, unknown, ThrowOnError>;
|
|
114
|
-
deleteAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountGroupResponse,
|
|
114
|
+
deleteAccountGroup: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteAccountGroupData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAccountGroupResponse, unknown, ThrowOnError>;
|
|
115
115
|
};
|
|
116
116
|
/**
|
|
117
117
|
* Media API - Upload and manage media files
|
|
@@ -635,13 +635,13 @@ declare class Zernio {
|
|
|
635
635
|
* contacts API
|
|
636
636
|
*/
|
|
637
637
|
contacts: {
|
|
638
|
-
listContacts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListContactsResponse,
|
|
638
|
+
listContacts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListContactsResponse, unknown, ThrowOnError>;
|
|
639
639
|
createContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateContactResponse, unknown, ThrowOnError>;
|
|
640
|
-
getContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactResponse,
|
|
641
|
-
updateContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateContactResponse,
|
|
642
|
-
deleteContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown,
|
|
643
|
-
getContactChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactChannelsResponse,
|
|
644
|
-
bulkCreateContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkCreateContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkCreateContactsResponse,
|
|
640
|
+
getContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactResponse, unknown, ThrowOnError>;
|
|
641
|
+
updateContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateContactResponse, unknown, ThrowOnError>;
|
|
642
|
+
deleteContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, unknown, ThrowOnError>;
|
|
643
|
+
getContactChannels: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetContactChannelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetContactChannelsResponse, unknown, ThrowOnError>;
|
|
644
|
+
bulkCreateContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<BulkCreateContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<BulkCreateContactsResponse, unknown, ThrowOnError>;
|
|
645
645
|
};
|
|
646
646
|
/**
|
|
647
647
|
* customfields API
|
|
@@ -658,16 +658,16 @@ declare class Zernio {
|
|
|
658
658
|
* broadcasts API
|
|
659
659
|
*/
|
|
660
660
|
broadcasts: {
|
|
661
|
-
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse,
|
|
662
|
-
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse,
|
|
661
|
+
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse, unknown, ThrowOnError>;
|
|
662
|
+
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse, unknown, ThrowOnError>;
|
|
663
663
|
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBroadcastResponse, GetBroadcastError, ThrowOnError>;
|
|
664
664
|
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBroadcastResponse, UpdateBroadcastError, ThrowOnError>;
|
|
665
665
|
deleteBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteBroadcastError, ThrowOnError>;
|
|
666
666
|
sendBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendBroadcastResponse, unknown, ThrowOnError>;
|
|
667
667
|
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ScheduleBroadcastResponse, unknown, ThrowOnError>;
|
|
668
668
|
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelBroadcastResponse, unknown, ThrowOnError>;
|
|
669
|
-
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse,
|
|
670
|
-
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse,
|
|
669
|
+
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse, unknown, ThrowOnError>;
|
|
670
|
+
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse, unknown, ThrowOnError>;
|
|
671
671
|
};
|
|
672
672
|
/**
|
|
673
673
|
* workflows API
|
|
@@ -707,7 +707,7 @@ declare class Zernio {
|
|
|
707
707
|
* commentautomations API
|
|
708
708
|
*/
|
|
709
709
|
commentautomations: {
|
|
710
|
-
listCommentAutomations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationsResponse,
|
|
710
|
+
listCommentAutomations: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListCommentAutomationsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCommentAutomationsResponse, unknown, ThrowOnError>;
|
|
711
711
|
createCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateCommentAutomationResponse, unknown, ThrowOnError>;
|
|
712
712
|
getCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetCommentAutomationResponse, GetCommentAutomationError, ThrowOnError>;
|
|
713
713
|
updateCommentAutomation: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateCommentAutomationData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateCommentAutomationResponse, UpdateCommentAutomationError, ThrowOnError>;
|
|
@@ -5007,15 +5007,15 @@ type UsageMetering = {
|
|
|
5007
5007
|
*/
|
|
5008
5008
|
tax?: {
|
|
5009
5009
|
/**
|
|
5010
|
-
* Estimated tax in USD
|
|
5010
|
+
* Estimated tax in USD, added on top of `totals.total`.
|
|
5011
5011
|
*/
|
|
5012
5012
|
taxUsd?: number;
|
|
5013
5013
|
/**
|
|
5014
|
-
* Combined rate percentage
|
|
5014
|
+
* Combined rate percentage, e.g. 21.
|
|
5015
5015
|
*/
|
|
5016
5016
|
ratePercent?: (number) | null;
|
|
5017
5017
|
/**
|
|
5018
|
-
* Human jurisdiction label
|
|
5018
|
+
* Human jurisdiction label, e.g. "ES VAT" or "WA sales tax".
|
|
5019
5019
|
*/
|
|
5020
5020
|
jurisdictionLabel?: (string) | null;
|
|
5021
5021
|
/**
|
|
@@ -8700,9 +8700,9 @@ type UpdateAccountGroupResponse = ({
|
|
|
8700
8700
|
[key: string]: unknown;
|
|
8701
8701
|
};
|
|
8702
8702
|
});
|
|
8703
|
-
type UpdateAccountGroupError = ({
|
|
8703
|
+
type UpdateAccountGroupError = (unknown | {
|
|
8704
8704
|
error?: string;
|
|
8705
|
-
}
|
|
8705
|
+
});
|
|
8706
8706
|
type DeleteAccountGroupData = {
|
|
8707
8707
|
path: {
|
|
8708
8708
|
groupId: string;
|
|
@@ -8711,7 +8711,7 @@ type DeleteAccountGroupData = {
|
|
|
8711
8711
|
type DeleteAccountGroupResponse = ({
|
|
8712
8712
|
message?: string;
|
|
8713
8713
|
});
|
|
8714
|
-
type DeleteAccountGroupError = ({
|
|
8714
|
+
type DeleteAccountGroupError = (unknown | {
|
|
8715
8715
|
error?: string;
|
|
8716
8716
|
});
|
|
8717
8717
|
type GetMediaPresignedUrlData = {
|
|
@@ -17314,7 +17314,7 @@ type StartSmsRegistrationData = {
|
|
|
17314
17314
|
messageFlow: string;
|
|
17315
17315
|
sample1: string;
|
|
17316
17316
|
/**
|
|
17317
|
-
* Second example message; carriers require two distinct samples
|
|
17317
|
+
* Second example message; carriers require two distinct samples, so it must differ from sample1.
|
|
17318
17318
|
*/
|
|
17319
17319
|
sample2: string;
|
|
17320
17320
|
helpMessage?: string;
|
|
@@ -20604,7 +20604,7 @@ type ListContactsResponse = ({
|
|
|
20604
20604
|
hasMore?: boolean;
|
|
20605
20605
|
};
|
|
20606
20606
|
});
|
|
20607
|
-
type ListContactsError = ({
|
|
20607
|
+
type ListContactsError = (unknown | {
|
|
20608
20608
|
error?: string;
|
|
20609
20609
|
});
|
|
20610
20610
|
type CreateContactData = {
|
|
@@ -20652,9 +20652,9 @@ type CreateContactResponse = ({
|
|
|
20652
20652
|
};
|
|
20653
20653
|
warning?: string;
|
|
20654
20654
|
});
|
|
20655
|
-
type CreateContactError = ({
|
|
20655
|
+
type CreateContactError = (unknown | {
|
|
20656
20656
|
error?: string;
|
|
20657
|
-
}
|
|
20657
|
+
});
|
|
20658
20658
|
type GetContactData = {
|
|
20659
20659
|
path: {
|
|
20660
20660
|
contactId: string;
|
|
@@ -20710,7 +20710,7 @@ type GetContactResponse = ({
|
|
|
20710
20710
|
createdAt?: string;
|
|
20711
20711
|
}>;
|
|
20712
20712
|
});
|
|
20713
|
-
type GetContactError = ({
|
|
20713
|
+
type GetContactError = (unknown | {
|
|
20714
20714
|
error?: string;
|
|
20715
20715
|
});
|
|
20716
20716
|
type UpdateContactData = {
|
|
@@ -20743,7 +20743,7 @@ type UpdateContactResponse = ({
|
|
|
20743
20743
|
updatedAt?: string;
|
|
20744
20744
|
};
|
|
20745
20745
|
});
|
|
20746
|
-
type UpdateContactError = ({
|
|
20746
|
+
type UpdateContactError = (unknown | {
|
|
20747
20747
|
error?: string;
|
|
20748
20748
|
});
|
|
20749
20749
|
type DeleteContactData = {
|
|
@@ -20752,7 +20752,7 @@ type DeleteContactData = {
|
|
|
20752
20752
|
};
|
|
20753
20753
|
};
|
|
20754
20754
|
type DeleteContactResponse = (unknown);
|
|
20755
|
-
type DeleteContactError = ({
|
|
20755
|
+
type DeleteContactError = (unknown | {
|
|
20756
20756
|
error?: string;
|
|
20757
20757
|
});
|
|
20758
20758
|
type GetContactChannelsData = {
|
|
@@ -20776,7 +20776,7 @@ type GetContactChannelsResponse = ({
|
|
|
20776
20776
|
createdAt?: string;
|
|
20777
20777
|
}>;
|
|
20778
20778
|
});
|
|
20779
|
-
type GetContactChannelsError = ({
|
|
20779
|
+
type GetContactChannelsError = (unknown | {
|
|
20780
20780
|
error?: string;
|
|
20781
20781
|
});
|
|
20782
20782
|
type BulkCreateContactsData = {
|
|
@@ -20803,7 +20803,7 @@ type BulkCreateContactsResponse = ({
|
|
|
20803
20803
|
}>;
|
|
20804
20804
|
total?: number;
|
|
20805
20805
|
});
|
|
20806
|
-
type BulkCreateContactsError = ({
|
|
20806
|
+
type BulkCreateContactsError = (unknown | {
|
|
20807
20807
|
error?: string;
|
|
20808
20808
|
});
|
|
20809
20809
|
type SetContactFieldValueData = {
|
|
@@ -20960,7 +20960,7 @@ type ListBroadcastsResponse = ({
|
|
|
20960
20960
|
hasMore?: boolean;
|
|
20961
20961
|
};
|
|
20962
20962
|
});
|
|
20963
|
-
type ListBroadcastsError = ({
|
|
20963
|
+
type ListBroadcastsError = (unknown | {
|
|
20964
20964
|
error?: string;
|
|
20965
20965
|
});
|
|
20966
20966
|
type CreateBroadcastData = {
|
|
@@ -21018,7 +21018,7 @@ type CreateBroadcastResponse = ({
|
|
|
21018
21018
|
createdAt?: string;
|
|
21019
21019
|
};
|
|
21020
21020
|
});
|
|
21021
|
-
type CreateBroadcastError = ({
|
|
21021
|
+
type CreateBroadcastError = (unknown | {
|
|
21022
21022
|
error?: string;
|
|
21023
21023
|
});
|
|
21024
21024
|
type GetBroadcastData = {
|
|
@@ -21220,7 +21220,7 @@ type ListBroadcastRecipientsResponse = ({
|
|
|
21220
21220
|
hasMore?: boolean;
|
|
21221
21221
|
};
|
|
21222
21222
|
});
|
|
21223
|
-
type ListBroadcastRecipientsError = ({
|
|
21223
|
+
type ListBroadcastRecipientsError = (unknown | {
|
|
21224
21224
|
error?: string;
|
|
21225
21225
|
});
|
|
21226
21226
|
type AddBroadcastRecipientsData = {
|
|
@@ -21253,7 +21253,7 @@ type AddBroadcastRecipientsResponse = ({
|
|
|
21253
21253
|
*/
|
|
21254
21254
|
skipped?: number;
|
|
21255
21255
|
});
|
|
21256
|
-
type AddBroadcastRecipientsError = ({
|
|
21256
|
+
type AddBroadcastRecipientsError = (unknown | {
|
|
21257
21257
|
error?: string;
|
|
21258
21258
|
});
|
|
21259
21259
|
type ListWorkflowsData = {
|
|
@@ -21999,7 +21999,7 @@ type ListCommentAutomationsResponse = ({
|
|
|
21999
21999
|
createdAt?: string;
|
|
22000
22000
|
}>;
|
|
22001
22001
|
});
|
|
22002
|
-
type ListCommentAutomationsError = ({
|
|
22002
|
+
type ListCommentAutomationsError = (unknown | {
|
|
22003
22003
|
error?: string;
|
|
22004
22004
|
});
|
|
22005
22005
|
type CreateCommentAutomationData = {
|
|
@@ -22514,11 +22514,15 @@ type BulkUpdateAdCampaignStatusError = (unknown | {
|
|
|
22514
22514
|
});
|
|
22515
22515
|
type DuplicateAdCampaignData = {
|
|
22516
22516
|
body: {
|
|
22517
|
-
platform: 'facebook' | 'instagram' | 'tiktok';
|
|
22517
|
+
platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin';
|
|
22518
22518
|
/**
|
|
22519
22519
|
* Copy child ad sets + ads + creatives + targeting
|
|
22520
22520
|
*/
|
|
22521
22521
|
deepCopy?: boolean;
|
|
22522
|
+
/**
|
|
22523
|
+
* ACTIVE = launch the clone immediately (spends the moment LinkedIn approves it). PAUSED = clone stays DRAFT, safe default. INHERITED_FROM_SOURCE = mirror each entity's source status per-entity. Duplicating an ACTIVE campaign this way starts a second front of spend.
|
|
22524
|
+
*
|
|
22525
|
+
*/
|
|
22522
22526
|
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
22523
22527
|
/**
|
|
22524
22528
|
* Reschedule the copied hierarchy's start time
|
|
@@ -23753,22 +23757,31 @@ type CreateStandaloneAdData = {
|
|
|
23753
23757
|
* to build N full ads sharing one ad set: create the first ad
|
|
23754
23758
|
* via the normal shape, then attach the rest one call each.
|
|
23755
23759
|
*
|
|
23756
|
-
* Supported on Meta (facebook, instagram)
|
|
23757
|
-
* the `adSetId` is the ad group ID; the
|
|
23758
|
-
* ad group's bid + budget + targeting.
|
|
23760
|
+
* Supported on Meta (facebook, instagram), TikTok, and
|
|
23761
|
+
* LinkedIn. On TikTok the `adSetId` is the ad group ID; the
|
|
23762
|
+
* new ad inherits the ad group's bid + budget + targeting.
|
|
23763
|
+
* On LinkedIn the `adSetId` is the LinkedIn Campaign ID
|
|
23764
|
+
* (numeric); we attach a new Creative to that Campaign, so
|
|
23765
|
+
* the Campaign's `platformSpecificData` bidding, targeting,
|
|
23766
|
+
* budget and schedule are inherited (passing those fields
|
|
23767
|
+
* returns 400).
|
|
23759
23768
|
*
|
|
23760
23769
|
*/
|
|
23761
23770
|
adSetId?: string;
|
|
23762
23771
|
/**
|
|
23763
|
-
* Meta
|
|
23764
|
-
* instead of creating a new one
|
|
23765
|
-
* The new ad set's budget
|
|
23766
|
-
*
|
|
23767
|
-
*
|
|
23768
|
-
*
|
|
23769
|
-
*
|
|
23770
|
-
*
|
|
23771
|
-
*
|
|
23772
|
+
* Meta + LinkedIn. On Meta: add the new ad set under this
|
|
23773
|
+
* EXISTING campaign instead of creating a new one
|
|
23774
|
+
* (multi-ad-set audience testing). The new ad set's budget
|
|
23775
|
+
* is matched to the campaign's mode automatically: for a
|
|
23776
|
+
* CBO campaign (campaign-level budget) omit
|
|
23777
|
+
* `budgetAmount`/`budgetType` — the campaign owns the
|
|
23778
|
+
* budget; for an ABO campaign pass them (they go on the new
|
|
23779
|
+
* ad set). On LinkedIn: create a new Campaign (and its
|
|
23780
|
+
* Creative) under this EXISTING CampaignGroup. On failure
|
|
23781
|
+
* only the entities we authored are cleaned up; the
|
|
23782
|
+
* pre-existing parent is left untouched and is never
|
|
23783
|
+
* (re)activated. Mutually exclusive with `adSetId` and
|
|
23784
|
+
* `creatives[]`.
|
|
23772
23785
|
*
|
|
23773
23786
|
*/
|
|
23774
23787
|
existingCampaignId?: string;
|
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.372",
|
|
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.372",
|
|
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
|
@@ -6257,6 +6257,17 @@ export const bulkUpdateAdCampaignStatus = <ThrowOnError extends boolean = false>
|
|
|
6257
6257
|
* carrying over budget / targeting / bid_type / bid_price /
|
|
6258
6258
|
* deep_bid_type / creative fields. Spark Ad linkage (`tiktok_item_id`)
|
|
6259
6259
|
* is preserved.
|
|
6260
|
+
* - **LinkedIn** has no native copy primitive; Zernio walks the source
|
|
6261
|
+
* CampaignGroup → Campaigns → Creatives and recreates each entity,
|
|
6262
|
+
* carrying over `type` / `costType` / `unitCost` /
|
|
6263
|
+
* `optimizationTargetType` / `creativeSelection` / `objectiveType` /
|
|
6264
|
+
* `format` / `dailyBudget` / `totalBudget` / `targetingCriteria` /
|
|
6265
|
+
* `runSchedule` and every Creative's `content` object verbatim.
|
|
6266
|
+
* `statusOption: INHERITED_FROM_SOURCE` is evaluated **per entity**:
|
|
6267
|
+
* any Group / Campaign / Creative whose source is `ACTIVE` gets its
|
|
6268
|
+
* clone activated too. Duplicating an ACTIVE campaign with
|
|
6269
|
+
* `INHERITED_FROM_SOURCE` starts a second front of spend the moment
|
|
6270
|
+
* the clone activates — the safe default is `PAUSED`.
|
|
6260
6271
|
*
|
|
6261
6272
|
* The new hierarchy is asynchronous to materialize in our DB — we
|
|
6262
6273
|
* trigger sync discovery automatically. Set `syncAfter: false` to
|
|
@@ -4298,15 +4298,15 @@ export type UsageMetering = {
|
|
|
4298
4298
|
*/
|
|
4299
4299
|
tax?: {
|
|
4300
4300
|
/**
|
|
4301
|
-
* Estimated tax in USD
|
|
4301
|
+
* Estimated tax in USD, added on top of `totals.total`.
|
|
4302
4302
|
*/
|
|
4303
4303
|
taxUsd?: number;
|
|
4304
4304
|
/**
|
|
4305
|
-
* Combined rate percentage
|
|
4305
|
+
* Combined rate percentage, e.g. 21.
|
|
4306
4306
|
*/
|
|
4307
4307
|
ratePercent?: (number) | null;
|
|
4308
4308
|
/**
|
|
4309
|
-
* Human jurisdiction label
|
|
4309
|
+
* Human jurisdiction label, e.g. "ES VAT" or "WA sales tax".
|
|
4310
4310
|
*/
|
|
4311
4311
|
jurisdictionLabel?: (string) | null;
|
|
4312
4312
|
/**
|
|
@@ -8180,9 +8180,9 @@ export type UpdateAccountGroupResponse = ({
|
|
|
8180
8180
|
};
|
|
8181
8181
|
});
|
|
8182
8182
|
|
|
8183
|
-
export type UpdateAccountGroupError = ({
|
|
8183
|
+
export type UpdateAccountGroupError = (unknown | {
|
|
8184
8184
|
error?: string;
|
|
8185
|
-
}
|
|
8185
|
+
});
|
|
8186
8186
|
|
|
8187
8187
|
export type DeleteAccountGroupData = {
|
|
8188
8188
|
path: {
|
|
@@ -8194,7 +8194,7 @@ export type DeleteAccountGroupResponse = ({
|
|
|
8194
8194
|
message?: string;
|
|
8195
8195
|
});
|
|
8196
8196
|
|
|
8197
|
-
export type DeleteAccountGroupError = ({
|
|
8197
|
+
export type DeleteAccountGroupError = (unknown | {
|
|
8198
8198
|
error?: string;
|
|
8199
8199
|
});
|
|
8200
8200
|
|
|
@@ -17452,7 +17452,7 @@ export type StartSmsRegistrationData = {
|
|
|
17452
17452
|
messageFlow: string;
|
|
17453
17453
|
sample1: string;
|
|
17454
17454
|
/**
|
|
17455
|
-
* Second example message; carriers require two distinct samples
|
|
17455
|
+
* Second example message; carriers require two distinct samples, so it must differ from sample1.
|
|
17456
17456
|
*/
|
|
17457
17457
|
sample2: string;
|
|
17458
17458
|
helpMessage?: string;
|
|
@@ -21031,7 +21031,7 @@ export type ListContactsResponse = ({
|
|
|
21031
21031
|
};
|
|
21032
21032
|
});
|
|
21033
21033
|
|
|
21034
|
-
export type ListContactsError = ({
|
|
21034
|
+
export type ListContactsError = (unknown | {
|
|
21035
21035
|
error?: string;
|
|
21036
21036
|
});
|
|
21037
21037
|
|
|
@@ -21082,9 +21082,9 @@ export type CreateContactResponse = ({
|
|
|
21082
21082
|
warning?: string;
|
|
21083
21083
|
});
|
|
21084
21084
|
|
|
21085
|
-
export type CreateContactError = ({
|
|
21085
|
+
export type CreateContactError = (unknown | {
|
|
21086
21086
|
error?: string;
|
|
21087
|
-
}
|
|
21087
|
+
});
|
|
21088
21088
|
|
|
21089
21089
|
export type GetContactData = {
|
|
21090
21090
|
path: {
|
|
@@ -21143,7 +21143,7 @@ export type GetContactResponse = ({
|
|
|
21143
21143
|
}>;
|
|
21144
21144
|
});
|
|
21145
21145
|
|
|
21146
|
-
export type GetContactError = ({
|
|
21146
|
+
export type GetContactError = (unknown | {
|
|
21147
21147
|
error?: string;
|
|
21148
21148
|
});
|
|
21149
21149
|
|
|
@@ -21179,7 +21179,7 @@ export type UpdateContactResponse = ({
|
|
|
21179
21179
|
};
|
|
21180
21180
|
});
|
|
21181
21181
|
|
|
21182
|
-
export type UpdateContactError = ({
|
|
21182
|
+
export type UpdateContactError = (unknown | {
|
|
21183
21183
|
error?: string;
|
|
21184
21184
|
});
|
|
21185
21185
|
|
|
@@ -21191,7 +21191,7 @@ export type DeleteContactData = {
|
|
|
21191
21191
|
|
|
21192
21192
|
export type DeleteContactResponse = (unknown);
|
|
21193
21193
|
|
|
21194
|
-
export type DeleteContactError = ({
|
|
21194
|
+
export type DeleteContactError = (unknown | {
|
|
21195
21195
|
error?: string;
|
|
21196
21196
|
});
|
|
21197
21197
|
|
|
@@ -21218,7 +21218,7 @@ export type GetContactChannelsResponse = ({
|
|
|
21218
21218
|
}>;
|
|
21219
21219
|
});
|
|
21220
21220
|
|
|
21221
|
-
export type GetContactChannelsError = ({
|
|
21221
|
+
export type GetContactChannelsError = (unknown | {
|
|
21222
21222
|
error?: string;
|
|
21223
21223
|
});
|
|
21224
21224
|
|
|
@@ -21248,7 +21248,7 @@ export type BulkCreateContactsResponse = ({
|
|
|
21248
21248
|
total?: number;
|
|
21249
21249
|
});
|
|
21250
21250
|
|
|
21251
|
-
export type BulkCreateContactsError = ({
|
|
21251
|
+
export type BulkCreateContactsError = (unknown | {
|
|
21252
21252
|
error?: string;
|
|
21253
21253
|
});
|
|
21254
21254
|
|
|
@@ -21426,7 +21426,7 @@ export type ListBroadcastsResponse = ({
|
|
|
21426
21426
|
};
|
|
21427
21427
|
});
|
|
21428
21428
|
|
|
21429
|
-
export type ListBroadcastsError = ({
|
|
21429
|
+
export type ListBroadcastsError = (unknown | {
|
|
21430
21430
|
error?: string;
|
|
21431
21431
|
});
|
|
21432
21432
|
|
|
@@ -21487,7 +21487,7 @@ export type CreateBroadcastResponse = ({
|
|
|
21487
21487
|
};
|
|
21488
21488
|
});
|
|
21489
21489
|
|
|
21490
|
-
export type CreateBroadcastError = ({
|
|
21490
|
+
export type CreateBroadcastError = (unknown | {
|
|
21491
21491
|
error?: string;
|
|
21492
21492
|
});
|
|
21493
21493
|
|
|
@@ -21710,7 +21710,7 @@ export type ListBroadcastRecipientsResponse = ({
|
|
|
21710
21710
|
};
|
|
21711
21711
|
});
|
|
21712
21712
|
|
|
21713
|
-
export type ListBroadcastRecipientsError = ({
|
|
21713
|
+
export type ListBroadcastRecipientsError = (unknown | {
|
|
21714
21714
|
error?: string;
|
|
21715
21715
|
});
|
|
21716
21716
|
|
|
@@ -21746,7 +21746,7 @@ export type AddBroadcastRecipientsResponse = ({
|
|
|
21746
21746
|
skipped?: number;
|
|
21747
21747
|
});
|
|
21748
21748
|
|
|
21749
|
-
export type AddBroadcastRecipientsError = ({
|
|
21749
|
+
export type AddBroadcastRecipientsError = (unknown | {
|
|
21750
21750
|
error?: string;
|
|
21751
21751
|
});
|
|
21752
21752
|
|
|
@@ -22567,7 +22567,7 @@ export type ListCommentAutomationsResponse = ({
|
|
|
22567
22567
|
}>;
|
|
22568
22568
|
});
|
|
22569
22569
|
|
|
22570
|
-
export type ListCommentAutomationsError = ({
|
|
22570
|
+
export type ListCommentAutomationsError = (unknown | {
|
|
22571
22571
|
error?: string;
|
|
22572
22572
|
});
|
|
22573
22573
|
|
|
@@ -23116,11 +23116,15 @@ export type BulkUpdateAdCampaignStatusError = (unknown | {
|
|
|
23116
23116
|
|
|
23117
23117
|
export type DuplicateAdCampaignData = {
|
|
23118
23118
|
body: {
|
|
23119
|
-
platform: 'facebook' | 'instagram' | 'tiktok';
|
|
23119
|
+
platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin';
|
|
23120
23120
|
/**
|
|
23121
23121
|
* Copy child ad sets + ads + creatives + targeting
|
|
23122
23122
|
*/
|
|
23123
23123
|
deepCopy?: boolean;
|
|
23124
|
+
/**
|
|
23125
|
+
* ACTIVE = launch the clone immediately (spends the moment LinkedIn approves it). PAUSED = clone stays DRAFT, safe default. INHERITED_FROM_SOURCE = mirror each entity's source status per-entity. Duplicating an ACTIVE campaign this way starts a second front of spend.
|
|
23126
|
+
*
|
|
23127
|
+
*/
|
|
23124
23128
|
statusOption?: 'ACTIVE' | 'PAUSED' | 'INHERITED_FROM_SOURCE';
|
|
23125
23129
|
/**
|
|
23126
23130
|
* Reschedule the copied hierarchy's start time
|
|
@@ -24415,22 +24419,31 @@ export type CreateStandaloneAdData = {
|
|
|
24415
24419
|
* to build N full ads sharing one ad set: create the first ad
|
|
24416
24420
|
* via the normal shape, then attach the rest one call each.
|
|
24417
24421
|
*
|
|
24418
|
-
* Supported on Meta (facebook, instagram)
|
|
24419
|
-
* the `adSetId` is the ad group ID; the
|
|
24420
|
-
* ad group's bid + budget + targeting.
|
|
24422
|
+
* Supported on Meta (facebook, instagram), TikTok, and
|
|
24423
|
+
* LinkedIn. On TikTok the `adSetId` is the ad group ID; the
|
|
24424
|
+
* new ad inherits the ad group's bid + budget + targeting.
|
|
24425
|
+
* On LinkedIn the `adSetId` is the LinkedIn Campaign ID
|
|
24426
|
+
* (numeric); we attach a new Creative to that Campaign, so
|
|
24427
|
+
* the Campaign's `platformSpecificData` bidding, targeting,
|
|
24428
|
+
* budget and schedule are inherited (passing those fields
|
|
24429
|
+
* returns 400).
|
|
24421
24430
|
*
|
|
24422
24431
|
*/
|
|
24423
24432
|
adSetId?: string;
|
|
24424
24433
|
/**
|
|
24425
|
-
* Meta
|
|
24426
|
-
* instead of creating a new one
|
|
24427
|
-
* The new ad set's budget
|
|
24428
|
-
*
|
|
24429
|
-
*
|
|
24430
|
-
*
|
|
24431
|
-
*
|
|
24432
|
-
*
|
|
24433
|
-
*
|
|
24434
|
+
* Meta + LinkedIn. On Meta: add the new ad set under this
|
|
24435
|
+
* EXISTING campaign instead of creating a new one
|
|
24436
|
+
* (multi-ad-set audience testing). The new ad set's budget
|
|
24437
|
+
* is matched to the campaign's mode automatically: for a
|
|
24438
|
+
* CBO campaign (campaign-level budget) omit
|
|
24439
|
+
* `budgetAmount`/`budgetType` — the campaign owns the
|
|
24440
|
+
* budget; for an ABO campaign pass them (they go on the new
|
|
24441
|
+
* ad set). On LinkedIn: create a new Campaign (and its
|
|
24442
|
+
* Creative) under this EXISTING CampaignGroup. On failure
|
|
24443
|
+
* only the entities we authored are cleaned up; the
|
|
24444
|
+
* pre-existing parent is left untouched and is never
|
|
24445
|
+
* (re)activated. Mutually exclusive with `adSetId` and
|
|
24446
|
+
* `creatives[]`.
|
|
24434
24447
|
*
|
|
24435
24448
|
*/
|
|
24436
24449
|
existingCampaignId?: string;
|