@pushwoosh/rpc-v2-http-api-data 0.2.519 → 0.2.521

package/data.js

@@ -23645,6 +23645,60 @@ export const data = {
                 "method": "delete",
                 "path": "/api/integrations/snap/ad-accounts/{ad_account_id}/audiences/{audience_id}"
             },
+            "GetTikTokAuthURL": {
+                "request": "pushwoosh.rpc_v2.integrations.GetTikTokAuthURLRequest",
+                "response": "pushwoosh.rpc_v2.integrations.GetTikTokAuthURLResponse",
+                "method": "get",
+                "path": "/api/integrations/tiktok/auth"
+            },
+            "GetTikTokConfiguration": {
+                "request": "pushwoosh.rpc_v2.integrations.GetTikTokConfigurationRequest",
+                "response": "pushwoosh.rpc_v2.integrations.GetTikTokConfigurationResponse",
+                "method": "get",
+                "path": "/api/integrations/configurations/tiktok"
+            },
+            "DeleteTikTokConfiguration": {
+                "request": "pushwoosh.rpc_v2.integrations.DeleteTikTokConfigurationRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DeleteTikTokConfigurationResponse",
+                "method": "delete",
+                "path": "/api/integrations/configurations/tiktok"
+            },
+            "ListTikTokAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.ListTikTokAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ListTikTokAdAccountsResponse",
+                "method": "get",
+                "path": "/api/integrations/tiktok/ad-accounts"
+            },
+            "ConnectTikTokAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.ConnectTikTokAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ConnectTikTokAdAccountsResponse",
+                "method": "post",
+                "path": "/api/integrations/tiktok/ad-accounts/connect"
+            },
+            "DisconnectTikTokAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.DisconnectTikTokAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DisconnectTikTokAdAccountsResponse",
+                "method": "post",
+                "path": "/api/integrations/tiktok/ad-accounts/disconnect"
+            },
+            "ListTikTokAudiences": {
+                "request": "pushwoosh.rpc_v2.integrations.ListTikTokAudiencesRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ListTikTokAudiencesResponse",
+                "method": "get",
+                "path": "/api/integrations/tiktok/ad-accounts/{ad_account_id}/audiences"
+            },
+            "CreateTikTokAudience": {
+                "request": "pushwoosh.rpc_v2.integrations.CreateTikTokAudienceRequest",
+                "response": "pushwoosh.rpc_v2.integrations.CreateTikTokAudienceResponse",
+                "method": "post",
+                "path": "/api/integrations/tiktok/ad-accounts/{ad_account_id}/audiences"
+            },
+            "DeleteTikTokAudience": {
+                "request": "pushwoosh.rpc_v2.integrations.DeleteTikTokAudienceRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DeleteTikTokAudienceResponse",
+                "method": "delete",
+                "path": "/api/integrations/tiktok/ad-accounts/{ad_account_id}/audiences/{audience_id}"
+            },
             "SetMetaTagMapping": {
                 "request": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingRequest",
                 "response": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingResponse",
@@ -23738,7 +23792,8 @@ export const data = {
             "DYNAMICS",
             "GOOGLE_ADS",
             "FLIGHT_STATUS",
-            "SNAP"
+            "SNAP",
+            "TIKTOK"
         ]
     },
     "pushwoosh.rpc_v2.integrations.ImportSegmentPianoRequest": {
@@ -25070,6 +25125,188 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.integrations.TikTokAdAccountStatus": {
+        "type": "E",
+        "values": [
+            "TIKTOK_AD_ACCOUNT_STATUS_UNSPECIFIED",
+            "TIKTOK_AD_ACCOUNT_STATUS_CONNECTED",
+            "TIKTOK_AD_ACCOUNT_STATUS_DISCONNECTED"
+        ]
+    },
+    "pushwoosh.rpc_v2.integrations.TikTokAdAccount": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAdAccountStatus"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetTikTokAuthURLRequest": {
+        "type": "I",
+        "fields": {
+            "returnTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetTikTokAuthURLResponse": {
+        "type": "I",
+        "fields": {
+            "authUrl": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetTikTokConfigurationRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.GetTikTokConfigurationResponse": {
+        "type": "I",
+        "fields": {
+            "connected": {
+                "type": "boolean"
+            },
+            "identity": {
+                "type": "string"
+            },
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteTikTokConfigurationRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteTikTokConfigurationResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.ListTikTokAdAccountsRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.ListTikTokAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ConnectTikTokAdAccountsRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ConnectTikTokAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DisconnectTikTokAdAccountsRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.TikTokAudience": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "approximateCount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ListTikTokAudiencesRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ListTikTokAudiencesResponse": {
+        "type": "I",
+        "fields": {
+            "audiences": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAudience",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.CreateTikTokAudienceRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.CreateTikTokAudienceResponse": {
+        "type": "I",
+        "fields": {
+            "audience": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAudience"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteTikTokAudienceRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            },
+            "audienceId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteTikTokAudienceResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.DisconnectTikTokAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.TikTokAdAccount",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.integrations.FlightStatusConfiguration": {
         "type": "I",
         "fields": {

package/integrations.d.ts

@@ -47,6 +47,15 @@ export type IntegrationsService_DisconnectSnapAdAccounts = RpcMethod<DisconnectS
 export type IntegrationsService_ListSnapAudiences = RpcMethod<ListSnapAudiencesRequest, ListSnapAudiencesResponse>;
 export type IntegrationsService_CreateSnapAudience = RpcMethod<CreateSnapAudienceRequest, CreateSnapAudienceResponse>;
 export type IntegrationsService_DeleteSnapAudience = RpcMethod<DeleteSnapAudienceRequest, DeleteSnapAudienceResponse>;
+export type IntegrationsService_GetTikTokAuthURL = RpcMethod<GetTikTokAuthURLRequest, GetTikTokAuthURLResponse>;
+export type IntegrationsService_GetTikTokConfiguration = RpcMethod<GetTikTokConfigurationRequest, GetTikTokConfigurationResponse>;
+export type IntegrationsService_DeleteTikTokConfiguration = RpcMethod<DeleteTikTokConfigurationRequest, DeleteTikTokConfigurationResponse>;
+export type IntegrationsService_ListTikTokAdAccounts = RpcMethod<ListTikTokAdAccountsRequest, ListTikTokAdAccountsResponse>;
+export type IntegrationsService_ConnectTikTokAdAccounts = RpcMethod<ConnectTikTokAdAccountsRequest, ConnectTikTokAdAccountsResponse>;
+export type IntegrationsService_DisconnectTikTokAdAccounts = RpcMethod<DisconnectTikTokAdAccountsRequest, DisconnectTikTokAdAccountsResponse>;
+export type IntegrationsService_ListTikTokAudiences = RpcMethod<ListTikTokAudiencesRequest, ListTikTokAudiencesResponse>;
+export type IntegrationsService_CreateTikTokAudience = RpcMethod<CreateTikTokAudienceRequest, CreateTikTokAudienceResponse>;
+export type IntegrationsService_DeleteTikTokAudience = RpcMethod<DeleteTikTokAudienceRequest, DeleteTikTokAudienceResponse>;
 export type IntegrationsService_SetMetaTagMapping = RpcMethod<SetMetaTagMappingRequest, SetMetaTagMappingResponse>;
 export type IntegrationsService_GetGoogleBQConfiguration = RpcMethod<GetGoogleBQConfigurationRequest, GetGoogleBQConfigurationResponse>;
 export type IntegrationsService_CreateGoogleBQConfiguration = RpcMethod<CreateGoogleBQConfigurationRequest, CreateGoogleBQConfigurationResponse>;
@@ -189,6 +198,27 @@ export interface IntegrationsService {
     CreateSnapAudience: IntegrationsService_CreateSnapAudience;
     /** Deletes a first-party (customer list) segment at Snap. Removal is permanent and every journey audience sync step pointing at the segment stops working, so ask the user first. */
     DeleteSnapAudience: IntegrationsService_DeleteSnapAudience;
+    /**
+     * tiktok
+     * Builds the TikTok for Business authorization URL to start connecting a TikTok for Business account. The consent flow is owned by integration-oauth, which stores the grant and sends the browser back to return_to — there is no callback method here.
+     */
+    GetTikTokAuthURL: IntegrationsService_GetTikTokAuthURL;
+    /** Returns the TikTok integration configuration for the current account: whether it is connected, the identity behind the grant and the connected ad accounts. Use to inspect the current TikTok connection state. */
+    GetTikTokConfiguration: IntegrationsService_GetTikTokConfiguration;
+    /** Removes the entire TikTok connection for the current account: the chosen ad accounts and the OAuth grant itself. Use to fully disconnect; not recoverable without reconnecting. */
+    DeleteTikTokConfiguration: IntegrationsService_DeleteTikTokConfiguration;
+    /** Lists the TikTok advertisers the connection can reach, each marked as connected or not. Use to discover ad accounts before connecting them with connect_tiktok_ad_accounts. */
+    ListTikTokAdAccounts: IntegrationsService_ListTikTokAdAccounts;
+    /** Connects the given TikTok advertisers by id. Ids the connection cannot reach are refused, so an account cannot be stored that would only fail later at send time. */
+    ConnectTikTokAdAccounts: IntegrationsService_ConnectTikTokAdAccounts;
+    /** Disconnects the given TikTok advertisers by id while keeping the OAuth grant. Use to remove specific ad accounts; to drop the whole connection use delete_tiktok_integration. */
+    DisconnectTikTokAdAccounts: IntegrationsService_DisconnectTikTokAdAccounts;
+    /** Lists the audience segments of a connected TikTok ad account. Use to pick an audience for a journey audience sync point, or to see what create_tiktok_audience produced. */
+    ListTikTokAudiences: IntegrationsService_ListTikTokAudiences;
+    /** Creates an audience segment on a connected TikTok ad account. Use before syncing users: an upload targets a segment that already exists. */
+    CreateTikTokAudience: IntegrationsService_CreateTikTokAudience;
+    /** Deletes an audience segment at TikTok. Removal is permanent and every journey audience sync step pointing at the segment stops working, so ask the user first. */
+    DeleteTikTokAudience: IntegrationsService_DeleteTikTokAudience;
     /** Overwrites the mapping between Pushwoosh tags and Meta custom-audience fields for the current account. Use to define which PW tags sync to Meta audiences; replaces the entire mapping. */
     SetMetaTagMapping: IntegrationsService_SetMetaTagMapping;
     /**
@@ -223,7 +253,7 @@ export interface IntegrationsService {
     DeleteFlightStatusSubscription: IntegrationsService_DeleteFlightStatusSubscription;
 }
 /** Integration contains all available integration for clients (to update props) */
-export type Integration = 'UNKNOWN' | 'SEGMENT' | 'PIANO' | 'WEBHOOK' | 'HUBSPOT' | 'SHOPIFY' | 'STRIPE' | 'META' | 'INBOUND_WEBHOOK' | 'GOOGLE_BQ' | 'GOOGLE' | 'AZURE' | 'SALESFORCE' | 'DYNAMICS' | 'GOOGLE_ADS' | 'FLIGHT_STATUS' | 'SNAP';
+export type Integration = 'UNKNOWN' | 'SEGMENT' | 'PIANO' | 'WEBHOOK' | 'HUBSPOT' | 'SHOPIFY' | 'STRIPE' | 'META' | 'INBOUND_WEBHOOK' | 'GOOGLE_BQ' | 'GOOGLE' | 'AZURE' | 'SALESFORCE' | 'DYNAMICS' | 'GOOGLE_ADS' | 'FLIGHT_STATUS' | 'SNAP' | 'TIKTOK';
 export type ImportSegmentPianoRequest = {
     /** application code */
     application?: string;
@@ -773,6 +803,72 @@ export type DeleteSnapAudienceResponse = {};
 export type DisconnectSnapAdAccountsResponse = {
     adAccounts: SnapAdAccount[];
 };
+export type TikTokAdAccountStatus = 'TIKTOK_AD_ACCOUNT_STATUS_UNSPECIFIED' | 'TIKTOK_AD_ACCOUNT_STATUS_CONNECTED' | 'TIKTOK_AD_ACCOUNT_STATUS_DISCONNECTED';
+export type TikTokAdAccount = {
+    /** TikTok customer id, digits only */
+    id: string;
+    name: string;
+    status: TikTokAdAccountStatus;
+};
+export type GetTikTokAuthURLRequest = {
+    /** where the browser lands once the connection is stored */
+    returnTo?: string;
+};
+export type GetTikTokAuthURLResponse = {
+    authUrl: string;
+};
+export type GetTikTokConfigurationRequest = {};
+export type GetTikTokConfigurationResponse = {
+    connected: boolean;
+    /** empty: TikTok issues no identity with the grant */
+    identity: string;
+    adAccounts: TikTokAdAccount[];
+};
+export type DeleteTikTokConfigurationRequest = {};
+export type DeleteTikTokConfigurationResponse = {};
+export type ListTikTokAdAccountsRequest = {};
+export type ListTikTokAdAccountsResponse = {
+    adAccounts: TikTokAdAccount[];
+};
+export type ConnectTikTokAdAccountsRequest = {
+    adAccountIds?: string[];
+};
+export type ConnectTikTokAdAccountsResponse = {
+    adAccounts: TikTokAdAccount[];
+};
+export type DisconnectTikTokAdAccountsRequest = {
+    adAccountIds?: string[];
+};
+/** TikTokAudience is a audience segment on an ad account. */
+export type TikTokAudience = {
+    id: string;
+    name: string;
+    /** TikTok's cover_num, 0 until matching runs (up to 48 hours) */
+    approximateCount: number;
+};
+export type ListTikTokAudiencesRequest = {
+    adAccountId?: string;
+};
+export type ListTikTokAudiencesResponse = {
+    audiences: TikTokAudience[];
+};
+export type CreateTikTokAudienceRequest = {
+    adAccountId?: string;
+    name?: string;
+    /** optional, the integration fills its own default when empty */
+    description?: string;
+};
+export type CreateTikTokAudienceResponse = {
+    audience: TikTokAudience;
+};
+export type DeleteTikTokAudienceRequest = {
+    adAccountId?: string;
+    audienceId?: string;
+};
+export type DeleteTikTokAudienceResponse = {};
+export type DisconnectTikTokAdAccountsResponse = {
+    adAccounts: TikTokAdAccount[];
+};
 export type FlightStatusConfiguration = {
     provider: string;
     apiKey: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.519",
+  "version": "0.2.521",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",