@pushwoosh/rpc-v2-http-api-data 0.2.279 → 0.2.280

package/applications_configurations.d.ts

@@ -1,12 +1,15 @@
 import { RpcMethod } from './commonTypes';
 export type ApplicationsConfigurationsService_Configure = RpcMethod<ConfigurationRequest, ConfigurationResponse>;
 export type ApplicationsConfigurationsService_ListSmsProviders = RpcMethod<ListSmsProvidersRequest, ListSmsProvidersResponse>;
+export type ApplicationsConfigurationsService_SendTestSms = RpcMethod<SendTestSmsRequest, SendTestSmsResponse>;
 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;
+    /** Sends one test SMS from an application (code XXXXX-XXXXX) through the provider it is configured with, and reports what the gateway answered — the status code and, on refusal, the provider's own wording. Use after saving an SMS configuration to check the credentials before a campaign does. */
+    SendTestSms: ApplicationsConfigurationsService_SendTestSms;
     /** 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;
 }
@@ -395,3 +398,15 @@ export type SmsProvider = {
     icon: string;
     description: string;
 };
+export type SendTestSmsRequest = {
+    code?: string;
+    phone?: string;
+    text?: string;
+};
+export type SendTestSmsResponse = {
+    accepted: boolean;
+    statusCode: number;
+    status: string;
+    /** error carries the gateway's own wording when it refused the send. */
+    error: string;
+};

package/data.js

@@ -5989,6 +5989,12 @@ export const data = {
                 "method": "get",
                 "path": "/api/applications_configurations:sms_providers"
             },
+            "SendTestSms": {
+                "request": "pushwoosh.rpc_v2.applications_configurations.SendTestSmsRequest",
+                "response": "pushwoosh.rpc_v2.applications_configurations.SendTestSmsResponse",
+                "method": "post",
+                "path": "/api/applications_configurations:test_sms/{code}"
+            },
             "EnablePlatform": {
                 "request": "pushwoosh.rpc_v2.applications_configurations.EnablePlatformRequest",
                 "response": "pushwoosh.rpc_v2.applications_configurations.EnablePlatformResponse",
@@ -6716,6 +6722,37 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.applications_configurations.SendTestSmsRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "phone": {
+                "type": "string"
+            },
+            "text": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications_configurations.SendTestSmsResponse": {
+        "type": "I",
+        "fields": {
+            "accepted": {
+                "type": "boolean"
+            },
+            "statusCode": {
+                "type": "number"
+            },
+            "status": {
+                "type": "string"
+            },
+            "error": {
+                "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.279",
+  "version": "0.2.280",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",