@pushwoosh/rpc-v2-http-api-data 0.2.99 → 0.2.100
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 +56 -0
- package/package.json +1 -1
- package/test_devices.d.ts +33 -0
package/data.js
CHANGED
|
@@ -26246,6 +26246,18 @@ export const data = {
|
|
|
26246
26246
|
"response": "pushwoosh.rpc_v2.test_devices.DeleteResponse",
|
|
26247
26247
|
"method": "post",
|
|
26248
26248
|
"path": "/api/test_devices:delete"
|
|
26249
|
+
},
|
|
26250
|
+
"GetAutoRegistration": {
|
|
26251
|
+
"request": "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationRequest",
|
|
26252
|
+
"response": "pushwoosh.rpc_v2.test_devices.GetAutoRegistrationResponse",
|
|
26253
|
+
"method": "get",
|
|
26254
|
+
"path": "/api/test_devices/auto_registration"
|
|
26255
|
+
},
|
|
26256
|
+
"SetAutoRegistration": {
|
|
26257
|
+
"request": "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationRequest",
|
|
26258
|
+
"response": "pushwoosh.rpc_v2.test_devices.SetAutoRegistrationResponse",
|
|
26259
|
+
"method": "post",
|
|
26260
|
+
"path": "/api/test_devices/auto_registration"
|
|
26249
26261
|
}
|
|
26250
26262
|
}
|
|
26251
26263
|
},
|
|
@@ -26292,6 +26304,9 @@ export const data = {
|
|
|
26292
26304
|
},
|
|
26293
26305
|
"description": {
|
|
26294
26306
|
"type": "string"
|
|
26307
|
+
},
|
|
26308
|
+
"autoCreated": {
|
|
26309
|
+
"type": "boolean"
|
|
26295
26310
|
}
|
|
26296
26311
|
}
|
|
26297
26312
|
},
|
|
@@ -26350,6 +26365,47 @@ export const data = {
|
|
|
26350
26365
|
"type": "I",
|
|
26351
26366
|
"fields": {}
|
|
26352
26367
|
},
|
|
26368
|
+
"pushwoosh.rpc_v2.test_devices.GetAutoRegistrationRequest": {
|
|
26369
|
+
"type": "I",
|
|
26370
|
+
"fields": {
|
|
26371
|
+
"application": {
|
|
26372
|
+
"type": "string"
|
|
26373
|
+
}
|
|
26374
|
+
}
|
|
26375
|
+
},
|
|
26376
|
+
"pushwoosh.rpc_v2.test_devices.GetAutoRegistrationResponse": {
|
|
26377
|
+
"type": "I",
|
|
26378
|
+
"fields": {
|
|
26379
|
+
"enabled": {
|
|
26380
|
+
"type": "boolean"
|
|
26381
|
+
},
|
|
26382
|
+
"expireAt": {
|
|
26383
|
+
"type": "Date"
|
|
26384
|
+
}
|
|
26385
|
+
}
|
|
26386
|
+
},
|
|
26387
|
+
"pushwoosh.rpc_v2.test_devices.SetAutoRegistrationRequest": {
|
|
26388
|
+
"type": "I",
|
|
26389
|
+
"fields": {
|
|
26390
|
+
"application": {
|
|
26391
|
+
"type": "string"
|
|
26392
|
+
},
|
|
26393
|
+
"enabled": {
|
|
26394
|
+
"type": "boolean"
|
|
26395
|
+
}
|
|
26396
|
+
}
|
|
26397
|
+
},
|
|
26398
|
+
"pushwoosh.rpc_v2.test_devices.SetAutoRegistrationResponse": {
|
|
26399
|
+
"type": "I",
|
|
26400
|
+
"fields": {
|
|
26401
|
+
"enabled": {
|
|
26402
|
+
"type": "boolean"
|
|
26403
|
+
},
|
|
26404
|
+
"expireAt": {
|
|
26405
|
+
"type": "Date"
|
|
26406
|
+
}
|
|
26407
|
+
}
|
|
26408
|
+
},
|
|
26353
26409
|
"pushwoosh.rpc_v2.users.UsersService": {
|
|
26354
26410
|
"type": "S",
|
|
26355
26411
|
"key": "users",
|
package/package.json
CHANGED
package/test_devices.d.ts
CHANGED
|
@@ -3,6 +3,8 @@ export type TestDevicesService_Create = RpcMethod<CreateRequest, CreateResponse>
|
|
|
3
3
|
export type TestDevicesService_Verify = RpcMethod<VerifyRequest, VerifyResponse>;
|
|
4
4
|
export type TestDevicesService_List = RpcMethod<ListRequest, ListResponse>;
|
|
5
5
|
export type TestDevicesService_Delete = RpcMethod<DeleteRequest, DeleteResponse>;
|
|
6
|
+
export type TestDevicesService_GetAutoRegistration = RpcMethod<GetAutoRegistrationRequest, GetAutoRegistrationResponse>;
|
|
7
|
+
export type TestDevicesService_SetAutoRegistration = RpcMethod<SetAutoRegistrationRequest, SetAutoRegistrationResponse>;
|
|
6
8
|
export interface TestDevicesService {
|
|
7
9
|
/** Registers a test device for an application by push token or HWID; for email, SMS, WhatsApp and LINE platforms it instead sends a verification code to the device and returns needs_verify=true, requiring verify_test_device to finish. Use to add a device that receives test sends. */
|
|
8
10
|
Create: TestDevicesService_Create;
|
|
@@ -12,6 +14,10 @@ export interface TestDevicesService {
|
|
|
12
14
|
List: TestDevicesService_List;
|
|
13
15
|
/** Removes a test device from an application by HWID or push token and clears its PW_TestDevice tag on the device. Use to stop a device from receiving test sends; cannot be undone. */
|
|
14
16
|
Delete: TestDevicesService_Delete;
|
|
17
|
+
/** Reports whether the application currently accepts test devices registered from the app itself (the SDK knock gesture), and when that window expires. Use to render the auto-registration switch and its countdown. */
|
|
18
|
+
GetAutoRegistration: TestDevicesService_GetAutoRegistration;
|
|
19
|
+
/** Opens a one-hour window in which the application accepts test devices registered from the app itself, or closes it immediately. While the window is closed such registrations are dropped; adding a test device from the Control Panel is never affected. */
|
|
20
|
+
SetAutoRegistration: TestDevicesService_SetAutoRegistration;
|
|
15
21
|
}
|
|
16
22
|
export type TestDevice = {
|
|
17
23
|
/** test device name */
|
|
@@ -55,6 +61,12 @@ export type CreateRequest = {
|
|
|
55
61
|
name?: string;
|
|
56
62
|
/** test device description. max length: 64 characters. */
|
|
57
63
|
description?: string;
|
|
64
|
+
/**
|
|
65
|
+
* set by the SDK when the device registered itself through the knock gesture
|
|
66
|
+
* instead of being added on purpose. such registrations are only accepted
|
|
67
|
+
* while the auto-registration window is open.
|
|
68
|
+
*/
|
|
69
|
+
autoCreated?: boolean;
|
|
58
70
|
};
|
|
59
71
|
export type CreateResponse = {
|
|
60
72
|
needsVerify: boolean;
|
|
@@ -81,3 +93,24 @@ export type DeleteRequest = {
|
|
|
81
93
|
pushToken?: string;
|
|
82
94
|
};
|
|
83
95
|
export type DeleteResponse = {};
|
|
96
|
+
export type GetAutoRegistrationRequest = {
|
|
97
|
+
/** application code */
|
|
98
|
+
application?: string;
|
|
99
|
+
};
|
|
100
|
+
export type GetAutoRegistrationResponse = {
|
|
101
|
+
/** true while the application accepts test devices registered from the app itself */
|
|
102
|
+
enabled: boolean;
|
|
103
|
+
/** when the window closes. unset when enabled is false */
|
|
104
|
+
expireAt: Date;
|
|
105
|
+
};
|
|
106
|
+
export type SetAutoRegistrationRequest = {
|
|
107
|
+
/** application code */
|
|
108
|
+
application?: string;
|
|
109
|
+
/** true opens the window for an hour, false closes it right away */
|
|
110
|
+
enabled?: boolean;
|
|
111
|
+
};
|
|
112
|
+
export type SetAutoRegistrationResponse = {
|
|
113
|
+
enabled: boolean;
|
|
114
|
+
/** when the window closes. unset when enabled is false */
|
|
115
|
+
expireAt: Date;
|
|
116
|
+
};
|