@pushwoosh/rpc-v2-http-api-data 0.2.33 → 0.2.34

package/data.js

@@ -10250,6 +10250,15 @@ export const data = {
                 "errors": {
                     "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
                 }
+            },
+            "TestConnection": {
+                "request": "pushwoosh.rpc.external_segments.v3.TestConnectionRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.TestConnectionResponse",
+                "method": "post",
+                "path": "/api/external-segments:test-connection",
+                "errors": {
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
             }
         }
     },
@@ -10535,6 +10544,52 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc.external_segments.v3.TestConnectionRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            },
+            "postgres": {
+                "type": "pushwoosh.rpc.external_segments.v3.PostgresConnection"
+            },
+            "mysql": {
+                "type": "pushwoosh.rpc.external_segments.v3.MysqlConnection"
+            },
+            "bigquery": {
+                "type": "pushwoosh.rpc.external_segments.v3.BigQueryConnection"
+            },
+            "query": {
+                "type": "string"
+            },
+            "checkQuery": {
+                "type": "boolean"
+            }
+        },
+        "oneofs": {
+            "connection": {
+                "oneof": [
+                    "postgres",
+                    "mysql",
+                    "bigquery"
+                ]
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.TestConnectionResponse": {
+        "type": "I",
+        "fields": {
+            "ok": {
+                "type": "boolean"
+            },
+            "error": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.filters.FiltersService": {
         "type": "S",
         "key": "filters",

package/package.json

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

package/pushwoosh_rpc_external_segments_v3.d.ts

@@ -161,6 +161,13 @@ export type ExternalSegmentsService_CheckConnection = RpcMethodV3<CheckConnectio
     error?: undefined;
     failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
+export type ExternalSegmentsService_TestConnection = RpcMethodV3<TestConnectionRequest, TestConnectionResponse, {
+    error: unknown;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
 /**
  * ExternalSegmentsService manages external segments: user populations materialized
  * from an external database (PostgreSQL / MySQL) via a user-supplied SQL query.
@@ -186,10 +193,18 @@ export interface ExternalSegmentsService {
     /** Delete an external segment. */
     Delete: ExternalSegmentsService_Delete;
     /**
-     * CheckConnection connects to the segment's database and pings it, then
+     * CheckConnection connects to the segment's database and validates its stored
+     * query (SQL: executes it and reads the first row; BigQuery: dry-run), then
      * stores the outcome in the segment's `valid` flag. Returns the result.
      */
     CheckConnection: ExternalSegmentsService_CheckConnection;
+    /**
+     * TestConnection validates connection parameters supplied inline (not yet
+     * persisted), so the create/edit form can test before saving. When
+     * check_query is false it only connects and pings; when true it also
+     * validates the query. It never persists anything (unlike CheckConnection).
+     */
+    TestConnection: ExternalSegmentsService_TestConnection;
 }
 export type ExternalSegmentsService_Errors = {
     List: {
@@ -212,6 +227,9 @@ export type ExternalSegmentsService_Errors = {
     CheckConnection: {
         failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
     };
+    TestConnection: {
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
 };
 /**
  * PostgresConnection holds PostgreSQL connection parameters.
@@ -422,3 +440,41 @@ export type CheckConnectionResponse = {
     /** Connection error message when valid is false; empty otherwise. */
     error: string;
 };
+export type TestConnectionRequest_connection_postgres = {
+    type: 'postgres';
+    data: PostgresConnection;
+};
+export type TestConnectionRequest_connection_mysql = {
+    type: 'mysql';
+    data: MysqlConnection;
+};
+export type TestConnectionRequest_connection_bigquery = {
+    type: 'bigquery';
+    data: BigQueryConnection;
+};
+export type TestConnectionRequest_connection = TestConnectionRequest_connection_postgres | TestConnectionRequest_connection_mysql | TestConnectionRequest_connection_bigquery;
+export type TestConnectionRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /**
+     * Optional external segment code. When set, blank write-only secrets
+     * (password / service account JSON) and TLS certificates are backfilled from
+     * the stored segment, so an existing segment can be tested without re-entering
+     * them. Leave empty when testing brand-new parameters on the create form.
+     */
+    code?: string;
+    /** SQL query to validate. Required (and only used) when check_query is true. */
+    query?: string;
+    /**
+     * When true, the query is executed to validate it (SQL: run it and read the
+     * first row; BigQuery: dry-run). When false, only connectivity is checked.
+     */
+    checkQuery?: boolean;
+    connection: TestConnectionRequest_connection;
+};
+export type TestConnectionResponse = {
+    /** Whether the test succeeded. */
+    ok: boolean;
+    /** Failure message when ok is false; empty otherwise. */
+    error: string;
+};