@grabjs/superapp-sdk 2.0.0-beta.50 → 2.0.0-beta.53
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/api-reference/api.json +31976 -20570
- package/dist/index.d.ts +657 -0
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -2
package/dist/index.d.ts
CHANGED
|
@@ -5,6 +5,9 @@ import * as v from 'valibot';
|
|
|
5
5
|
/**
|
|
6
6
|
* Request parameters for initiating an OAuth2 authorization flow with PKCE.
|
|
7
7
|
*
|
|
8
|
+
* @group Modules
|
|
9
|
+
* @category Identity
|
|
10
|
+
*
|
|
8
11
|
* @example
|
|
9
12
|
* **Production environment with redirect mode:**
|
|
10
13
|
* ```typescript
|
|
@@ -36,6 +39,9 @@ export declare type AuthorizeRequest = InferOutput<typeof AuthorizeRequestSchema
|
|
|
36
39
|
/**
|
|
37
40
|
* Valibot schema for {@link AuthorizeRequest}.
|
|
38
41
|
*
|
|
42
|
+
* @group Modules
|
|
43
|
+
* @category Identity
|
|
44
|
+
*
|
|
39
45
|
* @public
|
|
40
46
|
*/
|
|
41
47
|
export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
@@ -49,6 +55,9 @@ export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
|
49
55
|
/**
|
|
50
56
|
* Response when initiating an authorization flow.
|
|
51
57
|
*
|
|
58
|
+
* @group Modules
|
|
59
|
+
* @category Identity
|
|
60
|
+
*
|
|
52
61
|
* @remarks
|
|
53
62
|
* This response can have the following status codes:
|
|
54
63
|
* - `200`: Authorization completed successfully (native in_place flow). The `result` contains the authorization code, state, and PKCE artifacts (`codeVerifier`, `nonce`, `redirectUri`).
|
|
@@ -66,6 +75,9 @@ export declare type AuthorizeResponse = InferOutput<typeof AuthorizeResponseSche
|
|
|
66
75
|
/**
|
|
67
76
|
* Valibot schema for {@link AuthorizeResponse}.
|
|
68
77
|
*
|
|
78
|
+
* @group Modules
|
|
79
|
+
* @category Identity
|
|
80
|
+
*
|
|
69
81
|
* @public
|
|
70
82
|
*/
|
|
71
83
|
export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -99,6 +111,9 @@ export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
99
111
|
* Result object for the authorization flow.
|
|
100
112
|
* Contains the authorization code, state, and PKCE artifacts when native in_place flow completes successfully.
|
|
101
113
|
*
|
|
114
|
+
* @group Modules
|
|
115
|
+
* @category Identity
|
|
116
|
+
*
|
|
102
117
|
* @example
|
|
103
118
|
* ```typescript
|
|
104
119
|
* {
|
|
@@ -117,6 +132,9 @@ export declare type AuthorizeResult = InferOutput<typeof AuthorizeResultSchema>;
|
|
|
117
132
|
/**
|
|
118
133
|
* Valibot schema for {@link AuthorizeResult}.
|
|
119
134
|
*
|
|
135
|
+
* @group Modules
|
|
136
|
+
* @category Identity
|
|
137
|
+
*
|
|
120
138
|
* @public
|
|
121
139
|
*/
|
|
122
140
|
export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
@@ -130,6 +148,9 @@ export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
|
130
148
|
/**
|
|
131
149
|
* Response when triggering platform back navigation.
|
|
132
150
|
*
|
|
151
|
+
* @group Modules
|
|
152
|
+
* @category Platform
|
|
153
|
+
*
|
|
133
154
|
* @remarks
|
|
134
155
|
* This response can have the following status codes:
|
|
135
156
|
* - `204`: Back navigation triggered successfully.
|
|
@@ -143,6 +164,9 @@ export declare type BackResponse = InferOutput<typeof BackResponseSchema>;
|
|
|
143
164
|
/**
|
|
144
165
|
* Valibot schema for {@link BackResponse}.
|
|
145
166
|
*
|
|
167
|
+
* @group Modules
|
|
168
|
+
* @category Platform
|
|
169
|
+
*
|
|
146
170
|
* @public
|
|
147
171
|
*/
|
|
148
172
|
export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -159,6 +183,9 @@ export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
159
183
|
* Result when triggering platform back navigation.
|
|
160
184
|
* This operation returns no data on success.
|
|
161
185
|
*
|
|
186
|
+
* @group Modules
|
|
187
|
+
* @category Platform
|
|
188
|
+
*
|
|
162
189
|
* @public
|
|
163
190
|
*/
|
|
164
191
|
export declare type BackResult = void;
|
|
@@ -166,6 +193,8 @@ export declare type BackResult = void;
|
|
|
166
193
|
/**
|
|
167
194
|
* Base class for all JSBridge modules.
|
|
168
195
|
*
|
|
196
|
+
* @group Core
|
|
197
|
+
*
|
|
169
198
|
* @remarks
|
|
170
199
|
* On construction, the class wraps the JSBridge module on `window` (e.g., `WrappedContainerModule`).
|
|
171
200
|
* This code must run on the Grab SuperApp's webview to function correctly.
|
|
@@ -269,6 +298,8 @@ export declare class BaseModule {
|
|
|
269
298
|
/**
|
|
270
299
|
* Base response type for all JSBridge calls.
|
|
271
300
|
*
|
|
301
|
+
* @group Core
|
|
302
|
+
*
|
|
272
303
|
* @remarks
|
|
273
304
|
* Every response has a numeric `status_code`. Success responses (200) carry `result`;
|
|
274
305
|
* error responses (4xx/5xx) carry `error`. Use the type guards ({@link isSuccess},
|
|
@@ -292,6 +323,8 @@ export declare type BridgeResponse = {
|
|
|
292
323
|
/**
|
|
293
324
|
* A stream for receiving continuous data from JSBridge methods (e.g., location updates).
|
|
294
325
|
*
|
|
326
|
+
* @group Core
|
|
327
|
+
*
|
|
295
328
|
* @remarks
|
|
296
329
|
* Provides both Observable-like and Promise-like interfaces:
|
|
297
330
|
* - Use `subscribe()` to receive all values over time
|
|
@@ -316,6 +349,8 @@ export declare type BridgeStream<T extends BridgeResponse = BridgeResponse> = Re
|
|
|
316
349
|
/**
|
|
317
350
|
* Callbacks for handling stream events.
|
|
318
351
|
*
|
|
352
|
+
* @group Core
|
|
353
|
+
*
|
|
319
354
|
* @remarks
|
|
320
355
|
* Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
|
|
321
356
|
*
|
|
@@ -334,6 +369,7 @@ export declare type BridgeStreamHandlers<T extends BridgeResponse = BridgeRespon
|
|
|
334
369
|
* JSBridge module for accessing the device camera.
|
|
335
370
|
*
|
|
336
371
|
* @group Modules
|
|
372
|
+
* @category Camera
|
|
337
373
|
*
|
|
338
374
|
* @remarks
|
|
339
375
|
* Provides access to native camera functionality including QR code scanning.
|
|
@@ -410,6 +446,7 @@ export declare class CameraModule extends BaseModule {
|
|
|
410
446
|
* JSBridge module for triggering native payment flows.
|
|
411
447
|
*
|
|
412
448
|
* @group Modules
|
|
449
|
+
* @category Checkout
|
|
413
450
|
*
|
|
414
451
|
* @remarks
|
|
415
452
|
* Invokes the native Grab checkout/pay component to process payments.
|
|
@@ -501,6 +538,9 @@ export declare class CheckoutModule extends BaseModule {
|
|
|
501
538
|
/**
|
|
502
539
|
* Response when clearing stored authorization artifacts.
|
|
503
540
|
*
|
|
541
|
+
* @group Modules
|
|
542
|
+
* @category Identity
|
|
543
|
+
*
|
|
504
544
|
* @remarks
|
|
505
545
|
* This response returns status code `204` when artifacts are successfully cleared.
|
|
506
546
|
*
|
|
@@ -511,6 +551,9 @@ export declare type ClearAuthorizationArtifactsResponse = InferOutput<typeof Cle
|
|
|
511
551
|
/**
|
|
512
552
|
* Valibot schema for {@link ClearAuthorizationArtifactsResponse}.
|
|
513
553
|
*
|
|
554
|
+
* @group Modules
|
|
555
|
+
* @category Identity
|
|
556
|
+
*
|
|
514
557
|
* @public
|
|
515
558
|
*/
|
|
516
559
|
export declare const ClearAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -521,6 +564,9 @@ export declare const ClearAuthorizationArtifactsResponseSchema: v.UnionSchema<[v
|
|
|
521
564
|
* Result object for clearing authorization artifacts.
|
|
522
565
|
* This operation returns no data on success.
|
|
523
566
|
*
|
|
567
|
+
* @group Modules
|
|
568
|
+
* @category Identity
|
|
569
|
+
*
|
|
524
570
|
* @public
|
|
525
571
|
*/
|
|
526
572
|
export declare type ClearAuthorizationArtifactsResult = void;
|
|
@@ -528,6 +574,9 @@ export declare type ClearAuthorizationArtifactsResult = void;
|
|
|
528
574
|
/**
|
|
529
575
|
* Response when closing the container.
|
|
530
576
|
*
|
|
577
|
+
* @group Modules
|
|
578
|
+
* @category Container
|
|
579
|
+
*
|
|
531
580
|
* @remarks
|
|
532
581
|
* This response can have the following status codes:
|
|
533
582
|
* - `204`: Container closed successfully.
|
|
@@ -541,6 +590,9 @@ export declare type CloseResponse = InferOutput<typeof CloseResponseSchema>;
|
|
|
541
590
|
/**
|
|
542
591
|
* Valibot schema for {@link CloseResponse}.
|
|
543
592
|
*
|
|
593
|
+
* @group Modules
|
|
594
|
+
* @category Container
|
|
595
|
+
*
|
|
544
596
|
* @public
|
|
545
597
|
*/
|
|
546
598
|
export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -557,6 +609,9 @@ export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
557
609
|
* Result when closing the container.
|
|
558
610
|
* This operation returns no data on success.
|
|
559
611
|
*
|
|
612
|
+
* @group Modules
|
|
613
|
+
* @category Container
|
|
614
|
+
*
|
|
560
615
|
* @public
|
|
561
616
|
*/
|
|
562
617
|
export declare type CloseResult = void;
|
|
@@ -564,6 +619,9 @@ export declare type CloseResult = void;
|
|
|
564
619
|
/**
|
|
565
620
|
* Constants for container analytics event data.
|
|
566
621
|
*
|
|
622
|
+
* @group Modules
|
|
623
|
+
* @category Container
|
|
624
|
+
*
|
|
567
625
|
* @public
|
|
568
626
|
*/
|
|
569
627
|
export declare const ContainerAnalyticsEventData: {
|
|
@@ -575,6 +633,9 @@ export declare const ContainerAnalyticsEventData: {
|
|
|
575
633
|
/**
|
|
576
634
|
* Constants for container analytics event names.
|
|
577
635
|
*
|
|
636
|
+
* @group Modules
|
|
637
|
+
* @category Container
|
|
638
|
+
*
|
|
578
639
|
* @public
|
|
579
640
|
*/
|
|
580
641
|
export declare const ContainerAnalyticsEventName: {
|
|
@@ -584,6 +645,9 @@ export declare const ContainerAnalyticsEventName: {
|
|
|
584
645
|
/**
|
|
585
646
|
* Constants for container analytics event states.
|
|
586
647
|
*
|
|
648
|
+
* @group Modules
|
|
649
|
+
* @category Container
|
|
650
|
+
*
|
|
587
651
|
* @public
|
|
588
652
|
*/
|
|
589
653
|
export declare const ContainerAnalyticsEventState: {
|
|
@@ -597,6 +661,7 @@ export declare const ContainerAnalyticsEventState: {
|
|
|
597
661
|
* JSBridge module for controlling the WebView container.
|
|
598
662
|
*
|
|
599
663
|
* @group Modules
|
|
664
|
+
* @category Container
|
|
600
665
|
*
|
|
601
666
|
* @remarks
|
|
602
667
|
* Provides methods to interact with the WebView container.
|
|
@@ -1114,6 +1179,7 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1114
1179
|
* JSBridge module for querying native device information.
|
|
1115
1180
|
*
|
|
1116
1181
|
* @group Modules
|
|
1182
|
+
* @category Device
|
|
1117
1183
|
*
|
|
1118
1184
|
* @remarks
|
|
1119
1185
|
* Provides access to device checks exposed by the native Grab app bridge.
|
|
@@ -1190,6 +1256,9 @@ export declare class DeviceModule extends BaseModule {
|
|
|
1190
1256
|
/**
|
|
1191
1257
|
* Response when dismissing the splash screen.
|
|
1192
1258
|
*
|
|
1259
|
+
* @group Modules
|
|
1260
|
+
* @category Splash Screen
|
|
1261
|
+
*
|
|
1193
1262
|
* @remarks
|
|
1194
1263
|
* Possible status codes:
|
|
1195
1264
|
* - `204`: No splash screen shown, or it was closed successfully.
|
|
@@ -1229,6 +1298,9 @@ export declare type DismissSplashScreenResponse = InferOutput<typeof DismissSpla
|
|
|
1229
1298
|
/**
|
|
1230
1299
|
* Valibot schema for {@link DismissSplashScreenResponse}.
|
|
1231
1300
|
*
|
|
1301
|
+
* @group Modules
|
|
1302
|
+
* @category Splash Screen
|
|
1303
|
+
*
|
|
1232
1304
|
* @public
|
|
1233
1305
|
*/
|
|
1234
1306
|
export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1250,6 +1322,9 @@ export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectS
|
|
|
1250
1322
|
/**
|
|
1251
1323
|
* Request parameters for downloading a file via native bridge.
|
|
1252
1324
|
*
|
|
1325
|
+
* @group Modules
|
|
1326
|
+
* @category File
|
|
1327
|
+
*
|
|
1253
1328
|
* @example
|
|
1254
1329
|
* ```typescript
|
|
1255
1330
|
* {
|
|
@@ -1265,6 +1340,9 @@ export declare type DownloadFileRequest = InferOutput<typeof DownloadFileRequest
|
|
|
1265
1340
|
/**
|
|
1266
1341
|
* Valibot schema for {@link DownloadFileRequest}.
|
|
1267
1342
|
*
|
|
1343
|
+
* @group Modules
|
|
1344
|
+
* @category File
|
|
1345
|
+
*
|
|
1268
1346
|
* @public
|
|
1269
1347
|
*/
|
|
1270
1348
|
export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
@@ -1275,6 +1353,9 @@ export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
|
1275
1353
|
/**
|
|
1276
1354
|
* Response when requesting a native file download.
|
|
1277
1355
|
*
|
|
1356
|
+
* @group Modules
|
|
1357
|
+
* @category File
|
|
1358
|
+
*
|
|
1278
1359
|
* @remarks
|
|
1279
1360
|
* This response can have the following status codes:
|
|
1280
1361
|
* - `204`: File downloaded successfully.
|
|
@@ -1289,6 +1370,9 @@ export declare type DownloadFileResponse = InferOutput<typeof DownloadFileRespon
|
|
|
1289
1370
|
/**
|
|
1290
1371
|
* Valibot schema for {@link DownloadFileResponse}.
|
|
1291
1372
|
*
|
|
1373
|
+
* @group Modules
|
|
1374
|
+
* @category File
|
|
1375
|
+
*
|
|
1292
1376
|
* @public
|
|
1293
1377
|
*/
|
|
1294
1378
|
export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1307,6 +1391,9 @@ export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1307
1391
|
/**
|
|
1308
1392
|
* Result data structure for file download operations.
|
|
1309
1393
|
*
|
|
1394
|
+
* @group Modules
|
|
1395
|
+
* @category File
|
|
1396
|
+
*
|
|
1310
1397
|
* @remarks
|
|
1311
1398
|
* This is a void result type as successful downloads return status code 204 with no content.
|
|
1312
1399
|
*
|
|
@@ -1317,6 +1404,9 @@ export declare type DownloadFileResult = void;
|
|
|
1317
1404
|
/**
|
|
1318
1405
|
* DRM content configuration for playback.
|
|
1319
1406
|
*
|
|
1407
|
+
* @group Modules
|
|
1408
|
+
* @category Media
|
|
1409
|
+
*
|
|
1320
1410
|
* @remarks
|
|
1321
1411
|
* Configuration object containing DRM license information, content URLs, and playback settings.
|
|
1322
1412
|
* The exact structure depends on the DRM provider (e.g., FairPlay, Widevine).
|
|
@@ -1350,6 +1440,9 @@ export declare type DRMContentConfig = Record<string, unknown>;
|
|
|
1350
1440
|
/**
|
|
1351
1441
|
* Result object for DRM playback events.
|
|
1352
1442
|
*
|
|
1443
|
+
* @group Modules
|
|
1444
|
+
* @category Media
|
|
1445
|
+
*
|
|
1353
1446
|
* @example
|
|
1354
1447
|
* **Playback started event:**
|
|
1355
1448
|
* ```typescript
|
|
@@ -1390,6 +1483,9 @@ export declare type DRMPlaybackEvent = InferOutput<typeof DRMPlaybackEventSchema
|
|
|
1390
1483
|
/**
|
|
1391
1484
|
* Valibot schema for {@link DRMPlaybackEvent}.
|
|
1392
1485
|
*
|
|
1486
|
+
* @group Modules
|
|
1487
|
+
* @category Media
|
|
1488
|
+
*
|
|
1393
1489
|
* @public
|
|
1394
1490
|
*/
|
|
1395
1491
|
export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
@@ -1402,6 +1498,9 @@ export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
|
1402
1498
|
/**
|
|
1403
1499
|
* Response when fetching the user's email.
|
|
1404
1500
|
*
|
|
1501
|
+
* @group Modules
|
|
1502
|
+
* @category Profile
|
|
1503
|
+
*
|
|
1405
1504
|
* @remarks
|
|
1406
1505
|
* This response can have the following status codes:
|
|
1407
1506
|
* - `200`: Email fetched successfully. The `result` contains the email address.
|
|
@@ -1419,6 +1518,9 @@ export declare type FetchEmailResponse = InferOutput<typeof FetchEmailResponseSc
|
|
|
1419
1518
|
/**
|
|
1420
1519
|
* Valibot schema for {@link FetchEmailResponse}.
|
|
1421
1520
|
*
|
|
1521
|
+
* @group Modules
|
|
1522
|
+
* @category Profile
|
|
1523
|
+
*
|
|
1422
1524
|
* @public
|
|
1423
1525
|
*/
|
|
1424
1526
|
export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1448,6 +1550,9 @@ export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1448
1550
|
/**
|
|
1449
1551
|
* Result object containing the user's email address.
|
|
1450
1552
|
*
|
|
1553
|
+
* @group Modules
|
|
1554
|
+
* @category Profile
|
|
1555
|
+
*
|
|
1451
1556
|
* @example
|
|
1452
1557
|
* ```typescript
|
|
1453
1558
|
* { email: 'user@example.com' }
|
|
@@ -1460,6 +1565,9 @@ export declare type FetchEmailResult = InferOutput<typeof FetchEmailResultSchema
|
|
|
1460
1565
|
/**
|
|
1461
1566
|
* Valibot schema for {@link FetchEmailResult}.
|
|
1462
1567
|
*
|
|
1568
|
+
* @group Modules
|
|
1569
|
+
* @category Profile
|
|
1570
|
+
*
|
|
1463
1571
|
* @public
|
|
1464
1572
|
*/
|
|
1465
1573
|
export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
@@ -1470,6 +1578,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
|
1470
1578
|
* JSBridge module for downloading files to the user's device.
|
|
1471
1579
|
*
|
|
1472
1580
|
* @group Modules
|
|
1581
|
+
* @category File
|
|
1473
1582
|
*
|
|
1474
1583
|
* @remarks
|
|
1475
1584
|
* Initiates native file download handling in the Grab app using a file URL and file name.
|
|
@@ -1535,6 +1644,9 @@ export declare class FileModule extends BaseModule {
|
|
|
1535
1644
|
/**
|
|
1536
1645
|
* Response when retrieving stored authorization artifacts.
|
|
1537
1646
|
*
|
|
1647
|
+
* @group Modules
|
|
1648
|
+
* @category Identity
|
|
1649
|
+
*
|
|
1538
1650
|
* @remarks
|
|
1539
1651
|
* This response can have the following status codes:
|
|
1540
1652
|
* - `200`: All artifacts present. The `result` contains the PKCE artifacts needed for token exchange.
|
|
@@ -1548,6 +1660,9 @@ export declare type GetAuthorizationArtifactsResponse = InferOutput<typeof GetAu
|
|
|
1548
1660
|
/**
|
|
1549
1661
|
* Valibot schema for {@link GetAuthorizationArtifactsResponse}.
|
|
1550
1662
|
*
|
|
1663
|
+
* @group Modules
|
|
1664
|
+
* @category Identity
|
|
1665
|
+
*
|
|
1551
1666
|
* @public
|
|
1552
1667
|
*/
|
|
1553
1668
|
export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1569,6 +1684,9 @@ export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.O
|
|
|
1569
1684
|
* Result object containing the stored PKCE authorization artifacts.
|
|
1570
1685
|
* These are used to complete the OAuth2 authorization code exchange.
|
|
1571
1686
|
*
|
|
1687
|
+
* @group Modules
|
|
1688
|
+
* @category Identity
|
|
1689
|
+
*
|
|
1572
1690
|
* @example
|
|
1573
1691
|
* **All artifacts present:**
|
|
1574
1692
|
* ```typescript
|
|
@@ -1587,6 +1705,9 @@ export declare type GetAuthorizationArtifactsResult = InferOutput<typeof GetAuth
|
|
|
1587
1705
|
/**
|
|
1588
1706
|
* Valibot schema for {@link GetAuthorizationArtifactsResult}.
|
|
1589
1707
|
*
|
|
1708
|
+
* @group Modules
|
|
1709
|
+
* @category Identity
|
|
1710
|
+
*
|
|
1590
1711
|
* @public
|
|
1591
1712
|
*/
|
|
1592
1713
|
export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
@@ -1599,6 +1720,9 @@ export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
|
1599
1720
|
/**
|
|
1600
1721
|
* Request parameters for getting a boolean value from storage.
|
|
1601
1722
|
*
|
|
1723
|
+
* @group Modules
|
|
1724
|
+
* @category Storage
|
|
1725
|
+
*
|
|
1602
1726
|
* @example
|
|
1603
1727
|
* ```typescript
|
|
1604
1728
|
* { key: 'isDarkMode' }
|
|
@@ -1611,6 +1735,9 @@ export declare type GetBooleanRequest = InferOutput<typeof GetBooleanRequestSche
|
|
|
1611
1735
|
/**
|
|
1612
1736
|
* Valibot schema for {@link GetBooleanRequest}.
|
|
1613
1737
|
*
|
|
1738
|
+
* @group Modules
|
|
1739
|
+
* @category Storage
|
|
1740
|
+
*
|
|
1614
1741
|
* @public
|
|
1615
1742
|
*/
|
|
1616
1743
|
export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
@@ -1620,6 +1747,9 @@ export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
1620
1747
|
/**
|
|
1621
1748
|
* Response when getting a boolean value.
|
|
1622
1749
|
*
|
|
1750
|
+
* @group Modules
|
|
1751
|
+
* @category Storage
|
|
1752
|
+
*
|
|
1623
1753
|
* @remarks
|
|
1624
1754
|
* This response can have the following status codes:
|
|
1625
1755
|
* - `200`: Value retrieved successfully. The `result` contains the boolean value.
|
|
@@ -1636,6 +1766,9 @@ export declare type GetBooleanResponse = InferOutput<typeof GetBooleanResponseSc
|
|
|
1636
1766
|
/**
|
|
1637
1767
|
* Valibot schema for {@link GetBooleanResponse}.
|
|
1638
1768
|
*
|
|
1769
|
+
* @group Modules
|
|
1770
|
+
* @category Storage
|
|
1771
|
+
*
|
|
1639
1772
|
* @public
|
|
1640
1773
|
*/
|
|
1641
1774
|
export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1660,6 +1793,9 @@ export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1660
1793
|
/**
|
|
1661
1794
|
* The boolean value returned when a key exists in storage.
|
|
1662
1795
|
*
|
|
1796
|
+
* @group Modules
|
|
1797
|
+
* @category Storage
|
|
1798
|
+
*
|
|
1663
1799
|
* @remarks
|
|
1664
1800
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1665
1801
|
*
|
|
@@ -1675,6 +1811,9 @@ export declare type GetBooleanResult = InferOutput<typeof GetBooleanResultSchema
|
|
|
1675
1811
|
/**
|
|
1676
1812
|
* Valibot schema for {@link GetBooleanResult}.
|
|
1677
1813
|
*
|
|
1814
|
+
* @group Modules
|
|
1815
|
+
* @category Storage
|
|
1816
|
+
*
|
|
1678
1817
|
* @public
|
|
1679
1818
|
*/
|
|
1680
1819
|
export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
@@ -1682,6 +1821,9 @@ export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
|
1682
1821
|
/**
|
|
1683
1822
|
* Response when getting the device coordinates.
|
|
1684
1823
|
*
|
|
1824
|
+
* @group Modules
|
|
1825
|
+
* @category Location
|
|
1826
|
+
*
|
|
1685
1827
|
* @remarks
|
|
1686
1828
|
* This response can have the following status codes:
|
|
1687
1829
|
* - `200`: Coordinates retrieved successfully. The `result` contains latitude and longitude.
|
|
@@ -1697,6 +1839,9 @@ export declare type GetCoordinateResponse = InferOutput<typeof GetCoordinateResp
|
|
|
1697
1839
|
/**
|
|
1698
1840
|
* Valibot schema for {@link GetCoordinateResponse}.
|
|
1699
1841
|
*
|
|
1842
|
+
* @group Modules
|
|
1843
|
+
* @category Location
|
|
1844
|
+
*
|
|
1700
1845
|
* @public
|
|
1701
1846
|
*/
|
|
1702
1847
|
export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1722,6 +1867,9 @@ export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<
|
|
|
1722
1867
|
/**
|
|
1723
1868
|
* Result object containing the geographic coordinates.
|
|
1724
1869
|
*
|
|
1870
|
+
* @group Modules
|
|
1871
|
+
* @category Location
|
|
1872
|
+
*
|
|
1725
1873
|
* @example
|
|
1726
1874
|
* ```typescript
|
|
1727
1875
|
* { latitude: 1.3521, longitude: 103.8198 }
|
|
@@ -1734,6 +1882,9 @@ export declare type GetCoordinateResult = InferOutput<typeof GetCoordinateResult
|
|
|
1734
1882
|
/**
|
|
1735
1883
|
* Valibot schema for {@link GetCoordinateResult}.
|
|
1736
1884
|
*
|
|
1885
|
+
* @group Modules
|
|
1886
|
+
* @category Location
|
|
1887
|
+
*
|
|
1737
1888
|
* @public
|
|
1738
1889
|
*/
|
|
1739
1890
|
export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
@@ -1744,6 +1895,9 @@ export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
|
1744
1895
|
/**
|
|
1745
1896
|
* Response when getting the country code.
|
|
1746
1897
|
*
|
|
1898
|
+
* @group Modules
|
|
1899
|
+
* @category Location
|
|
1900
|
+
*
|
|
1747
1901
|
* @remarks
|
|
1748
1902
|
* This response can have the following status codes:
|
|
1749
1903
|
* - `200`: Country code retrieved successfully. The `result` is the ISO country code string.
|
|
@@ -1760,6 +1914,9 @@ export declare type GetCountryCodeResponse = InferOutput<typeof GetCountryCodeRe
|
|
|
1760
1914
|
/**
|
|
1761
1915
|
* Valibot schema for {@link GetCountryCodeResponse}.
|
|
1762
1916
|
*
|
|
1917
|
+
* @group Modules
|
|
1918
|
+
* @category Location
|
|
1919
|
+
*
|
|
1763
1920
|
* @public
|
|
1764
1921
|
*/
|
|
1765
1922
|
export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1784,6 +1941,9 @@ export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
1784
1941
|
/**
|
|
1785
1942
|
* The ISO country code string returned from the native bridge.
|
|
1786
1943
|
*
|
|
1944
|
+
* @group Modules
|
|
1945
|
+
* @category Location
|
|
1946
|
+
*
|
|
1787
1947
|
* @example
|
|
1788
1948
|
* ```typescript
|
|
1789
1949
|
* 'SG'
|
|
@@ -1801,6 +1961,9 @@ export declare type GetCountryCodeResult = InferOutput<typeof GetCountryCodeResu
|
|
|
1801
1961
|
/**
|
|
1802
1962
|
* Valibot schema for {@link GetCountryCodeResult}.
|
|
1803
1963
|
*
|
|
1964
|
+
* @group Modules
|
|
1965
|
+
* @category Location
|
|
1966
|
+
*
|
|
1804
1967
|
* @public
|
|
1805
1968
|
*/
|
|
1806
1969
|
export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
@@ -1808,6 +1971,9 @@ export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
|
1808
1971
|
/**
|
|
1809
1972
|
* Request parameters for getting a double value from storage.
|
|
1810
1973
|
*
|
|
1974
|
+
* @group Modules
|
|
1975
|
+
* @category Storage
|
|
1976
|
+
*
|
|
1811
1977
|
* @example
|
|
1812
1978
|
* ```typescript
|
|
1813
1979
|
* { key: 'price' }
|
|
@@ -1820,6 +1986,9 @@ export declare type GetDoubleRequest = InferOutput<typeof GetDoubleRequestSchema
|
|
|
1820
1986
|
/**
|
|
1821
1987
|
* Valibot schema for {@link GetDoubleRequest}.
|
|
1822
1988
|
*
|
|
1989
|
+
* @group Modules
|
|
1990
|
+
* @category Storage
|
|
1991
|
+
*
|
|
1823
1992
|
* @public
|
|
1824
1993
|
*/
|
|
1825
1994
|
export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
@@ -1829,6 +1998,9 @@ export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
1829
1998
|
/**
|
|
1830
1999
|
* Response when getting a double value.
|
|
1831
2000
|
*
|
|
2001
|
+
* @group Modules
|
|
2002
|
+
* @category Storage
|
|
2003
|
+
*
|
|
1832
2004
|
* @remarks
|
|
1833
2005
|
* This response can have the following status codes:
|
|
1834
2006
|
* - `200`: Value retrieved successfully. The `result` contains the double value.
|
|
@@ -1845,6 +2017,9 @@ export declare type GetDoubleResponse = InferOutput<typeof GetDoubleResponseSche
|
|
|
1845
2017
|
/**
|
|
1846
2018
|
* Valibot schema for {@link GetDoubleResponse}.
|
|
1847
2019
|
*
|
|
2020
|
+
* @group Modules
|
|
2021
|
+
* @category Storage
|
|
2022
|
+
*
|
|
1848
2023
|
* @public
|
|
1849
2024
|
*/
|
|
1850
2025
|
export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1869,6 +2044,9 @@ export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1869
2044
|
/**
|
|
1870
2045
|
* The floating-point value returned when a key exists in storage.
|
|
1871
2046
|
*
|
|
2047
|
+
* @group Modules
|
|
2048
|
+
* @category Storage
|
|
2049
|
+
*
|
|
1872
2050
|
* @remarks
|
|
1873
2051
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1874
2052
|
*
|
|
@@ -1884,6 +2062,9 @@ export declare type GetDoubleResult = InferOutput<typeof GetDoubleResultSchema>;
|
|
|
1884
2062
|
/**
|
|
1885
2063
|
* Valibot schema for {@link GetDoubleResult}.
|
|
1886
2064
|
*
|
|
2065
|
+
* @group Modules
|
|
2066
|
+
* @category Storage
|
|
2067
|
+
*
|
|
1887
2068
|
* @public
|
|
1888
2069
|
*/
|
|
1889
2070
|
export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
@@ -1891,6 +2072,9 @@ export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
|
1891
2072
|
/**
|
|
1892
2073
|
* Request parameters for getting an integer value from storage.
|
|
1893
2074
|
*
|
|
2075
|
+
* @group Modules
|
|
2076
|
+
* @category Storage
|
|
2077
|
+
*
|
|
1894
2078
|
* @example
|
|
1895
2079
|
* ```typescript
|
|
1896
2080
|
* { key: 'userCount' }
|
|
@@ -1903,6 +2087,9 @@ export declare type GetIntRequest = InferOutput<typeof GetIntRequestSchema>;
|
|
|
1903
2087
|
/**
|
|
1904
2088
|
* Valibot schema for {@link GetIntRequest}.
|
|
1905
2089
|
*
|
|
2090
|
+
* @group Modules
|
|
2091
|
+
* @category Storage
|
|
2092
|
+
*
|
|
1906
2093
|
* @public
|
|
1907
2094
|
*/
|
|
1908
2095
|
export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
@@ -1912,6 +2099,9 @@ export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
|
1912
2099
|
/**
|
|
1913
2100
|
* Response when getting an integer value.
|
|
1914
2101
|
*
|
|
2102
|
+
* @group Modules
|
|
2103
|
+
* @category Storage
|
|
2104
|
+
*
|
|
1915
2105
|
* @remarks
|
|
1916
2106
|
* This response can have the following status codes:
|
|
1917
2107
|
* - `200`: Value retrieved successfully. The `result` contains the integer value.
|
|
@@ -1928,6 +2118,9 @@ export declare type GetIntResponse = InferOutput<typeof GetIntResponseSchema>;
|
|
|
1928
2118
|
/**
|
|
1929
2119
|
* Valibot schema for {@link GetIntResponse}.
|
|
1930
2120
|
*
|
|
2121
|
+
* @group Modules
|
|
2122
|
+
* @category Storage
|
|
2123
|
+
*
|
|
1931
2124
|
* @public
|
|
1932
2125
|
*/
|
|
1933
2126
|
export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -1952,6 +2145,9 @@ export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1952
2145
|
/**
|
|
1953
2146
|
* The integer value returned when a key exists in storage.
|
|
1954
2147
|
*
|
|
2148
|
+
* @group Modules
|
|
2149
|
+
* @category Storage
|
|
2150
|
+
*
|
|
1955
2151
|
* @remarks
|
|
1956
2152
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
1957
2153
|
*
|
|
@@ -1967,6 +2163,9 @@ export declare type GetIntResult = InferOutput<typeof GetIntResultSchema>;
|
|
|
1967
2163
|
/**
|
|
1968
2164
|
* Valibot schema for {@link GetIntResult}.
|
|
1969
2165
|
*
|
|
2166
|
+
* @group Modules
|
|
2167
|
+
* @category Storage
|
|
2168
|
+
*
|
|
1970
2169
|
* @public
|
|
1971
2170
|
*/
|
|
1972
2171
|
export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
@@ -1974,6 +2173,9 @@ export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
|
1974
2173
|
/**
|
|
1975
2174
|
* Response when getting the language locale identifier from the device.
|
|
1976
2175
|
*
|
|
2176
|
+
* @group Modules
|
|
2177
|
+
* @category Locale
|
|
2178
|
+
*
|
|
1977
2179
|
* @remarks
|
|
1978
2180
|
* This response can have the following status codes:
|
|
1979
2181
|
* - `200`: Locale identifier retrieved successfully.
|
|
@@ -1989,6 +2191,9 @@ export declare type GetLanguageLocaleIdentifierResponse = InferOutput<typeof Get
|
|
|
1989
2191
|
/**
|
|
1990
2192
|
* Valibot schema for {@link GetLanguageLocaleIdentifierResponse}.
|
|
1991
2193
|
*
|
|
2194
|
+
* @group Modules
|
|
2195
|
+
* @category Locale
|
|
2196
|
+
*
|
|
1992
2197
|
* @public
|
|
1993
2198
|
*/
|
|
1994
2199
|
export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2010,6 +2215,9 @@ export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v
|
|
|
2010
2215
|
/**
|
|
2011
2216
|
* Result object containing the language locale identifier.
|
|
2012
2217
|
*
|
|
2218
|
+
* @group Modules
|
|
2219
|
+
* @category Locale
|
|
2220
|
+
*
|
|
2013
2221
|
* @remarks
|
|
2014
2222
|
* The locale identifier is the language code of the device's language settings.
|
|
2015
2223
|
* Common values include:
|
|
@@ -2041,6 +2249,9 @@ export declare type GetLanguageLocaleIdentifierResult = InferOutput<typeof GetLa
|
|
|
2041
2249
|
/**
|
|
2042
2250
|
* Valibot schema for {@link GetLanguageLocaleIdentifierResult}.
|
|
2043
2251
|
*
|
|
2252
|
+
* @group Modules
|
|
2253
|
+
* @category Locale
|
|
2254
|
+
*
|
|
2044
2255
|
* @public
|
|
2045
2256
|
*/
|
|
2046
2257
|
export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<undefined>;
|
|
@@ -2048,6 +2259,9 @@ export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<und
|
|
|
2048
2259
|
/**
|
|
2049
2260
|
* Response when reading the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
2050
2261
|
*
|
|
2262
|
+
* @group Modules
|
|
2263
|
+
* @category User Attributes
|
|
2264
|
+
*
|
|
2051
2265
|
* @remarks
|
|
2052
2266
|
* This response can have the following status codes:
|
|
2053
2267
|
* - `200`: The selected travel destination lowercase ISO 3166-1 alpha-2 country code was returned successfully.
|
|
@@ -2062,6 +2276,9 @@ export declare type GetSelectedTravelDestinationResponse = InferOutput<typeof Ge
|
|
|
2062
2276
|
/**
|
|
2063
2277
|
* Valibot schema for {@link GetSelectedTravelDestinationResponse}.
|
|
2064
2278
|
*
|
|
2279
|
+
* @group Modules
|
|
2280
|
+
* @category User Attributes
|
|
2281
|
+
*
|
|
2065
2282
|
* @public
|
|
2066
2283
|
*/
|
|
2067
2284
|
export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2080,6 +2297,9 @@ export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[
|
|
|
2080
2297
|
/**
|
|
2081
2298
|
* Result containing the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
2082
2299
|
*
|
|
2300
|
+
* @group Modules
|
|
2301
|
+
* @category User Attributes
|
|
2302
|
+
*
|
|
2083
2303
|
* @example
|
|
2084
2304
|
* ```typescript
|
|
2085
2305
|
* 'id'
|
|
@@ -2097,6 +2317,9 @@ export declare type GetSelectedTravelDestinationResult = InferOutput<typeof GetS
|
|
|
2097
2317
|
/**
|
|
2098
2318
|
* Valibot schema for {@link GetSelectedTravelDestinationResult}.
|
|
2099
2319
|
*
|
|
2320
|
+
* @group Modules
|
|
2321
|
+
* @category User Attributes
|
|
2322
|
+
*
|
|
2100
2323
|
* @public
|
|
2101
2324
|
*/
|
|
2102
2325
|
export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<undefined>;
|
|
@@ -2104,6 +2327,9 @@ export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<un
|
|
|
2104
2327
|
/**
|
|
2105
2328
|
* Response when getting session parameters.
|
|
2106
2329
|
*
|
|
2330
|
+
* @group Modules
|
|
2331
|
+
* @category Container
|
|
2332
|
+
*
|
|
2107
2333
|
* @remarks
|
|
2108
2334
|
* This response can have the following status codes:
|
|
2109
2335
|
* - `200`: Session parameters retrieved successfully.
|
|
@@ -2117,6 +2343,9 @@ export declare type GetSessionParamsResponse = InferOutput<typeof GetSessionPara
|
|
|
2117
2343
|
/**
|
|
2118
2344
|
* Valibot schema for {@link GetSessionParamsResponse}.
|
|
2119
2345
|
*
|
|
2346
|
+
* @group Modules
|
|
2347
|
+
* @category Container
|
|
2348
|
+
*
|
|
2120
2349
|
* @public
|
|
2121
2350
|
*/
|
|
2122
2351
|
export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2135,6 +2364,9 @@ export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSche
|
|
|
2135
2364
|
/**
|
|
2136
2365
|
* Result object containing session parameters as a JSON string.
|
|
2137
2366
|
*
|
|
2367
|
+
* @group Modules
|
|
2368
|
+
* @category Container
|
|
2369
|
+
*
|
|
2138
2370
|
* @remarks
|
|
2139
2371
|
* The `result` field contains a JSON string that must be parsed with `JSON.parse()` to use as an object.
|
|
2140
2372
|
* Session parameters can contain primitives, base64 encoded strings, or nested objects depending on the
|
|
@@ -2152,6 +2384,9 @@ export declare type GetSessionParamsResult = InferOutput<typeof GetSessionParams
|
|
|
2152
2384
|
/**
|
|
2153
2385
|
* Valibot schema for {@link GetSessionParamsResult}.
|
|
2154
2386
|
*
|
|
2387
|
+
* @group Modules
|
|
2388
|
+
* @category Container
|
|
2389
|
+
*
|
|
2155
2390
|
* @public
|
|
2156
2391
|
*/
|
|
2157
2392
|
export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
@@ -2159,6 +2394,9 @@ export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
|
2159
2394
|
/**
|
|
2160
2395
|
* Request parameters for getting a string value from storage.
|
|
2161
2396
|
*
|
|
2397
|
+
* @group Modules
|
|
2398
|
+
* @category Storage
|
|
2399
|
+
*
|
|
2162
2400
|
* @example
|
|
2163
2401
|
* ```typescript
|
|
2164
2402
|
* { key: 'username' }
|
|
@@ -2171,6 +2409,9 @@ export declare type GetStringRequest = InferOutput<typeof GetStringRequestSchema
|
|
|
2171
2409
|
/**
|
|
2172
2410
|
* Valibot schema for {@link GetStringRequest}.
|
|
2173
2411
|
*
|
|
2412
|
+
* @group Modules
|
|
2413
|
+
* @category Storage
|
|
2414
|
+
*
|
|
2174
2415
|
* @public
|
|
2175
2416
|
*/
|
|
2176
2417
|
export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
@@ -2180,6 +2421,9 @@ export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
|
2180
2421
|
/**
|
|
2181
2422
|
* Response when getting a string value.
|
|
2182
2423
|
*
|
|
2424
|
+
* @group Modules
|
|
2425
|
+
* @category Storage
|
|
2426
|
+
*
|
|
2183
2427
|
* @remarks
|
|
2184
2428
|
* This response can have the following status codes:
|
|
2185
2429
|
* - `200`: Value retrieved successfully. The `result` contains the string value.
|
|
@@ -2196,6 +2440,9 @@ export declare type GetStringResponse = InferOutput<typeof GetStringResponseSche
|
|
|
2196
2440
|
/**
|
|
2197
2441
|
* Valibot schema for {@link GetStringResponse}.
|
|
2198
2442
|
*
|
|
2443
|
+
* @group Modules
|
|
2444
|
+
* @category Storage
|
|
2445
|
+
*
|
|
2199
2446
|
* @public
|
|
2200
2447
|
*/
|
|
2201
2448
|
export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2220,6 +2467,9 @@ export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2220
2467
|
/**
|
|
2221
2468
|
* The string value returned when a key exists in storage.
|
|
2222
2469
|
*
|
|
2470
|
+
* @group Modules
|
|
2471
|
+
* @category Storage
|
|
2472
|
+
*
|
|
2223
2473
|
* @remarks
|
|
2224
2474
|
* When the key has no stored value, the response `status_code` is `204` instead.
|
|
2225
2475
|
*
|
|
@@ -2235,6 +2485,9 @@ export declare type GetStringResult = InferOutput<typeof GetStringResultSchema>;
|
|
|
2235
2485
|
/**
|
|
2236
2486
|
* Valibot schema for {@link GetStringResult}.
|
|
2237
2487
|
*
|
|
2488
|
+
* @group Modules
|
|
2489
|
+
* @category Storage
|
|
2490
|
+
*
|
|
2238
2491
|
* @public
|
|
2239
2492
|
*/
|
|
2240
2493
|
export declare const GetStringResultSchema: v.StringSchema<undefined>;
|
|
@@ -2242,6 +2495,8 @@ export declare const GetStringResultSchema: v.StringSchema<undefined>;
|
|
|
2242
2495
|
/**
|
|
2243
2496
|
* Represents parsed information from a Grab app user agent string.
|
|
2244
2497
|
*
|
|
2498
|
+
* @group Core
|
|
2499
|
+
*
|
|
2245
2500
|
* @public
|
|
2246
2501
|
*/
|
|
2247
2502
|
export declare interface GrabAppInfo {
|
|
@@ -2253,6 +2508,9 @@ export declare interface GrabAppInfo {
|
|
|
2253
2508
|
/**
|
|
2254
2509
|
* Request parameters for checking if the current client has access to a specific API.
|
|
2255
2510
|
*
|
|
2511
|
+
* @group Modules
|
|
2512
|
+
* @category Scope
|
|
2513
|
+
*
|
|
2256
2514
|
* @example
|
|
2257
2515
|
* ```typescript
|
|
2258
2516
|
* {
|
|
@@ -2268,6 +2526,9 @@ export declare type HasAccessToRequest = InferOutput<typeof HasAccessToRequestSc
|
|
|
2268
2526
|
/**
|
|
2269
2527
|
* Valibot schema for {@link HasAccessToRequest}.
|
|
2270
2528
|
*
|
|
2529
|
+
* @group Modules
|
|
2530
|
+
* @category Scope
|
|
2531
|
+
*
|
|
2271
2532
|
* @public
|
|
2272
2533
|
*/
|
|
2273
2534
|
export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
@@ -2278,6 +2539,9 @@ export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
|
2278
2539
|
/**
|
|
2279
2540
|
* Response when checking API access permissions.
|
|
2280
2541
|
*
|
|
2542
|
+
* @group Modules
|
|
2543
|
+
* @category Scope
|
|
2544
|
+
*
|
|
2281
2545
|
* @remarks
|
|
2282
2546
|
* This response can have the following status codes:
|
|
2283
2547
|
* - `200`: Access check completed successfully. The `result` contains the access status.
|
|
@@ -2293,6 +2557,9 @@ export declare type HasAccessToResponse = InferOutput<typeof HasAccessToResponse
|
|
|
2293
2557
|
/**
|
|
2294
2558
|
* Valibot schema for {@link HasAccessToResponse}.
|
|
2295
2559
|
*
|
|
2560
|
+
* @group Modules
|
|
2561
|
+
* @category Scope
|
|
2562
|
+
*
|
|
2296
2563
|
* @public
|
|
2297
2564
|
*/
|
|
2298
2565
|
export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2315,6 +2582,9 @@ export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2315
2582
|
/**
|
|
2316
2583
|
* Boolean result indicating whether the MiniApp has access to the specified API.
|
|
2317
2584
|
*
|
|
2585
|
+
* @group Modules
|
|
2586
|
+
* @category Scope
|
|
2587
|
+
*
|
|
2318
2588
|
* @example
|
|
2319
2589
|
* **Has access:**
|
|
2320
2590
|
* ```typescript
|
|
@@ -2334,6 +2604,9 @@ export declare type HasAccessToResult = InferOutput<typeof HasAccessToResultSche
|
|
|
2334
2604
|
/**
|
|
2335
2605
|
* Valibot schema for {@link HasAccessToResult}.
|
|
2336
2606
|
*
|
|
2607
|
+
* @group Modules
|
|
2608
|
+
* @category Scope
|
|
2609
|
+
*
|
|
2337
2610
|
* @public
|
|
2338
2611
|
*/
|
|
2339
2612
|
export declare const HasAccessToResultSchema: v.BooleanSchema<undefined>;
|
|
@@ -2341,6 +2614,8 @@ export declare const HasAccessToResultSchema: v.BooleanSchema<undefined>;
|
|
|
2341
2614
|
/**
|
|
2342
2615
|
* Type guard to check if a JSBridge response has a defined result (not null or undefined).
|
|
2343
2616
|
*
|
|
2617
|
+
* @group Type Guards
|
|
2618
|
+
*
|
|
2344
2619
|
* @param response - The JSBridge response to check
|
|
2345
2620
|
* @returns True if the response has a result that is neither null nor undefined, false otherwise
|
|
2346
2621
|
*
|
|
@@ -2362,6 +2637,9 @@ export declare function hasResult<T extends BridgeResponse>(response: T): respon
|
|
|
2362
2637
|
/**
|
|
2363
2638
|
* Response when hiding the back button.
|
|
2364
2639
|
*
|
|
2640
|
+
* @group Modules
|
|
2641
|
+
* @category Container
|
|
2642
|
+
*
|
|
2365
2643
|
* @remarks
|
|
2366
2644
|
* This response can have the following status codes:
|
|
2367
2645
|
* - `204`: Back button hidden successfully.
|
|
@@ -2375,6 +2653,9 @@ export declare type HideBackButtonResponse = InferOutput<typeof HideBackButtonRe
|
|
|
2375
2653
|
/**
|
|
2376
2654
|
* Valibot schema for {@link HideBackButtonResponse}.
|
|
2377
2655
|
*
|
|
2656
|
+
* @group Modules
|
|
2657
|
+
* @category Container
|
|
2658
|
+
*
|
|
2378
2659
|
* @public
|
|
2379
2660
|
*/
|
|
2380
2661
|
export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2391,6 +2672,9 @@ export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
2391
2672
|
* Result when hiding the back button.
|
|
2392
2673
|
* This operation returns no data on success.
|
|
2393
2674
|
*
|
|
2675
|
+
* @group Modules
|
|
2676
|
+
* @category Container
|
|
2677
|
+
*
|
|
2394
2678
|
* @public
|
|
2395
2679
|
*/
|
|
2396
2680
|
export declare type HideBackButtonResult = void;
|
|
@@ -2398,6 +2682,9 @@ export declare type HideBackButtonResult = void;
|
|
|
2398
2682
|
/**
|
|
2399
2683
|
* Response when hiding the loader.
|
|
2400
2684
|
*
|
|
2685
|
+
* @group Modules
|
|
2686
|
+
* @category Container
|
|
2687
|
+
*
|
|
2401
2688
|
* @remarks
|
|
2402
2689
|
* This response can have the following status codes:
|
|
2403
2690
|
* - `204`: Loader hidden successfully.
|
|
@@ -2411,6 +2698,9 @@ export declare type HideLoaderResponse = InferOutput<typeof HideLoaderResponseSc
|
|
|
2411
2698
|
/**
|
|
2412
2699
|
* Valibot schema for {@link HideLoaderResponse}.
|
|
2413
2700
|
*
|
|
2701
|
+
* @group Modules
|
|
2702
|
+
* @category Container
|
|
2703
|
+
*
|
|
2414
2704
|
* @public
|
|
2415
2705
|
*/
|
|
2416
2706
|
export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2427,6 +2717,9 @@ export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2427
2717
|
* Result when hiding the loader.
|
|
2428
2718
|
* This operation returns no data on success.
|
|
2429
2719
|
*
|
|
2720
|
+
* @group Modules
|
|
2721
|
+
* @category Container
|
|
2722
|
+
*
|
|
2430
2723
|
* @public
|
|
2431
2724
|
*/
|
|
2432
2725
|
export declare type HideLoaderResult = void;
|
|
@@ -2434,6 +2727,9 @@ export declare type HideLoaderResult = void;
|
|
|
2434
2727
|
/**
|
|
2435
2728
|
* Response when hiding the refresh button.
|
|
2436
2729
|
*
|
|
2730
|
+
* @group Modules
|
|
2731
|
+
* @category Container
|
|
2732
|
+
*
|
|
2437
2733
|
* @remarks
|
|
2438
2734
|
* This response can have the following status codes:
|
|
2439
2735
|
* - `204`: Refresh button hidden successfully.
|
|
@@ -2447,6 +2743,9 @@ export declare type HideRefreshButtonResponse = InferOutput<typeof HideRefreshBu
|
|
|
2447
2743
|
/**
|
|
2448
2744
|
* Valibot schema for {@link HideRefreshButtonResponse}.
|
|
2449
2745
|
*
|
|
2746
|
+
* @group Modules
|
|
2747
|
+
* @category Container
|
|
2748
|
+
*
|
|
2450
2749
|
* @public
|
|
2451
2750
|
*/
|
|
2452
2751
|
export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2463,6 +2762,9 @@ export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
2463
2762
|
* Result when hiding the refresh button.
|
|
2464
2763
|
* This operation returns no data on success.
|
|
2465
2764
|
*
|
|
2765
|
+
* @group Modules
|
|
2766
|
+
* @category Container
|
|
2767
|
+
*
|
|
2466
2768
|
* @public
|
|
2467
2769
|
*/
|
|
2468
2770
|
export declare type HideRefreshButtonResult = void;
|
|
@@ -2471,6 +2773,7 @@ export declare type HideRefreshButtonResult = void;
|
|
|
2471
2773
|
* JSBridge module for authenticating users via GrabID.
|
|
2472
2774
|
*
|
|
2473
2775
|
* @group Modules
|
|
2776
|
+
* @category Identity
|
|
2474
2777
|
*
|
|
2475
2778
|
* @remarks
|
|
2476
2779
|
* Handles OAuth2/OIDC authentication flows with PKCE support, enabling MiniApps to obtain user identity tokens.
|
|
@@ -2756,6 +3059,8 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2756
3059
|
/**
|
|
2757
3060
|
* Options for invoking a JSBridge method.
|
|
2758
3061
|
*
|
|
3062
|
+
* @group Core
|
|
3063
|
+
*
|
|
2759
3064
|
* @public
|
|
2760
3065
|
*/
|
|
2761
3066
|
export declare interface InvokeOptions {
|
|
@@ -2768,6 +3073,8 @@ export declare interface InvokeOptions {
|
|
|
2768
3073
|
/**
|
|
2769
3074
|
* Type guard to check if a JSBridge response is a client error (4xx status codes).
|
|
2770
3075
|
*
|
|
3076
|
+
* @group Type Guards
|
|
3077
|
+
*
|
|
2771
3078
|
* @param response - The JSBridge response to check
|
|
2772
3079
|
* @returns True if the response is a client error (400-499), false otherwise
|
|
2773
3080
|
*
|
|
@@ -2788,6 +3095,9 @@ export declare function isClientError<T extends BridgeResponse>(response: T): re
|
|
|
2788
3095
|
/**
|
|
2789
3096
|
* Response when checking connection status.
|
|
2790
3097
|
*
|
|
3098
|
+
* @group Modules
|
|
3099
|
+
* @category Container
|
|
3100
|
+
*
|
|
2791
3101
|
* @remarks
|
|
2792
3102
|
* This response can have the following status codes:
|
|
2793
3103
|
* - `200`: Connected to Grab SuperApp. The `result` contains the connection status.
|
|
@@ -2800,6 +3110,9 @@ export declare type IsConnectedResponse = InferOutput<typeof IsConnectedResponse
|
|
|
2800
3110
|
/**
|
|
2801
3111
|
* Valibot schema for {@link IsConnectedResponse}.
|
|
2802
3112
|
*
|
|
3113
|
+
* @group Modules
|
|
3114
|
+
* @category Container
|
|
3115
|
+
*
|
|
2803
3116
|
* @public
|
|
2804
3117
|
*/
|
|
2805
3118
|
export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2815,6 +3128,9 @@ export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2815
3128
|
/**
|
|
2816
3129
|
* Result object containing the connection status.
|
|
2817
3130
|
*
|
|
3131
|
+
* @group Modules
|
|
3132
|
+
* @category Container
|
|
3133
|
+
*
|
|
2818
3134
|
* @example
|
|
2819
3135
|
* **Connected to Grab SuperApp:**
|
|
2820
3136
|
* ```typescript
|
|
@@ -2834,6 +3150,9 @@ export declare type IsConnectedResult = InferOutput<typeof IsConnectedResultSche
|
|
|
2834
3150
|
/**
|
|
2835
3151
|
* Valibot schema for {@link IsConnectedResult}.
|
|
2836
3152
|
*
|
|
3153
|
+
* @group Modules
|
|
3154
|
+
* @category Container
|
|
3155
|
+
*
|
|
2837
3156
|
* @public
|
|
2838
3157
|
*/
|
|
2839
3158
|
export declare const IsConnectedResultSchema: v.ObjectSchema<{
|
|
@@ -2843,6 +3162,8 @@ export declare const IsConnectedResultSchema: v.ObjectSchema<{
|
|
|
2843
3162
|
/**
|
|
2844
3163
|
* Type guard to check if a JSBridge response is an error (4xx or 5xx status codes).
|
|
2845
3164
|
*
|
|
3165
|
+
* @group Type Guards
|
|
3166
|
+
*
|
|
2846
3167
|
* @param response - The JSBridge response to check
|
|
2847
3168
|
* @returns True if the response is any error (4xx or 5xx), false otherwise
|
|
2848
3169
|
*
|
|
@@ -2866,6 +3187,9 @@ export declare function isError<T extends BridgeResponse>(response: T): response
|
|
|
2866
3187
|
/**
|
|
2867
3188
|
* Response when checking whether the current device supports eSIM.
|
|
2868
3189
|
*
|
|
3190
|
+
* @group Modules
|
|
3191
|
+
* @category Device
|
|
3192
|
+
*
|
|
2869
3193
|
* @remarks
|
|
2870
3194
|
* This response can have the following status codes:
|
|
2871
3195
|
* - `200`: eSIM capability was checked successfully. The `result` contains `true` or `false`.
|
|
@@ -2882,6 +3206,9 @@ export declare type IsEsimSupportedResponse = InferOutput<typeof IsEsimSupported
|
|
|
2882
3206
|
/**
|
|
2883
3207
|
* Valibot schema for {@link IsEsimSupportedResponse}.
|
|
2884
3208
|
*
|
|
3209
|
+
* @group Modules
|
|
3210
|
+
* @category Device
|
|
3211
|
+
*
|
|
2885
3212
|
* @public
|
|
2886
3213
|
*/
|
|
2887
3214
|
export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -2907,6 +3234,9 @@ export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
2907
3234
|
/**
|
|
2908
3235
|
* Result indicating whether the current device supports eSIM.
|
|
2909
3236
|
*
|
|
3237
|
+
* @group Modules
|
|
3238
|
+
* @category Device
|
|
3239
|
+
*
|
|
2910
3240
|
* @example
|
|
2911
3241
|
* ```typescript
|
|
2912
3242
|
* true
|
|
@@ -2924,6 +3254,9 @@ export declare type IsEsimSupportedResult = InferOutput<typeof IsEsimSupportedRe
|
|
|
2924
3254
|
/**
|
|
2925
3255
|
* Valibot schema for {@link IsEsimSupportedResult}.
|
|
2926
3256
|
*
|
|
3257
|
+
* @group Modules
|
|
3258
|
+
* @category Device
|
|
3259
|
+
*
|
|
2927
3260
|
* @public
|
|
2928
3261
|
*/
|
|
2929
3262
|
export declare const IsEsimSupportedResultSchema: v.BooleanSchema<undefined>;
|
|
@@ -2931,6 +3264,8 @@ export declare const IsEsimSupportedResultSchema: v.BooleanSchema<undefined>;
|
|
|
2931
3264
|
/**
|
|
2932
3265
|
* Type guard to check if a JSBridge response is a 302 Found redirect.
|
|
2933
3266
|
*
|
|
3267
|
+
* @group Type Guards
|
|
3268
|
+
*
|
|
2934
3269
|
* @param response - The JSBridge response to check
|
|
2935
3270
|
* @returns True if the response has status code 302, false otherwise
|
|
2936
3271
|
*
|
|
@@ -2943,6 +3278,8 @@ export declare function isFound<T extends BridgeResponse>(response: T): response
|
|
|
2943
3278
|
/**
|
|
2944
3279
|
* Type guard to check if a JSBridge response is a 204 No Content (operation succeeded with no result).
|
|
2945
3280
|
*
|
|
3281
|
+
* @group Type Guards
|
|
3282
|
+
*
|
|
2946
3283
|
* @param response - The JSBridge response to check
|
|
2947
3284
|
* @returns True if the response has status code 204, false otherwise
|
|
2948
3285
|
*
|
|
@@ -2955,6 +3292,8 @@ export declare function isNoContent<T extends BridgeResponse>(response: T): resp
|
|
|
2955
3292
|
/**
|
|
2956
3293
|
* Type guard to check if a JSBridge response is a 200 OK (operation succeeded with a result).
|
|
2957
3294
|
*
|
|
3295
|
+
* @group Type Guards
|
|
3296
|
+
*
|
|
2958
3297
|
* @param response - The JSBridge response to check
|
|
2959
3298
|
* @returns True if the response has status code 200, false otherwise
|
|
2960
3299
|
*
|
|
@@ -2967,6 +3306,8 @@ export declare function isOk<T extends BridgeResponse>(response: T): response is
|
|
|
2967
3306
|
/**
|
|
2968
3307
|
* Type guard to check if a JSBridge response is a redirect (status code 302).
|
|
2969
3308
|
*
|
|
3309
|
+
* @group Type Guards
|
|
3310
|
+
*
|
|
2970
3311
|
* @param response - The JSBridge response to check
|
|
2971
3312
|
* @returns True if the response is a redirect (302), false otherwise
|
|
2972
3313
|
*
|
|
@@ -2987,6 +3328,8 @@ export declare function isRedirection<T extends BridgeResponse>(response: T): re
|
|
|
2987
3328
|
/**
|
|
2988
3329
|
* Type guard to check if a JSBridge response is a server error (5xx status codes).
|
|
2989
3330
|
*
|
|
3331
|
+
* @group Type Guards
|
|
3332
|
+
*
|
|
2990
3333
|
* @param response - The JSBridge response to check
|
|
2991
3334
|
* @returns True if the response is a server error (500-599), false otherwise
|
|
2992
3335
|
*
|
|
@@ -3007,6 +3350,8 @@ export declare function isServerError<T extends BridgeResponse>(response: T): re
|
|
|
3007
3350
|
/**
|
|
3008
3351
|
* Type guard to check if a JSBridge response is successful (2xx status codes).
|
|
3009
3352
|
*
|
|
3353
|
+
* @group Type Guards
|
|
3354
|
+
*
|
|
3010
3355
|
* @param response - The JSBridge response to check
|
|
3011
3356
|
* @returns True if the response is successful (200-299), false otherwise
|
|
3012
3357
|
*
|
|
@@ -3029,6 +3374,7 @@ export declare function isSuccess<T extends BridgeResponse>(response: T): respon
|
|
|
3029
3374
|
* JSBridge module for accessing device locale settings.
|
|
3030
3375
|
*
|
|
3031
3376
|
* @group Modules
|
|
3377
|
+
* @category Locale
|
|
3032
3378
|
*
|
|
3033
3379
|
* @remarks
|
|
3034
3380
|
* Provides the user's preferred language and region settings from the native device.
|
|
@@ -3090,6 +3436,7 @@ export declare class LocaleModule extends BaseModule {
|
|
|
3090
3436
|
* JSBridge module for accessing device location services.
|
|
3091
3437
|
*
|
|
3092
3438
|
* @group Modules
|
|
3439
|
+
* @category Location
|
|
3093
3440
|
*
|
|
3094
3441
|
* @remarks
|
|
3095
3442
|
* Provides access to the device's geolocation data including coordinates and country code.
|
|
@@ -3244,6 +3591,8 @@ export declare class LocationModule extends BaseModule {
|
|
|
3244
3591
|
/**
|
|
3245
3592
|
* Provides scoped logging for SDK modules.
|
|
3246
3593
|
*
|
|
3594
|
+
* @group Core
|
|
3595
|
+
*
|
|
3247
3596
|
* @remarks
|
|
3248
3597
|
* Log messages are prefixed with `[SuperAppSDK][ModuleName.methodName]`
|
|
3249
3598
|
* (e.g. `[SuperAppSDK][ContainerModule.setTitle] An error occurred`).
|
|
@@ -3262,6 +3611,7 @@ export declare class Logger {
|
|
|
3262
3611
|
* JSBridge module for playing DRM-protected media content.
|
|
3263
3612
|
*
|
|
3264
3613
|
* @group Modules
|
|
3614
|
+
* @category Media
|
|
3265
3615
|
*
|
|
3266
3616
|
* @remarks
|
|
3267
3617
|
* Provides access to the native media player with DRM support for secure content playback.
|
|
@@ -3382,6 +3732,7 @@ export declare class MediaModule extends BaseModule {
|
|
|
3382
3732
|
* JSBridge module for making network requests via the native bridge.
|
|
3383
3733
|
*
|
|
3384
3734
|
* @group Modules
|
|
3735
|
+
* @category Network
|
|
3385
3736
|
*
|
|
3386
3737
|
* @remarks
|
|
3387
3738
|
* Provides access to native network functionality for making HTTP requests.
|
|
@@ -3452,6 +3803,9 @@ export declare class NetworkModule extends BaseModule {
|
|
|
3452
3803
|
/**
|
|
3453
3804
|
* Response stream for observing DRM playback events.
|
|
3454
3805
|
*
|
|
3806
|
+
* @group Modules
|
|
3807
|
+
* @category Media
|
|
3808
|
+
*
|
|
3455
3809
|
* @remarks
|
|
3456
3810
|
* This is a `BridgeStream` that can be:
|
|
3457
3811
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
@@ -3464,6 +3818,9 @@ export declare class NetworkModule extends BaseModule {
|
|
|
3464
3818
|
export declare type ObserveDRMPlaybackResponse = BridgeStream<InferOutput<typeof ObserveDRMPlaybackResponseSchema>>;
|
|
3465
3819
|
|
|
3466
3820
|
/**
|
|
3821
|
+
* @group Modules
|
|
3822
|
+
* @category Media
|
|
3823
|
+
*
|
|
3467
3824
|
* @public
|
|
3468
3825
|
*/
|
|
3469
3826
|
export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3485,6 +3842,9 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
3485
3842
|
/**
|
|
3486
3843
|
* Response when observing the device coordinates.
|
|
3487
3844
|
*
|
|
3845
|
+
* @group Modules
|
|
3846
|
+
* @category Location
|
|
3847
|
+
*
|
|
3488
3848
|
* @remarks
|
|
3489
3849
|
* This is a `BridgeStream` that can be:
|
|
3490
3850
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
@@ -3499,6 +3859,9 @@ export declare type ObserveLocationChangeResponse = BridgeStream<GetCoordinateRe
|
|
|
3499
3859
|
/**
|
|
3500
3860
|
* Response when notifying content loaded.
|
|
3501
3861
|
*
|
|
3862
|
+
* @group Modules
|
|
3863
|
+
* @category Container
|
|
3864
|
+
*
|
|
3502
3865
|
* @remarks
|
|
3503
3866
|
* This response can have the following status codes:
|
|
3504
3867
|
* - `200`: Notification sent successfully.
|
|
@@ -3513,6 +3876,9 @@ export declare type OnContentLoadedResponse = InferOutput<typeof OnContentLoaded
|
|
|
3513
3876
|
/**
|
|
3514
3877
|
* Valibot schema for {@link OnContentLoadedResponse}.
|
|
3515
3878
|
*
|
|
3879
|
+
* @group Modules
|
|
3880
|
+
* @category Container
|
|
3881
|
+
*
|
|
3516
3882
|
* @public
|
|
3517
3883
|
*/
|
|
3518
3884
|
export declare const OnContentLoadedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3532,6 +3898,9 @@ export declare const OnContentLoadedResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
3532
3898
|
* Result when notifying content loaded.
|
|
3533
3899
|
* This operation returns no data on success.
|
|
3534
3900
|
*
|
|
3901
|
+
* @group Modules
|
|
3902
|
+
* @category Container
|
|
3903
|
+
*
|
|
3535
3904
|
* @public
|
|
3536
3905
|
*/
|
|
3537
3906
|
export declare type OnContentLoadedResult = void;
|
|
@@ -3539,6 +3908,9 @@ export declare type OnContentLoadedResult = void;
|
|
|
3539
3908
|
/**
|
|
3540
3909
|
* Request parameters for notifying CTA tap.
|
|
3541
3910
|
*
|
|
3911
|
+
* @group Modules
|
|
3912
|
+
* @category Container
|
|
3913
|
+
*
|
|
3542
3914
|
* @example
|
|
3543
3915
|
* ```typescript
|
|
3544
3916
|
* 'AV_LANDING_PAGE_CONTINUE'
|
|
@@ -3551,6 +3923,9 @@ export declare type OnCtaTapRequest = string;
|
|
|
3551
3923
|
/**
|
|
3552
3924
|
* Response when notifying CTA tap.
|
|
3553
3925
|
*
|
|
3926
|
+
* @group Modules
|
|
3927
|
+
* @category Container
|
|
3928
|
+
*
|
|
3554
3929
|
* @remarks
|
|
3555
3930
|
* This response can have the following status codes:
|
|
3556
3931
|
* - `200`: CTA tap notification sent successfully.
|
|
@@ -3564,6 +3939,9 @@ export declare type OnCtaTapResponse = InferOutput<typeof OnCtaTapResponseSchema
|
|
|
3564
3939
|
/**
|
|
3565
3940
|
* Valibot schema for {@link OnCtaTapResponse}.
|
|
3566
3941
|
*
|
|
3942
|
+
* @group Modules
|
|
3943
|
+
* @category Container
|
|
3944
|
+
*
|
|
3567
3945
|
* @public
|
|
3568
3946
|
*/
|
|
3569
3947
|
export declare const OnCtaTapResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3581,6 +3959,9 @@ export declare const OnCtaTapResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
3581
3959
|
* Result when notifying CTA tap.
|
|
3582
3960
|
* This operation returns no data on success.
|
|
3583
3961
|
*
|
|
3962
|
+
* @group Modules
|
|
3963
|
+
* @category Container
|
|
3964
|
+
*
|
|
3584
3965
|
* @public
|
|
3585
3966
|
*/
|
|
3586
3967
|
export declare type OnCtaTapResult = void;
|
|
@@ -3588,6 +3969,9 @@ export declare type OnCtaTapResult = void;
|
|
|
3588
3969
|
/**
|
|
3589
3970
|
* Request parameters for opening an external link.
|
|
3590
3971
|
*
|
|
3972
|
+
* @group Modules
|
|
3973
|
+
* @category Container
|
|
3974
|
+
*
|
|
3591
3975
|
* @example
|
|
3592
3976
|
* ```typescript
|
|
3593
3977
|
* 'https://example.com'
|
|
@@ -3600,6 +3984,9 @@ export declare type OpenExternalLinkRequest = string;
|
|
|
3600
3984
|
/**
|
|
3601
3985
|
* Response when opening an external link.
|
|
3602
3986
|
*
|
|
3987
|
+
* @group Modules
|
|
3988
|
+
* @category Container
|
|
3989
|
+
*
|
|
3603
3990
|
* @remarks
|
|
3604
3991
|
* This response can have the following status codes:
|
|
3605
3992
|
* - `204`: External link opened successfully.
|
|
@@ -3614,6 +4001,9 @@ export declare type OpenExternalLinkResponse = InferOutput<typeof OpenExternalLi
|
|
|
3614
4001
|
/**
|
|
3615
4002
|
* Valibot schema for {@link OpenExternalLinkResponse}.
|
|
3616
4003
|
*
|
|
4004
|
+
* @group Modules
|
|
4005
|
+
* @category Container
|
|
4006
|
+
*
|
|
3617
4007
|
* @public
|
|
3618
4008
|
*/
|
|
3619
4009
|
export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3633,6 +4023,9 @@ export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSche
|
|
|
3633
4023
|
* Result when opening an external link.
|
|
3634
4024
|
* This operation returns no data on success.
|
|
3635
4025
|
*
|
|
4026
|
+
* @group Modules
|
|
4027
|
+
* @category Container
|
|
4028
|
+
*
|
|
3636
4029
|
* @public
|
|
3637
4030
|
*/
|
|
3638
4031
|
export declare type OpenExternalLinkResult = void;
|
|
@@ -3640,6 +4033,8 @@ export declare type OpenExternalLinkResult = void;
|
|
|
3640
4033
|
/**
|
|
3641
4034
|
* Represents the mobile operating system platform.
|
|
3642
4035
|
*
|
|
4036
|
+
* @group Core
|
|
4037
|
+
*
|
|
3643
4038
|
* @public
|
|
3644
4039
|
*/
|
|
3645
4040
|
export declare type Platform = 'Android' | 'iOS';
|
|
@@ -3648,6 +4043,7 @@ export declare type Platform = 'Android' | 'iOS';
|
|
|
3648
4043
|
* JSBridge module for controlling platform navigation.
|
|
3649
4044
|
*
|
|
3650
4045
|
* @group Modules
|
|
4046
|
+
* @category Platform
|
|
3651
4047
|
*
|
|
3652
4048
|
* @remarks
|
|
3653
4049
|
* Provides methods to interact with the native platform navigation stack, such as triggering the back action.
|
|
@@ -3709,6 +4105,9 @@ export declare class PlatformModule extends BaseModule {
|
|
|
3709
4105
|
/**
|
|
3710
4106
|
* Response when initiating DRM content playback.
|
|
3711
4107
|
*
|
|
4108
|
+
* @group Modules
|
|
4109
|
+
* @category Media
|
|
4110
|
+
*
|
|
3712
4111
|
* @remarks
|
|
3713
4112
|
* This response can have the following status codes:
|
|
3714
4113
|
* - `200`: Playback initiated successfully (streaming content).
|
|
@@ -3723,6 +4122,9 @@ export declare type PlayDRMContentResponse = InferOutput<typeof PlayDRMContentRe
|
|
|
3723
4122
|
/**
|
|
3724
4123
|
* Valibot schema for {@link PlayDRMContentResponse}.
|
|
3725
4124
|
*
|
|
4125
|
+
* @group Modules
|
|
4126
|
+
* @category Media
|
|
4127
|
+
*
|
|
3726
4128
|
* @public
|
|
3727
4129
|
*/
|
|
3728
4130
|
export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3753,6 +4155,9 @@ export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
3753
4155
|
* Result object for DRM content playback initiation.
|
|
3754
4156
|
* This operation returns no data on success.
|
|
3755
4157
|
*
|
|
4158
|
+
* @group Modules
|
|
4159
|
+
* @category Media
|
|
4160
|
+
*
|
|
3756
4161
|
* @public
|
|
3757
4162
|
*/
|
|
3758
4163
|
export declare type PlayDRMContentResult = void;
|
|
@@ -3761,6 +4166,7 @@ export declare type PlayDRMContentResult = void;
|
|
|
3761
4166
|
* JSBridge module for accessing user profile information.
|
|
3762
4167
|
*
|
|
3763
4168
|
* @group Modules
|
|
4169
|
+
* @category Profile
|
|
3764
4170
|
*
|
|
3765
4171
|
* @remarks
|
|
3766
4172
|
* Provides access to user profile data such as email verification.
|
|
@@ -3905,6 +4311,9 @@ export declare class ProfileModule extends BaseModule {
|
|
|
3905
4311
|
/**
|
|
3906
4312
|
* Request parameters for redirecting to the system web view.
|
|
3907
4313
|
*
|
|
4314
|
+
* @group Modules
|
|
4315
|
+
* @category System WebView Kit
|
|
4316
|
+
*
|
|
3908
4317
|
* @example
|
|
3909
4318
|
* ```typescript
|
|
3910
4319
|
* {
|
|
@@ -3919,6 +4328,9 @@ export declare type RedirectToSystemWebViewRequest = InferOutput<typeof Redirect
|
|
|
3919
4328
|
/**
|
|
3920
4329
|
* Valibot schema for {@link RedirectToSystemWebViewRequest}.
|
|
3921
4330
|
*
|
|
4331
|
+
* @group Modules
|
|
4332
|
+
* @category System WebView Kit
|
|
4333
|
+
*
|
|
3922
4334
|
* @public
|
|
3923
4335
|
*/
|
|
3924
4336
|
export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
@@ -3928,6 +4340,9 @@ export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
|
3928
4340
|
/**
|
|
3929
4341
|
* Response when redirecting to the system web view.
|
|
3930
4342
|
*
|
|
4343
|
+
* @group Modules
|
|
4344
|
+
* @category System WebView Kit
|
|
4345
|
+
*
|
|
3931
4346
|
* @remarks
|
|
3932
4347
|
* This response can have the following status codes:
|
|
3933
4348
|
* - `200`: Redirect initiated successfully.
|
|
@@ -3943,6 +4358,9 @@ export declare type RedirectToSystemWebViewResponse = InferOutput<typeof Redirec
|
|
|
3943
4358
|
/**
|
|
3944
4359
|
* Valibot schema for {@link RedirectToSystemWebViewResponse}.
|
|
3945
4360
|
*
|
|
4361
|
+
* @group Modules
|
|
4362
|
+
* @category System WebView Kit
|
|
4363
|
+
*
|
|
3946
4364
|
* @public
|
|
3947
4365
|
*/
|
|
3948
4366
|
export declare const RedirectToSystemWebViewResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -3966,6 +4384,9 @@ export declare const RedirectToSystemWebViewResponseSchema: v.UnionSchema<[v.Obj
|
|
|
3966
4384
|
* Result object for redirecting to the system web view.
|
|
3967
4385
|
* This operation returns no data on success.
|
|
3968
4386
|
*
|
|
4387
|
+
* @group Modules
|
|
4388
|
+
* @category System WebView Kit
|
|
4389
|
+
*
|
|
3969
4390
|
* @public
|
|
3970
4391
|
*/
|
|
3971
4392
|
export declare type RedirectToSystemWebViewResult = void;
|
|
@@ -3973,6 +4394,9 @@ export declare type RedirectToSystemWebViewResult = void;
|
|
|
3973
4394
|
/**
|
|
3974
4395
|
* Response when reloading consented scopes.
|
|
3975
4396
|
*
|
|
4397
|
+
* @group Modules
|
|
4398
|
+
* @category Scope
|
|
4399
|
+
*
|
|
3976
4400
|
* @remarks
|
|
3977
4401
|
* This response can have the following status codes:
|
|
3978
4402
|
* - `204`: Scopes reloaded successfully (no content).
|
|
@@ -3987,6 +4411,9 @@ export declare type ReloadScopesResponse = InferOutput<typeof ReloadScopesRespon
|
|
|
3987
4411
|
/**
|
|
3988
4412
|
* Valibot schema for {@link ReloadScopesResponse}.
|
|
3989
4413
|
*
|
|
4414
|
+
* @group Modules
|
|
4415
|
+
* @category Scope
|
|
4416
|
+
*
|
|
3990
4417
|
* @public
|
|
3991
4418
|
*/
|
|
3992
4419
|
export declare const ReloadScopesResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4006,6 +4433,9 @@ export declare const ReloadScopesResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4006
4433
|
* Result object for reloading scopes.
|
|
4007
4434
|
* This operation returns no data on success.
|
|
4008
4435
|
*
|
|
4436
|
+
* @group Modules
|
|
4437
|
+
* @category Scope
|
|
4438
|
+
*
|
|
4009
4439
|
* @public
|
|
4010
4440
|
*/
|
|
4011
4441
|
export declare type ReloadScopesResult = void;
|
|
@@ -4013,6 +4443,9 @@ export declare type ReloadScopesResult = void;
|
|
|
4013
4443
|
/**
|
|
4014
4444
|
* Response when removing all values.
|
|
4015
4445
|
*
|
|
4446
|
+
* @group Modules
|
|
4447
|
+
* @category Storage
|
|
4448
|
+
*
|
|
4016
4449
|
* @remarks
|
|
4017
4450
|
* This response can have the following status codes:
|
|
4018
4451
|
* - `204`: All values removed successfully.
|
|
@@ -4027,6 +4460,9 @@ export declare type RemoveAllResponse = InferOutput<typeof RemoveAllResponseSche
|
|
|
4027
4460
|
/**
|
|
4028
4461
|
* Valibot schema for {@link RemoveAllResponse}.
|
|
4029
4462
|
*
|
|
4463
|
+
* @group Modules
|
|
4464
|
+
* @category Storage
|
|
4465
|
+
*
|
|
4030
4466
|
* @public
|
|
4031
4467
|
*/
|
|
4032
4468
|
export declare const RemoveAllResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4046,6 +4482,9 @@ export declare const RemoveAllResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4046
4482
|
* Result object for removing all values.
|
|
4047
4483
|
* This operation returns no data on success.
|
|
4048
4484
|
*
|
|
4485
|
+
* @group Modules
|
|
4486
|
+
* @category Storage
|
|
4487
|
+
*
|
|
4049
4488
|
* @public
|
|
4050
4489
|
*/
|
|
4051
4490
|
export declare type RemoveAllResult = void;
|
|
@@ -4053,6 +4492,9 @@ export declare type RemoveAllResult = void;
|
|
|
4053
4492
|
/**
|
|
4054
4493
|
* Response when removing a value.
|
|
4055
4494
|
*
|
|
4495
|
+
* @group Modules
|
|
4496
|
+
* @category Storage
|
|
4497
|
+
*
|
|
4056
4498
|
* @remarks
|
|
4057
4499
|
* This response can have the following status codes:
|
|
4058
4500
|
* - `204`: Value removed successfully.
|
|
@@ -4068,6 +4510,9 @@ export declare type RemoveResponse = InferOutput<typeof RemoveResponseSchema>;
|
|
|
4068
4510
|
/**
|
|
4069
4511
|
* Valibot schema for {@link RemoveResponse}.
|
|
4070
4512
|
*
|
|
4513
|
+
* @group Modules
|
|
4514
|
+
* @category Storage
|
|
4515
|
+
*
|
|
4071
4516
|
* @public
|
|
4072
4517
|
*/
|
|
4073
4518
|
export declare const RemoveResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4090,6 +4535,9 @@ export declare const RemoveResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4090
4535
|
* Result object for removing a value.
|
|
4091
4536
|
* This operation returns no data on success.
|
|
4092
4537
|
*
|
|
4538
|
+
* @group Modules
|
|
4539
|
+
* @category Storage
|
|
4540
|
+
*
|
|
4093
4541
|
* @public
|
|
4094
4542
|
*/
|
|
4095
4543
|
export declare type RemoveResult = void;
|
|
@@ -4097,6 +4545,9 @@ export declare type RemoveResult = void;
|
|
|
4097
4545
|
/**
|
|
4098
4546
|
* Request parameters for scanning QR codes.
|
|
4099
4547
|
*
|
|
4548
|
+
* @group Modules
|
|
4549
|
+
* @category Camera
|
|
4550
|
+
*
|
|
4100
4551
|
* @example
|
|
4101
4552
|
* **Request with custom title:**
|
|
4102
4553
|
* ```typescript
|
|
@@ -4116,6 +4567,9 @@ export declare type ScanQRCodeRequest = InferOutput<typeof ScanQRCodeRequestSche
|
|
|
4116
4567
|
/**
|
|
4117
4568
|
* Valibot schema for {@link ScanQRCodeRequest}.
|
|
4118
4569
|
*
|
|
4570
|
+
* @group Modules
|
|
4571
|
+
* @category Camera
|
|
4572
|
+
*
|
|
4119
4573
|
* @public
|
|
4120
4574
|
*/
|
|
4121
4575
|
export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
@@ -4125,6 +4579,9 @@ export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
|
4125
4579
|
/**
|
|
4126
4580
|
* Response when scanning a QR code.
|
|
4127
4581
|
*
|
|
4582
|
+
* @group Modules
|
|
4583
|
+
* @category Camera
|
|
4584
|
+
*
|
|
4128
4585
|
* @remarks
|
|
4129
4586
|
* This response can have the following status codes:
|
|
4130
4587
|
* - `200`: Successfully scanned QR code. The `result` contains the scanned QR code data.
|
|
@@ -4141,6 +4598,9 @@ export declare type ScanQRCodeResponse = InferOutput<typeof ScanQRCodeResponseSc
|
|
|
4141
4598
|
/**
|
|
4142
4599
|
* Valibot schema for {@link ScanQRCodeResponse}.
|
|
4143
4600
|
*
|
|
4601
|
+
* @group Modules
|
|
4602
|
+
* @category Camera
|
|
4603
|
+
*
|
|
4144
4604
|
* @public
|
|
4145
4605
|
*/
|
|
4146
4606
|
export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4167,6 +4627,9 @@ export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4167
4627
|
/**
|
|
4168
4628
|
* Result object containing the scanned QR code data.
|
|
4169
4629
|
*
|
|
4630
|
+
* @group Modules
|
|
4631
|
+
* @category Camera
|
|
4632
|
+
*
|
|
4170
4633
|
* @example
|
|
4171
4634
|
* ```typescript
|
|
4172
4635
|
* { qrCode: 'https://example.com/payment/123' }
|
|
@@ -4179,6 +4642,9 @@ export declare type ScanQRCodeResult = InferOutput<typeof ScanQRCodeResultSchema
|
|
|
4179
4642
|
/**
|
|
4180
4643
|
* Valibot schema for {@link ScanQRCodeResult}.
|
|
4181
4644
|
*
|
|
4645
|
+
* @group Modules
|
|
4646
|
+
* @category Camera
|
|
4647
|
+
*
|
|
4182
4648
|
* @public
|
|
4183
4649
|
*/
|
|
4184
4650
|
export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
@@ -4189,6 +4655,7 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
|
4189
4655
|
* JSBridge module for checking and refreshing API access permissions.
|
|
4190
4656
|
*
|
|
4191
4657
|
* @group Modules
|
|
4658
|
+
* @category Scope
|
|
4192
4659
|
*
|
|
4193
4660
|
* @remarks
|
|
4194
4661
|
* Manages OAuth scope permissions, allowing the MiniApp to check access rights and reload scopes from the server.
|
|
@@ -4282,6 +4749,9 @@ export declare class ScopeModule extends BaseModule {
|
|
|
4282
4749
|
/**
|
|
4283
4750
|
* Request parameters for sending analytics events.
|
|
4284
4751
|
*
|
|
4752
|
+
* @group Modules
|
|
4753
|
+
* @category Container
|
|
4754
|
+
*
|
|
4285
4755
|
* @remarks
|
|
4286
4756
|
* Use predefined constants to ensure consistency across the platform:
|
|
4287
4757
|
* - **States:** {@link ContainerAnalyticsEventState}
|
|
@@ -4313,6 +4783,9 @@ export declare type SendAnalyticsEventRequest = InferOutput<typeof SendAnalytics
|
|
|
4313
4783
|
/**
|
|
4314
4784
|
* Valibot schema for {@link SendAnalyticsEventRequest}.
|
|
4315
4785
|
*
|
|
4786
|
+
* @group Modules
|
|
4787
|
+
* @category Container
|
|
4788
|
+
*
|
|
4316
4789
|
* @public
|
|
4317
4790
|
*/
|
|
4318
4791
|
export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
@@ -4324,6 +4797,9 @@ export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
|
4324
4797
|
/**
|
|
4325
4798
|
* Response when sending analytics events.
|
|
4326
4799
|
*
|
|
4800
|
+
* @group Modules
|
|
4801
|
+
* @category Container
|
|
4802
|
+
*
|
|
4327
4803
|
* @remarks
|
|
4328
4804
|
* This response can have the following status codes:
|
|
4329
4805
|
* - `204`: Analytics event sent successfully.
|
|
@@ -4338,6 +4814,9 @@ export declare type SendAnalyticsEventResponse = InferOutput<typeof SendAnalytic
|
|
|
4338
4814
|
/**
|
|
4339
4815
|
* Valibot schema for {@link SendAnalyticsEventResponse}.
|
|
4340
4816
|
*
|
|
4817
|
+
* @group Modules
|
|
4818
|
+
* @category Container
|
|
4819
|
+
*
|
|
4341
4820
|
* @public
|
|
4342
4821
|
*/
|
|
4343
4822
|
export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4357,6 +4836,9 @@ export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
4357
4836
|
* Result when sending analytics events.
|
|
4358
4837
|
* This operation returns no data on success.
|
|
4359
4838
|
*
|
|
4839
|
+
* @group Modules
|
|
4840
|
+
* @category Container
|
|
4841
|
+
*
|
|
4360
4842
|
* @public
|
|
4361
4843
|
*/
|
|
4362
4844
|
export declare type SendAnalyticsEventResult = void;
|
|
@@ -4364,6 +4846,9 @@ export declare type SendAnalyticsEventResult = void;
|
|
|
4364
4846
|
/**
|
|
4365
4847
|
* Request parameters for sending a network request.
|
|
4366
4848
|
*
|
|
4849
|
+
* @group Modules
|
|
4850
|
+
* @category Network
|
|
4851
|
+
*
|
|
4367
4852
|
* @example
|
|
4368
4853
|
* **GET request with headers:**
|
|
4369
4854
|
* ```typescript
|
|
@@ -4403,6 +4888,9 @@ export declare type SendRequest = InferOutput<typeof SendRequestSchema>;
|
|
|
4403
4888
|
/**
|
|
4404
4889
|
* Valibot schema for {@link SendRequest}.
|
|
4405
4890
|
*
|
|
4891
|
+
* @group Modules
|
|
4892
|
+
* @category Network
|
|
4893
|
+
*
|
|
4406
4894
|
* @remarks
|
|
4407
4895
|
* This schema defines the structure of a network request with the following properties:
|
|
4408
4896
|
* - `endpoint`: API endpoint URL to send the request to
|
|
@@ -4426,6 +4914,9 @@ export declare const SendRequestSchema: v.ObjectSchema<{
|
|
|
4426
4914
|
/**
|
|
4427
4915
|
* Response when sending a network request.
|
|
4428
4916
|
*
|
|
4917
|
+
* @group Modules
|
|
4918
|
+
* @category Network
|
|
4919
|
+
*
|
|
4429
4920
|
* @remarks
|
|
4430
4921
|
* This response can have any HTTP status code returned by the external API:
|
|
4431
4922
|
* - Success codes (2xx): Contains the `result` with response data, except 204 which has no body.
|
|
@@ -4440,6 +4931,9 @@ export declare type SendResponse = InferOutput<typeof SendResponseSchema>;
|
|
|
4440
4931
|
/**
|
|
4441
4932
|
* Valibot schema for {@link SendResponse}.
|
|
4442
4933
|
*
|
|
4934
|
+
* @group Modules
|
|
4935
|
+
* @category Network
|
|
4936
|
+
*
|
|
4443
4937
|
* @public
|
|
4444
4938
|
*/
|
|
4445
4939
|
export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4476,6 +4970,9 @@ export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4476
4970
|
/**
|
|
4477
4971
|
* Result object containing the network response data.
|
|
4478
4972
|
*
|
|
4973
|
+
* @group Modules
|
|
4974
|
+
* @category Network
|
|
4975
|
+
*
|
|
4479
4976
|
* @remarks
|
|
4480
4977
|
* The result type is `Record<string, unknown>` as response bodies are always
|
|
4481
4978
|
* returned as objects. String responses from the native bridge are automatically
|
|
@@ -4488,6 +4985,9 @@ export declare type SendResult = InferOutput<typeof SendResultSchema>;
|
|
|
4488
4985
|
/**
|
|
4489
4986
|
* Valibot schema for {@link SendResult}.
|
|
4490
4987
|
*
|
|
4988
|
+
* @group Modules
|
|
4989
|
+
* @category Network
|
|
4990
|
+
*
|
|
4491
4991
|
* @public
|
|
4492
4992
|
*/
|
|
4493
4993
|
export declare const SendResultSchema: v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>;
|
|
@@ -4495,6 +4995,9 @@ export declare const SendResultSchema: v.RecordSchema<v.StringSchema<undefined>,
|
|
|
4495
4995
|
/**
|
|
4496
4996
|
* Request parameters for setting the background color.
|
|
4497
4997
|
*
|
|
4998
|
+
* @group Modules
|
|
4999
|
+
* @category Container
|
|
5000
|
+
*
|
|
4498
5001
|
* @example
|
|
4499
5002
|
* ```typescript
|
|
4500
5003
|
* '#ffffff'
|
|
@@ -4507,6 +5010,9 @@ export declare type SetBackgroundColorRequest = string;
|
|
|
4507
5010
|
/**
|
|
4508
5011
|
* Response when setting the background color.
|
|
4509
5012
|
*
|
|
5013
|
+
* @group Modules
|
|
5014
|
+
* @category Container
|
|
5015
|
+
*
|
|
4510
5016
|
* @remarks
|
|
4511
5017
|
* This response can have the following status codes:
|
|
4512
5018
|
* - `204`: Background color set successfully.
|
|
@@ -4521,6 +5027,9 @@ export declare type SetBackgroundColorResponse = InferOutput<typeof SetBackgroun
|
|
|
4521
5027
|
/**
|
|
4522
5028
|
* Valibot schema for {@link SetBackgroundColorResponse}.
|
|
4523
5029
|
*
|
|
5030
|
+
* @group Modules
|
|
5031
|
+
* @category Container
|
|
5032
|
+
*
|
|
4524
5033
|
* @public
|
|
4525
5034
|
*/
|
|
4526
5035
|
export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4540,6 +5049,9 @@ export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
4540
5049
|
* Result when setting the background color.
|
|
4541
5050
|
* This operation returns no data on success.
|
|
4542
5051
|
*
|
|
5052
|
+
* @group Modules
|
|
5053
|
+
* @category Container
|
|
5054
|
+
*
|
|
4543
5055
|
* @public
|
|
4544
5056
|
*/
|
|
4545
5057
|
export declare type SetBackgroundColorResult = void;
|
|
@@ -4547,6 +5059,9 @@ export declare type SetBackgroundColorResult = void;
|
|
|
4547
5059
|
/**
|
|
4548
5060
|
* Request parameters for storing a boolean value in storage.
|
|
4549
5061
|
*
|
|
5062
|
+
* @group Modules
|
|
5063
|
+
* @category Storage
|
|
5064
|
+
*
|
|
4550
5065
|
* @example
|
|
4551
5066
|
* ```typescript
|
|
4552
5067
|
* { key: 'isDarkMode', value: true }
|
|
@@ -4559,6 +5074,9 @@ export declare type SetBooleanRequest = InferOutput<typeof SetBooleanRequestSche
|
|
|
4559
5074
|
/**
|
|
4560
5075
|
* Valibot schema for {@link SetBooleanRequest}.
|
|
4561
5076
|
*
|
|
5077
|
+
* @group Modules
|
|
5078
|
+
* @category Storage
|
|
5079
|
+
*
|
|
4562
5080
|
* @public
|
|
4563
5081
|
*/
|
|
4564
5082
|
export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
@@ -4569,6 +5087,9 @@ export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
4569
5087
|
/**
|
|
4570
5088
|
* Response when setting a boolean value.
|
|
4571
5089
|
*
|
|
5090
|
+
* @group Modules
|
|
5091
|
+
* @category Storage
|
|
5092
|
+
*
|
|
4572
5093
|
* @remarks
|
|
4573
5094
|
* This response can have the following status codes:
|
|
4574
5095
|
* - `204`: Value stored successfully.
|
|
@@ -4584,6 +5105,9 @@ export declare type SetBooleanResponse = InferOutput<typeof SetBooleanResponseSc
|
|
|
4584
5105
|
/**
|
|
4585
5106
|
* Valibot schema for {@link SetBooleanResponse}.
|
|
4586
5107
|
*
|
|
5108
|
+
* @group Modules
|
|
5109
|
+
* @category Storage
|
|
5110
|
+
*
|
|
4587
5111
|
* @public
|
|
4588
5112
|
*/
|
|
4589
5113
|
export declare const SetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4606,6 +5130,9 @@ export declare const SetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4606
5130
|
* Result object for setting a boolean value.
|
|
4607
5131
|
* This operation returns no data on success.
|
|
4608
5132
|
*
|
|
5133
|
+
* @group Modules
|
|
5134
|
+
* @category Storage
|
|
5135
|
+
*
|
|
4609
5136
|
* @public
|
|
4610
5137
|
*/
|
|
4611
5138
|
export declare type SetBooleanResult = void;
|
|
@@ -4613,6 +5140,9 @@ export declare type SetBooleanResult = void;
|
|
|
4613
5140
|
/**
|
|
4614
5141
|
* Request parameters for storing a double value in storage.
|
|
4615
5142
|
*
|
|
5143
|
+
* @group Modules
|
|
5144
|
+
* @category Storage
|
|
5145
|
+
*
|
|
4616
5146
|
* @example
|
|
4617
5147
|
* ```typescript
|
|
4618
5148
|
* { key: 'price', value: 19.99 }
|
|
@@ -4625,6 +5155,9 @@ export declare type SetDoubleRequest = InferOutput<typeof SetDoubleRequestSchema
|
|
|
4625
5155
|
/**
|
|
4626
5156
|
* Valibot schema for {@link SetDoubleRequest}.
|
|
4627
5157
|
*
|
|
5158
|
+
* @group Modules
|
|
5159
|
+
* @category Storage
|
|
5160
|
+
*
|
|
4628
5161
|
* @public
|
|
4629
5162
|
*/
|
|
4630
5163
|
export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
@@ -4635,6 +5168,9 @@ export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
4635
5168
|
/**
|
|
4636
5169
|
* Response when setting a double value.
|
|
4637
5170
|
*
|
|
5171
|
+
* @group Modules
|
|
5172
|
+
* @category Storage
|
|
5173
|
+
*
|
|
4638
5174
|
* @remarks
|
|
4639
5175
|
* This response can have the following status codes:
|
|
4640
5176
|
* - `204`: Value stored successfully.
|
|
@@ -4650,6 +5186,9 @@ export declare type SetDoubleResponse = InferOutput<typeof SetDoubleResponseSche
|
|
|
4650
5186
|
/**
|
|
4651
5187
|
* Valibot schema for {@link SetDoubleResponse}.
|
|
4652
5188
|
*
|
|
5189
|
+
* @group Modules
|
|
5190
|
+
* @category Storage
|
|
5191
|
+
*
|
|
4653
5192
|
* @public
|
|
4654
5193
|
*/
|
|
4655
5194
|
export declare const SetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4672,6 +5211,9 @@ export declare const SetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4672
5211
|
* Result object for setting a double value.
|
|
4673
5212
|
* This operation returns no data on success.
|
|
4674
5213
|
*
|
|
5214
|
+
* @group Modules
|
|
5215
|
+
* @category Storage
|
|
5216
|
+
*
|
|
4675
5217
|
* @public
|
|
4676
5218
|
*/
|
|
4677
5219
|
export declare type SetDoubleResult = void;
|
|
@@ -4679,6 +5221,9 @@ export declare type SetDoubleResult = void;
|
|
|
4679
5221
|
/**
|
|
4680
5222
|
* Request parameters for storing an integer value in storage.
|
|
4681
5223
|
*
|
|
5224
|
+
* @group Modules
|
|
5225
|
+
* @category Storage
|
|
5226
|
+
*
|
|
4682
5227
|
* @example
|
|
4683
5228
|
* ```typescript
|
|
4684
5229
|
* { key: 'userCount', value: 42 }
|
|
@@ -4691,6 +5236,9 @@ export declare type SetIntRequest = InferOutput<typeof SetIntRequestSchema>;
|
|
|
4691
5236
|
/**
|
|
4692
5237
|
* Valibot schema for {@link SetIntRequest}.
|
|
4693
5238
|
*
|
|
5239
|
+
* @group Modules
|
|
5240
|
+
* @category Storage
|
|
5241
|
+
*
|
|
4694
5242
|
* @public
|
|
4695
5243
|
*/
|
|
4696
5244
|
export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
@@ -4701,6 +5249,9 @@ export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
|
4701
5249
|
/**
|
|
4702
5250
|
* Response when setting an integer value.
|
|
4703
5251
|
*
|
|
5252
|
+
* @group Modules
|
|
5253
|
+
* @category Storage
|
|
5254
|
+
*
|
|
4704
5255
|
* @remarks
|
|
4705
5256
|
* This response can have the following status codes:
|
|
4706
5257
|
* - `204`: Value stored successfully.
|
|
@@ -4716,6 +5267,9 @@ export declare type SetIntResponse = InferOutput<typeof SetIntResponseSchema>;
|
|
|
4716
5267
|
/**
|
|
4717
5268
|
* Valibot schema for {@link SetIntResponse}.
|
|
4718
5269
|
*
|
|
5270
|
+
* @group Modules
|
|
5271
|
+
* @category Storage
|
|
5272
|
+
*
|
|
4719
5273
|
* @public
|
|
4720
5274
|
*/
|
|
4721
5275
|
export declare const SetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4738,6 +5292,9 @@ export declare const SetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4738
5292
|
* Result object for setting an integer value.
|
|
4739
5293
|
* This operation returns no data on success.
|
|
4740
5294
|
*
|
|
5295
|
+
* @group Modules
|
|
5296
|
+
* @category Storage
|
|
5297
|
+
*
|
|
4741
5298
|
* @public
|
|
4742
5299
|
*/
|
|
4743
5300
|
export declare type SetIntResult = void;
|
|
@@ -4745,6 +5302,9 @@ export declare type SetIntResult = void;
|
|
|
4745
5302
|
/**
|
|
4746
5303
|
* Request parameters for storing a string value in storage.
|
|
4747
5304
|
*
|
|
5305
|
+
* @group Modules
|
|
5306
|
+
* @category Storage
|
|
5307
|
+
*
|
|
4748
5308
|
* @example
|
|
4749
5309
|
* ```typescript
|
|
4750
5310
|
* { key: 'username', value: 'john_doe' }
|
|
@@ -4757,6 +5317,9 @@ export declare type SetStringRequest = InferOutput<typeof SetStringRequestSchema
|
|
|
4757
5317
|
/**
|
|
4758
5318
|
* Valibot schema for {@link SetStringRequest}.
|
|
4759
5319
|
*
|
|
5320
|
+
* @group Modules
|
|
5321
|
+
* @category Storage
|
|
5322
|
+
*
|
|
4760
5323
|
* @public
|
|
4761
5324
|
*/
|
|
4762
5325
|
export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
@@ -4767,6 +5330,9 @@ export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
|
4767
5330
|
/**
|
|
4768
5331
|
* Response when setting a string value.
|
|
4769
5332
|
*
|
|
5333
|
+
* @group Modules
|
|
5334
|
+
* @category Storage
|
|
5335
|
+
*
|
|
4770
5336
|
* @remarks
|
|
4771
5337
|
* This response can have the following status codes:
|
|
4772
5338
|
* - `204`: Value stored successfully.
|
|
@@ -4782,6 +5348,9 @@ export declare type SetStringResponse = InferOutput<typeof SetStringResponseSche
|
|
|
4782
5348
|
/**
|
|
4783
5349
|
* Valibot schema for {@link SetStringResponse}.
|
|
4784
5350
|
*
|
|
5351
|
+
* @group Modules
|
|
5352
|
+
* @category Storage
|
|
5353
|
+
*
|
|
4785
5354
|
* @public
|
|
4786
5355
|
*/
|
|
4787
5356
|
export declare const SetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4804,6 +5373,9 @@ export declare const SetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4804
5373
|
* Result object for setting a string value.
|
|
4805
5374
|
* This operation returns no data on success.
|
|
4806
5375
|
*
|
|
5376
|
+
* @group Modules
|
|
5377
|
+
* @category Storage
|
|
5378
|
+
*
|
|
4807
5379
|
* @public
|
|
4808
5380
|
*/
|
|
4809
5381
|
export declare type SetStringResult = void;
|
|
@@ -4811,6 +5383,9 @@ export declare type SetStringResult = void;
|
|
|
4811
5383
|
/**
|
|
4812
5384
|
* Request parameters for setting the title.
|
|
4813
5385
|
*
|
|
5386
|
+
* @group Modules
|
|
5387
|
+
* @category Container
|
|
5388
|
+
*
|
|
4814
5389
|
* @example
|
|
4815
5390
|
* ```typescript
|
|
4816
5391
|
* 'Home Page'
|
|
@@ -4823,6 +5398,9 @@ export declare type SetTitleRequest = string;
|
|
|
4823
5398
|
/**
|
|
4824
5399
|
* Response when setting the title.
|
|
4825
5400
|
*
|
|
5401
|
+
* @group Modules
|
|
5402
|
+
* @category Container
|
|
5403
|
+
*
|
|
4826
5404
|
* @remarks
|
|
4827
5405
|
* This response can have the following status codes:
|
|
4828
5406
|
* - `204`: Title set successfully.
|
|
@@ -4837,6 +5415,9 @@ export declare type SetTitleResponse = InferOutput<typeof SetTitleResponseSchema
|
|
|
4837
5415
|
/**
|
|
4838
5416
|
* Valibot schema for {@link SetTitleResponse}.
|
|
4839
5417
|
*
|
|
5418
|
+
* @group Modules
|
|
5419
|
+
* @category Container
|
|
5420
|
+
*
|
|
4840
5421
|
* @public
|
|
4841
5422
|
*/
|
|
4842
5423
|
export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4856,6 +5437,9 @@ export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4856
5437
|
* Result when setting the title.
|
|
4857
5438
|
* This operation returns no data on success.
|
|
4858
5439
|
*
|
|
5440
|
+
* @group Modules
|
|
5441
|
+
* @category Container
|
|
5442
|
+
*
|
|
4859
5443
|
* @public
|
|
4860
5444
|
*/
|
|
4861
5445
|
export declare type SetTitleResult = void;
|
|
@@ -4863,6 +5447,9 @@ export declare type SetTitleResult = void;
|
|
|
4863
5447
|
/**
|
|
4864
5448
|
* Response when showing the back button.
|
|
4865
5449
|
*
|
|
5450
|
+
* @group Modules
|
|
5451
|
+
* @category Container
|
|
5452
|
+
*
|
|
4866
5453
|
* @remarks
|
|
4867
5454
|
* This response can have the following status codes:
|
|
4868
5455
|
* - `204`: Back button shown successfully.
|
|
@@ -4876,6 +5463,9 @@ export declare type ShowBackButtonResponse = InferOutput<typeof ShowBackButtonRe
|
|
|
4876
5463
|
/**
|
|
4877
5464
|
* Valibot schema for {@link ShowBackButtonResponse}.
|
|
4878
5465
|
*
|
|
5466
|
+
* @group Modules
|
|
5467
|
+
* @category Container
|
|
5468
|
+
*
|
|
4879
5469
|
* @public
|
|
4880
5470
|
*/
|
|
4881
5471
|
export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4892,6 +5482,9 @@ export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
4892
5482
|
* Result when showing the back button.
|
|
4893
5483
|
* This operation returns no data on success.
|
|
4894
5484
|
*
|
|
5485
|
+
* @group Modules
|
|
5486
|
+
* @category Container
|
|
5487
|
+
*
|
|
4895
5488
|
* @public
|
|
4896
5489
|
*/
|
|
4897
5490
|
export declare type ShowBackButtonResult = void;
|
|
@@ -4899,6 +5492,9 @@ export declare type ShowBackButtonResult = void;
|
|
|
4899
5492
|
/**
|
|
4900
5493
|
* Response when showing the loader.
|
|
4901
5494
|
*
|
|
5495
|
+
* @group Modules
|
|
5496
|
+
* @category Container
|
|
5497
|
+
*
|
|
4902
5498
|
* @remarks
|
|
4903
5499
|
* This response can have the following status codes:
|
|
4904
5500
|
* - `204`: Loader shown successfully.
|
|
@@ -4912,6 +5508,9 @@ export declare type ShowLoaderResponse = InferOutput<typeof ShowLoaderResponseSc
|
|
|
4912
5508
|
/**
|
|
4913
5509
|
* Valibot schema for {@link ShowLoaderResponse}.
|
|
4914
5510
|
*
|
|
5511
|
+
* @group Modules
|
|
5512
|
+
* @category Container
|
|
5513
|
+
*
|
|
4915
5514
|
* @public
|
|
4916
5515
|
*/
|
|
4917
5516
|
export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4928,6 +5527,9 @@ export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4928
5527
|
* Result when showing the loader.
|
|
4929
5528
|
* This operation returns no data on success.
|
|
4930
5529
|
*
|
|
5530
|
+
* @group Modules
|
|
5531
|
+
* @category Container
|
|
5532
|
+
*
|
|
4931
5533
|
* @public
|
|
4932
5534
|
*/
|
|
4933
5535
|
export declare type ShowLoaderResult = void;
|
|
@@ -4935,6 +5537,9 @@ export declare type ShowLoaderResult = void;
|
|
|
4935
5537
|
/**
|
|
4936
5538
|
* Response when showing the refresh button.
|
|
4937
5539
|
*
|
|
5540
|
+
* @group Modules
|
|
5541
|
+
* @category Container
|
|
5542
|
+
*
|
|
4938
5543
|
* @remarks
|
|
4939
5544
|
* This response can have the following status codes:
|
|
4940
5545
|
* - `204`: Refresh button shown successfully.
|
|
@@ -4948,6 +5553,9 @@ export declare type ShowRefreshButtonResponse = InferOutput<typeof ShowRefreshBu
|
|
|
4948
5553
|
/**
|
|
4949
5554
|
* Valibot schema for {@link ShowRefreshButtonResponse}.
|
|
4950
5555
|
*
|
|
5556
|
+
* @group Modules
|
|
5557
|
+
* @category Container
|
|
5558
|
+
*
|
|
4951
5559
|
* @public
|
|
4952
5560
|
*/
|
|
4953
5561
|
export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -4964,6 +5572,9 @@ export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
4964
5572
|
* Result when showing the refresh button.
|
|
4965
5573
|
* This operation returns no data on success.
|
|
4966
5574
|
*
|
|
5575
|
+
* @group Modules
|
|
5576
|
+
* @category Container
|
|
5577
|
+
*
|
|
4967
5578
|
* @public
|
|
4968
5579
|
*/
|
|
4969
5580
|
export declare type ShowRefreshButtonResult = void;
|
|
@@ -4972,6 +5583,7 @@ export declare type ShowRefreshButtonResult = void;
|
|
|
4972
5583
|
* JSBridge module for controlling the native splash / Lottie loading screen.
|
|
4973
5584
|
*
|
|
4974
5585
|
* @group Modules
|
|
5586
|
+
* @category Splash Screen
|
|
4975
5587
|
*
|
|
4976
5588
|
* @remarks
|
|
4977
5589
|
* Dismisses the splash overlay once the MiniApp is ready. Requires the Grab SuperApp WebView.
|
|
@@ -5027,6 +5639,7 @@ export declare class SplashScreenModule extends BaseModule {
|
|
|
5027
5639
|
* JSBridge module for persisting key-value data to native storage.
|
|
5028
5640
|
*
|
|
5029
5641
|
* @group Modules
|
|
5642
|
+
* @category Storage
|
|
5030
5643
|
*
|
|
5031
5644
|
* @remarks
|
|
5032
5645
|
* Stores data in the native app's persistent storage, allowing data to survive WebView restarts.
|
|
@@ -5407,6 +6020,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5407
6020
|
/**
|
|
5408
6021
|
* Controls an active stream subscription. Call `unsubscribe()` to stop receiving data.
|
|
5409
6022
|
*
|
|
6023
|
+
* @group Core
|
|
6024
|
+
*
|
|
5410
6025
|
* @remarks
|
|
5411
6026
|
* Returned by `subscribe()`. Use `unsubscribe()` to terminate the stream early.
|
|
5412
6027
|
* Use `isUnsubscribed()` to check if already terminated.
|
|
@@ -5424,6 +6039,7 @@ export declare type Subscription = Readonly<{
|
|
|
5424
6039
|
* JSBridge module for opening URLs in the device's system browser.
|
|
5425
6040
|
*
|
|
5426
6041
|
* @group Modules
|
|
6042
|
+
* @category System WebView Kit
|
|
5427
6043
|
*
|
|
5428
6044
|
* @remarks
|
|
5429
6045
|
* Allows MiniApps to redirect users to external content using the native system browser.
|
|
@@ -5488,6 +6104,9 @@ export declare class SystemWebViewKitModule extends BaseModule {
|
|
|
5488
6104
|
/**
|
|
5489
6105
|
* Request parameters for triggering the checkout flow.
|
|
5490
6106
|
*
|
|
6107
|
+
* @group Modules
|
|
6108
|
+
* @category Checkout
|
|
6109
|
+
*
|
|
5491
6110
|
* @remarks
|
|
5492
6111
|
* This type is intentionally flexible as the checkout parameters vary depending on the specific payment flow and partner requirements.
|
|
5493
6112
|
* Consult the Grab SuperApp SDK documentation for the specific parameters required for your use case.
|
|
@@ -5512,6 +6131,9 @@ export declare type TriggerCheckoutRequest = InferOutput<typeof TriggerCheckoutR
|
|
|
5512
6131
|
/**
|
|
5513
6132
|
* Valibot schema for {@link TriggerCheckoutRequest}.
|
|
5514
6133
|
*
|
|
6134
|
+
* @group Modules
|
|
6135
|
+
* @category Checkout
|
|
6136
|
+
*
|
|
5515
6137
|
* @remarks
|
|
5516
6138
|
* The checkout parameters vary depending on the specific payment flow and partner requirements.
|
|
5517
6139
|
*
|
|
@@ -5522,6 +6144,9 @@ export declare const TriggerCheckoutRequestSchema: v.RecordSchema<v.StringSchema
|
|
|
5522
6144
|
/**
|
|
5523
6145
|
* Response when triggering the checkout flow.
|
|
5524
6146
|
*
|
|
6147
|
+
* @group Modules
|
|
6148
|
+
* @category Checkout
|
|
6149
|
+
*
|
|
5525
6150
|
* @remarks
|
|
5526
6151
|
* This response can have the following status codes:
|
|
5527
6152
|
* - `200`: Checkout completed successfully. The `result` contains transaction details.
|
|
@@ -5536,6 +6161,9 @@ export declare type TriggerCheckoutResponse = InferOutput<typeof TriggerCheckout
|
|
|
5536
6161
|
/**
|
|
5537
6162
|
* Valibot schema for {@link TriggerCheckoutResponse}.
|
|
5538
6163
|
*
|
|
6164
|
+
* @group Modules
|
|
6165
|
+
* @category Checkout
|
|
6166
|
+
*
|
|
5539
6167
|
* @public
|
|
5540
6168
|
*/
|
|
5541
6169
|
export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -5568,6 +6196,9 @@ export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
5568
6196
|
/**
|
|
5569
6197
|
* Result object containing the checkout transaction details.
|
|
5570
6198
|
*
|
|
6199
|
+
* @group Modules
|
|
6200
|
+
* @category Checkout
|
|
6201
|
+
*
|
|
5571
6202
|
* @remarks
|
|
5572
6203
|
* - `status: 'success'` → `transactionID`
|
|
5573
6204
|
* - `status: 'failure'` → `transactionID`, `errorMessage`, `errorCode`
|
|
@@ -5618,6 +6249,9 @@ export declare type TriggerCheckoutResult = InferOutput<typeof TriggerCheckoutRe
|
|
|
5618
6249
|
/**
|
|
5619
6250
|
* Valibot schema for {@link TriggerCheckoutResult}.
|
|
5620
6251
|
*
|
|
6252
|
+
* @group Modules
|
|
6253
|
+
* @category Checkout
|
|
6254
|
+
*
|
|
5621
6255
|
* @public
|
|
5622
6256
|
*/
|
|
5623
6257
|
export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.ObjectSchema<{
|
|
@@ -5639,6 +6273,7 @@ export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.O
|
|
|
5639
6273
|
* JSBridge module for reading user-related attributes from native code.
|
|
5640
6274
|
*
|
|
5641
6275
|
* @group Modules
|
|
6276
|
+
* @category User Attributes
|
|
5642
6277
|
*
|
|
5643
6278
|
* @remarks
|
|
5644
6279
|
* Provides access to user and traveller attributes exposed by the native Grab app bridge.
|
|
@@ -5706,6 +6341,9 @@ export declare class UserAttributesModule extends BaseModule {
|
|
|
5706
6341
|
/**
|
|
5707
6342
|
* Request parameters for verifying the user's email.
|
|
5708
6343
|
*
|
|
6344
|
+
* @group Modules
|
|
6345
|
+
* @category Profile
|
|
6346
|
+
*
|
|
5709
6347
|
* @remarks
|
|
5710
6348
|
* Both properties are optional. If email is provided and skipUserInput is true,
|
|
5711
6349
|
* the verify OTP bottom sheet will be triggered directly without user editing.
|
|
@@ -5725,6 +6363,9 @@ export declare type VerifyEmailRequest = InferOutput<typeof VerifyEmailRequestSc
|
|
|
5725
6363
|
/**
|
|
5726
6364
|
* Valibot schema for {@link VerifyEmailRequest}.
|
|
5727
6365
|
*
|
|
6366
|
+
* @group Modules
|
|
6367
|
+
* @category Profile
|
|
6368
|
+
*
|
|
5728
6369
|
* @public
|
|
5729
6370
|
*/
|
|
5730
6371
|
export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
@@ -5735,6 +6376,9 @@ export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
|
5735
6376
|
/**
|
|
5736
6377
|
* Response when verifying the user's email.
|
|
5737
6378
|
*
|
|
6379
|
+
* @group Modules
|
|
6380
|
+
* @category Profile
|
|
6381
|
+
*
|
|
5738
6382
|
* @remarks
|
|
5739
6383
|
* This response can have the following status codes:
|
|
5740
6384
|
* - `200`: Success, email verified and returned in `result`.
|
|
@@ -5767,6 +6411,9 @@ export declare type VerifyEmailResponse = InferOutput<typeof VerifyEmailResponse
|
|
|
5767
6411
|
/**
|
|
5768
6412
|
* Valibot schema for {@link VerifyEmailResponse}.
|
|
5769
6413
|
*
|
|
6414
|
+
* @group Modules
|
|
6415
|
+
* @category Profile
|
|
6416
|
+
*
|
|
5770
6417
|
* @public
|
|
5771
6418
|
*/
|
|
5772
6419
|
export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
@@ -5796,6 +6443,9 @@ export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
5796
6443
|
/**
|
|
5797
6444
|
* Result object for verifying the user's email.
|
|
5798
6445
|
*
|
|
6446
|
+
* @group Modules
|
|
6447
|
+
* @category Profile
|
|
6448
|
+
*
|
|
5799
6449
|
* @example
|
|
5800
6450
|
* ```typescript
|
|
5801
6451
|
* { email: 'user@example.com' }
|
|
@@ -5808,6 +6458,9 @@ export declare type VerifyEmailResult = InferOutput<typeof VerifyEmailResultSche
|
|
|
5808
6458
|
/**
|
|
5809
6459
|
* Valibot schema for {@link VerifyEmailResult}.
|
|
5810
6460
|
*
|
|
6461
|
+
* @group Modules
|
|
6462
|
+
* @category Profile
|
|
6463
|
+
*
|
|
5811
6464
|
* @public
|
|
5812
6465
|
*/
|
|
5813
6466
|
export declare const VerifyEmailResultSchema: v.ObjectSchema<{
|
|
@@ -5817,6 +6470,8 @@ export declare const VerifyEmailResultSchema: v.ObjectSchema<{
|
|
|
5817
6470
|
/**
|
|
5818
6471
|
* Represents a semantic version with major, minor, and patch components.
|
|
5819
6472
|
*
|
|
6473
|
+
* @group Core
|
|
6474
|
+
*
|
|
5820
6475
|
* @public
|
|
5821
6476
|
*/
|
|
5822
6477
|
export declare interface Version {
|
|
@@ -5828,6 +6483,8 @@ export declare interface Version {
|
|
|
5828
6483
|
/**
|
|
5829
6484
|
* Generic interface for all native JSBridge module wrappers.
|
|
5830
6485
|
*
|
|
6486
|
+
* @group Core
|
|
6487
|
+
*
|
|
5831
6488
|
* @public
|
|
5832
6489
|
*/
|
|
5833
6490
|
export declare interface WrappedModule {
|