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

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

@@ -1,46 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetDoubleResponse
-
-# Type Alias: SetDoubleResponse
-
-> **SetDoubleResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204` \| `400` \| `500` \| `501`, [`SetDoubleResult`](SetDoubleResult.md)\>
-
-Response when setting a double value.
-
-## Remarks
-
-This response can have the following status codes:
-- `204`: Value stored successfully.
-- `400`: Missing required parameters - key or value not provided.
-- `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 (204):**
-```typescript
-{ status_code: 204 }
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Missing required parameters'
-}
-```
-
-**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/SetDoubleResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetDoubleResult
-
-# Type Alias: SetDoubleResult
-
-> **SetDoubleResult** = `void`
-
-Result object for setting a double value.
-This operation returns no data on success.

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

@@ -1,46 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetIntResponse
-
-# Type Alias: SetIntResponse
-
-> **SetIntResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204` \| `400` \| `500` \| `501`, [`SetIntResult`](SetIntResult.md)\>
-
-Response when setting an integer value.
-
-## Remarks
-
-This response can have the following status codes:
-- `204`: Value stored successfully.
-- `400`: Missing required parameters - key or value not provided.
-- `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 (204):**
-```typescript
-{ status_code: 204 }
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Missing required parameters'
-}
-```
-
-**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/SetIntResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetIntResult
-
-# Type Alias: SetIntResult
-
-> **SetIntResult** = `void`
-
-Result object for setting an integer value.
-This operation returns no data on success.

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

@@ -1,46 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetStringResponse
-
-# Type Alias: SetStringResponse
-
-> **SetStringResponse** = [`BridgeResponse`](BridgeResponse.md)\<`204` \| `400` \| `500` \| `501`, [`SetStringResult`](SetStringResult.md)\>
-
-Response when setting a string value.
-
-## Remarks
-
-This response can have the following status codes:
-- `204`: Value stored successfully.
-- `400`: Missing required parameters - key or value not provided.
-- `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 (204):**
-```typescript
-{ status_code: 204 }
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Missing required parameters'
-}
-```
-
-**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/SetStringResult.md

@@ -1,8 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetStringResult
-
-# Type Alias: SetStringResult
-
-> **SetStringResult** = `void`
-
-Result object for setting a string value.
-This operation returns no data on success.

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

@@ -1,13 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetTitleRequest
-
-# Type Alias: SetTitleRequest
-
-> **SetTitleRequest** = `string`
-
-Request parameters for setting the title.
-
-## Example
-
-```typescript
-'Home Page'
-```

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

@@ -1,46 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / SetTitleResponse
-
-# Type Alias: SetTitleResponse
-
-> **SetTitleResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`SetTitleResult`](SetTitleResult.md)\>
-
-Response when setting the title.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Title set successfully.
-- `400`: Invalid title 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: 'Invalid title parameter'
-}
-```
-
-**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/SetTitleResult.md

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

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

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ShowBackButtonResponse
-
-# Type Alias: ShowBackButtonResponse
-
-> **ShowBackButtonResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`ShowBackButtonResult`](ShowBackButtonResult.md)\>
-
-Response when showing the back button.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Back button shown 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/ShowBackButtonResult.md

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

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

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ShowLoaderResponse
-
-# Type Alias: ShowLoaderResponse
-
-> **ShowLoaderResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`ShowLoaderResult`](ShowLoaderResult.md)\>
-
-Response when showing the loader.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Loader shown 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/ShowLoaderResult.md

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

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

@@ -1,37 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / ShowRefreshButtonResponse
-
-# Type Alias: ShowRefreshButtonResponse
-
-> **ShowRefreshButtonResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`ShowRefreshButtonResult`](ShowRefreshButtonResult.md)\>
-
-Response when showing the refresh button.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Refresh button shown 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/ShowRefreshButtonResult.md

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

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

@@ -1,80 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / StatusCodeMap
-
-# Type Alias: StatusCodeMap\<T\>
-
-> **StatusCodeMap**\<`T`\> = \{ `200`: [`ResponseStatusCode200`](ResponseStatusCode200.md)\<`T`\>; `204`: [`ResponseStatusCode204`](ResponseStatusCode204.md); `302`: [`ResponseStatusCode302`](ResponseStatusCode302.md); `400`: [`ResponseStatusCode400`](ResponseStatusCode400.md); `401`: [`ResponseStatusCode401`](ResponseStatusCode401.md); `403`: [`ResponseStatusCode403`](ResponseStatusCode403.md); `404`: [`ResponseStatusCode404`](ResponseStatusCode404.md); `424`: [`ResponseStatusCode424`](ResponseStatusCode424.md); `426`: [`ResponseStatusCode426`](ResponseStatusCode426.md); `500`: [`ResponseStatusCode500`](ResponseStatusCode500.md); `501`: [`ResponseStatusCode501`](ResponseStatusCode501.md); \}
-
-Map of individual status codes to their JSBridge response types.
-Used internally by BridgeResponse to select specific response types.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Properties
-
-### 200
-
-> **200**: [`ResponseStatusCode200`](ResponseStatusCode200.md)\<`T`\>
-
-***
-
-### 204
-
-> **204**: [`ResponseStatusCode204`](ResponseStatusCode204.md)
-
-***
-
-### 302
-
-> **302**: [`ResponseStatusCode302`](ResponseStatusCode302.md)
-
-***
-
-### 400
-
-> **400**: [`ResponseStatusCode400`](ResponseStatusCode400.md)
-
-***
-
-### 401
-
-> **401**: [`ResponseStatusCode401`](ResponseStatusCode401.md)
-
-***
-
-### 403
-
-> **403**: [`ResponseStatusCode403`](ResponseStatusCode403.md)
-
-***
-
-### 404
-
-> **404**: [`ResponseStatusCode404`](ResponseStatusCode404.md)
-
-***
-
-### 424
-
-> **424**: [`ResponseStatusCode424`](ResponseStatusCode424.md)
-
-***
-
-### 426
-
-> **426**: [`ResponseStatusCode426`](ResponseStatusCode426.md)
-
-***
-
-### 500
-
-> **500**: [`ResponseStatusCode500`](ResponseStatusCode500.md)
-
-***
-
-### 501
-
-> **501**: [`ResponseStatusCode501`](ResponseStatusCode501.md)

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

@@ -1,12 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / Subscription
-
-# Type Alias: Subscription
-
-> **Subscription** = `Readonly`\<\{ `isUnsubscribed`: () => `boolean`; `unsubscribe`: () => `unknown`; \}\>
-
-Controls an active stream subscription. Call `unsubscribe()` to stop receiving data.
-
-## Remarks
-
-Returned by `subscribe()`. Use `unsubscribe()` to terminate the stream early.
-Use `isUnsubscribed()` to check if already terminated.

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

@@ -1,26 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / TriggerCheckoutRequest
-
-# Type Alias: TriggerCheckoutRequest
-
-> **TriggerCheckoutRequest** = `Record`\<`string`, `unknown`\>
-
-Request parameters for triggering the checkout flow.
-
-## Remarks
-
-This type is intentionally flexible as the checkout parameters vary depending on the specific payment flow and partner requirements.
-Consult the Grab SuperApp SDK documentation for the specific parameters required for your use case.
-
-## Example
-
-**Typical checkout request:**
-```typescript
-{
-  partnerTxID: 'txn-123456',
-  partnerGroupTxID: 'group-txn-789',
-  amount: 10000,
-  currency: 'SGD',
-  description: 'Payment for services',
-  // ... additional checkout-specific parameters
-}
-```

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

@@ -1,76 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / TriggerCheckoutResponse
-
-# Type Alias: TriggerCheckoutResponse
-
-> **TriggerCheckoutResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`TriggerCheckoutResult`](TriggerCheckoutResult.md)\>
-
-Response when triggering the checkout flow.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Checkout completed successfully. The `result` contains transaction details.
-- `400`: Bad request - invalid checkout parameters.
-- `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) - payment successful:**
-```typescript
-{
-  status_code: 200,
-  result: {
-    transactionID: 'grab-txn-abc123',
-    status: 'success'
-  }
-}
-```
-
-**Success response (200) - payment failed:**
-```typescript
-{
-  status_code: 200,
-  result: {
-    transactionID: 'grab-txn-abc123',
-    status: 'failure',
-    errorMessage: 'Insufficient funds',
-    errorCode: 'PAYMENT_FAILED'
-  }
-}
-```
-
-**Success response (200) - user cancelled:**
-```typescript
-{
-  status_code: 200,
-  result: {
-    transactionID: 'grab-txn-abc123',
-    status: 'userInitiatedCancel'
-  }
-}
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Invalid checkout parameters'
-}
-```
-
-**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/TriggerCheckoutResult.md

@@ -1,75 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / TriggerCheckoutResult
-
-# Type Alias: TriggerCheckoutResult
-
-> **TriggerCheckoutResult** = \{ `errorCode?`: `string`; `errorMessage?`: `string`; `status`: `"success"` \| `"failure"` \| `"pending"` \| `"userInitiatedCancel"`; `transactionID`: `string`; \}
-
-Result object containing the checkout transaction details.
-
-## Examples
-
-**Successful transaction:**
-```typescript
-{
-  transactionID: 'grab-txn-abc123',
-  status: 'success'
-}
-```
-
-**Failed transaction:**
-```typescript
-{
-  transactionID: 'grab-txn-abc123',
-  status: 'failure',
-  errorMessage: 'Insufficient funds',
-  errorCode: 'PAYMENT_FAILED'
-}
-```
-
-**Pending transaction:**
-```typescript
-{
-  transactionID: 'grab-txn-abc123',
-  status: 'pending'
-}
-```
-
-**User cancelled:**
-```typescript
-{
-  transactionID: 'grab-txn-abc123',
-  status: 'userInitiatedCancel'
-}
-```
-
-## Properties
-
-### errorCode?
-
-> `optional` **errorCode**: `string`
-
-Error code associated with the failed transaction.
-
-***
-
-### errorMessage?
-
-> `optional` **errorMessage**: `string`
-
-Error message if the transaction failed.
-
-***
-
-### status
-
-> **status**: `"success"` \| `"failure"` \| `"pending"` \| `"userInitiatedCancel"`
-
-Status of the transaction.
-
-***
-
-### transactionID
-
-> **transactionID**: `string`
-
-Unique identifier for the transaction at Grab side.

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

@@ -1,32 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / VerifyEmailRequest
-
-# Type Alias: VerifyEmailRequest
-
-> **VerifyEmailRequest** = \{ `email`: `string`; `otp`: `string`; \}
-
-Request parameters for verifying the user's email with an OTP.
-
-## Example
-
-```typescript
-{
-  email: 'user@example.com',
-  otp: '123456'
-}
-```
-
-## Properties
-
-### email
-
-> **email**: `string`
-
-The email address to verify.
-
-***
-
-### otp
-
-> **otp**: `string`
-
-The one-time password (OTP) entered by the user.