@pushwoosh/rpc-v2-http-api-data 0.1.999 → 0.1.1000

package/data.js

@@ -10160,6 +10160,312 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Create_FieldViolations": {
+        "type": "E",
+        "values": [
+            "CREATE_FV_UNSPECIFIED",
+            "CREATE_CONNECTION_REQUIRED",
+            "CREATE_HOST_EMPTY",
+            "CREATE_DATABASE_EMPTY",
+            "CREATE_USER_EMPTY",
+            "CREATE_QUERY_EMPTY",
+            "CREATE_HOST_NOT_ALLOWED"
+        ]
+    },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FieldViolations": {
+        "type": "E",
+        "values": [
+            "UPDATE_FV_UNSPECIFIED",
+            "UPDATE_CODE_EMPTY",
+            "UPDATE_HOST_EMPTY",
+            "UPDATE_DATABASE_EMPTY",
+            "UPDATE_USER_EMPTY",
+            "UPDATE_QUERY_EMPTY",
+            "UPDATE_HOST_NOT_ALLOWED"
+        ]
+    },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FailedPreconditions": {
+        "type": "E",
+        "values": [
+            "UPDATE_FP_UNSPECIFIED",
+            "UPDATE_SEGMENT_NOT_FOUND",
+            "UPDATE_KIND_MISMATCH"
+        ]
+    },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Delete_FailedPreconditions": {
+        "type": "E",
+        "values": [
+            "DELETE_FP_UNSPECIFIED",
+            "DELETE_SEGMENT_NOT_FOUND"
+        ]
+    },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService": {
+        "type": "S",
+        "key": "externalSegments",
+        "methods": {
+            "List": {
+                "request": "pushwoosh.rpc.external_segments.v3.ListRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.ListResponse",
+                "method": "get",
+                "path": "/api/external-segments",
+                "errors": {
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            },
+            "Get": {
+                "request": "pushwoosh.rpc.external_segments.v3.GetRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.GetResponse",
+                "method": "get",
+                "path": "/api/external-segments/{code}",
+                "errors": {
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            },
+            "Create": {
+                "request": "pushwoosh.rpc.external_segments.v3.CreateRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.CreateResponse",
+                "method": "post",
+                "path": "/api/external-segments",
+                "errors": {
+                    "fieldViolations": "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Create_FieldViolations",
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            },
+            "Update": {
+                "request": "pushwoosh.rpc.external_segments.v3.UpdateRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.UpdateResponse",
+                "method": "put",
+                "path": "/api/external-segments/{code}",
+                "errors": {
+                    "fieldViolations": "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FieldViolations",
+                    "failedPreconditions": "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Update_FailedPreconditions",
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            },
+            "Delete": {
+                "request": "pushwoosh.rpc.external_segments.v3.DeleteRequest",
+                "response": "pushwoosh.rpc.external_segments.v3.DeleteResponse",
+                "method": "delete",
+                "path": "/api/external-segments/{code}",
+                "errors": {
+                    "failedPreconditions": "pushwoosh.rpc.external_segments.v3.ExternalSegmentsService_Delete_FailedPreconditions",
+                    "commonFailedPreconditions": "pushwoosh.rpc.errors.v3.Common_FailedPreconditions"
+                }
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.PostgresConnection": {
+        "type": "I",
+        "fields": {
+            "host": {
+                "type": "string"
+            },
+            "port": {
+                "type": "number"
+            },
+            "user": {
+                "type": "string"
+            },
+            "password": {
+                "type": "string"
+            },
+            "database": {
+                "type": "string"
+            },
+            "options": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.MysqlConnection": {
+        "type": "I",
+        "fields": {
+            "host": {
+                "type": "string"
+            },
+            "port": {
+                "type": "number"
+            },
+            "user": {
+                "type": "string"
+            },
+            "password": {
+                "type": "string"
+            },
+            "database": {
+                "type": "string"
+            },
+            "params": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.ExternalSegment": {
+        "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"
+            },
+            "query": {
+                "type": "string"
+            },
+            "valid": {
+                "type": "boolean"
+            },
+            "lastRequestedAt": {
+                "type": "Date"
+            },
+            "lastError": {
+                "type": "string"
+            },
+            "generation": {
+                "type": "number"
+            },
+            "createdAt": {
+                "type": "Date"
+            }
+        },
+        "oneofs": {
+            "connection": {
+                "oneof": [
+                    "postgres",
+                    "mysql"
+                ]
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.ListRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.ListResponse": {
+        "type": "I",
+        "fields": {
+            "segments": {
+                "type": "pushwoosh.rpc.external_segments.v3.ExternalSegment",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.GetRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.GetResponse": {
+        "type": "I",
+        "fields": {
+            "segment": {
+                "type": "pushwoosh.rpc.external_segments.v3.ExternalSegment"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.CreateRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "postgres": {
+                "type": "pushwoosh.rpc.external_segments.v3.PostgresConnection"
+            },
+            "mysql": {
+                "type": "pushwoosh.rpc.external_segments.v3.MysqlConnection"
+            },
+            "query": {
+                "type": "string"
+            }
+        },
+        "oneofs": {
+            "connection": {
+                "oneof": [
+                    "postgres",
+                    "mysql"
+                ]
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.CreateResponse": {
+        "type": "I",
+        "fields": {
+            "segment": {
+                "type": "pushwoosh.rpc.external_segments.v3.ExternalSegment"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.UpdateRequest": {
+        "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"
+            },
+            "query": {
+                "type": "string",
+                "optional": true
+            }
+        },
+        "oneofs": {
+            "connection": {
+                "oneof": [
+                    "postgres",
+                    "mysql"
+                ]
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.UpdateResponse": {
+        "type": "I",
+        "fields": {
+            "segment": {
+                "type": "pushwoosh.rpc.external_segments.v3.ExternalSegment"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.DeleteRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc.external_segments.v3.DeleteResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc_v2.filters.FiltersService": {
         "type": "S",
         "key": "filters",

package/index.d.ts

@@ -27,6 +27,7 @@ import { EmailTemplatesService as pushwoosh_rpc_v2_accounts_EmailTemplatesServic
 import { EmailsConfigurationsService as pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService } from './emails_configurations';
 import { EventsService as pushwoosh_rpc_v2_events_EventsService } from './events';
 import { ExportStatisticsService as pushwoosh_rpc_v2_export_messages_ExportStatisticsService } from './export_messages';
+import { ExternalSegmentsService as pushwoosh_rpc_external_segments_v3_ExternalSegmentsService } from './pushwoosh_rpc_external_segments_v3';
 import { FiltersService as pushwoosh_rpc_v2_filters_FiltersService } from './filters';
 import { FrequencyCappingService as pushwoosh_rpc_v2_frequency_capping_FrequencyCappingService } from './frequency_capping';
 import { FrequencyCappingDisabledUsersService as pushwoosh_rpc_frequency_capping_disabled_users_v3_FrequencyCappingDisabledUsersService } from './pushwoosh_rpc_frequency_capping_disabled_users_v3';
@@ -92,6 +93,7 @@ export type API = {
     emailsConfigurations: pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService;
     events: pushwoosh_rpc_v2_events_EventsService;
     exportStatistics: pushwoosh_rpc_v2_export_messages_ExportStatisticsService;
+    externalSegments: pushwoosh_rpc_external_segments_v3_ExternalSegmentsService;
     filters: pushwoosh_rpc_v2_filters_FiltersService;
     frequencyCapping: pushwoosh_rpc_v2_frequency_capping_FrequencyCappingService;
     frequencyCappingDisabledUsers: pushwoosh_rpc_frequency_capping_disabled_users_v3_FrequencyCappingDisabledUsersService;

package/package.json

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

package/pushwoosh_rpc_external_segments_v3.d.ts

@@ -0,0 +1,302 @@
+import { RpcMethodV3 } from './commonTypes';
+import { Common_FailedPreconditions as pushwoosh_rpc_errors_v3_Common_FailedPreconditions } from './pushwoosh_rpc_errors_v3';
+export type ExternalSegmentsService_Create_FieldViolations = {
+    reason: 'CREATE_FV_UNSPECIFIED';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_CONNECTION_REQUIRED';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_HOST_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_DATABASE_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_USER_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_QUERY_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'CREATE_HOST_NOT_ALLOWED';
+    field: string;
+    description: string;
+};
+export type ExternalSegmentsService_Update_FieldViolations = {
+    reason: 'UPDATE_FV_UNSPECIFIED';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_CODE_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_HOST_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_DATABASE_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_USER_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_QUERY_EMPTY';
+    field: string;
+    description: string;
+} | {
+    reason: 'UPDATE_HOST_NOT_ALLOWED';
+    field: string;
+    description: string;
+};
+export type ExternalSegmentsService_Update_FailedPreconditions = {
+    type: 'UPDATE_FP_UNSPECIFIED';
+    description: string;
+} | {
+    type: 'UPDATE_SEGMENT_NOT_FOUND';
+    description: string;
+} | {
+    type: 'UPDATE_KIND_MISMATCH';
+    description: string;
+};
+export type ExternalSegmentsService_Delete_FailedPreconditions = {
+    type: 'DELETE_FP_UNSPECIFIED';
+    description: string;
+} | {
+    type: 'DELETE_SEGMENT_NOT_FOUND';
+    description: string;
+};
+export type ExternalSegmentsService_List = RpcMethodV3<ListRequest, ListResponse, {
+    error: unknown;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
+export type ExternalSegmentsService_Get = RpcMethodV3<GetRequest, GetResponse, {
+    error: unknown;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
+export type ExternalSegmentsService_Create = RpcMethodV3<CreateRequest, CreateResponse, {
+    error: unknown;
+    fieldViolations?: undefined;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    fieldViolations?: ExternalSegmentsService_Create_FieldViolations[];
+    failedPreconditions?: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
+export type ExternalSegmentsService_Update = RpcMethodV3<UpdateRequest, UpdateResponse, {
+    error: unknown;
+    fieldViolations?: undefined;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    fieldViolations?: ExternalSegmentsService_Update_FieldViolations[];
+    failedPreconditions?: ExternalSegmentsService_Update_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+}>;
+export type ExternalSegmentsService_Delete = RpcMethodV3<DeleteRequest, DeleteResponse, {
+    error: unknown;
+    failedPreconditions?: undefined;
+} | {
+    error?: undefined;
+    failedPreconditions?: ExternalSegmentsService_Delete_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.
+ *
+ * Unlike regular segments, an external segment is not built from filter conditions.
+ * It stores connection parameters and a query that must return a single "user_id"
+ * column. The query is executed and the result materialized by the storage service
+ * in background.
+ *
+ * The caller never deals with a raw connection string nor a database "kind": the
+ * database type is implied by which connection message is set, and the backend
+ * assembles the proper connection string from the structured parameters.
+ */
+export interface ExternalSegmentsService {
+    /** List external segments of the given application. */
+    List: ExternalSegmentsService_List;
+    /** Get a single external segment by code. */
+    Get: ExternalSegmentsService_Get;
+    /** Create a new external segment. */
+    Create: ExternalSegmentsService_Create;
+    /** Update an existing external segment. Only provided fields are changed. */
+    Update: ExternalSegmentsService_Update;
+    /** Delete an external segment. */
+    Delete: ExternalSegmentsService_Delete;
+}
+export type ExternalSegmentsService_Errors = {
+    List: {
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
+    Get: {
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
+    Create: {
+        fieldViolations: ExternalSegmentsService_Create_FieldViolations[];
+        failedPreconditions: pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
+    Update: {
+        fieldViolations: ExternalSegmentsService_Update_FieldViolations[];
+        failedPreconditions: ExternalSegmentsService_Update_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
+    Delete: {
+        failedPreconditions: ExternalSegmentsService_Delete_FailedPreconditions | pushwoosh_rpc_errors_v3_Common_FailedPreconditions;
+    };
+};
+/**
+ * PostgresConnection holds PostgreSQL connection parameters.
+ * The backend assembles them into a libpq connection string, e.g.
+ * postgresql://user:password@host:port/database?sslmode=disable
+ */
+export type PostgresConnection = {
+    /** Database server host. */
+    host: string;
+    /** Database server port. Defaults to 5432 if zero. */
+    port: number;
+    /** Database user. */
+    user: string;
+    /** Database password. Write-only: never returned by read methods. */
+    password: string;
+    /** 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.
+     */
+    options: Record<string, string>;
+};
+/**
+ * MysqlConnection holds MySQL connection parameters.
+ * The backend assembles them into a go-sql-driver DSN, e.g.
+ * user:password@tcp(host:port)/database?parseTime=true
+ */
+export type MysqlConnection = {
+    /** Database server host. */
+    host: string;
+    /** Database server port. Defaults to 3306 if zero. */
+    port: number;
+    /** Database user. */
+    user: string;
+    /** Database password. Write-only: never returned by read methods. */
+    password: string;
+    /** Database name. */
+    database: string;
+    /**
+     * Any additional standard DSN parameters (e.g. tls, charset, collation,
+     * parseTime, loc, timeout, readTimeout, writeTimeout).
+     */
+    params: Record<string, string>;
+};
+export type ExternalSegment_connection_postgres = {
+    type: 'postgres';
+    data: PostgresConnection;
+};
+export type ExternalSegment_connection_mysql = {
+    type: 'mysql';
+    data: MysqlConnection;
+};
+export type ExternalSegment_connection = ExternalSegment_connection_postgres | ExternalSegment_connection_mysql;
+/**
+ * ExternalSegment is the full representation returned by read methods.
+ * It exposes neither the raw connection string nor a database "kind" enum:
+ * the database type is conveyed by which connection message is set, and
+ * passwords are never returned.
+ */
+export type ExternalSegment = {
+    /** Owning application code. */
+    application: string;
+    /** Unique (within application) external segment code, generated on creation. */
+    code: string;
+    /** SQL query that returns a single "user_id" column. */
+    query: string;
+    /** Whether the segment configuration is considered valid and usable. */
+    valid: boolean;
+    /** Last time the segment was successfully refreshed. Unset if never refreshed. */
+    lastRequestedAt: Date;
+    /** Error message from the last failed refresh. Empty if the last refresh succeeded. */
+    lastError: string;
+    /** Materialized snapshot version, incremented on every successful refresh. */
+    generation: number;
+    /** Segment creation time. */
+    createdAt: Date;
+    connection: ExternalSegment_connection;
+};
+export type ListRequest = {
+    /** Application code to list external segments for. */
+    application?: string;
+};
+export type ListResponse = {
+    segments: ExternalSegment[];
+};
+export type GetRequest = {
+    /** Owning application code. */
+    application?: string;
+    /** External segment code. */
+    code?: string;
+};
+export type GetResponse = {
+    segment: ExternalSegment;
+};
+export type CreateRequest_connection_postgres = {
+    type: 'postgres';
+    data: PostgresConnection;
+};
+export type CreateRequest_connection_mysql = {
+    type: 'mysql';
+    data: MysqlConnection;
+};
+export type CreateRequest_connection = CreateRequest_connection_postgres | CreateRequest_connection_mysql;
+export type CreateRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /** SQL query that must return a single "user_id" column. */
+    query?: string;
+    connection: CreateRequest_connection;
+};
+export type CreateResponse = {
+    segment: ExternalSegment;
+};
+export type UpdateRequest_connection_postgres = {
+    type: 'postgres';
+    data: PostgresConnection;
+};
+export type UpdateRequest_connection_mysql = {
+    type: 'mysql';
+    data: MysqlConnection;
+};
+export type UpdateRequest_connection = UpdateRequest_connection_postgres | UpdateRequest_connection_mysql;
+export type UpdateRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /** External segment code to update. */
+    code?: string;
+    /** New SQL query. If set, replaces the current value. */
+    query?: string;
+    connection: UpdateRequest_connection;
+};
+export type UpdateResponse = {
+    segment: ExternalSegment;
+};
+export type DeleteRequest = {
+    /** Application code the segment belongs to. */
+    application?: string;
+    /** External segment code to delete. */
+    code?: string;
+};
+export type DeleteResponse = {};

package/pushwoosh_rpc_external_segments_v3.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};