@pushwoosh/rpc-v2-http-api-data 0.2.517 → 0.2.518

package/data.js

@@ -23591,6 +23591,60 @@ export const data = {
                 "method": "delete",
                 "path": "/api/integrations/google-ads/ad-accounts/{ad_account_id}/audiences/{audience_id}"
             },
+            "GetSnapAuthURL": {
+                "request": "pushwoosh.rpc_v2.integrations.GetSnapAuthURLRequest",
+                "response": "pushwoosh.rpc_v2.integrations.GetSnapAuthURLResponse",
+                "method": "get",
+                "path": "/api/integrations/snap/auth"
+            },
+            "GetSnapConfiguration": {
+                "request": "pushwoosh.rpc_v2.integrations.GetSnapConfigurationRequest",
+                "response": "pushwoosh.rpc_v2.integrations.GetSnapConfigurationResponse",
+                "method": "get",
+                "path": "/api/integrations/configurations/snap"
+            },
+            "DeleteSnapConfiguration": {
+                "request": "pushwoosh.rpc_v2.integrations.DeleteSnapConfigurationRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DeleteSnapConfigurationResponse",
+                "method": "delete",
+                "path": "/api/integrations/configurations/snap"
+            },
+            "ListSnapAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.ListSnapAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ListSnapAdAccountsResponse",
+                "method": "get",
+                "path": "/api/integrations/snap/ad-accounts"
+            },
+            "ConnectSnapAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.ConnectSnapAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ConnectSnapAdAccountsResponse",
+                "method": "post",
+                "path": "/api/integrations/snap/ad-accounts/connect"
+            },
+            "DisconnectSnapAdAccounts": {
+                "request": "pushwoosh.rpc_v2.integrations.DisconnectSnapAdAccountsRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DisconnectSnapAdAccountsResponse",
+                "method": "post",
+                "path": "/api/integrations/snap/ad-accounts/disconnect"
+            },
+            "ListSnapAudiences": {
+                "request": "pushwoosh.rpc_v2.integrations.ListSnapAudiencesRequest",
+                "response": "pushwoosh.rpc_v2.integrations.ListSnapAudiencesResponse",
+                "method": "get",
+                "path": "/api/integrations/snap/ad-accounts/{ad_account_id}/audiences"
+            },
+            "CreateSnapAudience": {
+                "request": "pushwoosh.rpc_v2.integrations.CreateSnapAudienceRequest",
+                "response": "pushwoosh.rpc_v2.integrations.CreateSnapAudienceResponse",
+                "method": "post",
+                "path": "/api/integrations/snap/ad-accounts/{ad_account_id}/audiences"
+            },
+            "DeleteSnapAudience": {
+                "request": "pushwoosh.rpc_v2.integrations.DeleteSnapAudienceRequest",
+                "response": "pushwoosh.rpc_v2.integrations.DeleteSnapAudienceResponse",
+                "method": "delete",
+                "path": "/api/integrations/snap/ad-accounts/{ad_account_id}/audiences/{audience_id}"
+            },
             "SetMetaTagMapping": {
                 "request": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingRequest",
                 "response": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingResponse",
@@ -23683,7 +23737,8 @@ export const data = {
             "SALESFORCE",
             "DYNAMICS",
             "GOOGLE_ADS",
-            "FLIGHT_STATUS"
+            "FLIGHT_STATUS",
+            "SNAP"
         ]
     },
     "pushwoosh.rpc_v2.integrations.ImportSegmentPianoRequest": {
@@ -24833,6 +24888,188 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.integrations.SnapAdAccountStatus": {
+        "type": "E",
+        "values": [
+            "SNAP_AD_ACCOUNT_STATUS_UNSPECIFIED",
+            "SNAP_AD_ACCOUNT_STATUS_CONNECTED",
+            "SNAP_AD_ACCOUNT_STATUS_DISCONNECTED"
+        ]
+    },
+    "pushwoosh.rpc_v2.integrations.SnapAdAccount": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAdAccountStatus"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetSnapAuthURLRequest": {
+        "type": "I",
+        "fields": {
+            "returnTo": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetSnapAuthURLResponse": {
+        "type": "I",
+        "fields": {
+            "authUrl": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.GetSnapConfigurationRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.GetSnapConfigurationResponse": {
+        "type": "I",
+        "fields": {
+            "connected": {
+                "type": "boolean"
+            },
+            "identity": {
+                "type": "string"
+            },
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteSnapConfigurationRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteSnapConfigurationResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.ListSnapAdAccountsRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.ListSnapAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ConnectSnapAdAccountsRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ConnectSnapAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAdAccount",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DisconnectSnapAdAccountsRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountIds": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.SnapAudience": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "approximateCount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ListSnapAudiencesRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.ListSnapAudiencesResponse": {
+        "type": "I",
+        "fields": {
+            "audiences": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAudience",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.CreateSnapAudienceRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.CreateSnapAudienceResponse": {
+        "type": "I",
+        "fields": {
+            "audience": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAudience"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteSnapAudienceRequest": {
+        "type": "I",
+        "fields": {
+            "adAccountId": {
+                "type": "string"
+            },
+            "audienceId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.integrations.DeleteSnapAudienceResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.integrations.DisconnectSnapAdAccountsResponse": {
+        "type": "I",
+        "fields": {
+            "adAccounts": {
+                "type": "pushwoosh.rpc_v2.integrations.SnapAdAccount",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.integrations.FlightStatusConfiguration": {
         "type": "I",
         "fields": {

package/integrations.d.ts

@@ -38,6 +38,15 @@ export type IntegrationsService_DisconnectGoogleAdsAdAccounts = RpcMethod<Discon
 export type IntegrationsService_ListGoogleAdsAudiences = RpcMethod<ListGoogleAdsAudiencesRequest, ListGoogleAdsAudiencesResponse>;
 export type IntegrationsService_CreateGoogleAdsAudience = RpcMethod<CreateGoogleAdsAudienceRequest, CreateGoogleAdsAudienceResponse>;
 export type IntegrationsService_DeleteGoogleAdsAudience = RpcMethod<DeleteGoogleAdsAudienceRequest, DeleteGoogleAdsAudienceResponse>;
+export type IntegrationsService_GetSnapAuthURL = RpcMethod<GetSnapAuthURLRequest, GetSnapAuthURLResponse>;
+export type IntegrationsService_GetSnapConfiguration = RpcMethod<GetSnapConfigurationRequest, GetSnapConfigurationResponse>;
+export type IntegrationsService_DeleteSnapConfiguration = RpcMethod<DeleteSnapConfigurationRequest, DeleteSnapConfigurationResponse>;
+export type IntegrationsService_ListSnapAdAccounts = RpcMethod<ListSnapAdAccountsRequest, ListSnapAdAccountsResponse>;
+export type IntegrationsService_ConnectSnapAdAccounts = RpcMethod<ConnectSnapAdAccountsRequest, ConnectSnapAdAccountsResponse>;
+export type IntegrationsService_DisconnectSnapAdAccounts = RpcMethod<DisconnectSnapAdAccountsRequest, DisconnectSnapAdAccountsResponse>;
+export type IntegrationsService_ListSnapAudiences = RpcMethod<ListSnapAudiencesRequest, ListSnapAudiencesResponse>;
+export type IntegrationsService_CreateSnapAudience = RpcMethod<CreateSnapAudienceRequest, CreateSnapAudienceResponse>;
+export type IntegrationsService_DeleteSnapAudience = RpcMethod<DeleteSnapAudienceRequest, DeleteSnapAudienceResponse>;
 export type IntegrationsService_SetMetaTagMapping = RpcMethod<SetMetaTagMappingRequest, SetMetaTagMappingResponse>;
 export type IntegrationsService_GetGoogleBQConfiguration = RpcMethod<GetGoogleBQConfigurationRequest, GetGoogleBQConfigurationResponse>;
 export type IntegrationsService_CreateGoogleBQConfiguration = RpcMethod<CreateGoogleBQConfigurationRequest, CreateGoogleBQConfigurationResponse>;
@@ -159,6 +168,27 @@ export interface IntegrationsService {
     CreateGoogleAdsAudience: IntegrationsService_CreateGoogleAdsAudience;
     /** Deletes a CRM-based user list at Google. Removal is permanent and every journey audience sync step pointing at the list stops working, so ask the user first. */
     DeleteGoogleAdsAudience: IntegrationsService_DeleteGoogleAdsAudience;
+    /**
+     * snap
+     * Builds the Snap OAuth authorization URL to start connecting a Snap 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.
+     */
+    GetSnapAuthURL: IntegrationsService_GetSnapAuthURL;
+    /** Returns the Snap integration configuration for the current account: whether it is connected, the Snap identity (email) behind the grant and the connected ad accounts. Use to inspect the current Snap connection state. */
+    GetSnapConfiguration: IntegrationsService_GetSnapConfiguration;
+    /** Removes the entire Snap connection for the current account: the chosen ad accounts and the OAuth grant itself. Use to fully disconnect; not recoverable without reconnecting. */
+    DeleteSnapConfiguration: IntegrationsService_DeleteSnapConfiguration;
+    /** Lists the Snap ad accounts the connection can reach, each marked as connected or not. Use to discover ad accounts before connecting them with connect_snap_ad_accounts. */
+    ListSnapAdAccounts: IntegrationsService_ListSnapAdAccounts;
+    /** Connects the given Snap ad accounts by id. Ids the connection cannot reach are refused, so an account cannot be stored that would only fail later at send time. */
+    ConnectSnapAdAccounts: IntegrationsService_ConnectSnapAdAccounts;
+    /** Disconnects the given Snap ad accounts by id while keeping the OAuth grant. Use to remove specific ad accounts; to drop the whole connection use delete_snap_integration. */
+    DisconnectSnapAdAccounts: IntegrationsService_DisconnectSnapAdAccounts;
+    /** Lists the first-party (customer list) segments of a connected Snap ad account. Use to pick an audience for a journey audience sync point, or to see what create_snap_audience produced. */
+    ListSnapAudiences: IntegrationsService_ListSnapAudiences;
+    /** Creates a first-party (customer list) segment on a connected Snap ad account. Use before syncing users: an upload targets a segment that already exists. */
+    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;
     /** 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;
     /**
@@ -193,7 +223,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';
+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 ImportSegmentPianoRequest = {
     /** application code */
     application?: string;
@@ -677,6 +707,72 @@ export type DeleteGoogleAdsAudienceResponse = {};
 export type DisconnectGoogleAdsAdAccountsResponse = {
     adAccounts: GoogleAdsAdAccount[];
 };
+export type SnapAdAccountStatus = 'SNAP_AD_ACCOUNT_STATUS_UNSPECIFIED' | 'SNAP_AD_ACCOUNT_STATUS_CONNECTED' | 'SNAP_AD_ACCOUNT_STATUS_DISCONNECTED';
+export type SnapAdAccount = {
+    /** Snap customer id, digits only */
+    id: string;
+    name: string;
+    status: SnapAdAccountStatus;
+};
+export type GetSnapAuthURLRequest = {
+    /** where the browser lands once the connection is stored */
+    returnTo?: string;
+};
+export type GetSnapAuthURLResponse = {
+    authUrl: string;
+};
+export type GetSnapConfigurationRequest = {};
+export type GetSnapConfigurationResponse = {
+    connected: boolean;
+    /** snap account email the grant belongs to */
+    identity: string;
+    adAccounts: SnapAdAccount[];
+};
+export type DeleteSnapConfigurationRequest = {};
+export type DeleteSnapConfigurationResponse = {};
+export type ListSnapAdAccountsRequest = {};
+export type ListSnapAdAccountsResponse = {
+    adAccounts: SnapAdAccount[];
+};
+export type ConnectSnapAdAccountsRequest = {
+    adAccountIds?: string[];
+};
+export type ConnectSnapAdAccountsResponse = {
+    adAccounts: SnapAdAccount[];
+};
+export type DisconnectSnapAdAccountsRequest = {
+    adAccountIds?: string[];
+};
+/** SnapAudience is a first-party (customer list) segment on an ad account. */
+export type SnapAudience = {
+    id: string;
+    name: string;
+    /** Snap's estimate of matched users, 0 until matching runs */
+    approximateCount: number;
+};
+export type ListSnapAudiencesRequest = {
+    adAccountId?: string;
+};
+export type ListSnapAudiencesResponse = {
+    audiences: SnapAudience[];
+};
+export type CreateSnapAudienceRequest = {
+    adAccountId?: string;
+    name?: string;
+    /** optional, the integration fills its own default when empty */
+    description?: string;
+};
+export type CreateSnapAudienceResponse = {
+    audience: SnapAudience;
+};
+export type DeleteSnapAudienceRequest = {
+    adAccountId?: string;
+    audienceId?: string;
+};
+export type DeleteSnapAudienceResponse = {};
+export type DisconnectSnapAdAccountsResponse = {
+    adAccounts: SnapAdAccount[];
+};
 export type FlightStatusConfiguration = {
     provider: string;
     apiKey: string;

package/package.json

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