@pushwoosh/rpc-v2-http-api-data 0.2.23 → 0.2.25

package/data.js

@@ -10237,6 +10237,15 @@ export const data = {
                     "failedPreconditions": "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Delete_FailedPreconditions",
                     "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
                 }
+            },
+            "CheckConnection": {
+                "request": "pushwoosh.rpc.external_segments.v3.CheckConnectionRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.CheckConnectionResponse",
+                "method": "post",
+                "path": "/api/external-segments/{code}:check-connection",
+                "errors": {
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
             }
         }
     },
@@ -10261,6 +10270,18 @@ export const data = {
             "options": {
                 "type": "string",
                 "mapKeyType": "string"
+            },
+            "sslmode": {
+                "type": "string"
+            },
+            "caCert": {
+                "type": "string"
+            },
+            "clientCert": {
+                "type": "string"
+            },
+            "clientKey": {
+                "type": "string"
             }
         }
     },
@@ -10462,6 +10483,28 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc.external_segments.v3.CheckConnectionRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.CheckConnectionResponse": {
+        "type": "I",
+        "fields": {
+            "valid": {
+                "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.23",
+  "version": "0.2.25",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",

package/pushwoosh_rpc_external_segments_v3.d.ts

@@ -138,6 +138,13 @@ export type ExternalSegmentsService_Delete = RpcMethodV3<DeleteRequest, DeleteRe
     error?: undefined;
     failedPreconditions?: ExternalSegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
 }>;
+export type ExternalSegmentsService_CheckConnection = RpcMethodV3<CheckConnectionRequest, CheckConnectionResponse, {
+    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.
@@ -162,6 +169,11 @@ export interface ExternalSegmentsService {
     Update: ExternalSegmentsService_Update;
     /** Delete an external segment. */
     Delete: ExternalSegmentsService_Delete;
+    /**
+     * CheckConnection connects to the segment's database and pings it, then
+     * stores the outcome in the segment's `valid` flag. Returns the result.
+     */
+    CheckConnection: ExternalSegmentsService_CheckConnection;
 }
 export type ExternalSegmentsService_Errors = {
     List: {
@@ -181,6 +193,9 @@ export type ExternalSegmentsService_Errors = {
     Delete: {
         failedPreconditions: ExternalSegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
     };
+    CheckConnection: {
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
 };
 /**
  * PostgresConnection holds PostgreSQL connection parameters.
@@ -199,11 +214,26 @@ export type PostgresConnection = {
     /** Database name. */
     database: string;
     /**
-     * Any additional standard libpq connection parameters (e.g. sslmode,
-     * connect_timeout, application_name, sslcert, sslkey, sslrootcert,
-     * target_session_attrs, options). Keys must be valid libpq keywords.
+     * Any additional standard libpq connection parameters (e.g.
+     * connect_timeout, application_name, target_session_attrs, options).
+     * Keys must be valid libpq keywords.
      */
     options: Record<string, string>;
+    /**
+     * SSL/TLS mode: disable, require, verify-ca, verify-full.
+     * Defaults to disable when empty.
+     */
+    sslmode: string;
+    /**
+     * TLS material. All three are write-only: never returned by read methods.
+     * On update, an empty value keeps the currently stored file (send it again
+     * to replace it). They are stored as external segment files, not in the DSN.
+     */
+    caCert: string;
+    /** client certificate (sslcert) */
+    clientCert: string;
+    /** client private key (sslkey) */
+    clientKey: string;
 };
 /**
  * MysqlConnection holds MySQL connection parameters.
@@ -333,3 +363,15 @@ export type DeleteRequest = {
     code?: string;
 };
 export type DeleteResponse = {};
+export type CheckConnectionRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /** External segment code to check. */
+    code?: string;
+};
+export type CheckConnectionResponse = {
+    /** Whether the database connection succeeded (also stored on the segment). */
+    valid: boolean;
+    /** Connection error message when valid is false; empty otherwise. */
+    error: string;
+};