@zernio/node 0.2.999 → 0.2.1001
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 +26 -22
- package/dist/index.d.ts +26 -22
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +2 -3
- package/src/generated/types.gen.ts +26 -22
package/dist/index.d.mts
CHANGED
|
@@ -2045,7 +2045,7 @@ type Ad = {
|
|
|
2045
2045
|
*/
|
|
2046
2046
|
status?: (AdStatus);
|
|
2047
2047
|
/**
|
|
2048
|
-
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request
|
|
2048
|
+
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request: a `PAUSED` create pauses only the top-most object it creates, so an ad under a new paused campaign or ad set reads ACTIVE here with `status: paused`, and only an ad attached to an existing ad set reads PAUSED. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
|
|
2049
2049
|
*/
|
|
2050
2050
|
configuredStatus?: (string) | null;
|
|
2051
2051
|
/**
|
|
@@ -6027,18 +6027,20 @@ type CtwaAdRequestBody = {
|
|
|
6027
6027
|
*/
|
|
6028
6028
|
objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
6029
6029
|
/**
|
|
6030
|
-
*
|
|
6031
|
-
*
|
|
6030
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
6031
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
6032
|
+
* `adSetId`, the new ads themselves.
|
|
6032
6033
|
*
|
|
6033
6034
|
*/
|
|
6034
6035
|
status?: 'ACTIVE' | 'PAUSED';
|
|
6035
6036
|
/**
|
|
6036
6037
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
6037
|
-
* to `
|
|
6038
|
-
*
|
|
6039
|
-
*
|
|
6040
|
-
* meaningful when a new campaign is being
|
|
6041
|
-
* alongside `adSetId` (the attach shape
|
|
6038
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
6039
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
6040
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
6041
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
6042
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
6043
|
+
* reuses an existing campaign).
|
|
6042
6044
|
*
|
|
6043
6045
|
*/
|
|
6044
6046
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
@@ -6125,18 +6127,20 @@ type advantageAudience = 0 | 1;
|
|
|
6125
6127
|
*/
|
|
6126
6128
|
type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
6127
6129
|
/**
|
|
6128
|
-
*
|
|
6129
|
-
*
|
|
6130
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
6131
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
6132
|
+
* `adSetId`, the new ads themselves.
|
|
6130
6133
|
*
|
|
6131
6134
|
*/
|
|
6132
6135
|
type status13 = 'ACTIVE' | 'PAUSED';
|
|
6133
6136
|
/**
|
|
6134
6137
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
6135
|
-
* to `
|
|
6136
|
-
*
|
|
6137
|
-
*
|
|
6138
|
-
* meaningful when a new campaign is being
|
|
6139
|
-
* alongside `adSetId` (the attach shape
|
|
6138
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
6139
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
6140
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
6141
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
6142
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
6143
|
+
* reuses an existing campaign).
|
|
6140
6144
|
*
|
|
6141
6145
|
*/
|
|
6142
6146
|
type campaignStatus = 'ACTIVE' | 'PAUSED';
|
|
@@ -32985,7 +32989,7 @@ type SubmitPhoneNumberKycData = {
|
|
|
32985
32989
|
*/
|
|
32986
32990
|
areaCode?: string;
|
|
32987
32991
|
/**
|
|
32988
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
32992
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
32989
32993
|
*/
|
|
32990
32994
|
preOrder?: boolean;
|
|
32991
32995
|
/**
|
|
@@ -33040,7 +33044,7 @@ type SubmitPhoneNumberKycData = {
|
|
|
33040
33044
|
type SubmitPhoneNumberKycResponse = ({
|
|
33041
33045
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
33042
33046
|
/**
|
|
33043
|
-
* True when nothing was
|
|
33047
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
33044
33048
|
*/
|
|
33045
33049
|
preOrder?: boolean;
|
|
33046
33050
|
/**
|
|
@@ -33807,7 +33811,7 @@ type SubmitWhatsAppNumberKycData = {
|
|
|
33807
33811
|
*/
|
|
33808
33812
|
areaCode?: string;
|
|
33809
33813
|
/**
|
|
33810
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
33814
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
33811
33815
|
*/
|
|
33812
33816
|
preOrder?: boolean;
|
|
33813
33817
|
/**
|
|
@@ -33858,7 +33862,7 @@ type SubmitWhatsAppNumberKycData = {
|
|
|
33858
33862
|
type SubmitWhatsAppNumberKycResponse = ({
|
|
33859
33863
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
33860
33864
|
/**
|
|
33861
|
-
* True when nothing was
|
|
33865
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
33862
33866
|
*/
|
|
33863
33867
|
preOrder?: boolean;
|
|
33864
33868
|
/**
|
|
@@ -44008,7 +44012,7 @@ type BoostPostData = {
|
|
|
44008
44012
|
*/
|
|
44009
44013
|
leadGenFormId?: string;
|
|
44010
44014
|
/**
|
|
44011
|
-
*
|
|
44015
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default); PAUSED pauses only the top-most object this boost creates and switches everything below it on: a new campaign is held paused with its ad set and ad on (one PUT /v1/ads/campaigns/{campaignId}/status with `active` brings it live); into an existing campaign (TikTok `existingCampaignId`) the new ad set is held paused; attached to an existing ad set (`adSetId`) the new ad itself is paused. On LinkedIn the held campaign group is PAUSED, its campaign and creative ACTIVE. X has no per-ad switch, so its lowest level is the line item.
|
|
44012
44016
|
*/
|
|
44013
44017
|
status?: 'ACTIVE' | 'PAUSED';
|
|
44014
44018
|
/**
|
|
@@ -44322,11 +44326,11 @@ type CreateStandaloneAdData = {
|
|
|
44322
44326
|
*/
|
|
44323
44327
|
budgetType?: 'daily' | 'lifetime';
|
|
44324
44328
|
/**
|
|
44325
|
-
*
|
|
44329
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default, back-compat); PAUSED pauses only the TOP-MOST object this call creates and switches everything below it on, so one resume of that object brings the new tree live and nothing that already existed is touched: a new campaign is held paused with its ad set and ad on; with `existingCampaignId` the new ad set is held paused with its ad on; with `adSetId` the new ad itself is paused. `campaignStatus: ACTIVE` with `status: PAUSED` moves the pause down to the new ad set. LinkedIn: a held campaign group is PAUSED with its campaign and creative ACTIVE; a new campaign in an existing group stays DRAFT. X has no per-ad switch, so its lowest level is the line item. Google Performance Max and Demand Gen accept PAUSED only (the campaign is created paused).
|
|
44326
44330
|
*/
|
|
44327
44331
|
status?: 'ACTIVE' | 'PAUSED';
|
|
44328
44332
|
/**
|
|
44329
|
-
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the campaign
|
|
44333
|
+
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the new campaign alone. `PAUSED` holds the campaign off with its ad set and ad on; `ACTIVE` with `status: PAUSED` switches the campaign on and holds the new ad set paused (its ad on). Omitted, it follows `status`.
|
|
44330
44334
|
*/
|
|
44331
44335
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
44332
44336
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -2045,7 +2045,7 @@ type Ad = {
|
|
|
2045
2045
|
*/
|
|
2046
2046
|
status?: (AdStatus);
|
|
2047
2047
|
/**
|
|
2048
|
-
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request
|
|
2048
|
+
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request: a `PAUSED` create pauses only the top-most object it creates, so an ad under a new paused campaign or ad set reads ACTIVE here with `status: paused`, and only an ad attached to an existing ad set reads PAUSED. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
|
|
2049
2049
|
*/
|
|
2050
2050
|
configuredStatus?: (string) | null;
|
|
2051
2051
|
/**
|
|
@@ -6027,18 +6027,20 @@ type CtwaAdRequestBody = {
|
|
|
6027
6027
|
*/
|
|
6028
6028
|
objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
6029
6029
|
/**
|
|
6030
|
-
*
|
|
6031
|
-
*
|
|
6030
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
6031
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
6032
|
+
* `adSetId`, the new ads themselves.
|
|
6032
6033
|
*
|
|
6033
6034
|
*/
|
|
6034
6035
|
status?: 'ACTIVE' | 'PAUSED';
|
|
6035
6036
|
/**
|
|
6036
6037
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
6037
|
-
* to `
|
|
6038
|
-
*
|
|
6039
|
-
*
|
|
6040
|
-
* meaningful when a new campaign is being
|
|
6041
|
-
* alongside `adSetId` (the attach shape
|
|
6038
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
6039
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
6040
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
6041
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
6042
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
6043
|
+
* reuses an existing campaign).
|
|
6042
6044
|
*
|
|
6043
6045
|
*/
|
|
6044
6046
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
@@ -6125,18 +6127,20 @@ type advantageAudience = 0 | 1;
|
|
|
6125
6127
|
*/
|
|
6126
6128
|
type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
6127
6129
|
/**
|
|
6128
|
-
*
|
|
6129
|
-
*
|
|
6130
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
6131
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
6132
|
+
* `adSetId`, the new ads themselves.
|
|
6130
6133
|
*
|
|
6131
6134
|
*/
|
|
6132
6135
|
type status13 = 'ACTIVE' | 'PAUSED';
|
|
6133
6136
|
/**
|
|
6134
6137
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
6135
|
-
* to `
|
|
6136
|
-
*
|
|
6137
|
-
*
|
|
6138
|
-
* meaningful when a new campaign is being
|
|
6139
|
-
* alongside `adSetId` (the attach shape
|
|
6138
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
6139
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
6140
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
6141
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
6142
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
6143
|
+
* reuses an existing campaign).
|
|
6140
6144
|
*
|
|
6141
6145
|
*/
|
|
6142
6146
|
type campaignStatus = 'ACTIVE' | 'PAUSED';
|
|
@@ -32985,7 +32989,7 @@ type SubmitPhoneNumberKycData = {
|
|
|
32985
32989
|
*/
|
|
32986
32990
|
areaCode?: string;
|
|
32987
32991
|
/**
|
|
32988
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
32992
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
32989
32993
|
*/
|
|
32990
32994
|
preOrder?: boolean;
|
|
32991
32995
|
/**
|
|
@@ -33040,7 +33044,7 @@ type SubmitPhoneNumberKycData = {
|
|
|
33040
33044
|
type SubmitPhoneNumberKycResponse = ({
|
|
33041
33045
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
33042
33046
|
/**
|
|
33043
|
-
* True when nothing was
|
|
33047
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
33044
33048
|
*/
|
|
33045
33049
|
preOrder?: boolean;
|
|
33046
33050
|
/**
|
|
@@ -33807,7 +33811,7 @@ type SubmitWhatsAppNumberKycData = {
|
|
|
33807
33811
|
*/
|
|
33808
33812
|
areaCode?: string;
|
|
33809
33813
|
/**
|
|
33810
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
33814
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
33811
33815
|
*/
|
|
33812
33816
|
preOrder?: boolean;
|
|
33813
33817
|
/**
|
|
@@ -33858,7 +33862,7 @@ type SubmitWhatsAppNumberKycData = {
|
|
|
33858
33862
|
type SubmitWhatsAppNumberKycResponse = ({
|
|
33859
33863
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
33860
33864
|
/**
|
|
33861
|
-
* True when nothing was
|
|
33865
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
33862
33866
|
*/
|
|
33863
33867
|
preOrder?: boolean;
|
|
33864
33868
|
/**
|
|
@@ -44008,7 +44012,7 @@ type BoostPostData = {
|
|
|
44008
44012
|
*/
|
|
44009
44013
|
leadGenFormId?: string;
|
|
44010
44014
|
/**
|
|
44011
|
-
*
|
|
44015
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default); PAUSED pauses only the top-most object this boost creates and switches everything below it on: a new campaign is held paused with its ad set and ad on (one PUT /v1/ads/campaigns/{campaignId}/status with `active` brings it live); into an existing campaign (TikTok `existingCampaignId`) the new ad set is held paused; attached to an existing ad set (`adSetId`) the new ad itself is paused. On LinkedIn the held campaign group is PAUSED, its campaign and creative ACTIVE. X has no per-ad switch, so its lowest level is the line item.
|
|
44012
44016
|
*/
|
|
44013
44017
|
status?: 'ACTIVE' | 'PAUSED';
|
|
44014
44018
|
/**
|
|
@@ -44322,11 +44326,11 @@ type CreateStandaloneAdData = {
|
|
|
44322
44326
|
*/
|
|
44323
44327
|
budgetType?: 'daily' | 'lifetime';
|
|
44324
44328
|
/**
|
|
44325
|
-
*
|
|
44329
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default, back-compat); PAUSED pauses only the TOP-MOST object this call creates and switches everything below it on, so one resume of that object brings the new tree live and nothing that already existed is touched: a new campaign is held paused with its ad set and ad on; with `existingCampaignId` the new ad set is held paused with its ad on; with `adSetId` the new ad itself is paused. `campaignStatus: ACTIVE` with `status: PAUSED` moves the pause down to the new ad set. LinkedIn: a held campaign group is PAUSED with its campaign and creative ACTIVE; a new campaign in an existing group stays DRAFT. X has no per-ad switch, so its lowest level is the line item. Google Performance Max and Demand Gen accept PAUSED only (the campaign is created paused).
|
|
44326
44330
|
*/
|
|
44327
44331
|
status?: 'ACTIVE' | 'PAUSED';
|
|
44328
44332
|
/**
|
|
44329
|
-
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the campaign
|
|
44333
|
+
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the new campaign alone. `PAUSED` holds the campaign off with its ad set and ad on; `ACTIVE` with `status: PAUSED` switches the campaign on and holds the new ad set paused (its ad on). Omitted, it follows `status`.
|
|
44330
44334
|
*/
|
|
44331
44335
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
44332
44336
|
/**
|
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: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.1001",
|
|
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: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.1001",
|
|
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
|
@@ -9324,9 +9324,8 @@ export const listAdCampaigns = <ThrowOnError extends boolean = false>(options?:
|
|
|
9324
9324
|
* `budgetType: daily`). On OpenAI `goal` sets the campaign objective, and
|
|
9325
9325
|
* `conversions` needs an active standard conversion event on the account. LinkedIn creates the
|
|
9326
9326
|
* campaign GROUP (our campaign level) and rejects a budget, which lives on the
|
|
9327
|
-
* campaign (ad set) level there; it comes back `status: DRAFT`.
|
|
9328
|
-
*
|
|
9329
|
-
* `status: ACTIVE` where the platform supports it.
|
|
9327
|
+
* campaign (ad set) level there; it comes back `status: DRAFT`. Created `PAUSED`
|
|
9328
|
+
* (TikTok `DISABLE`) unless `status: ACTIVE` where the platform supports it.
|
|
9330
9329
|
*
|
|
9331
9330
|
* **Idempotency:** send an `Idempotency-Key` header to make retries safe.
|
|
9332
9331
|
*/
|
|
@@ -92,7 +92,7 @@ export type Ad = {
|
|
|
92
92
|
*/
|
|
93
93
|
status?: (AdStatus);
|
|
94
94
|
/**
|
|
95
|
-
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request
|
|
95
|
+
* The ad's own on/off switch as configured on the platform, independent of its parents: an ACTIVE ad under a paused ad set or campaign still reads ACTIVE here while `status` reads `paused`. Sources: Meta `configured_status`, TikTok ad `operation_status` (ENABLE -> ACTIVE, DISABLE -> PAUSED), ChatGPT (OpenAI) ad `status` (ACTIVE / PAUSED, plus ARCHIVED on OpenAI). On create it is read back from the platform, not copied from the request: a `PAUSED` create pauses only the top-most object it creates, so an ad under a new paused campaign or ad set reads ACTIVE here with `status: paused`, and only an ad attached to an existing ad set reads PAUSED. Distinct from `status`, which is the ancestor-cascaded delivery status. Only present for Meta, TikTok and OpenAI ads created or synced after the field was added for that platform; null otherwise.
|
|
96
96
|
*/
|
|
97
97
|
configuredStatus?: (string) | null;
|
|
98
98
|
/**
|
|
@@ -4236,18 +4236,20 @@ export type CtwaAdRequestBody = {
|
|
|
4236
4236
|
*/
|
|
4237
4237
|
objective?: 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
4238
4238
|
/**
|
|
4239
|
-
*
|
|
4240
|
-
*
|
|
4239
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
4240
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
4241
|
+
* `adSetId`, the new ads themselves.
|
|
4241
4242
|
*
|
|
4242
4243
|
*/
|
|
4243
4244
|
status?: 'ACTIVE' | 'PAUSED';
|
|
4244
4245
|
/**
|
|
4245
4246
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
4246
|
-
* to `
|
|
4247
|
-
*
|
|
4248
|
-
*
|
|
4249
|
-
* meaningful when a new campaign is being
|
|
4250
|
-
* alongside `adSetId` (the attach shape
|
|
4247
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
4248
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
4249
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
4250
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
4251
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
4252
|
+
* reuses an existing campaign).
|
|
4251
4253
|
*
|
|
4252
4254
|
*/
|
|
4253
4255
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
@@ -4338,19 +4340,21 @@ export type advantageAudience = 0 | 1;
|
|
|
4338
4340
|
export type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS';
|
|
4339
4341
|
|
|
4340
4342
|
/**
|
|
4341
|
-
*
|
|
4342
|
-
*
|
|
4343
|
+
* Defaults to `ACTIVE`. `PAUSED` pauses only the top-most object this
|
|
4344
|
+
* call creates: the new campaign (ad set and ads switched on), or, with
|
|
4345
|
+
* `adSetId`, the new ads themselves.
|
|
4343
4346
|
*
|
|
4344
4347
|
*/
|
|
4345
4348
|
export type status13 = 'ACTIVE' | 'PAUSED';
|
|
4346
4349
|
|
|
4347
4350
|
/**
|
|
4348
4351
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
4349
|
-
* to `
|
|
4350
|
-
*
|
|
4351
|
-
*
|
|
4352
|
-
* meaningful when a new campaign is being
|
|
4353
|
-
* alongside `adSetId` (the attach shape
|
|
4352
|
+
* to `status`. `PAUSED` holds the new campaign off while the ad set and
|
|
4353
|
+
* ads switch on (one resume call brings the whole hierarchy live);
|
|
4354
|
+
* `ACTIVE` with `status: PAUSED` switches the campaign on and pauses the
|
|
4355
|
+
* new ad set instead. Only meaningful when a new campaign is being
|
|
4356
|
+
* created; rejected with a 400 alongside `adSetId` (the attach shape
|
|
4357
|
+
* reuses an existing campaign).
|
|
4354
4358
|
*
|
|
4355
4359
|
*/
|
|
4356
4360
|
export type campaignStatus = 'ACTIVE' | 'PAUSED';
|
|
@@ -32877,7 +32881,7 @@ export type SubmitPhoneNumberKycData = {
|
|
|
32877
32881
|
*/
|
|
32878
32882
|
areaCode?: string;
|
|
32879
32883
|
/**
|
|
32880
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
32884
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
32881
32885
|
*/
|
|
32882
32886
|
preOrder?: boolean;
|
|
32883
32887
|
/**
|
|
@@ -32933,7 +32937,7 @@ export type SubmitPhoneNumberKycData = {
|
|
|
32933
32937
|
export type SubmitPhoneNumberKycResponse = ({
|
|
32934
32938
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
32935
32939
|
/**
|
|
32936
|
-
* True when nothing was
|
|
32940
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
32937
32941
|
*/
|
|
32938
32942
|
preOrder?: boolean;
|
|
32939
32943
|
/**
|
|
@@ -33755,7 +33759,7 @@ export type SubmitWhatsAppNumberKycData = {
|
|
|
33755
33759
|
*/
|
|
33756
33760
|
areaCode?: string;
|
|
33757
33761
|
/**
|
|
33758
|
-
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
|
|
33762
|
+
* With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area. Not needed without areaCode: a whole pair with no stock, or an address in a geographic-match country whose area has no stock, is pre-ordered on its own (see preOrder in the response).
|
|
33759
33763
|
*/
|
|
33760
33764
|
preOrder?: boolean;
|
|
33761
33765
|
/**
|
|
@@ -33807,7 +33811,7 @@ export type SubmitWhatsAppNumberKycData = {
|
|
|
33807
33811
|
export type SubmitWhatsAppNumberKycResponse = ({
|
|
33808
33812
|
status?: 'kyc_submitted' | 'kyc_reused' | 'kyc_already_submitted';
|
|
33809
33813
|
/**
|
|
33810
|
-
* True when nothing was
|
|
33814
|
+
* True when this submission placed a pre-order instead of an order from stock: the country and type had nothing deliverable, the picked areaCode was sold out (preOrder: true sent), or the country requires the number's area to cover the registered address and that area has no stock (the carrier is then asked for a number in exactly that area). The number stays `pending_regulatory` until we get it, from regular stock the moment it returns or sourced by the carrier (usually 2 to 4 weeks, never guaranteed), and is not billed until active. Releasing it (DELETE /v1/phone-numbers/{id}) cancels the pre-order. A pre-order is one number: `quantity` above 1 is rejected with 400.
|
|
33811
33815
|
*/
|
|
33812
33816
|
preOrder?: boolean;
|
|
33813
33817
|
/**
|
|
@@ -44694,7 +44698,7 @@ export type BoostPostData = {
|
|
|
44694
44698
|
*/
|
|
44695
44699
|
leadGenFormId?: string;
|
|
44696
44700
|
/**
|
|
44697
|
-
*
|
|
44701
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default); PAUSED pauses only the top-most object this boost creates and switches everything below it on: a new campaign is held paused with its ad set and ad on (one PUT /v1/ads/campaigns/{campaignId}/status with `active` brings it live); into an existing campaign (TikTok `existingCampaignId`) the new ad set is held paused; attached to an existing ad set (`adSetId`) the new ad itself is paused. On LinkedIn the held campaign group is PAUSED, its campaign and creative ACTIVE. X has no per-ad switch, so its lowest level is the line item.
|
|
44698
44702
|
*/
|
|
44699
44703
|
status?: 'ACTIVE' | 'PAUSED';
|
|
44700
44704
|
/**
|
|
@@ -45032,11 +45036,11 @@ export type CreateStandaloneAdData = {
|
|
|
45032
45036
|
*/
|
|
45033
45037
|
budgetType?: 'daily' | 'lifetime';
|
|
45034
45038
|
/**
|
|
45035
|
-
*
|
|
45039
|
+
* Publish state of the created entities, on every platform. Omitted or ACTIVE publishes live (default, back-compat); PAUSED pauses only the TOP-MOST object this call creates and switches everything below it on, so one resume of that object brings the new tree live and nothing that already existed is touched: a new campaign is held paused with its ad set and ad on; with `existingCampaignId` the new ad set is held paused with its ad on; with `adSetId` the new ad itself is paused. `campaignStatus: ACTIVE` with `status: PAUSED` moves the pause down to the new ad set. LinkedIn: a held campaign group is PAUSED with its campaign and creative ACTIVE; a new campaign in an existing group stays DRAFT. X has no per-ad switch, so its lowest level is the line item. Google Performance Max and Demand Gen accept PAUSED only (the campaign is created paused).
|
|
45036
45040
|
*/
|
|
45037
45041
|
status?: 'ACTIVE' | 'PAUSED';
|
|
45038
45042
|
/**
|
|
45039
|
-
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the campaign
|
|
45043
|
+
* Meta, Google, and ChatGPT (OpenAI). Overrides `status` for the new campaign alone. `PAUSED` holds the campaign off with its ad set and ad on; `ACTIVE` with `status: PAUSED` switches the campaign on and holds the new ad set paused (its ad on). Omitted, it follows `status`.
|
|
45040
45044
|
*/
|
|
45041
45045
|
campaignStatus?: 'ACTIVE' | 'PAUSED';
|
|
45042
45046
|
/**
|