@pushwoosh/rpc-v2-http-api-data 0.2.277 → 0.2.278

package/applications_configurations.d.ts

@@ -1,9 +1,12 @@
 import { RpcMethod } from './commonTypes';
 export type ApplicationsConfigurationsService_Configure = RpcMethod<ConfigurationRequest, ConfigurationResponse>;
+export type ApplicationsConfigurationsService_ListSmsProviders = RpcMethod<ListSmsProvidersRequest, ListSmsProvidersResponse>;
 export type ApplicationsConfigurationsService_EnablePlatform = RpcMethod<EnablePlatformRequest, EnablePlatformResponse>;
 export interface ApplicationsConfigurationsService {
     /** Saves the provider credentials for one delivery platform or channel of an application (code XXXXX-XXXXX) — APNs/FCM push keys, an SMS provider, email sender, Telegram/Viber token, Google Wallet, etc. — then enables that platform. Pick the matching kind in the oneof; some providers (Telegram, Huawei) also call the external provider API to register a webhook or validate the token. */
     Configure: ApplicationsConfigurationsService_Configure;
+    /** Lists the SMS providers an application can be configured with: the built-in ones and every published provider template from the catalog. A template carries a JSON Schema of the credential form to render, so a provider added to the catalog shows up here without a release. */
+    ListSmsProviders: ApplicationsConfigurationsService_ListSmsProviders;
     /** Enables or disables a single delivery platform (by numeric platform id) for an application (code XXXXX-XXXXX) without touching its stored credentials. Use to toggle a channel on or off; update_platform_configuration already enables a platform after saving its credentials. */
     EnablePlatform: ApplicationsConfigurationsService_EnablePlatform;
 }
@@ -172,7 +175,11 @@ export type SmsConfiguration_provider_smsapiro = {
     type: 'smsapiro';
     data: SmsApiRoConfiguration;
 };
-export type SmsConfiguration_provider = SmsConfiguration_provider_twilio | SmsConfiguration_provider_amazon | SmsConfiguration_provider_smsGlobal | SmsConfiguration_provider_smsala | SmsConfiguration_provider_capitolemobile | SmsConfiguration_provider_mobipace | SmsConfiguration_provider_smscenter | SmsConfiguration_provider_smstraffic | SmsConfiguration_provider_textmecoil | SmsConfiguration_provider_ablemobile | SmsConfiguration_provider_mstat | SmsConfiguration_provider_smsapiro;
+export type SmsConfiguration_provider_template = {
+    type: 'template';
+    data: SmsTemplateConfiguration;
+};
+export type SmsConfiguration_provider = SmsConfiguration_provider_twilio | SmsConfiguration_provider_amazon | SmsConfiguration_provider_smsGlobal | SmsConfiguration_provider_smsala | SmsConfiguration_provider_capitolemobile | SmsConfiguration_provider_mobipace | SmsConfiguration_provider_smscenter | SmsConfiguration_provider_smstraffic | SmsConfiguration_provider_textmecoil | SmsConfiguration_provider_ablemobile | SmsConfiguration_provider_mstat | SmsConfiguration_provider_smsapiro | SmsConfiguration_provider_template;
 /**
  * SmsConfiguration carries per-application SMS provider credentials. Exactly
  * one provider must be set; the chosen oneof field selects which gateway
@@ -183,6 +190,14 @@ export type SmsConfiguration_provider = SmsConfiguration_provider_twilio | SmsCo
 export type SmsConfiguration = {
     provider: SmsConfiguration_provider;
 };
+/**
+ * SmsTemplateConfiguration points an application at a published provider template and carries the
+ * values of its config_schema. A "format": "password" field left empty keeps the stored credential.
+ */
+export type SmsTemplateConfiguration = {
+    slug: string;
+    config: Record<string, string>;
+};
 export type SmsTwilioConfiguration = {
     twilioSmsFromNumber: string;
     twilioSid: string;
@@ -363,3 +378,20 @@ export type EnablePlatformRequest = {
     enable?: boolean;
 };
 export type EnablePlatformResponse = {};
+export type ListSmsProvidersRequest = {};
+export type ListSmsProvidersResponse = {
+    providers: SmsProvider[];
+};
+/**
+ * SmsProvider is one entry of the provider picker. A built-in provider is identified by its value
+ * alone; a template also carries the schema of the form to render and the version in use.
+ */
+export type SmsProvider = {
+    value: string;
+    title: string;
+    isTemplate: boolean;
+    version: string;
+    configSchema: string;
+    icon: string;
+    description: string;
+};

package/data.js

@@ -5980,6 +5980,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/applications_configurations/{code}"
             },
+            "ListSmsProviders": {
+                "request": "pushwoosh.rpc_v2.applications_configurations.ListSmsProvidersRequest",
+                "response": "pushwoosh.rpc_v2.applications_configurations.ListSmsProvidersResponse",
+                "method": "get",
+                "path": "/api/applications_configurations:sms_providers"
+            },
             "EnablePlatform": {
                 "request": "pushwoosh.rpc_v2.applications_configurations.EnablePlatformRequest",
                 "response": "pushwoosh.rpc_v2.applications_configurations.EnablePlatformResponse",
@@ -6326,6 +6332,9 @@ export const data = {
             },
             "smsapiro": {
                 "type": "pushwoosh.rpc_v2.applications_configurations.SmsApiRoConfiguration"
+            },
+            "template": {
+                "type": "pushwoosh.rpc_v2.applications_configurations.SmsTemplateConfiguration"
             }
         },
         "oneofs": {
@@ -6342,11 +6351,24 @@ export const data = {
                     "textmecoil",
                     "ablemobile",
                     "mstat",
-                    "smsapiro"
+                    "smsapiro",
+                    "template"
                 ]
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_configurations.SmsTemplateConfiguration": {
+        "type": "I",
+        "fields": {
+            "slug": {
+                "type": "string"
+            },
+            "config": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications_configurations.SmsTwilioConfiguration": {
         "type": "I",
         "fields": {
@@ -6652,6 +6674,45 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.applications_configurations.ListSmsProvidersRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.applications_configurations.ListSmsProvidersResponse": {
+        "type": "I",
+        "fields": {
+            "providers": {
+                "type": "pushwoosh.rpc_v2.applications_configurations.SmsProvider",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_configurations.SmsProvider": {
+        "type": "I",
+        "fields": {
+            "value": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "isTemplate": {
+                "type": "boolean"
+            },
+            "version": {
+                "type": "string"
+            },
+            "configSchema": {
+                "type": "string"
+            },
+            "icon": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications_controlgroup.ApplicationsControlGroupService": {
         "type": "S",
         "key": "applicationsControlGroup",

package/package.json

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