@grabjs/superapp-sdk 2.0.0-beta.38 → 2.0.0-beta.47
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 +5649 -6906
- package/dist/index.d.ts +65 -73
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -1
- package/skills/SKILL.md +336 -76
package/dist/index.d.ts
CHANGED
|
@@ -340,7 +340,7 @@ export declare type BridgeStreamHandlers<T extends BridgeResponse = BridgeRespon
|
|
|
340
340
|
* @example
|
|
341
341
|
* **CDN (UMD):**
|
|
342
342
|
* ```html
|
|
343
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
343
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
344
344
|
* <script>
|
|
345
345
|
* const cameraModule = new SuperAppSDK.CameraModule();
|
|
346
346
|
* </script>
|
|
@@ -416,7 +416,7 @@ export declare class CameraModule extends BaseModule {
|
|
|
416
416
|
* @example
|
|
417
417
|
* **CDN (UMD):**
|
|
418
418
|
* ```html
|
|
419
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
419
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
420
420
|
* <script>
|
|
421
421
|
* const checkoutModule = new SuperAppSDK.CheckoutModule();
|
|
422
422
|
* </script>
|
|
@@ -430,6 +430,8 @@ export declare class CheckoutModule extends BaseModule {
|
|
|
430
430
|
/**
|
|
431
431
|
* Triggers the native checkout flow for payment processing.
|
|
432
432
|
*
|
|
433
|
+
* @requiredOAuthScope mobile.checkout
|
|
434
|
+
*
|
|
433
435
|
* @remarks
|
|
434
436
|
* You must create a transaction on your backend (via API POST https://partner-api.grab.com/grabpay/partner/v4/charge/init) **before** calling this method.
|
|
435
437
|
* Pass the transaction parameters returned from that API call as the `request` argument.
|
|
@@ -519,8 +521,7 @@ export declare type ClearAuthorizationArtifactsResult = void;
|
|
|
519
521
|
*
|
|
520
522
|
* @remarks
|
|
521
523
|
* This response can have the following status codes:
|
|
522
|
-
* - `
|
|
523
|
-
* - `204`: Operation completed successfully (no content).
|
|
524
|
+
* - `204`: Container closed successfully.
|
|
524
525
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
525
526
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
526
527
|
*
|
|
@@ -534,9 +535,6 @@ export declare type CloseResponse = InferOutput<typeof CloseResponseSchema>;
|
|
|
534
535
|
* @public
|
|
535
536
|
*/
|
|
536
537
|
export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
537
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
538
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
539
|
-
}, undefined>, v.ObjectSchema<{
|
|
540
538
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
541
539
|
}, undefined>, v.ObjectSchema<{
|
|
542
540
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -605,7 +603,7 @@ export declare const ContainerAnalyticsEventState: {
|
|
|
605
603
|
* @example
|
|
606
604
|
* **CDN (UMD):**
|
|
607
605
|
* ```html
|
|
608
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
606
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
609
607
|
* <script>
|
|
610
608
|
* const containerModule = new SuperAppSDK.ContainerModule();
|
|
611
609
|
* </script>
|
|
@@ -1122,7 +1120,7 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1122
1120
|
* @example
|
|
1123
1121
|
* **CDN (UMD):**
|
|
1124
1122
|
* ```html
|
|
1125
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
1123
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
1126
1124
|
* <script>
|
|
1127
1125
|
* const deviceModule = new SuperAppSDK.DeviceModule();
|
|
1128
1126
|
* </script>
|
|
@@ -1462,7 +1460,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
|
1462
1460
|
* @example
|
|
1463
1461
|
* **CDN (UMD):**
|
|
1464
1462
|
* ```html
|
|
1465
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
1463
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
1466
1464
|
* <script>
|
|
1467
1465
|
* const fileModule = new SuperAppSDK.FileModule();
|
|
1468
1466
|
* </script>
|
|
@@ -2361,8 +2359,7 @@ export declare function hasResult<T extends BridgeResponse>(response: T): respon
|
|
|
2361
2359
|
*
|
|
2362
2360
|
* @remarks
|
|
2363
2361
|
* This response can have the following status codes:
|
|
2364
|
-
* - `
|
|
2365
|
-
* - `204`: Operation completed successfully (no content).
|
|
2362
|
+
* - `204`: Back button hidden successfully.
|
|
2366
2363
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
2367
2364
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
2368
2365
|
*
|
|
@@ -2376,9 +2373,6 @@ export declare type HideBackButtonResponse = InferOutput<typeof HideBackButtonRe
|
|
|
2376
2373
|
* @public
|
|
2377
2374
|
*/
|
|
2378
2375
|
export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2379
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2380
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
2381
|
-
}, undefined>, v.ObjectSchema<{
|
|
2382
2376
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2383
2377
|
}, undefined>, v.ObjectSchema<{
|
|
2384
2378
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -2401,8 +2395,7 @@ export declare type HideBackButtonResult = void;
|
|
|
2401
2395
|
*
|
|
2402
2396
|
* @remarks
|
|
2403
2397
|
* This response can have the following status codes:
|
|
2404
|
-
* - `
|
|
2405
|
-
* - `204`: Operation completed successfully (no content).
|
|
2398
|
+
* - `204`: Loader hidden successfully.
|
|
2406
2399
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
2407
2400
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
2408
2401
|
*
|
|
@@ -2416,9 +2409,6 @@ export declare type HideLoaderResponse = InferOutput<typeof HideLoaderResponseSc
|
|
|
2416
2409
|
* @public
|
|
2417
2410
|
*/
|
|
2418
2411
|
export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2419
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2420
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
2421
|
-
}, undefined>, v.ObjectSchema<{
|
|
2422
2412
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2423
2413
|
}, undefined>, v.ObjectSchema<{
|
|
2424
2414
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -2441,8 +2431,7 @@ export declare type HideLoaderResult = void;
|
|
|
2441
2431
|
*
|
|
2442
2432
|
* @remarks
|
|
2443
2433
|
* This response can have the following status codes:
|
|
2444
|
-
* - `
|
|
2445
|
-
* - `204`: Operation completed successfully (no content).
|
|
2434
|
+
* - `204`: Refresh button hidden successfully.
|
|
2446
2435
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
2447
2436
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
2448
2437
|
*
|
|
@@ -2456,9 +2445,6 @@ export declare type HideRefreshButtonResponse = InferOutput<typeof HideRefreshBu
|
|
|
2456
2445
|
* @public
|
|
2457
2446
|
*/
|
|
2458
2447
|
export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2459
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2460
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
2461
|
-
}, undefined>, v.ObjectSchema<{
|
|
2462
2448
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2463
2449
|
}, undefined>, v.ObjectSchema<{
|
|
2464
2450
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -2496,7 +2482,7 @@ export declare type HideRefreshButtonResult = void;
|
|
|
2496
2482
|
* @example
|
|
2497
2483
|
* **CDN (UMD):**
|
|
2498
2484
|
* ```html
|
|
2499
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
2485
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
2500
2486
|
* <script>
|
|
2501
2487
|
* const identity = new SuperAppSDK.IdentityModule();
|
|
2502
2488
|
* </script>
|
|
@@ -3034,7 +3020,7 @@ export declare function isSuccess<T extends BridgeResponse>(response: T): respon
|
|
|
3034
3020
|
* @example
|
|
3035
3021
|
* **CDN (UMD):**
|
|
3036
3022
|
* ```html
|
|
3037
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3023
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3038
3024
|
* <script>
|
|
3039
3025
|
* const locale = new SuperAppSDK.LocaleModule();
|
|
3040
3026
|
* </script>
|
|
@@ -3095,7 +3081,7 @@ export declare class LocaleModule extends BaseModule {
|
|
|
3095
3081
|
* @example
|
|
3096
3082
|
* **CDN (UMD):**
|
|
3097
3083
|
* ```html
|
|
3098
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3084
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3099
3085
|
* <script>
|
|
3100
3086
|
* const location = new SuperAppSDK.LocationModule();
|
|
3101
3087
|
* </script>
|
|
@@ -3109,6 +3095,8 @@ export declare class LocationModule extends BaseModule {
|
|
|
3109
3095
|
/**
|
|
3110
3096
|
* Get the current geographic coordinates of the device.
|
|
3111
3097
|
*
|
|
3098
|
+
* @requiredOAuthScope mobile.geolocation
|
|
3099
|
+
*
|
|
3112
3100
|
* @returns The device's current latitude and longitude coordinates. See {@link GetCoordinateResponse}.
|
|
3113
3101
|
*
|
|
3114
3102
|
* @example
|
|
@@ -3145,6 +3133,8 @@ export declare class LocationModule extends BaseModule {
|
|
|
3145
3133
|
/**
|
|
3146
3134
|
* Subscribe to location change updates from the device.
|
|
3147
3135
|
*
|
|
3136
|
+
* @requiredOAuthScope mobile.geolocation
|
|
3137
|
+
*
|
|
3148
3138
|
* @remarks
|
|
3149
3139
|
* This method returns a `BridgeStream` that continuously emits location updates.
|
|
3150
3140
|
* Remember to call `unsubscribe()` on the subscription when you no longer need updates
|
|
@@ -3190,6 +3180,8 @@ export declare class LocationModule extends BaseModule {
|
|
|
3190
3180
|
/**
|
|
3191
3181
|
* Get the country code based on the device's current location.
|
|
3192
3182
|
*
|
|
3183
|
+
* @requiredOAuthScope mobile.geolocation
|
|
3184
|
+
*
|
|
3193
3185
|
* @returns The ISO country code (e.g., 'SG', 'ID') based on the device's location. See {@link GetCountryCodeResponse}.
|
|
3194
3186
|
*
|
|
3195
3187
|
* @example
|
|
@@ -3261,7 +3253,7 @@ export declare class Logger {
|
|
|
3261
3253
|
* @example
|
|
3262
3254
|
* **CDN (UMD):**
|
|
3263
3255
|
* ```html
|
|
3264
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3256
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3265
3257
|
* <script>
|
|
3266
3258
|
* const media = new SuperAppSDK.MediaModule();
|
|
3267
3259
|
* </script>
|
|
@@ -3275,6 +3267,8 @@ export declare class MediaModule extends BaseModule {
|
|
|
3275
3267
|
/**
|
|
3276
3268
|
* Plays DRM-protected media content in the native media player.
|
|
3277
3269
|
*
|
|
3270
|
+
* @requiredOAuthScope mobile.media
|
|
3271
|
+
*
|
|
3278
3272
|
* @remarks
|
|
3279
3273
|
* Requires proper DRM content configuration including license URL and content metadata.
|
|
3280
3274
|
* For playback events and status updates, use {@link MediaModule.observePlayDRMContent}.
|
|
@@ -3319,6 +3313,8 @@ export declare class MediaModule extends BaseModule {
|
|
|
3319
3313
|
/**
|
|
3320
3314
|
* Observes DRM-protected media content playback events.
|
|
3321
3315
|
*
|
|
3316
|
+
* @requiredOAuthScope mobile.media
|
|
3317
|
+
*
|
|
3322
3318
|
* @remarks
|
|
3323
3319
|
* Subscribe to this stream to receive real-time playback events such as progress,
|
|
3324
3320
|
* completion, and errors. Remember to call `unsubscribe()` when done to free resources.
|
|
@@ -3379,7 +3375,7 @@ export declare class MediaModule extends BaseModule {
|
|
|
3379
3375
|
* @example
|
|
3380
3376
|
* **CDN (UMD):**
|
|
3381
3377
|
* ```html
|
|
3382
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3378
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3383
3379
|
* <script>
|
|
3384
3380
|
* const networkModule = new SuperAppSDK.NetworkModule();
|
|
3385
3381
|
* </script>
|
|
@@ -3582,7 +3578,7 @@ export declare type OpenExternalLinkRequest = string;
|
|
|
3582
3578
|
*
|
|
3583
3579
|
* @remarks
|
|
3584
3580
|
* This response can have the following status codes:
|
|
3585
|
-
* - `
|
|
3581
|
+
* - `204`: External link opened successfully.
|
|
3586
3582
|
* - `400`: Invalid URL parameter.
|
|
3587
3583
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
3588
3584
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
@@ -3597,9 +3593,6 @@ export declare type OpenExternalLinkResponse = InferOutput<typeof OpenExternalLi
|
|
|
3597
3593
|
* @public
|
|
3598
3594
|
*/
|
|
3599
3595
|
export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3600
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3601
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
3602
|
-
}, undefined>, v.ObjectSchema<{
|
|
3603
3596
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
3604
3597
|
}, undefined>, v.ObjectSchema<{
|
|
3605
3598
|
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
@@ -3646,7 +3639,7 @@ export declare type Platform = 'Android' | 'iOS';
|
|
|
3646
3639
|
* @example
|
|
3647
3640
|
* **CDN (UMD):**
|
|
3648
3641
|
* ```html
|
|
3649
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3642
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3650
3643
|
* <script>
|
|
3651
3644
|
* const platform = new SuperAppSDK.PlatformModule();
|
|
3652
3645
|
* </script>
|
|
@@ -3759,7 +3752,7 @@ export declare type PlayDRMContentResult = void;
|
|
|
3759
3752
|
* @example
|
|
3760
3753
|
* **CDN (UMD):**
|
|
3761
3754
|
* ```html
|
|
3762
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
3755
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
3763
3756
|
* <script>
|
|
3764
3757
|
* const profile = new SuperAppSDK.ProfileModule();
|
|
3765
3758
|
* </script>
|
|
@@ -3774,9 +3767,9 @@ export declare class ProfileModule extends BaseModule {
|
|
|
3774
3767
|
/**
|
|
3775
3768
|
* Fetches the user's email address from their Grab profile.
|
|
3776
3769
|
*
|
|
3777
|
-
* @
|
|
3778
|
-
*
|
|
3779
|
-
*
|
|
3770
|
+
* @minimumGrabAppVersion Android: 5.399.0, iOS: 5.399.0
|
|
3771
|
+
*
|
|
3772
|
+
* @requiredOAuthScope mobile.profile
|
|
3780
3773
|
*
|
|
3781
3774
|
* @returns The user's email address if available. See {@link FetchEmailResponse}.
|
|
3782
3775
|
*
|
|
@@ -3818,10 +3811,11 @@ export declare class ProfileModule extends BaseModule {
|
|
|
3818
3811
|
/**
|
|
3819
3812
|
* Verifies the user's email address by triggering email capture bottom sheet and OTP verification.
|
|
3820
3813
|
*
|
|
3821
|
-
* @
|
|
3822
|
-
* This method requires Grab app version 5.399 or above. If called on an older version,
|
|
3823
|
-
* it will return a 426 (Upgrade Required) response.
|
|
3814
|
+
* @minimumGrabAppVersion Android: 5.399.0, iOS: 5.399.0
|
|
3824
3815
|
*
|
|
3816
|
+
* @requiredOAuthScope mobile.profile
|
|
3817
|
+
*
|
|
3818
|
+
* @remarks
|
|
3825
3819
|
* If the user closes the verify OTP bottom sheet, the method will return a `status_code` of `204`.
|
|
3826
3820
|
* Successful verification will also update the email address for the user on Grab.
|
|
3827
3821
|
*
|
|
@@ -4186,7 +4180,7 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
|
4186
4180
|
* @example
|
|
4187
4181
|
* **CDN (UMD):**
|
|
4188
4182
|
* ```html
|
|
4189
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
4183
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
4190
4184
|
* <script>
|
|
4191
4185
|
* const scope = new SuperAppSDK.ScopeModule();
|
|
4192
4186
|
* </script>
|
|
@@ -4308,7 +4302,7 @@ export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
|
4308
4302
|
*
|
|
4309
4303
|
* @remarks
|
|
4310
4304
|
* This response can have the following status codes:
|
|
4311
|
-
* - `
|
|
4305
|
+
* - `204`: Analytics event sent successfully.
|
|
4312
4306
|
* - `400`: Invalid analytics event parameters.
|
|
4313
4307
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
4314
4308
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
@@ -4323,9 +4317,6 @@ export declare type SendAnalyticsEventResponse = InferOutput<typeof SendAnalytic
|
|
|
4323
4317
|
* @public
|
|
4324
4318
|
*/
|
|
4325
4319
|
export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4326
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4327
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4328
|
-
}, undefined>, v.ObjectSchema<{
|
|
4329
4320
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4330
4321
|
}, undefined>, v.ObjectSchema<{
|
|
4331
4322
|
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
@@ -4509,9 +4500,6 @@ export declare type SetBackgroundColorResponse = InferOutput<typeof SetBackgroun
|
|
|
4509
4500
|
* @public
|
|
4510
4501
|
*/
|
|
4511
4502
|
export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4512
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4513
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4514
|
-
}, undefined>, v.ObjectSchema<{
|
|
4515
4503
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4516
4504
|
}, undefined>, v.ObjectSchema<{
|
|
4517
4505
|
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
@@ -4725,7 +4713,6 @@ export declare type SetTitleRequest = string;
|
|
|
4725
4713
|
*
|
|
4726
4714
|
* @remarks
|
|
4727
4715
|
* This response can have the following status codes:
|
|
4728
|
-
* - `200`: Title set successfully.
|
|
4729
4716
|
* - `204`: Title set successfully.
|
|
4730
4717
|
* - `400`: Invalid title parameter.
|
|
4731
4718
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
@@ -4741,9 +4728,6 @@ export declare type SetTitleResponse = InferOutput<typeof SetTitleResponseSchema
|
|
|
4741
4728
|
* @public
|
|
4742
4729
|
*/
|
|
4743
4730
|
export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4744
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4745
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4746
|
-
}, undefined>, v.ObjectSchema<{
|
|
4747
4731
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4748
4732
|
}, undefined>, v.ObjectSchema<{
|
|
4749
4733
|
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
@@ -4769,8 +4753,7 @@ export declare type SetTitleResult = void;
|
|
|
4769
4753
|
*
|
|
4770
4754
|
* @remarks
|
|
4771
4755
|
* This response can have the following status codes:
|
|
4772
|
-
* - `
|
|
4773
|
-
* - `204`: Operation completed successfully (no content).
|
|
4756
|
+
* - `204`: Back button shown successfully.
|
|
4774
4757
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
4775
4758
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
4776
4759
|
*
|
|
@@ -4784,9 +4767,6 @@ export declare type ShowBackButtonResponse = InferOutput<typeof ShowBackButtonRe
|
|
|
4784
4767
|
* @public
|
|
4785
4768
|
*/
|
|
4786
4769
|
export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4787
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4788
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4789
|
-
}, undefined>, v.ObjectSchema<{
|
|
4790
4770
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4791
4771
|
}, undefined>, v.ObjectSchema<{
|
|
4792
4772
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -4809,8 +4789,7 @@ export declare type ShowBackButtonResult = void;
|
|
|
4809
4789
|
*
|
|
4810
4790
|
* @remarks
|
|
4811
4791
|
* This response can have the following status codes:
|
|
4812
|
-
* - `
|
|
4813
|
-
* - `204`: Operation completed successfully (no content).
|
|
4792
|
+
* - `204`: Loader shown successfully.
|
|
4814
4793
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
4815
4794
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
4816
4795
|
*
|
|
@@ -4824,9 +4803,6 @@ export declare type ShowLoaderResponse = InferOutput<typeof ShowLoaderResponseSc
|
|
|
4824
4803
|
* @public
|
|
4825
4804
|
*/
|
|
4826
4805
|
export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4827
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4828
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4829
|
-
}, undefined>, v.ObjectSchema<{
|
|
4830
4806
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4831
4807
|
}, undefined>, v.ObjectSchema<{
|
|
4832
4808
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -4849,8 +4825,7 @@ export declare type ShowLoaderResult = void;
|
|
|
4849
4825
|
*
|
|
4850
4826
|
* @remarks
|
|
4851
4827
|
* This response can have the following status codes:
|
|
4852
|
-
* - `
|
|
4853
|
-
* - `204`: Operation completed successfully (no content).
|
|
4828
|
+
* - `204`: Refresh button shown successfully.
|
|
4854
4829
|
* - `500`: Internal server error - an unexpected error occurred on the native side.
|
|
4855
4830
|
* - `501`: Not implemented - this method requires the Grab app environment.
|
|
4856
4831
|
*
|
|
@@ -4864,9 +4839,6 @@ export declare type ShowRefreshButtonResponse = InferOutput<typeof ShowRefreshBu
|
|
|
4864
4839
|
* @public
|
|
4865
4840
|
*/
|
|
4866
4841
|
export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4867
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4868
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
4869
|
-
}, undefined>, v.ObjectSchema<{
|
|
4870
4842
|
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4871
4843
|
}, undefined>, v.ObjectSchema<{
|
|
4872
4844
|
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
@@ -4902,7 +4874,7 @@ export declare type ShowRefreshButtonResult = void;
|
|
|
4902
4874
|
* @example
|
|
4903
4875
|
* **CDN (UMD):**
|
|
4904
4876
|
* ```html
|
|
4905
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
4877
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
4906
4878
|
* <script>
|
|
4907
4879
|
* const splash = new SuperAppSDK.SplashScreenModule();
|
|
4908
4880
|
* </script>
|
|
@@ -4959,7 +4931,7 @@ export declare class SplashScreenModule extends BaseModule {
|
|
|
4959
4931
|
* @example
|
|
4960
4932
|
* **CDN (UMD):**
|
|
4961
4933
|
* ```html
|
|
4962
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
4934
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
4963
4935
|
* <script>
|
|
4964
4936
|
* const storage = new SuperAppSDK.StorageModule();
|
|
4965
4937
|
* </script>
|
|
@@ -4973,6 +4945,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
4973
4945
|
/**
|
|
4974
4946
|
* Stores a boolean value in the native storage.
|
|
4975
4947
|
*
|
|
4948
|
+
* @requiredOAuthScope mobile.storage
|
|
4949
|
+
*
|
|
4976
4950
|
* @param key - The key to store the value under.
|
|
4977
4951
|
* @param value - The boolean value to store.
|
|
4978
4952
|
*
|
|
@@ -5005,6 +4979,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5005
4979
|
/**
|
|
5006
4980
|
* Retrieves a boolean value from the native storage.
|
|
5007
4981
|
*
|
|
4982
|
+
* @requiredOAuthScope mobile.storage
|
|
4983
|
+
*
|
|
5008
4984
|
* @param key - The key to retrieve the value for.
|
|
5009
4985
|
*
|
|
5010
4986
|
* @returns The stored boolean value. See {@link GetBooleanResponse}.
|
|
@@ -5036,6 +5012,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5036
5012
|
/**
|
|
5037
5013
|
* Stores an integer value in the native storage.
|
|
5038
5014
|
*
|
|
5015
|
+
* @requiredOAuthScope mobile.storage
|
|
5016
|
+
*
|
|
5039
5017
|
* @param key - The key to store the value under.
|
|
5040
5018
|
* @param value - The integer value to store.
|
|
5041
5019
|
*
|
|
@@ -5068,6 +5046,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5068
5046
|
/**
|
|
5069
5047
|
* Retrieves an integer value from the native storage.
|
|
5070
5048
|
*
|
|
5049
|
+
* @requiredOAuthScope mobile.storage
|
|
5050
|
+
*
|
|
5071
5051
|
* @param key - The key to retrieve the value for.
|
|
5072
5052
|
*
|
|
5073
5053
|
* @returns The stored integer value. See {@link GetIntResponse}.
|
|
@@ -5099,6 +5079,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5099
5079
|
/**
|
|
5100
5080
|
* Stores a string value in the native storage.
|
|
5101
5081
|
*
|
|
5082
|
+
* @requiredOAuthScope mobile.storage
|
|
5083
|
+
*
|
|
5102
5084
|
* @param key - The key to store the value under.
|
|
5103
5085
|
* @param value - The string value to store.
|
|
5104
5086
|
*
|
|
@@ -5131,6 +5113,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5131
5113
|
/**
|
|
5132
5114
|
* Retrieves a string value from the native storage.
|
|
5133
5115
|
*
|
|
5116
|
+
* @requiredOAuthScope mobile.storage
|
|
5117
|
+
*
|
|
5134
5118
|
* @param key - The key to retrieve the value for.
|
|
5135
5119
|
*
|
|
5136
5120
|
* @returns The stored string value. See {@link GetStringResponse}.
|
|
@@ -5162,6 +5146,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5162
5146
|
/**
|
|
5163
5147
|
* Stores a double (floating point) value in the native storage.
|
|
5164
5148
|
*
|
|
5149
|
+
* @requiredOAuthScope mobile.storage
|
|
5150
|
+
*
|
|
5165
5151
|
* @param key - The key to store the value under.
|
|
5166
5152
|
* @param value - The double value to store.
|
|
5167
5153
|
*
|
|
@@ -5194,6 +5180,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5194
5180
|
/**
|
|
5195
5181
|
* Retrieves a double (floating point) value from the native storage.
|
|
5196
5182
|
*
|
|
5183
|
+
* @requiredOAuthScope mobile.storage
|
|
5184
|
+
*
|
|
5197
5185
|
* @param key - The key to retrieve the value for.
|
|
5198
5186
|
*
|
|
5199
5187
|
* @returns The stored double value. See {@link GetDoubleResponse}.
|
|
@@ -5225,6 +5213,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5225
5213
|
/**
|
|
5226
5214
|
* Removes a single value from the native storage by key.
|
|
5227
5215
|
*
|
|
5216
|
+
* @requiredOAuthScope mobile.storage
|
|
5217
|
+
*
|
|
5228
5218
|
* @param key - The key to remove from storage.
|
|
5229
5219
|
*
|
|
5230
5220
|
* @returns Confirmation that the value was removed. See {@link RemoveResponse}.
|
|
@@ -5256,6 +5246,8 @@ export declare class StorageModule extends BaseModule {
|
|
|
5256
5246
|
/**
|
|
5257
5247
|
* Removes all values from the native storage.
|
|
5258
5248
|
*
|
|
5249
|
+
* @requiredOAuthScope mobile.storage
|
|
5250
|
+
*
|
|
5259
5251
|
* @returns Confirmation that all values were removed. See {@link RemoveAllResponse}.
|
|
5260
5252
|
*
|
|
5261
5253
|
* @example
|
|
@@ -5319,7 +5311,7 @@ export declare type Subscription = Readonly<{
|
|
|
5319
5311
|
* @example
|
|
5320
5312
|
* **CDN (UMD):**
|
|
5321
5313
|
* ```html
|
|
5322
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
5314
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
5323
5315
|
* <script>
|
|
5324
5316
|
* const webViewKit = new SuperAppSDK.SystemWebViewKitModule();
|
|
5325
5317
|
* </script>
|
|
@@ -5534,7 +5526,7 @@ export declare const TriggerCheckoutResultSchema: v.VariantSchema<"status", [v.O
|
|
|
5534
5526
|
* @example
|
|
5535
5527
|
* **CDN (UMD):**
|
|
5536
5528
|
* ```html
|
|
5537
|
-
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk/dist/index.js"></script>
|
|
5529
|
+
* <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
|
|
5538
5530
|
* <script>
|
|
5539
5531
|
* const userAttributesModule = new SuperAppSDK.UserAttributesModule();
|
|
5540
5532
|
* </script>
|