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

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",
@@ -31069,6 +31106,222 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplatesService": {
+        "type": "S",
+        "key": "smsProviderTemplates",
+        "methods": {}
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus": {
+        "type": "E",
+        "values": [
+            "SMS_PROVIDER_TEMPLATE_STATUS_DRAFT",
+            "SMS_PROVIDER_TEMPLATE_STATUS_REVIEW",
+            "SMS_PROVIDER_TEMPLATE_STATUS_PUBLISHED",
+            "SMS_PROVIDER_TEMPLATE_STATUS_DEPRECATED"
+        ]
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateSend": {
+        "type": "I",
+        "fields": {
+            "method": {
+                "type": "string"
+            },
+            "url": {
+                "type": "string"
+            },
+            "contentType": {
+                "type": "string"
+            },
+            "headers": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "query": {
+                "type": "string",
+                "mapKeyType": "string"
+            },
+            "bodyTemplate": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateResponse": {
+        "type": "I",
+        "fields": {
+            "messageIdPath": {
+                "type": "string"
+            },
+            "errorPath": {
+                "type": "string"
+            },
+            "successHttpStatus": {
+                "type": "number",
+                "array": true
+            },
+            "successPath": {
+                "type": "string"
+            },
+            "successEquals": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateDlr": {
+        "type": "I",
+        "fields": {
+            "format": {
+                "type": "string"
+            },
+            "correlation": {
+                "type": "string"
+            },
+            "messageIdPath": {
+                "type": "string"
+            },
+            "statusPath": {
+                "type": "string"
+            },
+            "statusMap": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatusCodes",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatusCodes": {
+        "type": "I",
+        "fields": {
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate": {
+        "type": "I",
+        "fields": {
+            "slug": {
+                "type": "string"
+            },
+            "version": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            },
+            "icon": {
+                "type": "string"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus"
+            },
+            "configSchema": {
+                "type": "string"
+            },
+            "send": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateSend"
+            },
+            "response": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateResponse"
+            },
+            "dlr": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateDlr"
+            },
+            "allowedHosts": {
+                "type": "string",
+                "array": true
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            },
+            "publishedAt": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SaveSmsProviderTemplateRequest": {
+        "type": "I",
+        "fields": {
+            "template": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
+            },
+            "dryRun": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SaveSmsProviderTemplateResponse": {
+        "type": "I",
+        "fields": {
+            "template": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.ListSmsProviderTemplatesRequest": {
+        "type": "I",
+        "fields": {
+            "slug": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.ListSmsProviderTemplatesResponse": {
+        "type": "I",
+        "fields": {
+            "templates": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.GetSmsProviderTemplateRequest": {
+        "type": "I",
+        "fields": {
+            "slug": {
+                "type": "string"
+            },
+            "version": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.GetSmsProviderTemplateResponse": {
+        "type": "I",
+        "fields": {
+            "template": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SetSmsProviderTemplateStatusRequest": {
+        "type": "I",
+        "fields": {
+            "slug": {
+                "type": "string"
+            },
+            "version": {
+                "type": "string"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.sms_provider_templates.SetSmsProviderTemplateStatusResponse": {
+        "type": "I",
+        "fields": {
+            "template": {
+                "type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.statistics_dashboards.StatisticsDashboardsService": {
         "type": "S",
         "key": "statisticsDashboards",

package/index.d.ts

@@ -60,6 +60,7 @@ import { SegmentStatisticsService as pushwoosh_rpc_v2_segment_statistics_Segment
 import { SegmentsService as pushwoosh_rpc_segments_v3_SegmentsService } from './pushwoosh_rpc_segments_v3';
 import { SendRateService as pushwoosh_rpc_v2_send_rate_SendRateService } from './send_rate';
 import { smsPresetsService as pushwoosh_rpc_v2_sms_presets_smsPresetsService } from './sms_presets';
+import { SmsProviderTemplatesService as pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService } from './sms_provider_templates';
 import { StatisticsDashboardsService as pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService } from './statistics_dashboards';
 import { StatisticsDashboardsWidgetsService as pushwoosh_rpc_v2_statistics_dashboards_widgets_StatisticsDashboardsWidgetsService } from './statistics_dashboards_widgets';
 import { SubscriptionPromptService as pushwoosh_rpc_v2_subscription_prompt_SubscriptionPromptService } from './subscription_prompt';
@@ -133,6 +134,7 @@ export type API = {
     segments: pushwoosh_rpc_segments_v3_SegmentsService;
     sendRate: pushwoosh_rpc_v2_send_rate_SendRateService;
     smsPresets: pushwoosh_rpc_v2_sms_presets_smsPresetsService;
+    smsProviderTemplates: pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService;
     statisticsDashboards: pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService;
     statisticsDashboardsWidgets: pushwoosh_rpc_v2_statistics_dashboards_widgets_StatisticsDashboardsWidgetsService;
     subscriptionPrompt: pushwoosh_rpc_v2_subscription_prompt_SubscriptionPromptService;

package/package.json

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

package/sms_provider_templates.d.ts

@@ -0,0 +1,90 @@
+/**
+ * SmsProviderTemplatesService owns the catalog of SMS gateways described declaratively. Publishing
+ * a template is how a new provider reaches every DC without a release of the sending services.
+ */
+export interface SmsProviderTemplatesService {
+}
+/** SmsProviderTemplateStatus is the publication state of one version. */
+export type SmsProviderTemplateStatus = 'SMS_PROVIDER_TEMPLATE_STATUS_DRAFT' | 'SMS_PROVIDER_TEMPLATE_STATUS_REVIEW' | 'SMS_PROVIDER_TEMPLATE_STATUS_PUBLISHED' | 'SMS_PROVIDER_TEMPLATE_STATUS_DEPRECATED';
+/**
+ * SmsProviderTemplateSend is the HTTP call the gateway expects. Values come from {{config:<field>}}
+ * of config_schema and from the per-message macros {{phone}}, {{text}}, {{sender}}, {{message_id}}.
+ */
+export type SmsProviderTemplateSend = {
+    method: string;
+    url: string;
+    contentType: string;
+    headers: Record<string, string>;
+    query: Record<string, string>;
+    bodyTemplate: string;
+};
+/**
+ * SmsProviderTemplateResponse maps the send reply: where the provider message id is, where its
+ * error wording is, and what counts as an accepted send.
+ */
+export type SmsProviderTemplateResponse = {
+    messageIdPath: string;
+    errorPath: string;
+    successHttpStatus: number[];
+    successPath: string;
+    successEquals: string[];
+};
+/**
+ * SmsProviderTemplateDlr describes the delivery report: its transport, where the id and the status
+ * live, whose id the gateway echoes, and which gateway statuses mean what.
+ */
+export type SmsProviderTemplateDlr = {
+    format: string;
+    correlation: string;
+    messageIdPath: string;
+    statusPath: string;
+    statusMap: Record<string, SmsProviderTemplateStatusCodes>;
+};
+export type SmsProviderTemplateStatusCodes = {
+    codes: string[];
+};
+export type SmsProviderTemplate = {
+    slug: string;
+    version: string;
+    title: string;
+    description: string;
+    icon: string;
+    status: SmsProviderTemplateStatus;
+    configSchema: string;
+    send: SmsProviderTemplateSend;
+    response: SmsProviderTemplateResponse;
+    dlr: SmsProviderTemplateDlr;
+    allowedHosts: string[];
+    created: Date;
+    updated: Date;
+    publishedAt: Date;
+};
+export type SaveSmsProviderTemplateRequest = {
+    template: SmsProviderTemplate;
+    /** dry_run reports what the linter found without writing anything. */
+    dryRun: boolean;
+};
+export type SaveSmsProviderTemplateResponse = {
+    template: SmsProviderTemplate;
+};
+export type ListSmsProviderTemplatesRequest = {
+    slug: string;
+};
+export type ListSmsProviderTemplatesResponse = {
+    templates: SmsProviderTemplate[];
+};
+export type GetSmsProviderTemplateRequest = {
+    slug: string;
+    version: string;
+};
+export type GetSmsProviderTemplateResponse = {
+    template: SmsProviderTemplate;
+};
+export type SetSmsProviderTemplateStatusRequest = {
+    slug: string;
+    version: string;
+    status: SmsProviderTemplateStatus;
+};
+export type SetSmsProviderTemplateStatusResponse = {
+    template: SmsProviderTemplate;
+};

package/sms_provider_templates.js

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