@zernio/node 0.2.1499 → 0.2.1501

package/dist/index.d.mts

@@ -6824,7 +6824,7 @@ type CampaignBidding = {
 type channel2 = 'SEARCH' | 'DISPLAY';
 type CampaignLedgerEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     /**
      * Always positive; direction is given by debit and credit.
      */
@@ -6844,7 +6844,7 @@ type CampaignLedgerEntry = {
     actor: string;
     createdAt: string;
 };
-type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
 type CampaignParticipant = {
     id: string;
     campaignId: string;
@@ -9138,7 +9138,7 @@ type CreatorPortalParticipant = {
 type kind6 = 'participant';
 type CreatorPortalPayoutEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     amountCents: number;
     /**
      * The participant bucket the money left; null when it came from outside the participant.
@@ -25802,7 +25802,7 @@ type GetLedgerBalancesError = (ErrorResponse | {
 });
 type ListLedgerEntriesData = {
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         referenceId?: string;
         referenceType?: string;
@@ -25814,7 +25814,7 @@ type ListLedgerEntriesData = {
 type ListLedgerEntriesResponse = ({
     entries?: Array<{
         id?: string;
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         /**
          * Always positive; direction is given by debit and credit
          */
@@ -25846,7 +25846,7 @@ type ListLedgerEntriesError = (ErrorResponse | {
 });
 type GetBalanceResponse = ({
     /**
-     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent; transfers are refused while it is negative.
+     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent, or, on balance billing, when pay-per-use already in flight (a connected call, an SMS already with the carrier) lands past zero; the next top-up covers it. Transfers are refused while it is negative.
      */
     availableCents?: number;
     /**
@@ -62710,7 +62710,7 @@ type CreateAdAudienceData = {
          * - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`, `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` / `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
          * - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`, `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
          * - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
-         * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
+         * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER`.
          *
          */
         event?: string;
@@ -62735,11 +62735,11 @@ type CreateAdAudienceData = {
          */
         source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
         /**
-         * tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
+         * tiktok_engagement: ad group ids for `ads`, TikTok post ids (`item_id`) for `organic_video` and live video ids for `live_video` (max 10 for both). Not accepted for `business_account`: Zernio sends the core_user_id of the TikTok for Business user that connected the ad account.
          */
         sourceIds?: Array<(string)>;
         /**
-         * tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
+         * tiktok_engagement: the TikTok identity (TT_USER or BC_AUTH_TT) that owns the videos. Required for organic_video and live_video.
          */
         identityId?: string;
         /**
@@ -68423,7 +68423,7 @@ type ListCampaignLedgerData = {
         campaignId: string;
     };
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         /**
          * List only this participant's entries.

package/dist/index.d.ts

@@ -6824,7 +6824,7 @@ type CampaignBidding = {
 type channel2 = 'SEARCH' | 'DISPLAY';
 type CampaignLedgerEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     /**
      * Always positive; direction is given by debit and credit.
      */
@@ -6844,7 +6844,7 @@ type CampaignLedgerEntry = {
     actor: string;
     createdAt: string;
 };
-type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
 type CampaignParticipant = {
     id: string;
     campaignId: string;
@@ -9138,7 +9138,7 @@ type CreatorPortalParticipant = {
 type kind6 = 'participant';
 type CreatorPortalPayoutEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     amountCents: number;
     /**
      * The participant bucket the money left; null when it came from outside the participant.
@@ -25802,7 +25802,7 @@ type GetLedgerBalancesError = (ErrorResponse | {
 });
 type ListLedgerEntriesData = {
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         referenceId?: string;
         referenceType?: string;
@@ -25814,7 +25814,7 @@ type ListLedgerEntriesData = {
 type ListLedgerEntriesResponse = ({
     entries?: Array<{
         id?: string;
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         /**
          * Always positive; direction is given by debit and credit
          */
@@ -25846,7 +25846,7 @@ type ListLedgerEntriesError = (ErrorResponse | {
 });
 type GetBalanceResponse = ({
     /**
-     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent; transfers are refused while it is negative.
+     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent, or, on balance billing, when pay-per-use already in flight (a connected call, an SMS already with the carrier) lands past zero; the next top-up covers it. Transfers are refused while it is negative.
      */
     availableCents?: number;
     /**
@@ -62710,7 +62710,7 @@ type CreateAdAudienceData = {
          * - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`, `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` / `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
          * - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`, `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
          * - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
-         * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
+         * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER`.
          *
          */
         event?: string;
@@ -62735,11 +62735,11 @@ type CreateAdAudienceData = {
          */
         source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
         /**
-         * tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
+         * tiktok_engagement: ad group ids for `ads`, TikTok post ids (`item_id`) for `organic_video` and live video ids for `live_video` (max 10 for both). Not accepted for `business_account`: Zernio sends the core_user_id of the TikTok for Business user that connected the ad account.
          */
         sourceIds?: Array<(string)>;
         /**
-         * tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
+         * tiktok_engagement: the TikTok identity (TT_USER or BC_AUTH_TT) that owns the videos. Required for organic_video and live_video.
          */
         identityId?: string;
         /**
@@ -68423,7 +68423,7 @@ type ListCampaignLedgerData = {
         campaignId: string;
     };
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         /**
          * List only this participant's entries.

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.1499",
+  version: "0.2.1501",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@zernio/node",
-  version: "0.2.1499",
+  version: "0.2.1501",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zernio/node",
-  "version": "0.2.1499",
+  "version": "0.2.1501",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/types.gen.ts

@@ -4725,7 +4725,7 @@ export type channel2 = 'SEARCH' | 'DISPLAY';
 
 export type CampaignLedgerEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     /**
      * Always positive; direction is given by debit and credit.
      */
@@ -4746,7 +4746,7 @@ export type CampaignLedgerEntry = {
     createdAt: string;
 };
 
-export type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+export type kind3 = 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
 
 export type CampaignParticipant = {
     id: string;
@@ -7155,7 +7155,7 @@ export type kind6 = 'participant';
 
 export type CreatorPortalPayoutEntry = {
     id: string;
-    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+    kind: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
     amountCents: number;
     /**
      * The participant bucket the money left; null when it came from outside the participant.
@@ -24572,7 +24572,7 @@ export type GetLedgerBalancesError = (ErrorResponse | {
 
 export type ListLedgerEntriesData = {
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         referenceId?: string;
         referenceType?: string;
@@ -24585,7 +24585,7 @@ export type ListLedgerEntriesData = {
 export type ListLedgerEntriesResponse = ({
     entries?: Array<{
         id?: string;
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         /**
          * Always positive; direction is given by debit and credit
          */
@@ -24619,7 +24619,7 @@ export type ListLedgerEntriesError = (ErrorResponse | {
 
 export type GetBalanceResponse = ({
     /**
-     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent; transfers are refused while it is negative.
+     * Your balance, including card top-ups paid in the last 7 days (see payoutLockedCents). Negative after a dispute or refund of a top-up that was already spent, or, on balance billing, when pay-per-use already in flight (a connected call, an SMS already with the carrier) lands past zero; the next top-up covers it. Transfers are refused while it is negative.
      */
     availableCents?: number;
     /**
@@ -64064,7 +64064,7 @@ export type CreateAdAudienceData = {
      * - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`, `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` / `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
      * - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`, `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
      * - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
-     * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
+     * - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`, `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`, `BUSINESS ACCOUNT PLAY OVER`.
      *
      */
     event?: string;
@@ -64089,11 +64089,11 @@ export type CreateAdAudienceData = {
      */
     source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
     /**
-     * tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
+     * tiktok_engagement: ad group ids for `ads`, TikTok post ids (`item_id`) for `organic_video` and live video ids for `live_video` (max 10 for both). Not accepted for `business_account`: Zernio sends the core_user_id of the TikTok for Business user that connected the ad account.
      */
     sourceIds?: Array<(string)>;
     /**
-     * tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
+     * tiktok_engagement: the TikTok identity (TT_USER or BC_AUTH_TT) that owns the videos. Required for organic_video and live_video.
      */
     identityId?: string;
     /**
@@ -70503,7 +70503,7 @@ export type ListCampaignLedgerData = {
         campaignId: string;
     };
     query?: {
-        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee';
+        kind?: 'accrual' | 'approval' | 'hold_release' | 'adjustment' | 'settling' | 'settlement' | 'reversal' | 'topup' | 'transfer' | 'fee' | 'usage' | 'grant';
         limit?: number;
         /**
          * List only this participant's entries.