@pushwoosh/rpc-v2-http-api-data 0.2.525 → 0.2.527
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/accounts.d.ts +11 -48
- package/app_inbox_presets.d.ts +2 -2
- package/applications_controlgroup.d.ts +0 -22
- package/approvals.d.ts +0 -42
- package/commonTypes.d.ts +16 -4
- package/data.js +53 -575
- package/devices.d.ts +3 -3
- package/fb_messenger_presets.d.ts +2 -2
- package/feature_flags.d.ts +5 -5
- package/line_presets.d.ts +3 -3
- package/media_files.d.ts +0 -23
- package/package.json +1 -1
- package/presets.d.ts +5 -5
- package/pushwoosh_accounts_alerts_v1.d.ts +4 -4
- package/pushwoosh_channels_messagingApi_v2.d.ts +19 -51
- package/sms_provider_templates.d.ts +0 -84
- package/subscription_prompt.d.ts +3 -3
- package/tags.d.ts +9 -4
- package/types.js +2 -0
- package/web_sdk_config.d.ts +3 -3
package/devices.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type DevicesService_SetTags = RpcMethod<SetTagsRequest, SetTagsResponse>;
|
|
3
3
|
export interface DevicesService {
|
|
4
4
|
/** Sets or overwrites tag values on an existing device (by HWID) or user (by user_id) in an application. Send an empty string or null as a value to clear a tag; pass platform only when creating a device by HWID. */
|
|
@@ -10,7 +10,7 @@ export type SetTagsRequest = {
|
|
|
10
10
|
/** device hwid (use to set device-specific tags) */
|
|
11
11
|
hwid?: string;
|
|
12
12
|
/** to remove tag value, send empty string or null */
|
|
13
|
-
tags?:
|
|
13
|
+
tags?: JsonObject;
|
|
14
14
|
/** user id (to set user-specific tags) */
|
|
15
15
|
userId?: string;
|
|
16
16
|
/** platform (device type), used only when creating a device by hwid */
|
|
@@ -18,5 +18,5 @@ export type SetTagsRequest = {
|
|
|
18
18
|
};
|
|
19
19
|
export type SetTagsResponse = {
|
|
20
20
|
/** map<string, value>, value -- string, []string */
|
|
21
|
-
tags:
|
|
21
|
+
tags: JsonObject;
|
|
22
22
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type fbMessengerPresetsService_List = RpcMethod<ListFbMessengerPresetsRequest, ListFbMessengerPresetsResponse>;
|
|
3
3
|
export type fbMessengerPresetsService_Get = RpcMethod<GetFbMessengerPresetRequest, GetFbMessengerPresetResponse>;
|
|
4
4
|
export interface fbMessengerPresetsService {
|
|
@@ -11,7 +11,7 @@ export type FbMessengerPreset = {
|
|
|
11
11
|
name: string;
|
|
12
12
|
code: string;
|
|
13
13
|
/** Send API `message` object per language, as it is sent. */
|
|
14
|
-
localizedMessage: Record<string,
|
|
14
|
+
localizedMessage: Record<string, JsonObject>;
|
|
15
15
|
/** Code of the chat preset this preset is projected from. */
|
|
16
16
|
managedBy: string;
|
|
17
17
|
created: Date;
|
package/feature_flags.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type FeatureFlagsService_FieldViolations = {
|
|
3
3
|
reason: 'FV_UNSPECIFIED';
|
|
4
4
|
field: string;
|
|
@@ -192,7 +192,7 @@ export type FeatureFlagRule = {
|
|
|
192
192
|
/** Share of matching users the flag is on for, in basis points: 0..10000. */
|
|
193
193
|
percentBp: number;
|
|
194
194
|
/** Property values that replace the defaults for devices this rule turns on, keyed by property key. */
|
|
195
|
-
overrides:
|
|
195
|
+
overrides: JsonObject;
|
|
196
196
|
};
|
|
197
197
|
export type FeatureFlag = {
|
|
198
198
|
applicationCode: string;
|
|
@@ -203,7 +203,7 @@ export type FeatureFlag = {
|
|
|
203
203
|
status: string;
|
|
204
204
|
properties: FeatureFlagProperty[];
|
|
205
205
|
/** Value of every property for devices the flag is off for, keyed by property key. */
|
|
206
|
-
defaults:
|
|
206
|
+
defaults: JsonObject;
|
|
207
207
|
rules: FeatureFlagRule[];
|
|
208
208
|
/** Send back with Update, SetRulePercent and Reshuffle. */
|
|
209
209
|
version: number;
|
|
@@ -237,7 +237,7 @@ export type CreateFeatureFlagRequest = {
|
|
|
237
237
|
description?: string;
|
|
238
238
|
properties?: FeatureFlagProperty[];
|
|
239
239
|
/** Value of every property for devices the flag is off for, keyed by property key. Each value must match the property type. */
|
|
240
|
-
defaults?:
|
|
240
|
+
defaults?: JsonObject;
|
|
241
241
|
/** Ordered rules, at most 10. */
|
|
242
242
|
rules?: FeatureFlagRule[];
|
|
243
243
|
};
|
|
@@ -254,7 +254,7 @@ export type UpdateFeatureFlagRequest = {
|
|
|
254
254
|
description?: string;
|
|
255
255
|
properties?: FeatureFlagProperty[];
|
|
256
256
|
/** Value of every property for devices the flag is off for, keyed by property key. */
|
|
257
|
-
defaults?:
|
|
257
|
+
defaults?: JsonObject;
|
|
258
258
|
rules?: FeatureFlagRule[];
|
|
259
259
|
};
|
|
260
260
|
export type UpdateFeatureFlagResponse = {
|
package/line_presets.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type linePresetsService_List = RpcMethod<ListLinePresetsRequest, ListLinePresetsResponse>;
|
|
3
3
|
export type linePresetsService_Get = RpcMethod<GetLinePresetRequest, GetLinePresetResponse>;
|
|
4
4
|
export type linePresetsService_Create = RpcMethod<CreateLinePresetRequest, CreateLinePresetResponse>;
|
|
@@ -55,7 +55,7 @@ export type Template = {
|
|
|
55
55
|
};
|
|
56
56
|
export type MessageTemplate = {
|
|
57
57
|
/** The LINE Messaging API message object as it is sent. */
|
|
58
|
-
content:
|
|
58
|
+
content: JsonObject;
|
|
59
59
|
};
|
|
60
60
|
export type ImageTemplate = {
|
|
61
61
|
imageUrl: string;
|
|
@@ -67,7 +67,7 @@ export type ImageCarouselTemplate = {
|
|
|
67
67
|
};
|
|
68
68
|
export type RawTemplate = {
|
|
69
69
|
altText: string;
|
|
70
|
-
content:
|
|
70
|
+
content: JsonObject;
|
|
71
71
|
};
|
|
72
72
|
export type LinePreset = {
|
|
73
73
|
name: string;
|
package/media_files.d.ts
CHANGED
|
@@ -63,29 +63,6 @@ export type FocalPoint = {
|
|
|
63
63
|
export type CreateVariantResponse = {
|
|
64
64
|
file: MediaFile;
|
|
65
65
|
};
|
|
66
|
-
export type UploadMediaFileRequest = {
|
|
67
|
-
/** Application code (format XXXXX-XXXXX) to store the image under. */
|
|
68
|
-
application: string;
|
|
69
|
-
/** Original filename; defaults to "upload_<date>" when empty. */
|
|
70
|
-
filename: string;
|
|
71
|
-
/** Raw image bytes to upload. */
|
|
72
|
-
data: string;
|
|
73
|
-
/** MIME type of the image (image/jpeg, image/png, image/gif, image/webp); auto-detected from the bytes when empty. */
|
|
74
|
-
mimeType: string;
|
|
75
|
-
description?: string;
|
|
76
|
-
/** Where the image came from: empty for a file from disk, "canva", "figma", "ai" or "stock". */
|
|
77
|
-
source: string;
|
|
78
|
-
/** Provider-side identity of the image as a JSON object, e.g. {"design_id": "...", "page": 2}. */
|
|
79
|
-
sourceRef: string;
|
|
80
|
-
/**
|
|
81
|
-
* uuid of an original of this application to store a new version of; the old one keeps its URL.
|
|
82
|
-
* Another application's uuid is NOT_FOUND, a cropped variant's INVALID_ARGUMENT.
|
|
83
|
-
*/
|
|
84
|
-
replacesUuid?: string;
|
|
85
|
-
};
|
|
86
|
-
export type UploadMediaFileResponse = {
|
|
87
|
-
file: MediaFile;
|
|
88
|
-
};
|
|
89
66
|
export type ListMediaFilesRequest = {
|
|
90
67
|
/** Application code (format XXXXX-XXXXX) whose media files to list. */
|
|
91
68
|
application?: string;
|
package/package.json
CHANGED
package/presets.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
import { PushButton_Action as pushwoosh_channels_messagingApi_v2_PushButton_Action } from './pushwoosh_channels_messagingApi_v2';
|
|
3
3
|
import { PushButton_Style as pushwoosh_channels_messagingApi_v2_PushButton_Style } from './pushwoosh_channels_messagingApi_v2';
|
|
4
4
|
import { Content as pushwoosh_channels_messagingApi_v2_Content } from './pushwoosh_channels_messagingApi_v2';
|
|
@@ -170,7 +170,7 @@ export type Preset = {
|
|
|
170
170
|
created: Date;
|
|
171
171
|
updated: Date;
|
|
172
172
|
/** userdata content map {"data": "content"...} */
|
|
173
|
-
customData:
|
|
173
|
+
customData: JsonObject;
|
|
174
174
|
isV2: boolean;
|
|
175
175
|
/** banner attachment */
|
|
176
176
|
banner: string;
|
|
@@ -264,7 +264,7 @@ export type CreatePresetRequest = {
|
|
|
264
264
|
/** inbox date */
|
|
265
265
|
inboxDate?: Date;
|
|
266
266
|
/** user data */
|
|
267
|
-
customData?:
|
|
267
|
+
customData?: JsonObject;
|
|
268
268
|
/** categories */
|
|
269
269
|
categories?: string[];
|
|
270
270
|
/** banner attachment */
|
|
@@ -339,7 +339,7 @@ export type UpdatePresetRequest = {
|
|
|
339
339
|
/** inbox date */
|
|
340
340
|
inboxDate?: Date;
|
|
341
341
|
/** user data */
|
|
342
|
-
customData?:
|
|
342
|
+
customData?: JsonObject;
|
|
343
343
|
/** categories */
|
|
344
344
|
categories?: string[];
|
|
345
345
|
/** banner attachment */
|
|
@@ -412,7 +412,7 @@ export type UpdatePresetPartialRequest = {
|
|
|
412
412
|
/** inbox date */
|
|
413
413
|
inboxDate?: Date;
|
|
414
414
|
/** user data */
|
|
415
|
-
customData?:
|
|
415
|
+
customData?: JsonObject;
|
|
416
416
|
/** categories */
|
|
417
417
|
categories?: string[];
|
|
418
418
|
/** banner attachment */
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type AlertsService_List = RpcMethod<ListRequest, ListResponse>;
|
|
3
3
|
export type AlertsService_Send = RpcMethod<SendRequest, SendResponse>;
|
|
4
4
|
export type AlertsService_UpdateStatus = RpcMethod<UpdateStatusRequest, UpdateStatusResponse>;
|
|
@@ -65,7 +65,7 @@ export type ListResponse_Alert = {
|
|
|
65
65
|
uuid: string;
|
|
66
66
|
accountId: number;
|
|
67
67
|
applicationId?: number;
|
|
68
|
-
meta?:
|
|
68
|
+
meta?: JsonObject;
|
|
69
69
|
actionLink?: string;
|
|
70
70
|
actionLinkLabel?: string;
|
|
71
71
|
imageUrl?: string;
|
|
@@ -86,7 +86,7 @@ export type SendRequest = {
|
|
|
86
86
|
banner?: AlertBanner;
|
|
87
87
|
email?: AlertEmail;
|
|
88
88
|
applicationId?: number;
|
|
89
|
-
meta?:
|
|
89
|
+
meta?: JsonObject;
|
|
90
90
|
/** check unique alert within the `unique_key` in the provided request */
|
|
91
91
|
uniqueKey?: string;
|
|
92
92
|
/**
|
|
@@ -224,7 +224,7 @@ export type GetResponse_Alert = {
|
|
|
224
224
|
uniqueKey: string;
|
|
225
225
|
accountId: number;
|
|
226
226
|
applicationId?: number;
|
|
227
|
-
meta?:
|
|
227
|
+
meta?: JsonObject;
|
|
228
228
|
actionLink?: string;
|
|
229
229
|
actionLinkLabel?: string;
|
|
230
230
|
imageUrl?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod, Duration } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject, Duration } from './commonTypes';
|
|
2
2
|
import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } from './pushwoosh_objects_filters_v1';
|
|
3
3
|
/**
|
|
4
4
|
* MessagesInProgressService is an INTERNAL service (exposed on the private gRPC
|
|
@@ -11,38 +11,6 @@ import { FilterExpression as pushwoosh_objects_filters_v1_FilterExpression } fro
|
|
|
11
11
|
*/
|
|
12
12
|
export interface MessagesInProgressService {
|
|
13
13
|
}
|
|
14
|
-
export type MessageStalledStatusState = 'MESSAGE_STATUS_STATE_UNKNOWN' | 'MESSAGE_STATUS_STATE_ALIVE' | 'MESSAGE_STATUS_STATE_STUCK' | 'MESSAGE_STATUS_STATE_DEAD';
|
|
15
|
-
export type MessageStalled = {
|
|
16
|
-
messageCode: string;
|
|
17
|
-
clientId: string;
|
|
18
|
-
state: MessageStalledStatusState;
|
|
19
|
-
processed: number;
|
|
20
|
-
isClientAlive: boolean;
|
|
21
|
-
accountId: number;
|
|
22
|
-
/** Last progress update; unset if absent. */
|
|
23
|
-
lastUpdated: Date;
|
|
24
|
-
/** Last resend; unset if the message was never resent. */
|
|
25
|
-
lastResend: Date;
|
|
26
|
-
sendDate: Date;
|
|
27
|
-
};
|
|
28
|
-
export type ListRequest = {};
|
|
29
|
-
export type ListResponse = {
|
|
30
|
-
messages: MessageStalled[];
|
|
31
|
-
};
|
|
32
|
-
export type GetStalledMessageRequest = {
|
|
33
|
-
messageCode: string;
|
|
34
|
-
};
|
|
35
|
-
export type GetStalledMessageResponse = {
|
|
36
|
-
message: MessageStalled;
|
|
37
|
-
};
|
|
38
|
-
export type ResendMessageRequest = {
|
|
39
|
-
messageCode: string;
|
|
40
|
-
};
|
|
41
|
-
export type ResendMessageResponse = {};
|
|
42
|
-
export type ClearMessageRequest = {
|
|
43
|
-
messageCode: string;
|
|
44
|
-
};
|
|
45
|
-
export type ClearMessageResponse = {};
|
|
46
14
|
export type MessagingService_Notify = RpcMethod<NotifyRequest, NotifyResponse>;
|
|
47
15
|
export type MessagingService_NotifyBatch = RpcMethod<NotifyBatchRequest, NotifyBatchResponse>;
|
|
48
16
|
export type MessagingService_Cancel = RpcMethod<CancelRequest, CancelResponse>;
|
|
@@ -282,7 +250,7 @@ export type NotifySegment = {
|
|
|
282
250
|
/** Throttling for this message. */
|
|
283
251
|
sendRate: SendRate;
|
|
284
252
|
/** Free-form JSON stored with the message and echoed in tracking-log events. */
|
|
285
|
-
metaData:
|
|
253
|
+
metaData: JsonObject;
|
|
286
254
|
/** Placeholder name to the value substituted into the message content. */
|
|
287
255
|
dynamicContentPlaceholders: Record<string, string>;
|
|
288
256
|
/**
|
|
@@ -310,7 +278,7 @@ export type NotifySegment = {
|
|
|
310
278
|
/** Internal: where message_type came from, e.g. a journey default baked at publish; ignored for external requests. */
|
|
311
279
|
messageTypeSource: MessageTypeSource;
|
|
312
280
|
/** Placeholder name to the value substituted into the message content; wins over dynamic_content_placeholders on the same key. */
|
|
313
|
-
contentPlaceholders:
|
|
281
|
+
contentPlaceholders: JsonObject;
|
|
314
282
|
resend: Resend;
|
|
315
283
|
geoZone: GeoZone;
|
|
316
284
|
target: NotifySegment_target;
|
|
@@ -387,7 +355,7 @@ export type NotifyTransactional = {
|
|
|
387
355
|
/** Throttling for this message. */
|
|
388
356
|
sendRate: SendRate;
|
|
389
357
|
/** Free-form JSON stored with the message and echoed in tracking-log events. */
|
|
390
|
-
metaData:
|
|
358
|
+
metaData: JsonObject;
|
|
391
359
|
/** Placeholder name to the value substituted into the message content. */
|
|
392
360
|
dynamicContentPlaceholders: Record<string, string>;
|
|
393
361
|
/**
|
|
@@ -422,7 +390,7 @@ export type NotifyTransactional = {
|
|
|
422
390
|
/** Internal: where message_type came from, e.g. a journey default baked at publish; ignored for external requests. */
|
|
423
391
|
messageTypeSource: MessageTypeSource;
|
|
424
392
|
/** Placeholder name to the value substituted into the message content; wins over dynamic_content_placeholders on the same key. */
|
|
425
|
-
contentPlaceholders:
|
|
393
|
+
contentPlaceholders: JsonObject;
|
|
426
394
|
resend: Resend;
|
|
427
395
|
target: NotifyTransactional_target;
|
|
428
396
|
messagePayload: NotifyTransactional_messagePayload;
|
|
@@ -513,7 +481,7 @@ export type LiveActivity = {
|
|
|
513
481
|
/** Unix time after which an ended activity is dismissed. */
|
|
514
482
|
dismissalDate: number;
|
|
515
483
|
/** Dynamic ContentState of the activity. */
|
|
516
|
-
contentState:
|
|
484
|
+
contentState: JsonObject;
|
|
517
485
|
/** Unix time after which the shown content counts as stale. */
|
|
518
486
|
staleDate: number;
|
|
519
487
|
/** Ordering hint when several activities compete for the same slot. */
|
|
@@ -521,7 +489,7 @@ export type LiveActivity = {
|
|
|
521
489
|
/** Name of the ActivityAttributes type; required to start an activity. */
|
|
522
490
|
attributesType: string;
|
|
523
491
|
/** Static attributes passed when the activity starts. */
|
|
524
|
-
attributes:
|
|
492
|
+
attributes: JsonObject;
|
|
525
493
|
/** Unix time the activity starts. */
|
|
526
494
|
start: number;
|
|
527
495
|
};
|
|
@@ -576,7 +544,7 @@ export type LiveUpdate = {
|
|
|
576
544
|
/** Colored segments the progress bar is split into. */
|
|
577
545
|
segments: LiveUpdate_Segment[];
|
|
578
546
|
/** Free-form data passed to the app with the update. */
|
|
579
|
-
extras:
|
|
547
|
+
extras: JsonObject;
|
|
580
548
|
/** Unix time the update refers to. */
|
|
581
549
|
when: number;
|
|
582
550
|
/** Render `when` as a running timer. */
|
|
@@ -685,7 +653,7 @@ export type Content_PlatformPropertiesIos = {
|
|
|
685
653
|
/** iOS interruption level: passive, active, time-sensitive or critical. */
|
|
686
654
|
interruptionLevel: string;
|
|
687
655
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
688
|
-
rootParams:
|
|
656
|
+
rootParams: JsonObject;
|
|
689
657
|
/** Live Activity payload. */
|
|
690
658
|
liveActivity: LiveActivity;
|
|
691
659
|
/** APNs collapse identifier: a newer notification replaces one with the same id. */
|
|
@@ -731,7 +699,7 @@ export type Content_PlatformPropertiesAndroid = {
|
|
|
731
699
|
/** Show the notification on the lock screen. */
|
|
732
700
|
showOnLockscreen: boolean;
|
|
733
701
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
734
|
-
rootParams:
|
|
702
|
+
rootParams: JsonObject;
|
|
735
703
|
/** URL of a large custom icon. */
|
|
736
704
|
customIcon: string;
|
|
737
705
|
/** In-tray notification priority. */
|
|
@@ -758,7 +726,7 @@ export type Content_PlatformPropertiesChrome = {
|
|
|
758
726
|
/** Large image URL. */
|
|
759
727
|
image: string;
|
|
760
728
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
761
|
-
rootParams:
|
|
729
|
+
rootParams: JsonObject;
|
|
762
730
|
/** Auto-close timer for the notification. */
|
|
763
731
|
duration: Duration;
|
|
764
732
|
/** Label of the first action button. */
|
|
@@ -780,7 +748,7 @@ export type Content_PlatformPropertiesFirefox = {
|
|
|
780
748
|
/** Notification small icon. */
|
|
781
749
|
icon: string;
|
|
782
750
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
783
|
-
rootParams:
|
|
751
|
+
rootParams: JsonObject;
|
|
784
752
|
/** Message Inbox entry created for this notification. */
|
|
785
753
|
inbox: Inbox;
|
|
786
754
|
};
|
|
@@ -814,7 +782,7 @@ export type Content_PlatformPropertiesMacOS = {
|
|
|
814
782
|
/** Badge value: absolute ("5") or relative ("+1"). */
|
|
815
783
|
badges: string;
|
|
816
784
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
817
|
-
rootParams:
|
|
785
|
+
rootParams: JsonObject;
|
|
818
786
|
/** Message Inbox entry created for this notification. */
|
|
819
787
|
inbox: Inbox;
|
|
820
788
|
/** Notification subtitle. */
|
|
@@ -834,7 +802,7 @@ export type Content_PlatformPropertiesAmazon = {
|
|
|
834
802
|
/** Enables or suppresses the notification sound. */
|
|
835
803
|
soundEnabled: boolean;
|
|
836
804
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
837
|
-
rootParams:
|
|
805
|
+
rootParams: JsonObject;
|
|
838
806
|
/** Notification small icon. */
|
|
839
807
|
icon: string;
|
|
840
808
|
/** URL of a large custom icon. */
|
|
@@ -872,7 +840,7 @@ export type Content_PlatformPropertiesBaiduAndroid = {
|
|
|
872
840
|
/** Show the notification on the lock screen. */
|
|
873
841
|
showOnLockscreen: boolean;
|
|
874
842
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
875
|
-
rootParams:
|
|
843
|
+
rootParams: JsonObject;
|
|
876
844
|
/** URL of a large custom icon. */
|
|
877
845
|
customIcon: string;
|
|
878
846
|
/** In-tray notification priority. */
|
|
@@ -911,7 +879,7 @@ export type Content_PlatformPropertiesHuaweiAndroid = {
|
|
|
911
879
|
/** Show the notification on the lock screen. */
|
|
912
880
|
showOnLockscreen: boolean;
|
|
913
881
|
/** Raw platform payload overrides merged into the outgoing push. */
|
|
914
|
-
rootParams:
|
|
882
|
+
rootParams: JsonObject;
|
|
915
883
|
/** URL of a large custom icon. */
|
|
916
884
|
customIcon: string;
|
|
917
885
|
/** In-tray notification priority. */
|
|
@@ -983,7 +951,7 @@ export type Content_PlatformPropertiesAppInbox = {
|
|
|
983
951
|
/** Action performed when the user taps the entry. */
|
|
984
952
|
openAction: OpenAction;
|
|
985
953
|
/** Free-form JSON delivered to the SDK with the entry. */
|
|
986
|
-
customData:
|
|
954
|
+
customData: JsonObject;
|
|
987
955
|
/** Inbox cell layout: classic (default when empty), captioned, banner or carousel. */
|
|
988
956
|
layoutType: string;
|
|
989
957
|
/** Slides of the carousel layout. */
|
|
@@ -1207,7 +1175,7 @@ export type Payload = {
|
|
|
1207
1175
|
*/
|
|
1208
1176
|
preset: string;
|
|
1209
1177
|
/** Free-form JSON delivered to the SDK as the `u` parameter. */
|
|
1210
|
-
customData:
|
|
1178
|
+
customData: JsonObject;
|
|
1211
1179
|
/** Action performed when the user opens the notification. */
|
|
1212
1180
|
openAction: OpenAction;
|
|
1213
1181
|
/** Per-platform override of open_action, keyed by the numeric platform code. */
|
|
@@ -1287,7 +1255,7 @@ export type InAppPayload = {
|
|
|
1287
1255
|
/** Rich media page to show: a code or a remote page URL. Required. */
|
|
1288
1256
|
richMedia: RichMedia;
|
|
1289
1257
|
/** Free-form JSON delivered to the SDK as the `u` parameter. */
|
|
1290
|
-
customData:
|
|
1258
|
+
customData: JsonObject;
|
|
1291
1259
|
/** How long the push service keeps the message for an offline device on iOS, Android and Huawei. */
|
|
1292
1260
|
timeToLive: Duration;
|
|
1293
1261
|
};
|
|
@@ -4,87 +4,3 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SmsProviderTemplatesService {
|
|
6
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
|
-
};
|
package/subscription_prompt.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type SubscriptionPromptService_GetUseCase = RpcMethod<GetUseCaseRequest, GetUseCaseResponse>;
|
|
3
3
|
export type SubscriptionPromptService_SetUseCase = RpcMethod<SetUseCaseRequest, SetUseCaseResponse>;
|
|
4
4
|
export type SubscriptionPromptService_GetWidget = RpcMethod<GetWidgetRequest, GetWidgetResponse>;
|
|
@@ -34,7 +34,7 @@ export type GetWidgetRequest = {
|
|
|
34
34
|
export type GetWidgetResponse = {
|
|
35
35
|
code: string;
|
|
36
36
|
type: string;
|
|
37
|
-
params:
|
|
37
|
+
params: JsonObject;
|
|
38
38
|
};
|
|
39
39
|
export type SetWidgetRequest = {
|
|
40
40
|
/** Application code (XXXXX-XXXXX) whose subscription-prompt widget is created or overwritten. */
|
|
@@ -42,6 +42,6 @@ export type SetWidgetRequest = {
|
|
|
42
42
|
/** Widget type identifier to store for the prompt. */
|
|
43
43
|
type?: string;
|
|
44
44
|
/** Arbitrary widget configuration stored as JSON params. */
|
|
45
|
-
params?:
|
|
45
|
+
params?: JsonObject;
|
|
46
46
|
};
|
|
47
47
|
export type SetWidgetResponse = {};
|
package/tags.d.ts
CHANGED
|
@@ -48,8 +48,13 @@ export type Tag = {
|
|
|
48
48
|
export type TagField = {
|
|
49
49
|
/** Field name relative to its object: "amount" for the tag "order.amount". */
|
|
50
50
|
name: string;
|
|
51
|
-
/** INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE or
|
|
51
|
+
/** INTEGER, STRING, LIST, DATE, BOOLEAN, PRICE, VERSION, or OBJECT and OBJECT_LIST for a nested object. */
|
|
52
52
|
type: Tag_Type;
|
|
53
|
+
/**
|
|
54
|
+
* Fields of an OBJECT or OBJECT_LIST field, 1 to 20, ordered by name. Objects nest at most 3 levels deep, the tag itself
|
|
55
|
+
* being the first, and one object tag holds at most 50 fields with values.
|
|
56
|
+
*/
|
|
57
|
+
fields: TagField[];
|
|
53
58
|
};
|
|
54
59
|
export type CreateTagRequest = {
|
|
55
60
|
/** Tag name to create (letters, digits, spaces and dashes; max 64 chars). */
|
|
@@ -58,7 +63,7 @@ export type CreateTagRequest = {
|
|
|
58
63
|
type?: Tag_Type;
|
|
59
64
|
/** If true the tag is stored per user id rather than per device. OBJECT and OBJECT_LIST tags are always user-specific. */
|
|
60
65
|
userSpecific?: boolean;
|
|
61
|
-
/** Fields of an OBJECT or OBJECT_LIST tag, 1 to 20; ignored for other types. */
|
|
66
|
+
/** Fields of an OBJECT or OBJECT_LIST tag, 1 to 20; ignored for other types. A field may be an object itself, see TagField. */
|
|
62
67
|
fields?: TagField[];
|
|
63
68
|
};
|
|
64
69
|
export type CreateTagResponse = {
|
|
@@ -150,7 +155,7 @@ export type GetTagValuesResponse = {
|
|
|
150
155
|
perPage: number;
|
|
151
156
|
};
|
|
152
157
|
export type AddTagFieldRequest = {
|
|
153
|
-
/** Name of the OBJECT or OBJECT_LIST tag. */
|
|
158
|
+
/** Name of the OBJECT or OBJECT_LIST tag, or the full name of a nested object field ("order.address"). */
|
|
154
159
|
name?: string;
|
|
155
160
|
field?: TagField;
|
|
156
161
|
};
|
|
@@ -158,7 +163,7 @@ export type AddTagFieldResponse = {
|
|
|
158
163
|
tag: Tag;
|
|
159
164
|
};
|
|
160
165
|
export type DeleteTagFieldRequest = {
|
|
161
|
-
/** Name of the OBJECT or OBJECT_LIST tag. */
|
|
166
|
+
/** Name of the OBJECT or OBJECT_LIST tag, or the full name of a nested object field ("order.address"). */
|
|
162
167
|
name?: string;
|
|
163
168
|
/** Field name relative to the object. */
|
|
164
169
|
field?: string;
|
package/types.js
CHANGED
package/web_sdk_config.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RpcMethod } from './commonTypes';
|
|
1
|
+
import { RpcMethod, JsonObject } from './commonTypes';
|
|
2
2
|
export type WebSdkConfigService_GetConfig = RpcMethod<GetConfigRequest, GetConfigResponse>;
|
|
3
3
|
export type WebSdkConfigService_SetConfig = RpcMethod<SetConfigRequest, SetConfigResponse>;
|
|
4
4
|
export type WebSdkConfigService_SetMode = RpcMethod<SetModeRequest, SetModeResponse>;
|
|
@@ -18,14 +18,14 @@ export type GetConfigResponse = {
|
|
|
18
18
|
/** Either legacy or managed. */
|
|
19
19
|
mode: string;
|
|
20
20
|
/** Web SDK settings keyed by init parameter name; empty when nothing was saved yet. */
|
|
21
|
-
config:
|
|
21
|
+
config: JsonObject;
|
|
22
22
|
updated: Date;
|
|
23
23
|
};
|
|
24
24
|
export type SetConfigRequest = {
|
|
25
25
|
/** Application code (XXXXX-XXXXX) whose Web SDK configuration is written. */
|
|
26
26
|
applicationCode?: string;
|
|
27
27
|
/** Web SDK settings keyed by init parameter name, as the SDK names them: subscribeWidget, autoSubscribe, defaultNotificationTitle, defaultNotificationImage, safariWebsitePushID. */
|
|
28
|
-
config?:
|
|
28
|
+
config?: JsonObject;
|
|
29
29
|
};
|
|
30
30
|
export type SetConfigResponse = {};
|
|
31
31
|
export type SetModeRequest = {
|