@grabjs/superapp-sdk 2.0.0-beta.12 → 2.0.0-beta.23
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/README.md +170 -55
- package/api-reference/json/api.json +27688 -0
- package/api-reference/markdown/README.md +194 -0
- package/api-reference/markdown/classes/BaseModule.md +123 -0
- package/api-reference/markdown/classes/CameraModule.md +177 -0
- package/api-reference/markdown/classes/CheckoutModule.md +181 -0
- package/api-reference/markdown/classes/ContainerModule.md +751 -0
- package/api-reference/markdown/classes/DeviceCapabilityModule.md +161 -0
- package/api-reference/markdown/classes/FileModule.md +178 -0
- package/api-reference/markdown/classes/IdentityModule.md +299 -0
- package/api-reference/markdown/classes/LocaleModule.md +161 -0
- package/api-reference/markdown/classes/LocationModule.md +239 -0
- package/api-reference/markdown/classes/MediaModule.md +219 -0
- package/api-reference/markdown/classes/PlatformModule.md +162 -0
- package/api-reference/markdown/classes/ProfileModule.md +224 -0
- package/api-reference/markdown/classes/ScopeModule.md +219 -0
- package/api-reference/markdown/classes/StorageModule.md +608 -0
- package/api-reference/markdown/classes/SystemWebViewKitModule.md +177 -0
- package/api-reference/markdown/classes/UserAttributesModule.md +164 -0
- package/api-reference/markdown/functions/isClientError.md +37 -0
- package/api-reference/markdown/functions/isErrorResponse.md +40 -0
- package/api-reference/markdown/functions/isRedirection.md +37 -0
- package/api-reference/markdown/functions/isServerError.md +37 -0
- package/api-reference/markdown/functions/isSuccess.md +39 -0
- package/api-reference/markdown/globals.md +176 -0
- package/api-reference/markdown/interfaces/GrabAppInfo.md +23 -0
- package/api-reference/markdown/interfaces/InvokeOptions.md +63 -0
- package/api-reference/markdown/interfaces/Version.md +23 -0
- package/api-reference/markdown/interfaces/WrappedModule.md +51 -0
- package/api-reference/markdown/type-aliases/AuthorizeRequest.md +79 -0
- package/api-reference/markdown/type-aliases/AuthorizeResponse.md +58 -0
- package/api-reference/markdown/type-aliases/AuthorizeResult.md +33 -0
- package/api-reference/markdown/type-aliases/BackResponse.md +37 -0
- package/api-reference/markdown/type-aliases/BackResult.md +8 -0
- package/api-reference/markdown/type-aliases/BridgeClientError.md +9 -0
- package/api-reference/markdown/type-aliases/BridgeError.md +8 -0
- package/api-reference/markdown/type-aliases/BridgeRedirection.md +8 -0
- package/api-reference/markdown/type-aliases/BridgeResponse.md +40 -0
- package/api-reference/markdown/type-aliases/BridgeServerError.md +8 -0
- package/api-reference/markdown/type-aliases/BridgeStatusCode.md +7 -0
- package/api-reference/markdown/type-aliases/BridgeStream.md +29 -0
- package/api-reference/markdown/type-aliases/BridgeStreamHandlers.md +25 -0
- package/api-reference/markdown/type-aliases/BridgeSuccessResponse.md +14 -0
- package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResponse.md +18 -0
- package/api-reference/markdown/type-aliases/ClearAuthorizationArtifactsResult.md +8 -0
- package/api-reference/markdown/type-aliases/CloseResponse.md +37 -0
- package/api-reference/markdown/type-aliases/CloseResult.md +8 -0
- package/api-reference/markdown/type-aliases/DRMContentConfig.md +34 -0
- package/api-reference/markdown/type-aliases/DRMPlaybackEvent.md +43 -0
- package/api-reference/markdown/type-aliases/DownloadFileRequest.md +32 -0
- package/api-reference/markdown/type-aliases/DownloadFileResponse.md +48 -0
- package/api-reference/markdown/type-aliases/DownloadFileResult.md +11 -0
- package/api-reference/markdown/type-aliases/ErrorResponse.md +32 -0
- package/api-reference/markdown/type-aliases/FetchEmailResponse.md +58 -0
- package/api-reference/markdown/type-aliases/FetchEmailResult.md +21 -0
- package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResponse.md +42 -0
- package/api-reference/markdown/type-aliases/GetAuthorizationArtifactsResult.md +57 -0
- package/api-reference/markdown/type-aliases/GetBooleanRequest.md +21 -0
- package/api-reference/markdown/type-aliases/GetBooleanResponse.md +57 -0
- package/api-reference/markdown/type-aliases/GetBooleanResult.md +27 -0
- package/api-reference/markdown/type-aliases/GetCoordinateResponse.md +49 -0
- package/api-reference/markdown/type-aliases/GetCoordinateResult.md +29 -0
- package/api-reference/markdown/type-aliases/GetCountryCodeResponse.md +57 -0
- package/api-reference/markdown/type-aliases/GetCountryCodeResult.md +25 -0
- package/api-reference/markdown/type-aliases/GetDoubleRequest.md +21 -0
- package/api-reference/markdown/type-aliases/GetDoubleResponse.md +57 -0
- package/api-reference/markdown/type-aliases/GetDoubleResult.md +27 -0
- package/api-reference/markdown/type-aliases/GetIntRequest.md +21 -0
- package/api-reference/markdown/type-aliases/GetIntResponse.md +57 -0
- package/api-reference/markdown/type-aliases/GetIntResult.md +27 -0
- package/api-reference/markdown/type-aliases/GetLanguageLocaleIdentifierResponse.md +48 -0
- package/api-reference/markdown/type-aliases/GetLanguageLocaleIdentifierResult.md +31 -0
- package/api-reference/markdown/type-aliases/GetSelectedTravelDestinationResponse.md +48 -0
- package/api-reference/markdown/type-aliases/GetSelectedTravelDestinationResult.md +17 -0
- package/api-reference/markdown/type-aliases/GetSessionParamsResponse.md +40 -0
- package/api-reference/markdown/type-aliases/GetSessionParamsResult.md +27 -0
- package/api-reference/markdown/type-aliases/GetStringRequest.md +21 -0
- package/api-reference/markdown/type-aliases/GetStringResponse.md +57 -0
- package/api-reference/markdown/type-aliases/GetStringResult.md +27 -0
- package/api-reference/markdown/type-aliases/HasAccessToResponse.md +66 -0
- package/api-reference/markdown/type-aliases/HasAccessToResult.md +27 -0
- package/api-reference/markdown/type-aliases/HideBackButtonResponse.md +37 -0
- package/api-reference/markdown/type-aliases/HideBackButtonResult.md +8 -0
- package/api-reference/markdown/type-aliases/HideLoaderResponse.md +37 -0
- package/api-reference/markdown/type-aliases/HideLoaderResult.md +8 -0
- package/api-reference/markdown/type-aliases/HideRefreshButtonResponse.md +37 -0
- package/api-reference/markdown/type-aliases/HideRefreshButtonResult.md +8 -0
- package/api-reference/markdown/type-aliases/IsConnectedResponse.md +31 -0
- package/api-reference/markdown/type-aliases/IsConnectedResult.md +27 -0
- package/api-reference/markdown/type-aliases/IsEsimSupportedResponse.md +48 -0
- package/api-reference/markdown/type-aliases/IsEsimSupportedResult.md +17 -0
- package/api-reference/markdown/type-aliases/ObserveDRMPlaybackResponse.md +15 -0
- package/api-reference/markdown/type-aliases/ObserveLocationChangeResponse.md +15 -0
- package/api-reference/markdown/type-aliases/OnContentLoadedResponse.md +37 -0
- package/api-reference/markdown/type-aliases/OnContentLoadedResult.md +8 -0
- package/api-reference/markdown/type-aliases/OnCtaTapRequest.md +13 -0
- package/api-reference/markdown/type-aliases/OnCtaTapResponse.md +37 -0
- package/api-reference/markdown/type-aliases/OnCtaTapResult.md +8 -0
- package/api-reference/markdown/type-aliases/OpenExternalLinkRequest.md +13 -0
- package/api-reference/markdown/type-aliases/OpenExternalLinkResponse.md +46 -0
- package/api-reference/markdown/type-aliases/OpenExternalLinkResult.md +8 -0
- package/api-reference/markdown/type-aliases/Platform.md +7 -0
- package/api-reference/markdown/type-aliases/PlayDRMContentResponse.md +43 -0
- package/api-reference/markdown/type-aliases/PlayDRMContentResult.md +8 -0
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewRequest.md +23 -0
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResponse.md +55 -0
- package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResult.md +8 -0
- package/api-reference/markdown/type-aliases/ReloadScopesResponse.md +46 -0
- package/api-reference/markdown/type-aliases/ReloadScopesResult.md +8 -0
- package/api-reference/markdown/type-aliases/RemoveAllResponse.md +37 -0
- package/api-reference/markdown/type-aliases/RemoveAllResult.md +8 -0
- package/api-reference/markdown/type-aliases/RemoveResponse.md +46 -0
- package/api-reference/markdown/type-aliases/RemoveResult.md +8 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode200.md +34 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode204.md +20 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode302.md +20 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode400.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode401.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode403.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode404.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode424.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode426.md +12 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode500.md +7 -0
- package/api-reference/markdown/type-aliases/ResponseStatusCode501.md +12 -0
- package/api-reference/markdown/type-aliases/ScanQRCodeRequest.md +27 -0
- package/api-reference/markdown/type-aliases/ScanQRCodeResponse.md +64 -0
- package/api-reference/markdown/type-aliases/ScanQRCodeResult.md +21 -0
- package/api-reference/markdown/type-aliases/SendAnalyticsEventRequest.md +56 -0
- package/api-reference/markdown/type-aliases/SendAnalyticsEventResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SendAnalyticsEventResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetBackgroundColorRequest.md +13 -0
- package/api-reference/markdown/type-aliases/SetBackgroundColorResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetBackgroundColorResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetBooleanResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetBooleanResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetDoubleResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetDoubleResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetIntResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetIntResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetStringResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetStringResult.md +8 -0
- package/api-reference/markdown/type-aliases/SetTitleRequest.md +13 -0
- package/api-reference/markdown/type-aliases/SetTitleResponse.md +46 -0
- package/api-reference/markdown/type-aliases/SetTitleResult.md +8 -0
- package/api-reference/markdown/type-aliases/ShowBackButtonResponse.md +37 -0
- package/api-reference/markdown/type-aliases/ShowBackButtonResult.md +8 -0
- package/api-reference/markdown/type-aliases/ShowLoaderResponse.md +37 -0
- package/api-reference/markdown/type-aliases/ShowLoaderResult.md +8 -0
- package/api-reference/markdown/type-aliases/ShowRefreshButtonResponse.md +37 -0
- package/api-reference/markdown/type-aliases/ShowRefreshButtonResult.md +8 -0
- package/api-reference/markdown/type-aliases/StatusCodeMap.md +80 -0
- package/api-reference/markdown/type-aliases/Subscription.md +12 -0
- package/api-reference/markdown/type-aliases/TriggerCheckoutRequest.md +26 -0
- package/api-reference/markdown/type-aliases/TriggerCheckoutResponse.md +76 -0
- package/api-reference/markdown/type-aliases/TriggerCheckoutResult.md +75 -0
- package/api-reference/markdown/type-aliases/VerifyEmailRequest.md +32 -0
- package/api-reference/markdown/type-aliases/VerifyEmailResponse.md +55 -0
- package/api-reference/markdown/type-aliases/VerifyEmailResult.md +8 -0
- package/api-reference/markdown/variables/ContainerAnalyticsEventData.md +21 -0
- package/api-reference/markdown/variables/ContainerAnalyticsEventName.md +13 -0
- package/api-reference/markdown/variables/ContainerAnalyticsEventState.md +25 -0
- package/dist/index.d.ts +3377 -1139
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +24 -13
- package/dist/api.json +0 -16795
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[@grabjs/superapp-sdk](../globals.md) / VerifyEmailResponse
|
|
2
|
+
|
|
3
|
+
# Type Alias: VerifyEmailResponse
|
|
4
|
+
|
|
5
|
+
> **VerifyEmailResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `426` \| `500` \| `501`, [`VerifyEmailResult`](VerifyEmailResult.md)\>
|
|
6
|
+
|
|
7
|
+
Response when verifying the user's email.
|
|
8
|
+
|
|
9
|
+
## Remarks
|
|
10
|
+
|
|
11
|
+
This response can have the following status codes:
|
|
12
|
+
- `200`: Email verified successfully.
|
|
13
|
+
- `400`: Invalid request - OTP is incorrect or expired.
|
|
14
|
+
- `426`: Upgrade Required - feature requires Grab app version 5.399 or above.
|
|
15
|
+
- `500`: Internal server error - an unexpected error occurred on the native side.
|
|
16
|
+
- `501`: Not implemented - this method requires the Grab app environment.
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
**Success response (200):**
|
|
21
|
+
```typescript
|
|
22
|
+
{ status_code: 200 }
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Bad request response (400):**
|
|
26
|
+
```typescript
|
|
27
|
+
{
|
|
28
|
+
status_code: 400,
|
|
29
|
+
error: 'Invalid OTP'
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**Upgrade Required response (426):**
|
|
34
|
+
```typescript
|
|
35
|
+
{
|
|
36
|
+
status_code: 426,
|
|
37
|
+
error: 'Upgrade Required: This method requires Grab app version 5.399.0 or above on iOS'
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Not implemented response (501) - outside Grab app:**
|
|
42
|
+
```typescript
|
|
43
|
+
{
|
|
44
|
+
status_code: 501,
|
|
45
|
+
error: 'Not implemented: This method requires the Grab app environment'
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
**Internal server error response (500):**
|
|
50
|
+
```typescript
|
|
51
|
+
{
|
|
52
|
+
status_code: 500,
|
|
53
|
+
error: 'Internal server error'
|
|
54
|
+
}
|
|
55
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[@grabjs/superapp-sdk](../globals.md) / ContainerAnalyticsEventData
|
|
2
|
+
|
|
3
|
+
# Variable: ContainerAnalyticsEventData
|
|
4
|
+
|
|
5
|
+
> `const` **ContainerAnalyticsEventData**: \{ `PAGE`: `string`; `TRANSACTION_AMOUNT`: `string`; `TRANSACTION_CURRENCY`: `string`; \}
|
|
6
|
+
|
|
7
|
+
Constants for container analytics event data.
|
|
8
|
+
|
|
9
|
+
## Type Declaration
|
|
10
|
+
|
|
11
|
+
### PAGE
|
|
12
|
+
|
|
13
|
+
> **PAGE**: `string` = `'page'`
|
|
14
|
+
|
|
15
|
+
### TRANSACTION\_AMOUNT
|
|
16
|
+
|
|
17
|
+
> **TRANSACTION\_AMOUNT**: `string` = `'transaction_amount'`
|
|
18
|
+
|
|
19
|
+
### TRANSACTION\_CURRENCY
|
|
20
|
+
|
|
21
|
+
> **TRANSACTION\_CURRENCY**: `string` = `'transaction_currency'`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[@grabjs/superapp-sdk](../globals.md) / ContainerAnalyticsEventName
|
|
2
|
+
|
|
3
|
+
# Variable: ContainerAnalyticsEventName
|
|
4
|
+
|
|
5
|
+
> `const` **ContainerAnalyticsEventName**: \{ `DEFAULT`: `string`; \}
|
|
6
|
+
|
|
7
|
+
Constants for container analytics event names.
|
|
8
|
+
|
|
9
|
+
## Type Declaration
|
|
10
|
+
|
|
11
|
+
### DEFAULT
|
|
12
|
+
|
|
13
|
+
> **DEFAULT**: `string` = `'DEFAULT'`
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[@grabjs/superapp-sdk](../globals.md) / ContainerAnalyticsEventState
|
|
2
|
+
|
|
3
|
+
# Variable: ContainerAnalyticsEventState
|
|
4
|
+
|
|
5
|
+
> `const` **ContainerAnalyticsEventState**: \{ `BOOKING_COMPLETION`: `string`; `CHECKOUT_PAGE`: `string`; `CUSTOM`: `string`; `HOMEPAGE`: `string`; \}
|
|
6
|
+
|
|
7
|
+
Constants for container analytics event states.
|
|
8
|
+
|
|
9
|
+
## Type Declaration
|
|
10
|
+
|
|
11
|
+
### BOOKING\_COMPLETION
|
|
12
|
+
|
|
13
|
+
> **BOOKING\_COMPLETION**: `string` = `'BOOKING_COMPLETION'`
|
|
14
|
+
|
|
15
|
+
### CHECKOUT\_PAGE
|
|
16
|
+
|
|
17
|
+
> **CHECKOUT\_PAGE**: `string` = `'CHECKOUT_PAGE'`
|
|
18
|
+
|
|
19
|
+
### CUSTOM
|
|
20
|
+
|
|
21
|
+
> **CUSTOM**: `string` = `'CUSTOM'`
|
|
22
|
+
|
|
23
|
+
### HOMEPAGE
|
|
24
|
+
|
|
25
|
+
> **HOMEPAGE**: `string` = `'HOMEPAGE'`
|