@grabjs/superapp-sdk 2.0.0-beta.23 → 2.0.0-beta.28

package/api-reference/markdown/type-aliases/HasAccessToResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HasAccessToResult
-
-# Type Alias: HasAccessToResult
-
-> **HasAccessToResult** = \{ `hasAccess`: `boolean`; \}
-
-Result object containing the access check result.
-
-## Examples
-
-**Has access:**
-```typescript
-{ hasAccess: true }
-```
-
-**No access:**
-```typescript
-{ hasAccess: false }
-```
-
-## Properties
-
-### hasAccess
-
-> **hasAccess**: `boolean`
-
-True if the current client has access to the specified API, false otherwise.

package/api-reference/markdown/type-aliases/HideBackButtonResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideBackButtonResponse
-
-# Type Alias: HideBackButtonResponse
-
-> **HideBackButtonResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`HideBackButtonResult`](HideBackButtonResult.md)\>
-
-Response when hiding the back button.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Back button hidden successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/HideBackButtonResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideBackButtonResult
-
-# Type Alias: HideBackButtonResult
-
-> **HideBackButtonResult** = `void`
-
-Result when hiding the back button.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/HideLoaderResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideLoaderResponse
-
-# Type Alias: HideLoaderResponse
-
-> **HideLoaderResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`HideLoaderResult`](HideLoaderResult.md)\>
-
-Response when hiding the loader.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Loader hidden successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/HideLoaderResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideLoaderResult
-
-# Type Alias: HideLoaderResult
-
-> **HideLoaderResult** = `void`
-
-Result when hiding the loader.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/HideRefreshButtonResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideRefreshButtonResponse
-
-# Type Alias: HideRefreshButtonResponse
-
-> **HideRefreshButtonResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`HideRefreshButtonResult`](HideRefreshButtonResult.md)\>
-
-Response when hiding the refresh button.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Refresh button hidden successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/HideRefreshButtonResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HideRefreshButtonResult
-
-# Type Alias: HideRefreshButtonResult
-
-> **HideRefreshButtonResult** = `void`
-
-Result when hiding the refresh button.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/IsConnectedResponse.md

@@ -1,31 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / IsConnectedResponse
-
-# Type Alias: IsConnectedResponse
-
-> **IsConnectedResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `404`, [`IsConnectedResult`](IsConnectedResult.md)\>
-
-Response when checking connection status.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Connected to Grab SuperApp. The `result` contains the connection status.
-- `404`: Not connected to Grab SuperApp.
-
-## Examples
-
-**Connected response (200):**
-```typescript
-{
-  status_code: 200,
-  result: { connected: true }
-}
-```
-
-**Not connected response (404):**
-```typescript
-{
-  status_code: 404,
-  error: 'Not connected to Grab app'
-}
-```

package/api-reference/markdown/type-aliases/IsConnectedResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / IsConnectedResult
-
-# Type Alias: IsConnectedResult
-
-> **IsConnectedResult** = \{ `connected`: `boolean`; \}
-
-Result object containing the connection status.
-
-## Examples
-
-**Connected to Grab SuperApp:**
-```typescript
-{ connected: true }
-```
-
-**Not connected:**
-```typescript
-{ connected: false }
-```
-
-## Properties
-
-### connected
-
-> **connected**: `boolean`
-
-Whether the MiniApp is connected to the Grab SuperApp.

package/api-reference/markdown/type-aliases/IsEsimSupportedResponse.md

@@ -1,48 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / IsEsimSupportedResponse
-
-# Type Alias: IsEsimSupportedResponse
-
-> **IsEsimSupportedResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`IsEsimSupportedResult`](IsEsimSupportedResult.md)\>
-
-Response when checking whether the current device supports eSIM.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: eSIM capability was checked successfully. The `result` contains `true` or `false`.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200) - eSIM supported:**
-```typescript
-{
-  status_code: 200,
-  result: true
-}
-```
-
-**Success response (200) - eSIM not supported:**
-```typescript
-{
-  status_code: 200,
-  result: false
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/IsEsimSupportedResult.md

@@ -1,17 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / IsEsimSupportedResult
-
-# Type Alias: IsEsimSupportedResult
-
-> **IsEsimSupportedResult** = `boolean`
-
-Result indicating whether the current device supports eSIM.
-
-## Examples
-
-```typescript
-true
-```
-
-```typescript
-false
-```

package/api-reference/markdown/type-aliases/ObserveDRMPlaybackResponse.md

@@ -1,15 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ObserveDRMPlaybackResponse
-
-# Type Alias: ObserveDRMPlaybackResponse
-
-> **ObserveDRMPlaybackResponse** = [`BridgeStream`](BridgeStream.md)\<`200` \| `500` \| `501`, [`DRMPlaybackEvent`](DRMPlaybackEvent.md)\>
-
-Response stream for observing DRM playback events.
-
-## Remarks
-
-This is a `BridgeStream` that can be:
-- Subscribed to via `.subscribe()` for continuous updates
-- Awaited via `await` to get the first value only
-
-The stream can emit status codes 200 (event data), 500 (server error), or 501 (not implemented).

package/api-reference/markdown/type-aliases/ObserveLocationChangeResponse.md

@@ -1,15 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ObserveLocationChangeResponse
-
-# Type Alias: ObserveLocationChangeResponse
-
-> **ObserveLocationChangeResponse** = [`BridgeStream`](BridgeStream.md)\<`200` \| `424` \| `500` \| `501`, [`GetCoordinateResult`](GetCoordinateResult.md)\>
-
-Response when observing the device coordinates.
-
-## Remarks
-
-This is a `BridgeStream` that can be:
-- Subscribed to via `.subscribe()` for continuous updates
-- Awaited via `await` to get the first value only
-
-The stream can emit the same status codes as [GetCoordinateResponse](GetCoordinateResponse.md).

package/api-reference/markdown/type-aliases/OnContentLoadedResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OnContentLoadedResponse
-
-# Type Alias: OnContentLoadedResponse
-
-> **OnContentLoadedResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`OnContentLoadedResult`](OnContentLoadedResult.md)\>
-
-Response when notifying content loaded.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Notification sent successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/OnContentLoadedResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OnContentLoadedResult
-
-# Type Alias: OnContentLoadedResult
-
-> **OnContentLoadedResult** = `void`
-
-Result when notifying content loaded.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/OnCtaTapRequest.md

@@ -1,13 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OnCtaTapRequest
-
-# Type Alias: OnCtaTapRequest
-
-> **OnCtaTapRequest** = `string`
-
-Request parameters for notifying CTA tap.
-
-## Example
-
-```typescript
-'AV_LANDING_PAGE_CONTINUE'
-```

package/api-reference/markdown/type-aliases/OnCtaTapResponse.md

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OnCtaTapResponse
-
-# Type Alias: OnCtaTapResponse
-
-> **OnCtaTapResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`OnCtaTapResult`](OnCtaTapResult.md)\>
-
-Response when notifying CTA tap.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: CTA tap notification sent successfully.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/OnCtaTapResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OnCtaTapResult
-
-# Type Alias: OnCtaTapResult
-
-> **OnCtaTapResult** = `void`
-
-Result when notifying CTA tap.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/OpenExternalLinkRequest.md

@@ -1,13 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OpenExternalLinkRequest
-
-# Type Alias: OpenExternalLinkRequest
-
-> **OpenExternalLinkRequest** = `string`
-
-Request parameters for opening an external link.
-
-## Example
-
-```typescript
-'https://example.com'
-```

package/api-reference/markdown/type-aliases/OpenExternalLinkResponse.md

@@ -1,46 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OpenExternalLinkResponse
-
-# Type Alias: OpenExternalLinkResponse
-
-> **OpenExternalLinkResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`OpenExternalLinkResult`](OpenExternalLinkResult.md)\>
-
-Response when opening an external link.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: External link opened successfully.
-- `400`: Invalid URL parameter.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'URL parameter not found'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/OpenExternalLinkResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / OpenExternalLinkResult
-
-# Type Alias: OpenExternalLinkResult
-
-> **OpenExternalLinkResult** = `void`
-
-Result when opening an external link.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/Platform.md

@@ -1,7 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / Platform
-
-# Type Alias: Platform
-
-> **Platform** = `"Android"` \| `"iOS"`
-
-Represents the mobile operating system platform.

package/api-reference/markdown/type-aliases/PlayDRMContentResponse.md

@@ -1,43 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / PlayDRMContentResponse
-
-# Type Alias: PlayDRMContentResponse
-
-> **PlayDRMContentResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `204` \| `500` \| `501`, [`PlayDRMContentResult`](PlayDRMContentResult.md)\>
-
-Response when initiating DRM content playback.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Playback initiated successfully (streaming content).
-- `204`: Invalid parameters - the DRM configuration is malformed or missing required fields.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Invalid parameters response (204):**
-```typescript
-{ status_code: 204 }
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/PlayDRMContentResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / PlayDRMContentResult
-
-# Type Alias: PlayDRMContentResult
-
-> **PlayDRMContentResult** = `void`
-
-Result object for DRM content playback initiation.
-This operation returns no data on success.

package/api-reference/markdown/type-aliases/RedirectToSystemWebViewRequest.md

@@ -1,23 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / RedirectToSystemWebViewRequest
-
-# Type Alias: RedirectToSystemWebViewRequest
-
-> **RedirectToSystemWebViewRequest** = \{ `url`: `string`; \}
-
-Request parameters for redirecting to the system web view.
-
-## Example
-
-```typescript
-{
-  url: 'https://www.example.com'
-}
-```
-
-## Properties
-
-### url
-
-> **url**: `string`
-
-The URL to open in the system web view.

package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResponse.md

@@ -1,55 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / RedirectToSystemWebViewResponse
-
-# Type Alias: RedirectToSystemWebViewResponse
-
-> **RedirectToSystemWebViewResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `424` \| `500` \| `501`, [`RedirectToSystemWebViewResult`](RedirectToSystemWebViewResult.md)\>
-
-Response when redirecting to the system web view.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Redirect initiated successfully.
-- `400`: Invalid URL, domain not whitelisted, or missing callback URL.
-- `424`: ASWebAuthenticationSession error - dependency error on iOS.
-- `500`: Internal server error - an unexpected error occurred on the native side.
-- `501`: Not implemented - this method requires the Grab app environment.
-
-## Examples
-
-**Success response (200):**
-```typescript
-{ status_code: 200 }
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Invalid URL or domain not whitelisted'
-}
-```
-
-**Failed dependency response (424):**
-```typescript
-{
-  status_code: 424,
-  error: 'ASWebAuthenticationSession error'
-}
-```
-
-**Not implemented response (501) - outside Grab app:**
-```typescript
-{
-  status_code: 501,
-  error: 'Not implemented: This method requires the Grab app environment'
-}
-```
-
-**Internal server error response (500):**
-```typescript
-{
-  status_code: 500,
-  error: 'Internal server error'
-}
-```

package/api-reference/markdown/type-aliases/RedirectToSystemWebViewResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / RedirectToSystemWebViewResult
-
-# Type Alias: RedirectToSystemWebViewResult
-
-> **RedirectToSystemWebViewResult** = `void`
-
-Result object for redirecting to the system web view.
-This operation returns no data on success.