@pushwoosh/rpc-v2-http-api-data 0.2.280 → 0.2.282
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data.js +281 -0
- package/index.d.ts +2 -0
- package/integrations.d.ts +28 -0
- package/package.json +1 -1
- package/sms_provider_templates.d.ts +90 -0
- package/sms_provider_templates.js +3 -0
package/data.js
CHANGED
|
@@ -18482,6 +18482,18 @@ export const data = {
|
|
|
18482
18482
|
"method": "post",
|
|
18483
18483
|
"path": "/api/integrations/google-ads/ad-accounts/disconnect"
|
|
18484
18484
|
},
|
|
18485
|
+
"ListGoogleAdsAudiences": {
|
|
18486
|
+
"request": "pushwoosh.rpc_v2.integrations.ListGoogleAdsAudiencesRequest",
|
|
18487
|
+
"response": "pushwoosh.rpc_v2.integrations.ListGoogleAdsAudiencesResponse",
|
|
18488
|
+
"method": "get",
|
|
18489
|
+
"path": "/api/integrations/google-ads/ad-accounts/{ad_account_id}/audiences"
|
|
18490
|
+
},
|
|
18491
|
+
"CreateGoogleAdsAudience": {
|
|
18492
|
+
"request": "pushwoosh.rpc_v2.integrations.CreateGoogleAdsAudienceRequest",
|
|
18493
|
+
"response": "pushwoosh.rpc_v2.integrations.CreateGoogleAdsAudienceResponse",
|
|
18494
|
+
"method": "post",
|
|
18495
|
+
"path": "/api/integrations/google-ads/ad-accounts/{ad_account_id}/audiences"
|
|
18496
|
+
},
|
|
18485
18497
|
"SetMetaTagMapping": {
|
|
18486
18498
|
"request": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingRequest",
|
|
18487
18499
|
"response": "pushwoosh.rpc_v2.integrations.SetMetaTagMappingResponse",
|
|
@@ -19578,6 +19590,59 @@ export const data = {
|
|
|
19578
19590
|
}
|
|
19579
19591
|
}
|
|
19580
19592
|
},
|
|
19593
|
+
"pushwoosh.rpc_v2.integrations.GoogleAdsAudience": {
|
|
19594
|
+
"type": "I",
|
|
19595
|
+
"fields": {
|
|
19596
|
+
"id": {
|
|
19597
|
+
"type": "string"
|
|
19598
|
+
},
|
|
19599
|
+
"name": {
|
|
19600
|
+
"type": "string"
|
|
19601
|
+
},
|
|
19602
|
+
"approximateCount": {
|
|
19603
|
+
"type": "number"
|
|
19604
|
+
}
|
|
19605
|
+
}
|
|
19606
|
+
},
|
|
19607
|
+
"pushwoosh.rpc_v2.integrations.ListGoogleAdsAudiencesRequest": {
|
|
19608
|
+
"type": "I",
|
|
19609
|
+
"fields": {
|
|
19610
|
+
"adAccountId": {
|
|
19611
|
+
"type": "string"
|
|
19612
|
+
}
|
|
19613
|
+
}
|
|
19614
|
+
},
|
|
19615
|
+
"pushwoosh.rpc_v2.integrations.ListGoogleAdsAudiencesResponse": {
|
|
19616
|
+
"type": "I",
|
|
19617
|
+
"fields": {
|
|
19618
|
+
"audiences": {
|
|
19619
|
+
"type": "pushwoosh.rpc_v2.integrations.GoogleAdsAudience",
|
|
19620
|
+
"array": true
|
|
19621
|
+
}
|
|
19622
|
+
}
|
|
19623
|
+
},
|
|
19624
|
+
"pushwoosh.rpc_v2.integrations.CreateGoogleAdsAudienceRequest": {
|
|
19625
|
+
"type": "I",
|
|
19626
|
+
"fields": {
|
|
19627
|
+
"adAccountId": {
|
|
19628
|
+
"type": "string"
|
|
19629
|
+
},
|
|
19630
|
+
"name": {
|
|
19631
|
+
"type": "string"
|
|
19632
|
+
},
|
|
19633
|
+
"description": {
|
|
19634
|
+
"type": "string"
|
|
19635
|
+
}
|
|
19636
|
+
}
|
|
19637
|
+
},
|
|
19638
|
+
"pushwoosh.rpc_v2.integrations.CreateGoogleAdsAudienceResponse": {
|
|
19639
|
+
"type": "I",
|
|
19640
|
+
"fields": {
|
|
19641
|
+
"audience": {
|
|
19642
|
+
"type": "pushwoosh.rpc_v2.integrations.GoogleAdsAudience"
|
|
19643
|
+
}
|
|
19644
|
+
}
|
|
19645
|
+
},
|
|
19581
19646
|
"pushwoosh.rpc_v2.integrations.DisconnectGoogleAdsAdAccountsResponse": {
|
|
19582
19647
|
"type": "I",
|
|
19583
19648
|
"fields": {
|
|
@@ -31106,6 +31171,222 @@ export const data = {
|
|
|
31106
31171
|
"type": "I",
|
|
31107
31172
|
"fields": {}
|
|
31108
31173
|
},
|
|
31174
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplatesService": {
|
|
31175
|
+
"type": "S",
|
|
31176
|
+
"key": "smsProviderTemplates",
|
|
31177
|
+
"methods": {}
|
|
31178
|
+
},
|
|
31179
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus": {
|
|
31180
|
+
"type": "E",
|
|
31181
|
+
"values": [
|
|
31182
|
+
"SMS_PROVIDER_TEMPLATE_STATUS_DRAFT",
|
|
31183
|
+
"SMS_PROVIDER_TEMPLATE_STATUS_REVIEW",
|
|
31184
|
+
"SMS_PROVIDER_TEMPLATE_STATUS_PUBLISHED",
|
|
31185
|
+
"SMS_PROVIDER_TEMPLATE_STATUS_DEPRECATED"
|
|
31186
|
+
]
|
|
31187
|
+
},
|
|
31188
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateSend": {
|
|
31189
|
+
"type": "I",
|
|
31190
|
+
"fields": {
|
|
31191
|
+
"method": {
|
|
31192
|
+
"type": "string"
|
|
31193
|
+
},
|
|
31194
|
+
"url": {
|
|
31195
|
+
"type": "string"
|
|
31196
|
+
},
|
|
31197
|
+
"contentType": {
|
|
31198
|
+
"type": "string"
|
|
31199
|
+
},
|
|
31200
|
+
"headers": {
|
|
31201
|
+
"type": "string",
|
|
31202
|
+
"mapKeyType": "string"
|
|
31203
|
+
},
|
|
31204
|
+
"query": {
|
|
31205
|
+
"type": "string",
|
|
31206
|
+
"mapKeyType": "string"
|
|
31207
|
+
},
|
|
31208
|
+
"bodyTemplate": {
|
|
31209
|
+
"type": "string"
|
|
31210
|
+
}
|
|
31211
|
+
}
|
|
31212
|
+
},
|
|
31213
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateResponse": {
|
|
31214
|
+
"type": "I",
|
|
31215
|
+
"fields": {
|
|
31216
|
+
"messageIdPath": {
|
|
31217
|
+
"type": "string"
|
|
31218
|
+
},
|
|
31219
|
+
"errorPath": {
|
|
31220
|
+
"type": "string"
|
|
31221
|
+
},
|
|
31222
|
+
"successHttpStatus": {
|
|
31223
|
+
"type": "number",
|
|
31224
|
+
"array": true
|
|
31225
|
+
},
|
|
31226
|
+
"successPath": {
|
|
31227
|
+
"type": "string"
|
|
31228
|
+
},
|
|
31229
|
+
"successEquals": {
|
|
31230
|
+
"type": "string",
|
|
31231
|
+
"array": true
|
|
31232
|
+
}
|
|
31233
|
+
}
|
|
31234
|
+
},
|
|
31235
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateDlr": {
|
|
31236
|
+
"type": "I",
|
|
31237
|
+
"fields": {
|
|
31238
|
+
"format": {
|
|
31239
|
+
"type": "string"
|
|
31240
|
+
},
|
|
31241
|
+
"correlation": {
|
|
31242
|
+
"type": "string"
|
|
31243
|
+
},
|
|
31244
|
+
"messageIdPath": {
|
|
31245
|
+
"type": "string"
|
|
31246
|
+
},
|
|
31247
|
+
"statusPath": {
|
|
31248
|
+
"type": "string"
|
|
31249
|
+
},
|
|
31250
|
+
"statusMap": {
|
|
31251
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatusCodes",
|
|
31252
|
+
"mapKeyType": "string"
|
|
31253
|
+
}
|
|
31254
|
+
}
|
|
31255
|
+
},
|
|
31256
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatusCodes": {
|
|
31257
|
+
"type": "I",
|
|
31258
|
+
"fields": {
|
|
31259
|
+
"codes": {
|
|
31260
|
+
"type": "string",
|
|
31261
|
+
"array": true
|
|
31262
|
+
}
|
|
31263
|
+
}
|
|
31264
|
+
},
|
|
31265
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate": {
|
|
31266
|
+
"type": "I",
|
|
31267
|
+
"fields": {
|
|
31268
|
+
"slug": {
|
|
31269
|
+
"type": "string"
|
|
31270
|
+
},
|
|
31271
|
+
"version": {
|
|
31272
|
+
"type": "string"
|
|
31273
|
+
},
|
|
31274
|
+
"title": {
|
|
31275
|
+
"type": "string"
|
|
31276
|
+
},
|
|
31277
|
+
"description": {
|
|
31278
|
+
"type": "string"
|
|
31279
|
+
},
|
|
31280
|
+
"icon": {
|
|
31281
|
+
"type": "string"
|
|
31282
|
+
},
|
|
31283
|
+
"status": {
|
|
31284
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus"
|
|
31285
|
+
},
|
|
31286
|
+
"configSchema": {
|
|
31287
|
+
"type": "string"
|
|
31288
|
+
},
|
|
31289
|
+
"send": {
|
|
31290
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateSend"
|
|
31291
|
+
},
|
|
31292
|
+
"response": {
|
|
31293
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateResponse"
|
|
31294
|
+
},
|
|
31295
|
+
"dlr": {
|
|
31296
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateDlr"
|
|
31297
|
+
},
|
|
31298
|
+
"allowedHosts": {
|
|
31299
|
+
"type": "string",
|
|
31300
|
+
"array": true
|
|
31301
|
+
},
|
|
31302
|
+
"created": {
|
|
31303
|
+
"type": "Date"
|
|
31304
|
+
},
|
|
31305
|
+
"updated": {
|
|
31306
|
+
"type": "Date"
|
|
31307
|
+
},
|
|
31308
|
+
"publishedAt": {
|
|
31309
|
+
"type": "Date"
|
|
31310
|
+
}
|
|
31311
|
+
}
|
|
31312
|
+
},
|
|
31313
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SaveSmsProviderTemplateRequest": {
|
|
31314
|
+
"type": "I",
|
|
31315
|
+
"fields": {
|
|
31316
|
+
"template": {
|
|
31317
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
|
|
31318
|
+
},
|
|
31319
|
+
"dryRun": {
|
|
31320
|
+
"type": "boolean"
|
|
31321
|
+
}
|
|
31322
|
+
}
|
|
31323
|
+
},
|
|
31324
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SaveSmsProviderTemplateResponse": {
|
|
31325
|
+
"type": "I",
|
|
31326
|
+
"fields": {
|
|
31327
|
+
"template": {
|
|
31328
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
|
|
31329
|
+
}
|
|
31330
|
+
}
|
|
31331
|
+
},
|
|
31332
|
+
"pushwoosh.rpc_v2.sms_provider_templates.ListSmsProviderTemplatesRequest": {
|
|
31333
|
+
"type": "I",
|
|
31334
|
+
"fields": {
|
|
31335
|
+
"slug": {
|
|
31336
|
+
"type": "string"
|
|
31337
|
+
}
|
|
31338
|
+
}
|
|
31339
|
+
},
|
|
31340
|
+
"pushwoosh.rpc_v2.sms_provider_templates.ListSmsProviderTemplatesResponse": {
|
|
31341
|
+
"type": "I",
|
|
31342
|
+
"fields": {
|
|
31343
|
+
"templates": {
|
|
31344
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate",
|
|
31345
|
+
"array": true
|
|
31346
|
+
}
|
|
31347
|
+
}
|
|
31348
|
+
},
|
|
31349
|
+
"pushwoosh.rpc_v2.sms_provider_templates.GetSmsProviderTemplateRequest": {
|
|
31350
|
+
"type": "I",
|
|
31351
|
+
"fields": {
|
|
31352
|
+
"slug": {
|
|
31353
|
+
"type": "string"
|
|
31354
|
+
},
|
|
31355
|
+
"version": {
|
|
31356
|
+
"type": "string"
|
|
31357
|
+
}
|
|
31358
|
+
}
|
|
31359
|
+
},
|
|
31360
|
+
"pushwoosh.rpc_v2.sms_provider_templates.GetSmsProviderTemplateResponse": {
|
|
31361
|
+
"type": "I",
|
|
31362
|
+
"fields": {
|
|
31363
|
+
"template": {
|
|
31364
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
|
|
31365
|
+
}
|
|
31366
|
+
}
|
|
31367
|
+
},
|
|
31368
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SetSmsProviderTemplateStatusRequest": {
|
|
31369
|
+
"type": "I",
|
|
31370
|
+
"fields": {
|
|
31371
|
+
"slug": {
|
|
31372
|
+
"type": "string"
|
|
31373
|
+
},
|
|
31374
|
+
"version": {
|
|
31375
|
+
"type": "string"
|
|
31376
|
+
},
|
|
31377
|
+
"status": {
|
|
31378
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplateStatus"
|
|
31379
|
+
}
|
|
31380
|
+
}
|
|
31381
|
+
},
|
|
31382
|
+
"pushwoosh.rpc_v2.sms_provider_templates.SetSmsProviderTemplateStatusResponse": {
|
|
31383
|
+
"type": "I",
|
|
31384
|
+
"fields": {
|
|
31385
|
+
"template": {
|
|
31386
|
+
"type": "pushwoosh.rpc_v2.sms_provider_templates.SmsProviderTemplate"
|
|
31387
|
+
}
|
|
31388
|
+
}
|
|
31389
|
+
},
|
|
31109
31390
|
"pushwoosh.rpc_v2.statistics_dashboards.StatisticsDashboardsService": {
|
|
31110
31391
|
"type": "S",
|
|
31111
31392
|
"key": "statisticsDashboards",
|
package/index.d.ts
CHANGED
|
@@ -60,6 +60,7 @@ import { SegmentStatisticsService as pushwoosh_rpc_v2_segment_statistics_Segment
|
|
|
60
60
|
import { SegmentsService as pushwoosh_rpc_segments_v3_SegmentsService } from './pushwoosh_rpc_segments_v3';
|
|
61
61
|
import { SendRateService as pushwoosh_rpc_v2_send_rate_SendRateService } from './send_rate';
|
|
62
62
|
import { smsPresetsService as pushwoosh_rpc_v2_sms_presets_smsPresetsService } from './sms_presets';
|
|
63
|
+
import { SmsProviderTemplatesService as pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService } from './sms_provider_templates';
|
|
63
64
|
import { StatisticsDashboardsService as pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService } from './statistics_dashboards';
|
|
64
65
|
import { StatisticsDashboardsWidgetsService as pushwoosh_rpc_v2_statistics_dashboards_widgets_StatisticsDashboardsWidgetsService } from './statistics_dashboards_widgets';
|
|
65
66
|
import { SubscriptionPromptService as pushwoosh_rpc_v2_subscription_prompt_SubscriptionPromptService } from './subscription_prompt';
|
|
@@ -133,6 +134,7 @@ export type API = {
|
|
|
133
134
|
segments: pushwoosh_rpc_segments_v3_SegmentsService;
|
|
134
135
|
sendRate: pushwoosh_rpc_v2_send_rate_SendRateService;
|
|
135
136
|
smsPresets: pushwoosh_rpc_v2_sms_presets_smsPresetsService;
|
|
137
|
+
smsProviderTemplates: pushwoosh_rpc_v2_sms_provider_templates_SmsProviderTemplatesService;
|
|
136
138
|
statisticsDashboards: pushwoosh_rpc_v2_statistics_dashboards_StatisticsDashboardsService;
|
|
137
139
|
statisticsDashboardsWidgets: pushwoosh_rpc_v2_statistics_dashboards_widgets_StatisticsDashboardsWidgetsService;
|
|
138
140
|
subscriptionPrompt: pushwoosh_rpc_v2_subscription_prompt_SubscriptionPromptService;
|
package/integrations.d.ts
CHANGED
|
@@ -34,6 +34,8 @@ export type IntegrationsService_DeleteGoogleAdsConfiguration = RpcMethod<DeleteG
|
|
|
34
34
|
export type IntegrationsService_ListGoogleAdsAdAccounts = RpcMethod<ListGoogleAdsAdAccountsRequest, ListGoogleAdsAdAccountsResponse>;
|
|
35
35
|
export type IntegrationsService_ConnectGoogleAdsAdAccounts = RpcMethod<ConnectGoogleAdsAdAccountsRequest, ConnectGoogleAdsAdAccountsResponse>;
|
|
36
36
|
export type IntegrationsService_DisconnectGoogleAdsAdAccounts = RpcMethod<DisconnectGoogleAdsAdAccountsRequest, DisconnectGoogleAdsAdAccountsResponse>;
|
|
37
|
+
export type IntegrationsService_ListGoogleAdsAudiences = RpcMethod<ListGoogleAdsAudiencesRequest, ListGoogleAdsAudiencesResponse>;
|
|
38
|
+
export type IntegrationsService_CreateGoogleAdsAudience = RpcMethod<CreateGoogleAdsAudienceRequest, CreateGoogleAdsAudienceResponse>;
|
|
37
39
|
export type IntegrationsService_SetMetaTagMapping = RpcMethod<SetMetaTagMappingRequest, SetMetaTagMappingResponse>;
|
|
38
40
|
export type IntegrationsService_GetGoogleBQConfiguration = RpcMethod<GetGoogleBQConfigurationRequest, GetGoogleBQConfigurationResponse>;
|
|
39
41
|
export type IntegrationsService_CreateGoogleBQConfiguration = RpcMethod<CreateGoogleBQConfigurationRequest, CreateGoogleBQConfigurationResponse>;
|
|
@@ -142,6 +144,10 @@ export interface IntegrationsService {
|
|
|
142
144
|
ConnectGoogleAdsAdAccounts: IntegrationsService_ConnectGoogleAdsAdAccounts;
|
|
143
145
|
/** Disconnects the given Google Ads customers by id while keeping the OAuth grant. Use to remove specific ad accounts; to drop the whole connection use delete_google_ads_integration. */
|
|
144
146
|
DisconnectGoogleAdsAdAccounts: IntegrationsService_DisconnectGoogleAdsAdAccounts;
|
|
147
|
+
/** Lists the CRM-based user lists of a connected Google Ads ad account. Use to pick an audience for a journey audience sync point, or to see what create_google_ads_audience produced. */
|
|
148
|
+
ListGoogleAdsAudiences: IntegrationsService_ListGoogleAdsAudiences;
|
|
149
|
+
/** Creates a CRM-based user list on a connected Google Ads ad account. Use before syncing users: a Customer Match upload targets a list that already exists. */
|
|
150
|
+
CreateGoogleAdsAudience: IntegrationsService_CreateGoogleAdsAudience;
|
|
145
151
|
/** Overwrites the mapping between Pushwoosh tags and Meta custom-audience fields for the current account. Use to define which PW tags sync to Meta audiences; replaces the entire mapping. */
|
|
146
152
|
SetMetaTagMapping: IntegrationsService_SetMetaTagMapping;
|
|
147
153
|
/**
|
|
@@ -600,6 +606,28 @@ export type ConnectGoogleAdsAdAccountsResponse = {
|
|
|
600
606
|
export type DisconnectGoogleAdsAdAccountsRequest = {
|
|
601
607
|
adAccountIds?: string[];
|
|
602
608
|
};
|
|
609
|
+
/** GoogleAdsAudience is a CRM-based user list on an ad account. */
|
|
610
|
+
export type GoogleAdsAudience = {
|
|
611
|
+
id: string;
|
|
612
|
+
name: string;
|
|
613
|
+
/** Google's own estimate of matched members, 0 until matching runs */
|
|
614
|
+
approximateCount: number;
|
|
615
|
+
};
|
|
616
|
+
export type ListGoogleAdsAudiencesRequest = {
|
|
617
|
+
adAccountId?: string;
|
|
618
|
+
};
|
|
619
|
+
export type ListGoogleAdsAudiencesResponse = {
|
|
620
|
+
audiences: GoogleAdsAudience[];
|
|
621
|
+
};
|
|
622
|
+
export type CreateGoogleAdsAudienceRequest = {
|
|
623
|
+
adAccountId?: string;
|
|
624
|
+
name?: string;
|
|
625
|
+
/** optional, the integration fills its own default when empty */
|
|
626
|
+
description?: string;
|
|
627
|
+
};
|
|
628
|
+
export type CreateGoogleAdsAudienceResponse = {
|
|
629
|
+
audience: GoogleAdsAudience;
|
|
630
|
+
};
|
|
603
631
|
export type DisconnectGoogleAdsAdAccountsResponse = {
|
|
604
632
|
adAccounts: GoogleAdsAdAccount[];
|
|
605
633
|
};
|
package/package.json
CHANGED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SmsProviderTemplatesService owns the catalog of SMS gateways described declaratively. Publishing
|
|
3
|
+
* a template is how a new provider reaches every DC without a release of the sending services.
|
|
4
|
+
*/
|
|
5
|
+
export interface SmsProviderTemplatesService {
|
|
6
|
+
}
|
|
7
|
+
/** SmsProviderTemplateStatus is the publication state of one version. */
|
|
8
|
+
export type SmsProviderTemplateStatus = 'SMS_PROVIDER_TEMPLATE_STATUS_DRAFT' | 'SMS_PROVIDER_TEMPLATE_STATUS_REVIEW' | 'SMS_PROVIDER_TEMPLATE_STATUS_PUBLISHED' | 'SMS_PROVIDER_TEMPLATE_STATUS_DEPRECATED';
|
|
9
|
+
/**
|
|
10
|
+
* SmsProviderTemplateSend is the HTTP call the gateway expects. Values come from {{config:<field>}}
|
|
11
|
+
* of config_schema and from the per-message macros {{phone}}, {{text}}, {{sender}}, {{message_id}}.
|
|
12
|
+
*/
|
|
13
|
+
export type SmsProviderTemplateSend = {
|
|
14
|
+
method: string;
|
|
15
|
+
url: string;
|
|
16
|
+
contentType: string;
|
|
17
|
+
headers: Record<string, string>;
|
|
18
|
+
query: Record<string, string>;
|
|
19
|
+
bodyTemplate: string;
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* SmsProviderTemplateResponse maps the send reply: where the provider message id is, where its
|
|
23
|
+
* error wording is, and what counts as an accepted send.
|
|
24
|
+
*/
|
|
25
|
+
export type SmsProviderTemplateResponse = {
|
|
26
|
+
messageIdPath: string;
|
|
27
|
+
errorPath: string;
|
|
28
|
+
successHttpStatus: number[];
|
|
29
|
+
successPath: string;
|
|
30
|
+
successEquals: string[];
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* SmsProviderTemplateDlr describes the delivery report: its transport, where the id and the status
|
|
34
|
+
* live, whose id the gateway echoes, and which gateway statuses mean what.
|
|
35
|
+
*/
|
|
36
|
+
export type SmsProviderTemplateDlr = {
|
|
37
|
+
format: string;
|
|
38
|
+
correlation: string;
|
|
39
|
+
messageIdPath: string;
|
|
40
|
+
statusPath: string;
|
|
41
|
+
statusMap: Record<string, SmsProviderTemplateStatusCodes>;
|
|
42
|
+
};
|
|
43
|
+
export type SmsProviderTemplateStatusCodes = {
|
|
44
|
+
codes: string[];
|
|
45
|
+
};
|
|
46
|
+
export type SmsProviderTemplate = {
|
|
47
|
+
slug: string;
|
|
48
|
+
version: string;
|
|
49
|
+
title: string;
|
|
50
|
+
description: string;
|
|
51
|
+
icon: string;
|
|
52
|
+
status: SmsProviderTemplateStatus;
|
|
53
|
+
configSchema: string;
|
|
54
|
+
send: SmsProviderTemplateSend;
|
|
55
|
+
response: SmsProviderTemplateResponse;
|
|
56
|
+
dlr: SmsProviderTemplateDlr;
|
|
57
|
+
allowedHosts: string[];
|
|
58
|
+
created: Date;
|
|
59
|
+
updated: Date;
|
|
60
|
+
publishedAt: Date;
|
|
61
|
+
};
|
|
62
|
+
export type SaveSmsProviderTemplateRequest = {
|
|
63
|
+
template: SmsProviderTemplate;
|
|
64
|
+
/** dry_run reports what the linter found without writing anything. */
|
|
65
|
+
dryRun: boolean;
|
|
66
|
+
};
|
|
67
|
+
export type SaveSmsProviderTemplateResponse = {
|
|
68
|
+
template: SmsProviderTemplate;
|
|
69
|
+
};
|
|
70
|
+
export type ListSmsProviderTemplatesRequest = {
|
|
71
|
+
slug: string;
|
|
72
|
+
};
|
|
73
|
+
export type ListSmsProviderTemplatesResponse = {
|
|
74
|
+
templates: SmsProviderTemplate[];
|
|
75
|
+
};
|
|
76
|
+
export type GetSmsProviderTemplateRequest = {
|
|
77
|
+
slug: string;
|
|
78
|
+
version: string;
|
|
79
|
+
};
|
|
80
|
+
export type GetSmsProviderTemplateResponse = {
|
|
81
|
+
template: SmsProviderTemplate;
|
|
82
|
+
};
|
|
83
|
+
export type SetSmsProviderTemplateStatusRequest = {
|
|
84
|
+
slug: string;
|
|
85
|
+
version: string;
|
|
86
|
+
status: SmsProviderTemplateStatus;
|
|
87
|
+
};
|
|
88
|
+
export type SetSmsProviderTemplateStatusResponse = {
|
|
89
|
+
template: SmsProviderTemplate;
|
|
90
|
+
};
|