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

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

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetCountryCodeResponse
-
-# Type Alias: GetCountryCodeResponse
-
-> **GetCountryCodeResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `424` \| `500` \| `501`, [`GetCountryCodeResult`](GetCountryCodeResult.md)\>
-
-Response when getting the country code.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Country code retrieved successfully. The `result` contains the ISO country code.
-- `424`: GeoKit/Resolver error - location services unavailable.
-- `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) - Singapore:**
-```typescript
-{
-  status_code: 200,
-  result: { countryCode: 'SG' }
-}
-```
-
-**Success response (200) - Indonesia:**
-```typescript
-{
-  status_code: 200,
-  result: { countryCode: 'ID' }
-}
-```
-
-**Failed dependency response (424):**
-```typescript
-{
-  status_code: 424,
-  error: 'GeoKit/Resolver 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/GetCountryCodeResult.md

@@ -1,25 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetCountryCodeResult
-
-# Type Alias: GetCountryCodeResult
-
-> **GetCountryCodeResult** = \{ `countryCode`: `string`; \}
-
-Result object containing the country code.
-
-## Examples
-
-```typescript
-{ countryCode: 'SG' }
-```
-
-```typescript
-{ countryCode: 'ID' }
-```
-
-## Properties
-
-### countryCode
-
-> **countryCode**: `string`
-
-ISO country code (e.g., "SG", "ID", "MY")

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

@@ -1,21 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetDoubleRequest
-
-# Type Alias: GetDoubleRequest
-
-> **GetDoubleRequest** = \{ `key`: `string`; \}
-
-Request parameters for getting a double value from storage.
-
-## Example
-
-```typescript
-{ key: 'price' }
-```
-
-## Properties
-
-### key
-
-> **key**: `string`
-
-The key to retrieve the value for.

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

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetDoubleResponse
-
-# Type Alias: GetDoubleResponse
-
-> **GetDoubleResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`GetDoubleResult`](GetDoubleResult.md)\>
-
-Response when getting a double value.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Value retrieved successfully. The `result` contains the double value or null if not found.
-- `400`: Missing required parameters - key 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 (200) - value exists:**
-```typescript
-{
-  status_code: 200,
-  result: { value: 19.99 }
-}
-```
-
-**Success response (200) - value not found:**
-```typescript
-{
-  status_code: 200,
-  result: { value: null }
-}
-```
-
-**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/GetDoubleResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetDoubleResult
-
-# Type Alias: GetDoubleResult
-
-> **GetDoubleResult** = \{ `value`: `number` \| `null`; \}
-
-Result object containing the double value.
-
-## Examples
-
-**Value exists:**
-```typescript
-{ value: 19.99 }
-```
-
-**Value not found:**
-```typescript
-{ value: null }
-```
-
-## Properties
-
-### value
-
-> **value**: `number` \| `null`
-
-The stored double value, or null if not found.

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

@@ -1,21 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetIntRequest
-
-# Type Alias: GetIntRequest
-
-> **GetIntRequest** = \{ `key`: `string`; \}
-
-Request parameters for getting an integer value from storage.
-
-## Example
-
-```typescript
-{ key: 'userCount' }
-```
-
-## Properties
-
-### key
-
-> **key**: `string`
-
-The key to retrieve the value for.

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

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetIntResponse
-
-# Type Alias: GetIntResponse
-
-> **GetIntResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`GetIntResult`](GetIntResult.md)\>
-
-Response when getting an integer value.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Value retrieved successfully. The `result` contains the integer value or null if not found.
-- `400`: Missing required parameters - key 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 (200) - value exists:**
-```typescript
-{
-  status_code: 200,
-  result: { value: 42 }
-}
-```
-
-**Success response (200) - value not found:**
-```typescript
-{
-  status_code: 200,
-  result: { value: null }
-}
-```
-
-**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/GetIntResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetIntResult
-
-# Type Alias: GetIntResult
-
-> **GetIntResult** = \{ `value`: `number` \| `null`; \}
-
-Result object containing the integer value.
-
-## Examples
-
-**Value exists:**
-```typescript
-{ value: 42 }
-```
-
-**Value not found:**
-```typescript
-{ value: null }
-```
-
-## Properties
-
-### value
-
-> **value**: `number` \| `null`
-
-The stored integer value, or null if not found.

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

@@ -1,48 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetLanguageLocaleIdentifierResponse
-
-# Type Alias: GetLanguageLocaleIdentifierResponse
-
-> **GetLanguageLocaleIdentifierResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`GetLanguageLocaleIdentifierResult`](GetLanguageLocaleIdentifierResult.md)\>
-
-Response when getting the language locale identifier from the device.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Locale identifier retrieved 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) - English locale:**
-```typescript
-{
-  status_code: 200,
-  result: 'en'
-}
-```
-
-**Success response (200) - Indonesian locale:**
-```typescript
-{
-  status_code: 200,
-  result: 'id'
-}
-```
-
-**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/GetLanguageLocaleIdentifierResult.md

@@ -1,31 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetLanguageLocaleIdentifierResult
-
-# Type Alias: GetLanguageLocaleIdentifierResult
-
-> **GetLanguageLocaleIdentifierResult** = `string`
-
-Result object containing the language locale identifier.
-
-## Remarks
-
-The locale identifier is the language code of the device's language settings.
-Common values include:
-- "en" (English)
-- "id" (Indonesian)
-- "zh" (Chinese)
-- "ms" (Malay)
-- "th" (Thai)
-- "vi" (Vietnamese)
-- "zg" (Burmese Zawgyi)
-- "my" (Burmese Unicode)
-- "km" (Khmer)
-
-## Examples
-
-```typescript
-'en'
-```
-
-```typescript
-'id'
-```

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

@@ -1,48 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetSelectedTravelDestinationResponse
-
-# Type Alias: GetSelectedTravelDestinationResponse
-
-> **GetSelectedTravelDestinationResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `204` \| `500` \| `501`, [`GetSelectedTravelDestinationResult`](GetSelectedTravelDestinationResult.md)\>
-
-Response when reading the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: The selected travel destination lowercase ISO 3166-1 alpha-2 country code was returned successfully.
-- `204`: No selected travel destination is currently available.
-- `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,
-  result: 'id'
-}
-```
-
-**No content 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/GetSelectedTravelDestinationResult.md

@@ -1,17 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetSelectedTravelDestinationResult
-
-# Type Alias: GetSelectedTravelDestinationResult
-
-> **GetSelectedTravelDestinationResult** = `string`
-
-Result containing the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
-
-## Examples
-
-```typescript
-'id'
-```
-
-```typescript
-'sg'
-```

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

@@ -1,40 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetSessionParamsResponse
-
-# Type Alias: GetSessionParamsResponse
-
-> **GetSessionParamsResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `500` \| `501`, [`GetSessionParamsResult`](GetSessionParamsResult.md)\>
-
-Response when getting session parameters.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Session parameters retrieved 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,
-  result: { result: '{"userId": "123", "sessionToken": "abc"}' }
-}
-```
-
-**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/GetSessionParamsResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetSessionParamsResult
-
-# Type Alias: GetSessionParamsResult
-
-> **GetSessionParamsResult** = \{ `result`: `string`; \}
-
-Result object containing session parameters as a JSON string.
-
-## Remarks
-
-The `result` field contains a JSON string that must be parsed with `JSON.parse()` to use as an object.
-Session parameters can contain primitives, base64 encoded strings, or nested objects depending on the
-SuperApp's configuration.
-
-## Example
-
-```typescript
-{ result: '{"userId": "123", "sessionToken": "abc"}' }
-```
-
-## Properties
-
-### result
-
-> **result**: `string`
-
-JSON string containing session parameters.

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

@@ -1,21 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetStringRequest
-
-# Type Alias: GetStringRequest
-
-> **GetStringRequest** = \{ `key`: `string`; \}
-
-Request parameters for getting a string value from storage.
-
-## Example
-
-```typescript
-{ key: 'username' }
-```
-
-## Properties
-
-### key
-
-> **key**: `string`
-
-The key to retrieve the value for.

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

@@ -1,57 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetStringResponse
-
-# Type Alias: GetStringResponse
-
-> **GetStringResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `500` \| `501`, [`GetStringResult`](GetStringResult.md)\>
-
-Response when getting a string value.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Value retrieved successfully. The `result` contains the string value or null if not found.
-- `400`: Missing required parameters - key 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 (200) - value exists:**
-```typescript
-{
-  status_code: 200,
-  result: { value: 'john_doe' }
-}
-```
-
-**Success response (200) - value not found:**
-```typescript
-{
-  status_code: 200,
-  result: { value: null }
-}
-```
-
-**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/GetStringResult.md

@@ -1,27 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / GetStringResult
-
-# Type Alias: GetStringResult
-
-> **GetStringResult** = \{ `value`: `string` \| `null`; \}
-
-Result object containing the string value.
-
-## Examples
-
-**Value exists:**
-```typescript
-{ value: 'john_doe' }
-```
-
-**Value not found:**
-```typescript
-{ value: null }
-```
-
-## Properties
-
-### value
-
-> **value**: `string` \| `null`
-
-The stored string value, or null if not found.

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

@@ -1,66 +0,0 @@
-[@grabjs/superapp-sdk](../globals.md) / HasAccessToResponse
-
-# Type Alias: HasAccessToResponse
-
-> **HasAccessToResponse** = [`BridgeResponse`](BridgeResponse.md)\<`200` \| `400` \| `424` \| `500` \| `501`, [`HasAccessToResult`](HasAccessToResult.md)\>
-
-Response when checking API access permissions.
-
-## Remarks
-
-This response can have the following status codes:
-- `200`: Access check completed successfully. The `result` contains the access status.
-- `400`: Missing required parameters - module or method not provided.
-- `424`: ScopeKit error - unable to check access due to a dependency error.
-- `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) - has access:**
-```typescript
-{
-  status_code: 200,
-  result: { hasAccess: true }
-}
-```
-
-**Success response (200) - no access:**
-```typescript
-{
-  status_code: 200,
-  result: { hasAccess: false }
-}
-```
-
-**Bad request response (400):**
-```typescript
-{
-  status_code: 400,
-  error: 'Missing required parameters'
-}
-```
-
-**Failed dependency response (424):**
-```typescript
-{
-  status_code: 424,
-  error: 'ScopeKit 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'
-}
-```