@grabjs/superapp-sdk 2.0.0-beta.53 → 2.0.0-beta.55
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 +3 -3
- package/api-reference/api.json +11560 -47939
- package/dist/index.d.ts +462 -1846
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/skills/SKILL.md +87 -85
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
import { GenericSchema } from 'valibot';
|
|
2
|
-
import type { InferOutput } from 'valibot';
|
|
3
|
-
import * as v from 'valibot';
|
|
4
2
|
|
|
5
3
|
/**
|
|
6
4
|
* Request parameters for initiating an OAuth2 authorization flow with PKCE.
|
|
@@ -34,23 +32,13 @@ import * as v from 'valibot';
|
|
|
34
32
|
*
|
|
35
33
|
* @public
|
|
36
34
|
*/
|
|
37
|
-
export declare type AuthorizeRequest =
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
*
|
|
45
|
-
* @public
|
|
46
|
-
*/
|
|
47
|
-
export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
48
|
-
readonly clientId: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
49
|
-
readonly redirectUri: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
50
|
-
readonly scope: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
51
|
-
readonly environment: v.PicklistSchema<["staging", "production"], undefined>;
|
|
52
|
-
readonly responseMode: v.OptionalSchema<v.PicklistSchema<["redirect", "in_place"], undefined>, undefined>;
|
|
53
|
-
}, undefined>;
|
|
35
|
+
export declare type AuthorizeRequest = {
|
|
36
|
+
clientId: string;
|
|
37
|
+
redirectUri: string;
|
|
38
|
+
scope: string;
|
|
39
|
+
environment: 'staging' | 'production';
|
|
40
|
+
responseMode?: 'redirect' | 'in_place';
|
|
41
|
+
};
|
|
54
42
|
|
|
55
43
|
/**
|
|
56
44
|
* Response when initiating an authorization flow.
|
|
@@ -70,42 +58,7 @@ export declare const AuthorizeRequestSchema: v.ObjectSchema<{
|
|
|
70
58
|
*
|
|
71
59
|
* @public
|
|
72
60
|
*/
|
|
73
|
-
export declare type AuthorizeResponse =
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* Valibot schema for {@link AuthorizeResponse}.
|
|
77
|
-
*
|
|
78
|
-
* @group Modules
|
|
79
|
-
* @category Identity
|
|
80
|
-
*
|
|
81
|
-
* @public
|
|
82
|
-
*/
|
|
83
|
-
export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
84
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
85
|
-
readonly result: v.ObjectSchema<{
|
|
86
|
-
readonly code: v.StringSchema<undefined>;
|
|
87
|
-
readonly state: v.StringSchema<undefined>;
|
|
88
|
-
readonly codeVerifier: v.StringSchema<undefined>;
|
|
89
|
-
readonly nonce: v.StringSchema<undefined>;
|
|
90
|
-
readonly redirectUri: v.StringSchema<undefined>;
|
|
91
|
-
}, undefined>;
|
|
92
|
-
}, undefined>, v.ObjectSchema<{
|
|
93
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
94
|
-
}, undefined>, v.ObjectSchema<{
|
|
95
|
-
readonly status_code: v.LiteralSchema<302, undefined>;
|
|
96
|
-
}, undefined>, v.ObjectSchema<{
|
|
97
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
98
|
-
readonly error: v.StringSchema<undefined>;
|
|
99
|
-
}, undefined>, v.ObjectSchema<{
|
|
100
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
101
|
-
readonly error: v.StringSchema<undefined>;
|
|
102
|
-
}, undefined>, v.ObjectSchema<{
|
|
103
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
104
|
-
readonly error: v.StringSchema<undefined>;
|
|
105
|
-
}, undefined>, v.ObjectSchema<{
|
|
106
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
107
|
-
readonly error: v.StringSchema<undefined>;
|
|
108
|
-
}, undefined>], undefined>;
|
|
61
|
+
export declare type AuthorizeResponse = SDKOkResponse<AuthorizeResult> | SDKNoContentResponse | SDKRedirectResponse | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
109
62
|
|
|
110
63
|
/**
|
|
111
64
|
* Result object for the authorization flow.
|
|
@@ -127,23 +80,13 @@ export declare const AuthorizeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
127
80
|
*
|
|
128
81
|
* @public
|
|
129
82
|
*/
|
|
130
|
-
export declare type AuthorizeResult =
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
*
|
|
138
|
-
* @public
|
|
139
|
-
*/
|
|
140
|
-
export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
141
|
-
readonly code: v.StringSchema<undefined>;
|
|
142
|
-
readonly state: v.StringSchema<undefined>;
|
|
143
|
-
readonly codeVerifier: v.StringSchema<undefined>;
|
|
144
|
-
readonly nonce: v.StringSchema<undefined>;
|
|
145
|
-
readonly redirectUri: v.StringSchema<undefined>;
|
|
146
|
-
}, undefined>;
|
|
83
|
+
export declare type AuthorizeResult = {
|
|
84
|
+
code: string;
|
|
85
|
+
state: string;
|
|
86
|
+
codeVerifier: string;
|
|
87
|
+
nonce: string;
|
|
88
|
+
redirectUri: string;
|
|
89
|
+
};
|
|
147
90
|
|
|
148
91
|
/**
|
|
149
92
|
* Response when triggering platform back navigation.
|
|
@@ -159,25 +102,7 @@ export declare const AuthorizeResultSchema: v.ObjectSchema<{
|
|
|
159
102
|
*
|
|
160
103
|
* @public
|
|
161
104
|
*/
|
|
162
|
-
export declare type BackResponse =
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Valibot schema for {@link BackResponse}.
|
|
166
|
-
*
|
|
167
|
-
* @group Modules
|
|
168
|
-
* @category Platform
|
|
169
|
-
*
|
|
170
|
-
* @public
|
|
171
|
-
*/
|
|
172
|
-
export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
173
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
174
|
-
}, undefined>, v.ObjectSchema<{
|
|
175
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
176
|
-
readonly error: v.StringSchema<undefined>;
|
|
177
|
-
}, undefined>, v.ObjectSchema<{
|
|
178
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
179
|
-
readonly error: v.StringSchema<undefined>;
|
|
180
|
-
}, undefined>], undefined>;
|
|
105
|
+
export declare type BackResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
181
106
|
|
|
182
107
|
/**
|
|
183
108
|
* Result when triggering platform back navigation.
|
|
@@ -191,29 +116,29 @@ export declare const BackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
191
116
|
export declare type BackResult = void;
|
|
192
117
|
|
|
193
118
|
/**
|
|
194
|
-
* Base class for all
|
|
119
|
+
* Base class for all modules.
|
|
195
120
|
*
|
|
196
121
|
* @group Core
|
|
197
122
|
*
|
|
198
123
|
* @remarks
|
|
199
|
-
* On construction, the class wraps the
|
|
124
|
+
* On construction, the class wraps the module on `window` (e.g., `WrappedContainerModule`).
|
|
200
125
|
* This code must run on the Grab SuperApp's webview to function correctly.
|
|
201
126
|
*
|
|
202
127
|
* @public
|
|
203
128
|
*/
|
|
204
129
|
export declare class BaseModule {
|
|
205
130
|
/**
|
|
206
|
-
* The module name
|
|
131
|
+
* The module name.
|
|
207
132
|
*/
|
|
208
133
|
private readonly name;
|
|
209
134
|
/**
|
|
210
|
-
* Logger scoped to this module
|
|
135
|
+
* Logger scoped to this module.
|
|
211
136
|
*
|
|
212
137
|
* @protected
|
|
213
138
|
*/
|
|
214
139
|
protected readonly logger: Logger;
|
|
215
140
|
/**
|
|
216
|
-
* Returns the wrapped
|
|
141
|
+
* Returns the wrapped module from the global `window` object.
|
|
217
142
|
*
|
|
218
143
|
* @returns The wrapped module instance with native method bindings.
|
|
219
144
|
*
|
|
@@ -224,7 +149,7 @@ export declare class BaseModule {
|
|
|
224
149
|
* Creates a new module instance and wraps it on the global `window` object.
|
|
225
150
|
*
|
|
226
151
|
* @param moduleName - The name of the module (e.g., "ContainerModule", "ProfileModule").
|
|
227
|
-
* @throws Error when the
|
|
152
|
+
* @throws Error when the module fails to initialize.
|
|
228
153
|
*/
|
|
229
154
|
constructor(moduleName: string);
|
|
230
155
|
/**
|
|
@@ -241,10 +166,9 @@ export declare class BaseModule {
|
|
|
241
166
|
* Checks whether the current app version supports this method.
|
|
242
167
|
*
|
|
243
168
|
* @remarks
|
|
244
|
-
* Returns 501 if not running in the Grab app, 426 if the version check fails,
|
|
245
|
-
* or `null` if the method is supported.
|
|
169
|
+
* Returns `501` status code if not running in the Grab app, `426` status code if the version check fails. Otherwise, returns `null`.
|
|
246
170
|
*
|
|
247
|
-
* @param isSupported - A function receiving the detected app info, returning true if supported.
|
|
171
|
+
* @param isSupported - A function receiving the detected app info, returning `true` if supported.
|
|
248
172
|
* @returns An error response, or `null` if supported.
|
|
249
173
|
*
|
|
250
174
|
* @protected
|
|
@@ -257,116 +181,44 @@ export declare class BaseModule {
|
|
|
257
181
|
error: string;
|
|
258
182
|
} | null;
|
|
259
183
|
/**
|
|
260
|
-
* Invokes a
|
|
184
|
+
* Invokes a method.
|
|
261
185
|
*
|
|
262
186
|
* @remarks
|
|
263
|
-
* - Always checks if running in Grab app (returns 501 if not).
|
|
187
|
+
* - Always checks if running in Grab app (returns `501` status code if not).
|
|
264
188
|
* - All errors are reported via the `status_code` field; this method never rejects.
|
|
265
|
-
* - For streaming methods, use `invokeStream` instead.
|
|
266
189
|
*
|
|
267
190
|
* @param options - The invoke options including method name and params.
|
|
268
|
-
* @returns A promise resolving to the
|
|
191
|
+
* @returns A promise resolving to the SDK response.
|
|
269
192
|
*
|
|
270
193
|
* @protected
|
|
271
194
|
*/
|
|
272
|
-
protected invoke(options:
|
|
195
|
+
protected invoke(options: ModuleInvokeOptions): Promise<SDKResponse>;
|
|
273
196
|
/**
|
|
274
|
-
* Creates a
|
|
275
|
-
* Used for 501, 426, and 500 error scenarios in invokeStream.
|
|
197
|
+
* Creates a {@link SDKStream} that immediately emits an error response.
|
|
276
198
|
*
|
|
277
|
-
* @returns A
|
|
199
|
+
* @returns A {@link SDKStream} that immediately emits an error response.
|
|
278
200
|
*
|
|
279
201
|
* @private
|
|
280
202
|
*/
|
|
281
203
|
private createErrorStream;
|
|
282
204
|
/**
|
|
283
|
-
* Invokes a
|
|
205
|
+
* Invokes a streaming method that returns a {@link SDKStream}.
|
|
284
206
|
*
|
|
285
207
|
* @remarks
|
|
286
|
-
* - Always checks if running in Grab app (returns 501
|
|
287
|
-
* - Returns a
|
|
208
|
+
* - Always checks if running in Grab app (returns `501` status code if not).
|
|
209
|
+
* - Returns a {@link SDKStream} that can be subscribed to or awaited for the first value.
|
|
288
210
|
* - All errors are reported via error responses in the stream; this method never rejects.
|
|
289
211
|
*
|
|
290
212
|
* @param options - The invoke options including method name and params.
|
|
291
|
-
* @returns A
|
|
213
|
+
* @returns A {@link SDKStream} for receiving continuous data.
|
|
292
214
|
*
|
|
293
215
|
* @protected
|
|
294
216
|
*/
|
|
295
|
-
protected invokeStream(options:
|
|
217
|
+
protected invokeStream(options: ModuleInvokeOptions): SDKStream;
|
|
296
218
|
}
|
|
297
219
|
|
|
298
220
|
/**
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
* @group Core
|
|
302
|
-
*
|
|
303
|
-
* @remarks
|
|
304
|
-
* Every response has a numeric `status_code`. Success responses (200) carry `result`;
|
|
305
|
-
* error responses (4xx/5xx) carry `error`. Use the type guards ({@link isSuccess},
|
|
306
|
-
* {@link isError}, etc.) to narrow to a specific shape.
|
|
307
|
-
*
|
|
308
|
-
* Per-module response types (e.g., `ScanQRCodeResponse`) are derived from their valibot
|
|
309
|
-
* schemas via `v.InferOutput` and form proper discriminated unions — enabling precise
|
|
310
|
-
* TypeScript narrowing while this base type serves as the internal contract.
|
|
311
|
-
*
|
|
312
|
-
* @public
|
|
313
|
-
*/
|
|
314
|
-
export declare type BridgeResponse = {
|
|
315
|
-
/** HTTP-style status code indicating the outcome of the JSBridge method call */
|
|
316
|
-
status_code: number;
|
|
317
|
-
/** The result data from the JSBridge method, present on 200 responses */
|
|
318
|
-
result?: unknown;
|
|
319
|
-
/** Error message, present on 4xx/5xx responses */
|
|
320
|
-
error?: string;
|
|
321
|
-
};
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
* A stream for receiving continuous data from JSBridge methods (e.g., location updates).
|
|
325
|
-
*
|
|
326
|
-
* @group Core
|
|
327
|
-
*
|
|
328
|
-
* @remarks
|
|
329
|
-
* Provides both Observable-like and Promise-like interfaces:
|
|
330
|
-
* - Use `subscribe()` to receive all values over time
|
|
331
|
-
* - Use `then()` or `await` to receive only the first value
|
|
332
|
-
*
|
|
333
|
-
* Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
|
|
334
|
-
*
|
|
335
|
-
* @typeParam T - The response type emitted by the stream.
|
|
336
|
-
*
|
|
337
|
-
* @public
|
|
338
|
-
*/
|
|
339
|
-
export declare type BridgeStream<T extends BridgeResponse = BridgeResponse> = Readonly<{
|
|
340
|
-
/**
|
|
341
|
-
* Subscribe to receive stream data.
|
|
342
|
-
*
|
|
343
|
-
* @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
|
|
344
|
-
* @returns A `Subscription` to terminate the stream when needed.
|
|
345
|
-
*/
|
|
346
|
-
subscribe: (handlers?: BridgeStreamHandlers<T>) => Subscription;
|
|
347
|
-
}> & PromiseLike<T>;
|
|
348
|
-
|
|
349
|
-
/**
|
|
350
|
-
* Callbacks for handling stream events.
|
|
351
|
-
*
|
|
352
|
-
* @group Core
|
|
353
|
-
*
|
|
354
|
-
* @remarks
|
|
355
|
-
* Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
|
|
356
|
-
*
|
|
357
|
-
* @typeParam T - The response type emitted by the stream.
|
|
358
|
-
*
|
|
359
|
-
* @public
|
|
360
|
-
*/
|
|
361
|
-
export declare type BridgeStreamHandlers<T extends BridgeResponse = BridgeResponse> = Readonly<{
|
|
362
|
-
/** Called with each new value from the stream. */
|
|
363
|
-
next?: (data: T) => unknown;
|
|
364
|
-
/** Called when the stream ends and no more data will arrive. */
|
|
365
|
-
complete?: () => unknown;
|
|
366
|
-
}>;
|
|
367
|
-
|
|
368
|
-
/**
|
|
369
|
-
* JSBridge module for accessing the device camera.
|
|
221
|
+
* SDK module for accessing the device camera via `JSBridge`.
|
|
370
222
|
*
|
|
371
223
|
* @group Modules
|
|
372
224
|
* @category Camera
|
|
@@ -411,7 +263,7 @@ export declare class CameraModule extends BaseModule {
|
|
|
411
263
|
* // Initialize the camera module
|
|
412
264
|
* const camera = new CameraModule();
|
|
413
265
|
*
|
|
414
|
-
* // Scan
|
|
266
|
+
* // Scan a QR code
|
|
415
267
|
* const response = await camera.scanQRCode({ title: 'Scan Payment QR' });
|
|
416
268
|
*
|
|
417
269
|
* // Handle the response
|
|
@@ -443,7 +295,7 @@ export declare class CameraModule extends BaseModule {
|
|
|
443
295
|
}
|
|
444
296
|
|
|
445
297
|
/**
|
|
446
|
-
*
|
|
298
|
+
* SDK module for triggering native payment flows via `JSBridge`.
|
|
447
299
|
*
|
|
448
300
|
* @group Modules
|
|
449
301
|
* @category Checkout
|
|
@@ -542,23 +394,11 @@ export declare class CheckoutModule extends BaseModule {
|
|
|
542
394
|
* @category Identity
|
|
543
395
|
*
|
|
544
396
|
* @remarks
|
|
545
|
-
* This response returns status code `204` when artifacts are successfully
|
|
546
|
-
*
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
export declare type ClearAuthorizationArtifactsResponse = InferOutput<typeof ClearAuthorizationArtifactsResponseSchema>;
|
|
550
|
-
|
|
551
|
-
/**
|
|
552
|
-
* Valibot schema for {@link ClearAuthorizationArtifactsResponse}.
|
|
553
|
-
*
|
|
554
|
-
* @group Modules
|
|
555
|
-
* @category Identity
|
|
397
|
+
* This response returns status code `204` when artifacts are cleared successfully.
|
|
556
398
|
*
|
|
557
399
|
* @public
|
|
558
400
|
*/
|
|
559
|
-
export declare
|
|
560
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
561
|
-
}, undefined>], undefined>;
|
|
401
|
+
export declare type ClearAuthorizationArtifactsResponse = SDKNoContentResponse;
|
|
562
402
|
|
|
563
403
|
/**
|
|
564
404
|
* Result object for clearing authorization artifacts.
|
|
@@ -585,25 +425,7 @@ export declare type ClearAuthorizationArtifactsResult = void;
|
|
|
585
425
|
*
|
|
586
426
|
* @public
|
|
587
427
|
*/
|
|
588
|
-
export declare type CloseResponse =
|
|
589
|
-
|
|
590
|
-
/**
|
|
591
|
-
* Valibot schema for {@link CloseResponse}.
|
|
592
|
-
*
|
|
593
|
-
* @group Modules
|
|
594
|
-
* @category Container
|
|
595
|
-
*
|
|
596
|
-
* @public
|
|
597
|
-
*/
|
|
598
|
-
export declare const CloseResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
599
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
600
|
-
}, undefined>, v.ObjectSchema<{
|
|
601
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
602
|
-
readonly error: v.StringSchema<undefined>;
|
|
603
|
-
}, undefined>, v.ObjectSchema<{
|
|
604
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
605
|
-
readonly error: v.StringSchema<undefined>;
|
|
606
|
-
}, undefined>], undefined>;
|
|
428
|
+
export declare type CloseResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
607
429
|
|
|
608
430
|
/**
|
|
609
431
|
* Result when closing the container.
|
|
@@ -658,7 +480,7 @@ export declare const ContainerAnalyticsEventState: {
|
|
|
658
480
|
};
|
|
659
481
|
|
|
660
482
|
/**
|
|
661
|
-
*
|
|
483
|
+
* SDK module for controlling the WebView container via `JSBridge`.
|
|
662
484
|
*
|
|
663
485
|
* @group Modules
|
|
664
486
|
* @category Container
|
|
@@ -1103,7 +925,7 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1103
925
|
*/
|
|
1104
926
|
sendAnalyticsEvent(request: SendAnalyticsEventRequest): Promise<SendAnalyticsEventResponse>;
|
|
1105
927
|
/**
|
|
1106
|
-
* Check if the web app is connected to the Grab SuperApp via JSBridge
|
|
928
|
+
* Check if the web app is connected to the Grab SuperApp via `JSBridge`.
|
|
1107
929
|
*
|
|
1108
930
|
* @remarks
|
|
1109
931
|
* Call this method to verify the connection status before using other features.
|
|
@@ -1176,7 +998,7 @@ export declare class ContainerModule extends BaseModule {
|
|
|
1176
998
|
}
|
|
1177
999
|
|
|
1178
1000
|
/**
|
|
1179
|
-
*
|
|
1001
|
+
* SDK module for querying native device information via `JSBridge`.
|
|
1180
1002
|
*
|
|
1181
1003
|
* @group Modules
|
|
1182
1004
|
* @category Device
|
|
@@ -1264,7 +1086,7 @@ export declare class DeviceModule extends BaseModule {
|
|
|
1264
1086
|
* - `204`: No splash screen shown, or it was closed successfully.
|
|
1265
1087
|
* - `400`: Invalid input (Grablet / client validation error).
|
|
1266
1088
|
* - `403`: Missing consent for the required OAuth scope.
|
|
1267
|
-
* - `500`: Unexpected error while invoking
|
|
1089
|
+
* - `500`: Unexpected error while invoking `JSBridge`.
|
|
1268
1090
|
* - `501`: Not in the Grab app WebView environment.
|
|
1269
1091
|
*
|
|
1270
1092
|
* @example
|
|
@@ -1293,34 +1115,10 @@ export declare class DeviceModule extends BaseModule {
|
|
|
1293
1115
|
*
|
|
1294
1116
|
* @public
|
|
1295
1117
|
*/
|
|
1296
|
-
export declare type DismissSplashScreenResponse =
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1299
|
-
* Valibot schema for {@link DismissSplashScreenResponse}.
|
|
1300
|
-
*
|
|
1301
|
-
* @group Modules
|
|
1302
|
-
* @category Splash Screen
|
|
1303
|
-
*
|
|
1304
|
-
* @public
|
|
1305
|
-
*/
|
|
1306
|
-
export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1307
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1308
|
-
}, undefined>, v.ObjectSchema<{
|
|
1309
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
1310
|
-
readonly error: v.StringSchema<undefined>;
|
|
1311
|
-
}, undefined>, v.ObjectSchema<{
|
|
1312
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
1313
|
-
readonly error: v.StringSchema<undefined>;
|
|
1314
|
-
}, undefined>, v.ObjectSchema<{
|
|
1315
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1316
|
-
readonly error: v.StringSchema<undefined>;
|
|
1317
|
-
}, undefined>, v.ObjectSchema<{
|
|
1318
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1319
|
-
readonly error: v.StringSchema<undefined>;
|
|
1320
|
-
}, undefined>], undefined>;
|
|
1118
|
+
export declare type DismissSplashScreenResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1321
1119
|
|
|
1322
1120
|
/**
|
|
1323
|
-
* Request parameters for downloading a file
|
|
1121
|
+
* Request parameters for downloading a file through `JSBridge`.
|
|
1324
1122
|
*
|
|
1325
1123
|
* @group Modules
|
|
1326
1124
|
* @category File
|
|
@@ -1335,20 +1133,10 @@ export declare const DismissSplashScreenResponseSchema: v.UnionSchema<[v.ObjectS
|
|
|
1335
1133
|
*
|
|
1336
1134
|
* @public
|
|
1337
1135
|
*/
|
|
1338
|
-
export declare type DownloadFileRequest =
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
*
|
|
1343
|
-
* @group Modules
|
|
1344
|
-
* @category File
|
|
1345
|
-
*
|
|
1346
|
-
* @public
|
|
1347
|
-
*/
|
|
1348
|
-
export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
1349
|
-
readonly fileUrl: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
1350
|
-
readonly fileName: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
1351
|
-
}, undefined>;
|
|
1136
|
+
export declare type DownloadFileRequest = {
|
|
1137
|
+
fileName: string;
|
|
1138
|
+
fileUrl: string;
|
|
1139
|
+
};
|
|
1352
1140
|
|
|
1353
1141
|
/**
|
|
1354
1142
|
* Response when requesting a native file download.
|
|
@@ -1365,28 +1153,7 @@ export declare const DownloadFileRequestSchema: v.ObjectSchema<{
|
|
|
1365
1153
|
*
|
|
1366
1154
|
* @public
|
|
1367
1155
|
*/
|
|
1368
|
-
export declare type DownloadFileResponse =
|
|
1369
|
-
|
|
1370
|
-
/**
|
|
1371
|
-
* Valibot schema for {@link DownloadFileResponse}.
|
|
1372
|
-
*
|
|
1373
|
-
* @group Modules
|
|
1374
|
-
* @category File
|
|
1375
|
-
*
|
|
1376
|
-
* @public
|
|
1377
|
-
*/
|
|
1378
|
-
export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1379
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1380
|
-
}, undefined>, v.ObjectSchema<{
|
|
1381
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
1382
|
-
readonly error: v.StringSchema<undefined>;
|
|
1383
|
-
}, undefined>, v.ObjectSchema<{
|
|
1384
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1385
|
-
readonly error: v.StringSchema<undefined>;
|
|
1386
|
-
}, undefined>, v.ObjectSchema<{
|
|
1387
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1388
|
-
readonly error: v.StringSchema<undefined>;
|
|
1389
|
-
}, undefined>], undefined>;
|
|
1156
|
+
export declare type DownloadFileResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1390
1157
|
|
|
1391
1158
|
/**
|
|
1392
1159
|
* Result data structure for file download operations.
|
|
@@ -1395,7 +1162,7 @@ export declare const DownloadFileResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1395
1162
|
* @category File
|
|
1396
1163
|
*
|
|
1397
1164
|
* @remarks
|
|
1398
|
-
* This is a void result type as successful downloads return status code 204 with no content.
|
|
1165
|
+
* This is a void result type as successful downloads return status code `204` with no content.
|
|
1399
1166
|
*
|
|
1400
1167
|
* @public
|
|
1401
1168
|
*/
|
|
@@ -1478,22 +1245,12 @@ export declare type DRMContentConfig = Record<string, unknown>;
|
|
|
1478
1245
|
*
|
|
1479
1246
|
* @public
|
|
1480
1247
|
*/
|
|
1481
|
-
export declare type DRMPlaybackEvent =
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
* @category Media
|
|
1488
|
-
*
|
|
1489
|
-
* @public
|
|
1490
|
-
*/
|
|
1491
|
-
export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
1492
|
-
readonly type: v.PicklistSchema<["START_PLAYBACK", "PROGRESS_PLAYBACK", "START_SEEK", "STOP_SEEK", "STOP_PLAYBACK", "CLOSE_PLAYBACK", "PAUSE_PLAYBACK", "RESUME_PLAYBACK", "FAST_FORWARD_PLAYBACK", "REWIND_PLAYBACK", "ERROR_PLAYBACK", "CHANGE_VOLUME"], undefined>;
|
|
1493
|
-
readonly titleId: v.StringSchema<undefined>;
|
|
1494
|
-
readonly position: v.NumberSchema<undefined>;
|
|
1495
|
-
readonly length: v.NumberSchema<undefined>;
|
|
1496
|
-
}, undefined>;
|
|
1248
|
+
export declare type DRMPlaybackEvent = {
|
|
1249
|
+
length: number;
|
|
1250
|
+
position: number;
|
|
1251
|
+
titleId: string;
|
|
1252
|
+
type: 'START_PLAYBACK' | 'PROGRESS_PLAYBACK' | 'START_SEEK' | 'STOP_SEEK' | 'STOP_PLAYBACK' | 'CLOSE_PLAYBACK' | 'PAUSE_PLAYBACK' | 'RESUME_PLAYBACK' | 'FAST_FORWARD_PLAYBACK' | 'REWIND_PLAYBACK' | 'ERROR_PLAYBACK' | 'CHANGE_VOLUME';
|
|
1253
|
+
};
|
|
1497
1254
|
|
|
1498
1255
|
/**
|
|
1499
1256
|
* Response when fetching the user's email.
|
|
@@ -1513,39 +1270,7 @@ export declare const DRMPlaybackEventSchema: v.ObjectSchema<{
|
|
|
1513
1270
|
*
|
|
1514
1271
|
* @public
|
|
1515
1272
|
*/
|
|
1516
|
-
export declare type FetchEmailResponse =
|
|
1517
|
-
|
|
1518
|
-
/**
|
|
1519
|
-
* Valibot schema for {@link FetchEmailResponse}.
|
|
1520
|
-
*
|
|
1521
|
-
* @group Modules
|
|
1522
|
-
* @category Profile
|
|
1523
|
-
*
|
|
1524
|
-
* @public
|
|
1525
|
-
*/
|
|
1526
|
-
export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1527
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
1528
|
-
readonly result: v.ObjectSchema<{
|
|
1529
|
-
readonly email: v.StringSchema<undefined>;
|
|
1530
|
-
}, undefined>;
|
|
1531
|
-
}, undefined>, v.ObjectSchema<{
|
|
1532
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1533
|
-
}, undefined>, v.ObjectSchema<{
|
|
1534
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
1535
|
-
readonly error: v.StringSchema<undefined>;
|
|
1536
|
-
}, undefined>, v.ObjectSchema<{
|
|
1537
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
1538
|
-
readonly error: v.StringSchema<undefined>;
|
|
1539
|
-
}, undefined>, v.ObjectSchema<{
|
|
1540
|
-
readonly status_code: v.LiteralSchema<426, undefined>;
|
|
1541
|
-
readonly error: v.StringSchema<undefined>;
|
|
1542
|
-
}, undefined>, v.ObjectSchema<{
|
|
1543
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1544
|
-
readonly error: v.StringSchema<undefined>;
|
|
1545
|
-
}, undefined>, v.ObjectSchema<{
|
|
1546
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1547
|
-
readonly error: v.StringSchema<undefined>;
|
|
1548
|
-
}, undefined>], undefined>;
|
|
1273
|
+
export declare type FetchEmailResponse = SDKOkResponse<FetchEmailResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<426> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1549
1274
|
|
|
1550
1275
|
/**
|
|
1551
1276
|
* Result object containing the user's email address.
|
|
@@ -1560,22 +1285,12 @@ export declare const FetchEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1560
1285
|
*
|
|
1561
1286
|
* @public
|
|
1562
1287
|
*/
|
|
1563
|
-
export declare type FetchEmailResult =
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
* Valibot schema for {@link FetchEmailResult}.
|
|
1567
|
-
*
|
|
1568
|
-
* @group Modules
|
|
1569
|
-
* @category Profile
|
|
1570
|
-
*
|
|
1571
|
-
* @public
|
|
1572
|
-
*/
|
|
1573
|
-
export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
1574
|
-
readonly email: v.StringSchema<undefined>;
|
|
1575
|
-
}, undefined>;
|
|
1288
|
+
export declare type FetchEmailResult = {
|
|
1289
|
+
email: string;
|
|
1290
|
+
};
|
|
1576
1291
|
|
|
1577
1292
|
/**
|
|
1578
|
-
*
|
|
1293
|
+
* SDK module for downloading files to the user's device via `JSBridge`.
|
|
1579
1294
|
*
|
|
1580
1295
|
* @group Modules
|
|
1581
1296
|
* @category File
|
|
@@ -1606,7 +1321,7 @@ export declare const FetchEmailResultSchema: v.ObjectSchema<{
|
|
|
1606
1321
|
export declare class FileModule extends BaseModule {
|
|
1607
1322
|
constructor();
|
|
1608
1323
|
/**
|
|
1609
|
-
* Downloads a file
|
|
1324
|
+
* Downloads a file through `JSBridge`.
|
|
1610
1325
|
*
|
|
1611
1326
|
* @param request - File information, including URL and target file name. See {@link DownloadFileRequest}.
|
|
1612
1327
|
*
|
|
@@ -1655,30 +1370,7 @@ export declare class FileModule extends BaseModule {
|
|
|
1655
1370
|
*
|
|
1656
1371
|
* @public
|
|
1657
1372
|
*/
|
|
1658
|
-
export declare type GetAuthorizationArtifactsResponse =
|
|
1659
|
-
|
|
1660
|
-
/**
|
|
1661
|
-
* Valibot schema for {@link GetAuthorizationArtifactsResponse}.
|
|
1662
|
-
*
|
|
1663
|
-
* @group Modules
|
|
1664
|
-
* @category Identity
|
|
1665
|
-
*
|
|
1666
|
-
* @public
|
|
1667
|
-
*/
|
|
1668
|
-
export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1669
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
1670
|
-
readonly result: v.ObjectSchema<{
|
|
1671
|
-
readonly state: v.StringSchema<undefined>;
|
|
1672
|
-
readonly codeVerifier: v.StringSchema<undefined>;
|
|
1673
|
-
readonly nonce: v.StringSchema<undefined>;
|
|
1674
|
-
readonly redirectUri: v.StringSchema<undefined>;
|
|
1675
|
-
}, undefined>;
|
|
1676
|
-
}, undefined>, v.ObjectSchema<{
|
|
1677
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1678
|
-
}, undefined>, v.ObjectSchema<{
|
|
1679
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
1680
|
-
readonly error: v.StringSchema<undefined>;
|
|
1681
|
-
}, undefined>], undefined>;
|
|
1373
|
+
export declare type GetAuthorizationArtifactsResponse = SDKOkResponse<GetAuthorizationArtifactsResult> | SDKNoContentResponse | SDKErrorResponse<400>;
|
|
1682
1374
|
|
|
1683
1375
|
/**
|
|
1684
1376
|
* Result object containing the stored PKCE authorization artifacts.
|
|
@@ -1700,22 +1392,12 @@ export declare const GetAuthorizationArtifactsResponseSchema: v.UnionSchema<[v.O
|
|
|
1700
1392
|
*
|
|
1701
1393
|
* @public
|
|
1702
1394
|
*/
|
|
1703
|
-
export declare type GetAuthorizationArtifactsResult =
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
* @category Identity
|
|
1710
|
-
*
|
|
1711
|
-
* @public
|
|
1712
|
-
*/
|
|
1713
|
-
export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
1714
|
-
readonly state: v.StringSchema<undefined>;
|
|
1715
|
-
readonly codeVerifier: v.StringSchema<undefined>;
|
|
1716
|
-
readonly nonce: v.StringSchema<undefined>;
|
|
1717
|
-
readonly redirectUri: v.StringSchema<undefined>;
|
|
1718
|
-
}, undefined>;
|
|
1395
|
+
export declare type GetAuthorizationArtifactsResult = {
|
|
1396
|
+
state: string;
|
|
1397
|
+
codeVerifier: string;
|
|
1398
|
+
nonce: string;
|
|
1399
|
+
redirectUri: string;
|
|
1400
|
+
};
|
|
1719
1401
|
|
|
1720
1402
|
/**
|
|
1721
1403
|
* Request parameters for getting a boolean value from storage.
|
|
@@ -1730,19 +1412,9 @@ export declare const GetAuthorizationArtifactsResultSchema: v.ObjectSchema<{
|
|
|
1730
1412
|
*
|
|
1731
1413
|
* @public
|
|
1732
1414
|
*/
|
|
1733
|
-
export declare type GetBooleanRequest =
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
* Valibot schema for {@link GetBooleanRequest}.
|
|
1737
|
-
*
|
|
1738
|
-
* @group Modules
|
|
1739
|
-
* @category Storage
|
|
1740
|
-
*
|
|
1741
|
-
* @public
|
|
1742
|
-
*/
|
|
1743
|
-
export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
1744
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
1745
|
-
}, undefined>;
|
|
1415
|
+
export declare type GetBooleanRequest = {
|
|
1416
|
+
key: string;
|
|
1417
|
+
};
|
|
1746
1418
|
|
|
1747
1419
|
/**
|
|
1748
1420
|
* Response when getting a boolean value.
|
|
@@ -1761,34 +1433,7 @@ export declare const GetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
1761
1433
|
*
|
|
1762
1434
|
* @public
|
|
1763
1435
|
*/
|
|
1764
|
-
export declare type GetBooleanResponse =
|
|
1765
|
-
|
|
1766
|
-
/**
|
|
1767
|
-
* Valibot schema for {@link GetBooleanResponse}.
|
|
1768
|
-
*
|
|
1769
|
-
* @group Modules
|
|
1770
|
-
* @category Storage
|
|
1771
|
-
*
|
|
1772
|
-
* @public
|
|
1773
|
-
*/
|
|
1774
|
-
export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1775
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
1776
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
1777
|
-
}, undefined>, v.ObjectSchema<{
|
|
1778
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1779
|
-
}, undefined>, v.ObjectSchema<{
|
|
1780
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
1781
|
-
readonly error: v.StringSchema<undefined>;
|
|
1782
|
-
}, undefined>, v.ObjectSchema<{
|
|
1783
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
1784
|
-
readonly error: v.StringSchema<undefined>;
|
|
1785
|
-
}, undefined>, v.ObjectSchema<{
|
|
1786
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1787
|
-
readonly error: v.StringSchema<undefined>;
|
|
1788
|
-
}, undefined>, v.ObjectSchema<{
|
|
1789
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1790
|
-
readonly error: v.StringSchema<undefined>;
|
|
1791
|
-
}, undefined>], undefined>;
|
|
1436
|
+
export declare type GetBooleanResponse = SDKOkResponse<GetBooleanResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1792
1437
|
|
|
1793
1438
|
/**
|
|
1794
1439
|
* The boolean value returned when a key exists in storage.
|
|
@@ -1806,17 +1451,7 @@ export declare const GetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
1806
1451
|
*
|
|
1807
1452
|
* @public
|
|
1808
1453
|
*/
|
|
1809
|
-
export declare type GetBooleanResult =
|
|
1810
|
-
|
|
1811
|
-
/**
|
|
1812
|
-
* Valibot schema for {@link GetBooleanResult}.
|
|
1813
|
-
*
|
|
1814
|
-
* @group Modules
|
|
1815
|
-
* @category Storage
|
|
1816
|
-
*
|
|
1817
|
-
* @public
|
|
1818
|
-
*/
|
|
1819
|
-
export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
1454
|
+
export declare type GetBooleanResult = boolean;
|
|
1820
1455
|
|
|
1821
1456
|
/**
|
|
1822
1457
|
* Response when getting the device coordinates.
|
|
@@ -1834,35 +1469,7 @@ export declare const GetBooleanResultSchema: v.BooleanSchema<undefined>;
|
|
|
1834
1469
|
*
|
|
1835
1470
|
* @public
|
|
1836
1471
|
*/
|
|
1837
|
-
export declare type GetCoordinateResponse =
|
|
1838
|
-
|
|
1839
|
-
/**
|
|
1840
|
-
* Valibot schema for {@link GetCoordinateResponse}.
|
|
1841
|
-
*
|
|
1842
|
-
* @group Modules
|
|
1843
|
-
* @category Location
|
|
1844
|
-
*
|
|
1845
|
-
* @public
|
|
1846
|
-
*/
|
|
1847
|
-
export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1848
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
1849
|
-
readonly result: v.ObjectSchema<{
|
|
1850
|
-
readonly latitude: v.NumberSchema<undefined>;
|
|
1851
|
-
readonly longitude: v.NumberSchema<undefined>;
|
|
1852
|
-
}, undefined>;
|
|
1853
|
-
}, undefined>, v.ObjectSchema<{
|
|
1854
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
1855
|
-
readonly error: v.StringSchema<undefined>;
|
|
1856
|
-
}, undefined>, v.ObjectSchema<{
|
|
1857
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
1858
|
-
readonly error: v.StringSchema<undefined>;
|
|
1859
|
-
}, undefined>, v.ObjectSchema<{
|
|
1860
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1861
|
-
readonly error: v.StringSchema<undefined>;
|
|
1862
|
-
}, undefined>, v.ObjectSchema<{
|
|
1863
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1864
|
-
readonly error: v.StringSchema<undefined>;
|
|
1865
|
-
}, undefined>], undefined>;
|
|
1472
|
+
export declare type GetCoordinateResponse = SDKOkResponse<GetCoordinateResult> | SDKErrorResponse<403> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1866
1473
|
|
|
1867
1474
|
/**
|
|
1868
1475
|
* Result object containing the geographic coordinates.
|
|
@@ -1877,20 +1484,10 @@ export declare const GetCoordinateResponseSchema: v.UnionSchema<[v.ObjectSchema<
|
|
|
1877
1484
|
*
|
|
1878
1485
|
* @public
|
|
1879
1486
|
*/
|
|
1880
|
-
export declare type GetCoordinateResult =
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
*
|
|
1885
|
-
* @group Modules
|
|
1886
|
-
* @category Location
|
|
1887
|
-
*
|
|
1888
|
-
* @public
|
|
1889
|
-
*/
|
|
1890
|
-
export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
1891
|
-
readonly latitude: v.NumberSchema<undefined>;
|
|
1892
|
-
readonly longitude: v.NumberSchema<undefined>;
|
|
1893
|
-
}, undefined>;
|
|
1487
|
+
export declare type GetCoordinateResult = {
|
|
1488
|
+
latitude: number;
|
|
1489
|
+
longitude: number;
|
|
1490
|
+
};
|
|
1894
1491
|
|
|
1895
1492
|
/**
|
|
1896
1493
|
* Response when getting the country code.
|
|
@@ -1909,37 +1506,10 @@ export declare const GetCoordinateResultSchema: v.ObjectSchema<{
|
|
|
1909
1506
|
*
|
|
1910
1507
|
* @public
|
|
1911
1508
|
*/
|
|
1912
|
-
export declare type GetCountryCodeResponse =
|
|
1913
|
-
|
|
1914
|
-
/**
|
|
1915
|
-
* Valibot schema for {@link GetCountryCodeResponse}.
|
|
1916
|
-
*
|
|
1917
|
-
* @group Modules
|
|
1918
|
-
* @category Location
|
|
1919
|
-
*
|
|
1920
|
-
* @public
|
|
1921
|
-
*/
|
|
1922
|
-
export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
1923
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
1924
|
-
readonly result: v.StringSchema<undefined>;
|
|
1925
|
-
}, undefined>, v.ObjectSchema<{
|
|
1926
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
1927
|
-
}, undefined>, v.ObjectSchema<{
|
|
1928
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
1929
|
-
readonly error: v.StringSchema<undefined>;
|
|
1930
|
-
}, undefined>, v.ObjectSchema<{
|
|
1931
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
1932
|
-
readonly error: v.StringSchema<undefined>;
|
|
1933
|
-
}, undefined>, v.ObjectSchema<{
|
|
1934
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
1935
|
-
readonly error: v.StringSchema<undefined>;
|
|
1936
|
-
}, undefined>, v.ObjectSchema<{
|
|
1937
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
1938
|
-
readonly error: v.StringSchema<undefined>;
|
|
1939
|
-
}, undefined>], undefined>;
|
|
1509
|
+
export declare type GetCountryCodeResponse = SDKOkResponse<GetCountryCodeResult> | SDKNoContentResponse | SDKErrorResponse<403> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
1940
1510
|
|
|
1941
1511
|
/**
|
|
1942
|
-
* The ISO country code string returned from
|
|
1512
|
+
* The ISO country code string returned from `JSBridge`.
|
|
1943
1513
|
*
|
|
1944
1514
|
* @group Modules
|
|
1945
1515
|
* @category Location
|
|
@@ -1956,17 +1526,7 @@ export declare const GetCountryCodeResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
1956
1526
|
*
|
|
1957
1527
|
* @public
|
|
1958
1528
|
*/
|
|
1959
|
-
export declare type GetCountryCodeResult =
|
|
1960
|
-
|
|
1961
|
-
/**
|
|
1962
|
-
* Valibot schema for {@link GetCountryCodeResult}.
|
|
1963
|
-
*
|
|
1964
|
-
* @group Modules
|
|
1965
|
-
* @category Location
|
|
1966
|
-
*
|
|
1967
|
-
* @public
|
|
1968
|
-
*/
|
|
1969
|
-
export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
1529
|
+
export declare type GetCountryCodeResult = string;
|
|
1970
1530
|
|
|
1971
1531
|
/**
|
|
1972
1532
|
* Request parameters for getting a double value from storage.
|
|
@@ -1981,19 +1541,9 @@ export declare const GetCountryCodeResultSchema: v.StringSchema<undefined>;
|
|
|
1981
1541
|
*
|
|
1982
1542
|
* @public
|
|
1983
1543
|
*/
|
|
1984
|
-
export declare type GetDoubleRequest =
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
* Valibot schema for {@link GetDoubleRequest}.
|
|
1988
|
-
*
|
|
1989
|
-
* @group Modules
|
|
1990
|
-
* @category Storage
|
|
1991
|
-
*
|
|
1992
|
-
* @public
|
|
1993
|
-
*/
|
|
1994
|
-
export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
1995
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
1996
|
-
}, undefined>;
|
|
1544
|
+
export declare type GetDoubleRequest = {
|
|
1545
|
+
key: string;
|
|
1546
|
+
};
|
|
1997
1547
|
|
|
1998
1548
|
/**
|
|
1999
1549
|
* Response when getting a double value.
|
|
@@ -2012,34 +1562,7 @@ export declare const GetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
2012
1562
|
*
|
|
2013
1563
|
* @public
|
|
2014
1564
|
*/
|
|
2015
|
-
export declare type GetDoubleResponse =
|
|
2016
|
-
|
|
2017
|
-
/**
|
|
2018
|
-
* Valibot schema for {@link GetDoubleResponse}.
|
|
2019
|
-
*
|
|
2020
|
-
* @group Modules
|
|
2021
|
-
* @category Storage
|
|
2022
|
-
*
|
|
2023
|
-
* @public
|
|
2024
|
-
*/
|
|
2025
|
-
export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2026
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2027
|
-
readonly result: v.NumberSchema<undefined>;
|
|
2028
|
-
}, undefined>, v.ObjectSchema<{
|
|
2029
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2030
|
-
}, undefined>, v.ObjectSchema<{
|
|
2031
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
2032
|
-
readonly error: v.StringSchema<undefined>;
|
|
2033
|
-
}, undefined>, v.ObjectSchema<{
|
|
2034
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
2035
|
-
readonly error: v.StringSchema<undefined>;
|
|
2036
|
-
}, undefined>, v.ObjectSchema<{
|
|
2037
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2038
|
-
readonly error: v.StringSchema<undefined>;
|
|
2039
|
-
}, undefined>, v.ObjectSchema<{
|
|
2040
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2041
|
-
readonly error: v.StringSchema<undefined>;
|
|
2042
|
-
}, undefined>], undefined>;
|
|
1565
|
+
export declare type GetDoubleResponse = SDKOkResponse<GetDoubleResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2043
1566
|
|
|
2044
1567
|
/**
|
|
2045
1568
|
* The floating-point value returned when a key exists in storage.
|
|
@@ -2057,17 +1580,7 @@ export declare const GetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2057
1580
|
*
|
|
2058
1581
|
* @public
|
|
2059
1582
|
*/
|
|
2060
|
-
export declare type GetDoubleResult =
|
|
2061
|
-
|
|
2062
|
-
/**
|
|
2063
|
-
* Valibot schema for {@link GetDoubleResult}.
|
|
2064
|
-
*
|
|
2065
|
-
* @group Modules
|
|
2066
|
-
* @category Storage
|
|
2067
|
-
*
|
|
2068
|
-
* @public
|
|
2069
|
-
*/
|
|
2070
|
-
export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
1583
|
+
export declare type GetDoubleResult = number;
|
|
2071
1584
|
|
|
2072
1585
|
/**
|
|
2073
1586
|
* Request parameters for getting an integer value from storage.
|
|
@@ -2082,19 +1595,9 @@ export declare const GetDoubleResultSchema: v.NumberSchema<undefined>;
|
|
|
2082
1595
|
*
|
|
2083
1596
|
* @public
|
|
2084
1597
|
*/
|
|
2085
|
-
export declare type GetIntRequest =
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
* Valibot schema for {@link GetIntRequest}.
|
|
2089
|
-
*
|
|
2090
|
-
* @group Modules
|
|
2091
|
-
* @category Storage
|
|
2092
|
-
*
|
|
2093
|
-
* @public
|
|
2094
|
-
*/
|
|
2095
|
-
export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
2096
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
2097
|
-
}, undefined>;
|
|
1598
|
+
export declare type GetIntRequest = {
|
|
1599
|
+
key: string;
|
|
1600
|
+
};
|
|
2098
1601
|
|
|
2099
1602
|
/**
|
|
2100
1603
|
* Response when getting an integer value.
|
|
@@ -2113,34 +1616,7 @@ export declare const GetIntRequestSchema: v.ObjectSchema<{
|
|
|
2113
1616
|
*
|
|
2114
1617
|
* @public
|
|
2115
1618
|
*/
|
|
2116
|
-
export declare type GetIntResponse =
|
|
2117
|
-
|
|
2118
|
-
/**
|
|
2119
|
-
* Valibot schema for {@link GetIntResponse}.
|
|
2120
|
-
*
|
|
2121
|
-
* @group Modules
|
|
2122
|
-
* @category Storage
|
|
2123
|
-
*
|
|
2124
|
-
* @public
|
|
2125
|
-
*/
|
|
2126
|
-
export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2127
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2128
|
-
readonly result: v.NumberSchema<undefined>;
|
|
2129
|
-
}, undefined>, v.ObjectSchema<{
|
|
2130
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2131
|
-
}, undefined>, v.ObjectSchema<{
|
|
2132
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
2133
|
-
readonly error: v.StringSchema<undefined>;
|
|
2134
|
-
}, undefined>, v.ObjectSchema<{
|
|
2135
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
2136
|
-
readonly error: v.StringSchema<undefined>;
|
|
2137
|
-
}, undefined>, v.ObjectSchema<{
|
|
2138
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2139
|
-
readonly error: v.StringSchema<undefined>;
|
|
2140
|
-
}, undefined>, v.ObjectSchema<{
|
|
2141
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2142
|
-
readonly error: v.StringSchema<undefined>;
|
|
2143
|
-
}, undefined>], undefined>;
|
|
1619
|
+
export declare type GetIntResponse = SDKOkResponse<GetIntResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2144
1620
|
|
|
2145
1621
|
/**
|
|
2146
1622
|
* The integer value returned when a key exists in storage.
|
|
@@ -2158,17 +1634,7 @@ export declare const GetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2158
1634
|
*
|
|
2159
1635
|
* @public
|
|
2160
1636
|
*/
|
|
2161
|
-
export declare type GetIntResult =
|
|
2162
|
-
|
|
2163
|
-
/**
|
|
2164
|
-
* Valibot schema for {@link GetIntResult}.
|
|
2165
|
-
*
|
|
2166
|
-
* @group Modules
|
|
2167
|
-
* @category Storage
|
|
2168
|
-
*
|
|
2169
|
-
* @public
|
|
2170
|
-
*/
|
|
2171
|
-
export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
1637
|
+
export declare type GetIntResult = number;
|
|
2172
1638
|
|
|
2173
1639
|
/**
|
|
2174
1640
|
* Response when getting the language locale identifier from the device.
|
|
@@ -2186,31 +1652,7 @@ export declare const GetIntResultSchema: v.NumberSchema<undefined>;
|
|
|
2186
1652
|
*
|
|
2187
1653
|
* @public
|
|
2188
1654
|
*/
|
|
2189
|
-
export declare type GetLanguageLocaleIdentifierResponse =
|
|
2190
|
-
|
|
2191
|
-
/**
|
|
2192
|
-
* Valibot schema for {@link GetLanguageLocaleIdentifierResponse}.
|
|
2193
|
-
*
|
|
2194
|
-
* @group Modules
|
|
2195
|
-
* @category Locale
|
|
2196
|
-
*
|
|
2197
|
-
* @public
|
|
2198
|
-
*/
|
|
2199
|
-
export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2200
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2201
|
-
readonly result: v.StringSchema<undefined>;
|
|
2202
|
-
}, undefined>, v.ObjectSchema<{
|
|
2203
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2204
|
-
}, undefined>, v.ObjectSchema<{
|
|
2205
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
2206
|
-
readonly error: v.StringSchema<undefined>;
|
|
2207
|
-
}, undefined>, v.ObjectSchema<{
|
|
2208
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2209
|
-
readonly error: v.StringSchema<undefined>;
|
|
2210
|
-
}, undefined>, v.ObjectSchema<{
|
|
2211
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2212
|
-
readonly error: v.StringSchema<undefined>;
|
|
2213
|
-
}, undefined>], undefined>;
|
|
1655
|
+
export declare type GetLanguageLocaleIdentifierResponse = SDKOkResponse<GetLanguageLocaleIdentifierResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2214
1656
|
|
|
2215
1657
|
/**
|
|
2216
1658
|
* Result object containing the language locale identifier.
|
|
@@ -2244,17 +1686,7 @@ export declare const GetLanguageLocaleIdentifierResponseSchema: v.UnionSchema<[v
|
|
|
2244
1686
|
*
|
|
2245
1687
|
* @public
|
|
2246
1688
|
*/
|
|
2247
|
-
export declare type GetLanguageLocaleIdentifierResult =
|
|
2248
|
-
|
|
2249
|
-
/**
|
|
2250
|
-
* Valibot schema for {@link GetLanguageLocaleIdentifierResult}.
|
|
2251
|
-
*
|
|
2252
|
-
* @group Modules
|
|
2253
|
-
* @category Locale
|
|
2254
|
-
*
|
|
2255
|
-
* @public
|
|
2256
|
-
*/
|
|
2257
|
-
export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<undefined>;
|
|
1689
|
+
export declare type GetLanguageLocaleIdentifierResult = string;
|
|
2258
1690
|
|
|
2259
1691
|
/**
|
|
2260
1692
|
* Response when reading the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
@@ -2271,28 +1703,7 @@ export declare const GetLanguageLocaleIdentifierResultSchema: v.StringSchema<und
|
|
|
2271
1703
|
*
|
|
2272
1704
|
* @public
|
|
2273
1705
|
*/
|
|
2274
|
-
export declare type GetSelectedTravelDestinationResponse =
|
|
2275
|
-
|
|
2276
|
-
/**
|
|
2277
|
-
* Valibot schema for {@link GetSelectedTravelDestinationResponse}.
|
|
2278
|
-
*
|
|
2279
|
-
* @group Modules
|
|
2280
|
-
* @category User Attributes
|
|
2281
|
-
*
|
|
2282
|
-
* @public
|
|
2283
|
-
*/
|
|
2284
|
-
export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2285
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2286
|
-
readonly result: v.StringSchema<undefined>;
|
|
2287
|
-
}, undefined>, v.ObjectSchema<{
|
|
2288
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2289
|
-
}, undefined>, v.ObjectSchema<{
|
|
2290
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2291
|
-
readonly error: v.StringSchema<undefined>;
|
|
2292
|
-
}, undefined>, v.ObjectSchema<{
|
|
2293
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2294
|
-
readonly error: v.StringSchema<undefined>;
|
|
2295
|
-
}, undefined>], undefined>;
|
|
1706
|
+
export declare type GetSelectedTravelDestinationResponse = SDKOkResponse<GetSelectedTravelDestinationResult> | SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2296
1707
|
|
|
2297
1708
|
/**
|
|
2298
1709
|
* Result containing the selected travel destination lowercase ISO 3166-1 alpha-2 country code.
|
|
@@ -2312,17 +1723,7 @@ export declare const GetSelectedTravelDestinationResponseSchema: v.UnionSchema<[
|
|
|
2312
1723
|
*
|
|
2313
1724
|
* @public
|
|
2314
1725
|
*/
|
|
2315
|
-
export declare type GetSelectedTravelDestinationResult =
|
|
2316
|
-
|
|
2317
|
-
/**
|
|
2318
|
-
* Valibot schema for {@link GetSelectedTravelDestinationResult}.
|
|
2319
|
-
*
|
|
2320
|
-
* @group Modules
|
|
2321
|
-
* @category User Attributes
|
|
2322
|
-
*
|
|
2323
|
-
* @public
|
|
2324
|
-
*/
|
|
2325
|
-
export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<undefined>;
|
|
1726
|
+
export declare type GetSelectedTravelDestinationResult = string;
|
|
2326
1727
|
|
|
2327
1728
|
/**
|
|
2328
1729
|
* Response when getting session parameters.
|
|
@@ -2338,28 +1739,7 @@ export declare const GetSelectedTravelDestinationResultSchema: v.StringSchema<un
|
|
|
2338
1739
|
*
|
|
2339
1740
|
* @public
|
|
2340
1741
|
*/
|
|
2341
|
-
export declare type GetSessionParamsResponse =
|
|
2342
|
-
|
|
2343
|
-
/**
|
|
2344
|
-
* Valibot schema for {@link GetSessionParamsResponse}.
|
|
2345
|
-
*
|
|
2346
|
-
* @group Modules
|
|
2347
|
-
* @category Container
|
|
2348
|
-
*
|
|
2349
|
-
* @public
|
|
2350
|
-
*/
|
|
2351
|
-
export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2352
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2353
|
-
readonly result: v.StringSchema<undefined>;
|
|
2354
|
-
}, undefined>, v.ObjectSchema<{
|
|
2355
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2356
|
-
}, undefined>, v.ObjectSchema<{
|
|
2357
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2358
|
-
readonly error: v.StringSchema<undefined>;
|
|
2359
|
-
}, undefined>, v.ObjectSchema<{
|
|
2360
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2361
|
-
readonly error: v.StringSchema<undefined>;
|
|
2362
|
-
}, undefined>], undefined>;
|
|
1742
|
+
export declare type GetSessionParamsResponse = SDKOkResponse<GetSessionParamsResult> | SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2363
1743
|
|
|
2364
1744
|
/**
|
|
2365
1745
|
* Result object containing session parameters as a JSON string.
|
|
@@ -2379,17 +1759,7 @@ export declare const GetSessionParamsResponseSchema: v.UnionSchema<[v.ObjectSche
|
|
|
2379
1759
|
*
|
|
2380
1760
|
* @public
|
|
2381
1761
|
*/
|
|
2382
|
-
export declare type GetSessionParamsResult =
|
|
2383
|
-
|
|
2384
|
-
/**
|
|
2385
|
-
* Valibot schema for {@link GetSessionParamsResult}.
|
|
2386
|
-
*
|
|
2387
|
-
* @group Modules
|
|
2388
|
-
* @category Container
|
|
2389
|
-
*
|
|
2390
|
-
* @public
|
|
2391
|
-
*/
|
|
2392
|
-
export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
1762
|
+
export declare type GetSessionParamsResult = string;
|
|
2393
1763
|
|
|
2394
1764
|
/**
|
|
2395
1765
|
* Request parameters for getting a string value from storage.
|
|
@@ -2404,19 +1774,9 @@ export declare const GetSessionParamsResultSchema: v.StringSchema<undefined>;
|
|
|
2404
1774
|
*
|
|
2405
1775
|
* @public
|
|
2406
1776
|
*/
|
|
2407
|
-
export declare type GetStringRequest =
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
* Valibot schema for {@link GetStringRequest}.
|
|
2411
|
-
*
|
|
2412
|
-
* @group Modules
|
|
2413
|
-
* @category Storage
|
|
2414
|
-
*
|
|
2415
|
-
* @public
|
|
2416
|
-
*/
|
|
2417
|
-
export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
2418
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
2419
|
-
}, undefined>;
|
|
1777
|
+
export declare type GetStringRequest = {
|
|
1778
|
+
key: string;
|
|
1779
|
+
};
|
|
2420
1780
|
|
|
2421
1781
|
/**
|
|
2422
1782
|
* Response when getting a string value.
|
|
@@ -2435,34 +1795,7 @@ export declare const GetStringRequestSchema: v.ObjectSchema<{
|
|
|
2435
1795
|
*
|
|
2436
1796
|
* @public
|
|
2437
1797
|
*/
|
|
2438
|
-
export declare type GetStringResponse =
|
|
2439
|
-
|
|
2440
|
-
/**
|
|
2441
|
-
* Valibot schema for {@link GetStringResponse}.
|
|
2442
|
-
*
|
|
2443
|
-
* @group Modules
|
|
2444
|
-
* @category Storage
|
|
2445
|
-
*
|
|
2446
|
-
* @public
|
|
2447
|
-
*/
|
|
2448
|
-
export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2449
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2450
|
-
readonly result: v.StringSchema<undefined>;
|
|
2451
|
-
}, undefined>, v.ObjectSchema<{
|
|
2452
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2453
|
-
}, undefined>, v.ObjectSchema<{
|
|
2454
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
2455
|
-
readonly error: v.StringSchema<undefined>;
|
|
2456
|
-
}, undefined>, v.ObjectSchema<{
|
|
2457
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
2458
|
-
readonly error: v.StringSchema<undefined>;
|
|
2459
|
-
}, undefined>, v.ObjectSchema<{
|
|
2460
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2461
|
-
readonly error: v.StringSchema<undefined>;
|
|
2462
|
-
}, undefined>, v.ObjectSchema<{
|
|
2463
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2464
|
-
readonly error: v.StringSchema<undefined>;
|
|
2465
|
-
}, undefined>], undefined>;
|
|
1798
|
+
export declare type GetStringResponse = SDKOkResponse<GetStringResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2466
1799
|
|
|
2467
1800
|
/**
|
|
2468
1801
|
* The string value returned when a key exists in storage.
|
|
@@ -2480,17 +1813,7 @@ export declare const GetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2480
1813
|
*
|
|
2481
1814
|
* @public
|
|
2482
1815
|
*/
|
|
2483
|
-
export declare type GetStringResult =
|
|
2484
|
-
|
|
2485
|
-
/**
|
|
2486
|
-
* Valibot schema for {@link GetStringResult}.
|
|
2487
|
-
*
|
|
2488
|
-
* @group Modules
|
|
2489
|
-
* @category Storage
|
|
2490
|
-
*
|
|
2491
|
-
* @public
|
|
2492
|
-
*/
|
|
2493
|
-
export declare const GetStringResultSchema: v.StringSchema<undefined>;
|
|
1816
|
+
export declare type GetStringResult = string;
|
|
2494
1817
|
|
|
2495
1818
|
/**
|
|
2496
1819
|
* Represents parsed information from a Grab app user agent string.
|
|
@@ -2521,20 +1844,10 @@ export declare interface GrabAppInfo {
|
|
|
2521
1844
|
*
|
|
2522
1845
|
* @public
|
|
2523
1846
|
*/
|
|
2524
|
-
export declare type HasAccessToRequest =
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
*
|
|
2529
|
-
* @group Modules
|
|
2530
|
-
* @category Scope
|
|
2531
|
-
*
|
|
2532
|
-
* @public
|
|
2533
|
-
*/
|
|
2534
|
-
export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
2535
|
-
readonly module: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
2536
|
-
readonly method: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
2537
|
-
}, undefined>;
|
|
1847
|
+
export declare type HasAccessToRequest = {
|
|
1848
|
+
method: string;
|
|
1849
|
+
module: string;
|
|
1850
|
+
};
|
|
2538
1851
|
|
|
2539
1852
|
/**
|
|
2540
1853
|
* Response when checking API access permissions.
|
|
@@ -2552,32 +1865,7 @@ export declare const HasAccessToRequestSchema: v.ObjectSchema<{
|
|
|
2552
1865
|
*
|
|
2553
1866
|
* @public
|
|
2554
1867
|
*/
|
|
2555
|
-
export declare type HasAccessToResponse =
|
|
2556
|
-
|
|
2557
|
-
/**
|
|
2558
|
-
* Valibot schema for {@link HasAccessToResponse}.
|
|
2559
|
-
*
|
|
2560
|
-
* @group Modules
|
|
2561
|
-
* @category Scope
|
|
2562
|
-
*
|
|
2563
|
-
* @public
|
|
2564
|
-
*/
|
|
2565
|
-
export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2566
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
2567
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
2568
|
-
}, undefined>, v.ObjectSchema<{
|
|
2569
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
2570
|
-
readonly error: v.StringSchema<undefined>;
|
|
2571
|
-
}, undefined>, v.ObjectSchema<{
|
|
2572
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
2573
|
-
readonly error: v.StringSchema<undefined>;
|
|
2574
|
-
}, undefined>, v.ObjectSchema<{
|
|
2575
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2576
|
-
readonly error: v.StringSchema<undefined>;
|
|
2577
|
-
}, undefined>, v.ObjectSchema<{
|
|
2578
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2579
|
-
readonly error: v.StringSchema<undefined>;
|
|
2580
|
-
}, undefined>], undefined>;
|
|
1868
|
+
export declare type HasAccessToResponse = SDKOkResponse<HasAccessToResult> | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2581
1869
|
|
|
2582
1870
|
/**
|
|
2583
1871
|
* Boolean result indicating whether the MiniApp has access to the specified API.
|
|
@@ -2599,38 +1887,28 @@ export declare const HasAccessToResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
2599
1887
|
*
|
|
2600
1888
|
* @public
|
|
2601
1889
|
*/
|
|
2602
|
-
export declare type HasAccessToResult =
|
|
2603
|
-
|
|
2604
|
-
/**
|
|
2605
|
-
* Valibot schema for {@link HasAccessToResult}.
|
|
2606
|
-
*
|
|
2607
|
-
* @group Modules
|
|
2608
|
-
* @category Scope
|
|
2609
|
-
*
|
|
2610
|
-
* @public
|
|
2611
|
-
*/
|
|
2612
|
-
export declare const HasAccessToResultSchema: v.BooleanSchema<undefined>;
|
|
1890
|
+
export declare type HasAccessToResult = boolean;
|
|
2613
1891
|
|
|
2614
1892
|
/**
|
|
2615
|
-
* Type guard to check if
|
|
1893
|
+
* Type guard to check if an SDK response has a `result` that is neither `null` nor `undefined`.
|
|
2616
1894
|
*
|
|
2617
1895
|
* @group Type Guards
|
|
2618
1896
|
*
|
|
2619
|
-
* @param response - The
|
|
2620
|
-
* @returns
|
|
1897
|
+
* @param response - The SDK response to check
|
|
1898
|
+
* @returns `true` if the response has a `result` that is neither `null` nor `undefined`, `false` otherwise
|
|
2621
1899
|
*
|
|
2622
1900
|
* @example
|
|
2623
1901
|
* ```typescript
|
|
2624
1902
|
* const response = await someBridgeMethod();
|
|
2625
|
-
* if (
|
|
2626
|
-
* // response
|
|
1903
|
+
* if (isOk(response) && hasResult(response)) {
|
|
1904
|
+
* // response narrowed to status code `200` variant, and `result` is available
|
|
2627
1905
|
* console.log('Result:', response.result);
|
|
2628
1906
|
* }
|
|
2629
1907
|
* ```
|
|
2630
1908
|
*
|
|
2631
1909
|
* @public
|
|
2632
1910
|
*/
|
|
2633
|
-
export declare function hasResult<T extends
|
|
1911
|
+
export declare function hasResult<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
2634
1912
|
result: NonNullable<unknown>;
|
|
2635
1913
|
}>;
|
|
2636
1914
|
|
|
@@ -2648,25 +1926,7 @@ export declare function hasResult<T extends BridgeResponse>(response: T): respon
|
|
|
2648
1926
|
*
|
|
2649
1927
|
* @public
|
|
2650
1928
|
*/
|
|
2651
|
-
export declare type HideBackButtonResponse =
|
|
2652
|
-
|
|
2653
|
-
/**
|
|
2654
|
-
* Valibot schema for {@link HideBackButtonResponse}.
|
|
2655
|
-
*
|
|
2656
|
-
* @group Modules
|
|
2657
|
-
* @category Container
|
|
2658
|
-
*
|
|
2659
|
-
* @public
|
|
2660
|
-
*/
|
|
2661
|
-
export declare const HideBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2662
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2663
|
-
}, undefined>, v.ObjectSchema<{
|
|
2664
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2665
|
-
readonly error: v.StringSchema<undefined>;
|
|
2666
|
-
}, undefined>, v.ObjectSchema<{
|
|
2667
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2668
|
-
readonly error: v.StringSchema<undefined>;
|
|
2669
|
-
}, undefined>], undefined>;
|
|
1929
|
+
export declare type HideBackButtonResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2670
1930
|
|
|
2671
1931
|
/**
|
|
2672
1932
|
* Result when hiding the back button.
|
|
@@ -2693,25 +1953,7 @@ export declare type HideBackButtonResult = void;
|
|
|
2693
1953
|
*
|
|
2694
1954
|
* @public
|
|
2695
1955
|
*/
|
|
2696
|
-
export declare type HideLoaderResponse =
|
|
2697
|
-
|
|
2698
|
-
/**
|
|
2699
|
-
* Valibot schema for {@link HideLoaderResponse}.
|
|
2700
|
-
*
|
|
2701
|
-
* @group Modules
|
|
2702
|
-
* @category Container
|
|
2703
|
-
*
|
|
2704
|
-
* @public
|
|
2705
|
-
*/
|
|
2706
|
-
export declare const HideLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2707
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2708
|
-
}, undefined>, v.ObjectSchema<{
|
|
2709
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2710
|
-
readonly error: v.StringSchema<undefined>;
|
|
2711
|
-
}, undefined>, v.ObjectSchema<{
|
|
2712
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2713
|
-
readonly error: v.StringSchema<undefined>;
|
|
2714
|
-
}, undefined>], undefined>;
|
|
1956
|
+
export declare type HideLoaderResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2715
1957
|
|
|
2716
1958
|
/**
|
|
2717
1959
|
* Result when hiding the loader.
|
|
@@ -2738,25 +1980,7 @@ export declare type HideLoaderResult = void;
|
|
|
2738
1980
|
*
|
|
2739
1981
|
* @public
|
|
2740
1982
|
*/
|
|
2741
|
-
export declare type HideRefreshButtonResponse =
|
|
2742
|
-
|
|
2743
|
-
/**
|
|
2744
|
-
* Valibot schema for {@link HideRefreshButtonResponse}.
|
|
2745
|
-
*
|
|
2746
|
-
* @group Modules
|
|
2747
|
-
* @category Container
|
|
2748
|
-
*
|
|
2749
|
-
* @public
|
|
2750
|
-
*/
|
|
2751
|
-
export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
2752
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
2753
|
-
}, undefined>, v.ObjectSchema<{
|
|
2754
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
2755
|
-
readonly error: v.StringSchema<undefined>;
|
|
2756
|
-
}, undefined>, v.ObjectSchema<{
|
|
2757
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
2758
|
-
readonly error: v.StringSchema<undefined>;
|
|
2759
|
-
}, undefined>], undefined>;
|
|
1983
|
+
export declare type HideRefreshButtonResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
2760
1984
|
|
|
2761
1985
|
/**
|
|
2762
1986
|
* Result when hiding the refresh button.
|
|
@@ -2770,7 +1994,7 @@ export declare const HideRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
2770
1994
|
export declare type HideRefreshButtonResult = void;
|
|
2771
1995
|
|
|
2772
1996
|
/**
|
|
2773
|
-
*
|
|
1997
|
+
* SDK module for authenticating users with GrabID via `JSBridge`.
|
|
2774
1998
|
*
|
|
2775
1999
|
* @group Modules
|
|
2776
2000
|
* @category Identity
|
|
@@ -2943,7 +2167,7 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2943
2167
|
* Determines whether to use web-based consent flow based on app version and environment.
|
|
2944
2168
|
*
|
|
2945
2169
|
* @param request - The authorization request containing the environment setting.
|
|
2946
|
-
* @returns
|
|
2170
|
+
* @returns `true` if web consent should be used, `false` for native consent.
|
|
2947
2171
|
*
|
|
2948
2172
|
* @internal
|
|
2949
2173
|
*/
|
|
@@ -2959,7 +2183,7 @@ export declare class IdentityModule extends BaseModule {
|
|
|
2959
2183
|
*/
|
|
2960
2184
|
private performWebAuthorization;
|
|
2961
2185
|
/**
|
|
2962
|
-
* Performs native in-app OAuth2 authorization using
|
|
2186
|
+
* Performs native in-app OAuth2 authorization using `JSBridge`.
|
|
2963
2187
|
*
|
|
2964
2188
|
* @param invokeParams - The authorization parameters.
|
|
2965
2189
|
*
|
|
@@ -3057,38 +2281,25 @@ export declare class IdentityModule extends BaseModule {
|
|
|
3057
2281
|
}
|
|
3058
2282
|
|
|
3059
2283
|
/**
|
|
3060
|
-
*
|
|
3061
|
-
*
|
|
3062
|
-
* @group Core
|
|
3063
|
-
*
|
|
3064
|
-
* @public
|
|
3065
|
-
*/
|
|
3066
|
-
export declare interface InvokeOptions {
|
|
3067
|
-
/** The name of the JSBridge method to invoke */
|
|
3068
|
-
method: string;
|
|
3069
|
-
/** The parameters to pass to the method */
|
|
3070
|
-
params?: unknown;
|
|
3071
|
-
}
|
|
3072
|
-
|
|
3073
|
-
/**
|
|
3074
|
-
* Type guard to check if a JSBridge response is a client error (4xx status codes).
|
|
2284
|
+
* Type guard to check if an SDK response has a client error status code (`400`, `401`, `403`, `404`, `424`, `426`).
|
|
3075
2285
|
*
|
|
3076
2286
|
* @group Type Guards
|
|
3077
2287
|
*
|
|
3078
|
-
* @param response - The
|
|
3079
|
-
* @returns
|
|
2288
|
+
* @param response - The SDK response to check
|
|
2289
|
+
* @returns `true` if the response is a client error, `false` otherwise
|
|
3080
2290
|
*
|
|
3081
2291
|
* @example
|
|
3082
2292
|
* ```typescript
|
|
3083
2293
|
* const response = await someBridgeMethod();
|
|
3084
2294
|
* if (isClientError(response)) {
|
|
3085
|
-
*
|
|
2295
|
+
* // response narrowed to client error variants, `error` is available
|
|
2296
|
+
* console.error(response.error);
|
|
3086
2297
|
* }
|
|
3087
2298
|
* ```
|
|
3088
2299
|
*
|
|
3089
2300
|
* @public
|
|
3090
2301
|
*/
|
|
3091
|
-
export declare function isClientError<T extends
|
|
2302
|
+
export declare function isClientError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3092
2303
|
status_code: 400 | 401 | 403 | 404 | 424 | 426;
|
|
3093
2304
|
}>;
|
|
3094
2305
|
|
|
@@ -3105,25 +2316,7 @@ export declare function isClientError<T extends BridgeResponse>(response: T): re
|
|
|
3105
2316
|
*
|
|
3106
2317
|
* @public
|
|
3107
2318
|
*/
|
|
3108
|
-
export declare type IsConnectedResponse =
|
|
3109
|
-
|
|
3110
|
-
/**
|
|
3111
|
-
* Valibot schema for {@link IsConnectedResponse}.
|
|
3112
|
-
*
|
|
3113
|
-
* @group Modules
|
|
3114
|
-
* @category Container
|
|
3115
|
-
*
|
|
3116
|
-
* @public
|
|
3117
|
-
*/
|
|
3118
|
-
export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3119
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3120
|
-
readonly result: v.ObjectSchema<{
|
|
3121
|
-
readonly connected: v.BooleanSchema<undefined>;
|
|
3122
|
-
}, undefined>;
|
|
3123
|
-
}, undefined>, v.ObjectSchema<{
|
|
3124
|
-
readonly status_code: v.LiteralSchema<404, undefined>;
|
|
3125
|
-
readonly error: v.StringSchema<undefined>;
|
|
3126
|
-
}, undefined>], undefined>;
|
|
2319
|
+
export declare type IsConnectedResponse = SDKOkResponse<IsConnectedResult> | SDKErrorResponse<404>;
|
|
3127
2320
|
|
|
3128
2321
|
/**
|
|
3129
2322
|
* Result object containing the connection status.
|
|
@@ -3145,42 +2338,30 @@ export declare const IsConnectedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
3145
2338
|
*
|
|
3146
2339
|
* @public
|
|
3147
2340
|
*/
|
|
3148
|
-
export declare type IsConnectedResult =
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
* Valibot schema for {@link IsConnectedResult}.
|
|
3152
|
-
*
|
|
3153
|
-
* @group Modules
|
|
3154
|
-
* @category Container
|
|
3155
|
-
*
|
|
3156
|
-
* @public
|
|
3157
|
-
*/
|
|
3158
|
-
export declare const IsConnectedResultSchema: v.ObjectSchema<{
|
|
3159
|
-
readonly connected: v.BooleanSchema<undefined>;
|
|
3160
|
-
}, undefined>;
|
|
2341
|
+
export declare type IsConnectedResult = {
|
|
2342
|
+
connected: boolean;
|
|
2343
|
+
};
|
|
3161
2344
|
|
|
3162
2345
|
/**
|
|
3163
|
-
* Type guard to check if
|
|
2346
|
+
* Type guard to check if an SDK response has an error status code (`400`, `401`, `403`, `404`, `424`, `426`, `500`, `501`).
|
|
3164
2347
|
*
|
|
3165
2348
|
* @group Type Guards
|
|
3166
2349
|
*
|
|
3167
|
-
* @param response - The
|
|
3168
|
-
* @returns
|
|
2350
|
+
* @param response - The SDK response to check
|
|
2351
|
+
* @returns `true` if the response is an error, `false` otherwise
|
|
3169
2352
|
*
|
|
3170
2353
|
* @example
|
|
3171
2354
|
* ```typescript
|
|
3172
2355
|
* const response = await someBridgeMethod();
|
|
3173
2356
|
* if (isError(response)) {
|
|
3174
|
-
* // response narrowed to error variants
|
|
3175
|
-
* console.error(
|
|
3176
|
-
* } else {
|
|
3177
|
-
* console.log('Success!');
|
|
2357
|
+
* // response narrowed to error variants, `error` is available
|
|
2358
|
+
* console.error(response.error);
|
|
3178
2359
|
* }
|
|
3179
2360
|
* ```
|
|
3180
2361
|
*
|
|
3181
2362
|
* @public
|
|
3182
2363
|
*/
|
|
3183
|
-
export declare function isError<T extends
|
|
2364
|
+
export declare function isError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3184
2365
|
error: string;
|
|
3185
2366
|
}>;
|
|
3186
2367
|
|
|
@@ -3201,35 +2382,7 @@ export declare function isError<T extends BridgeResponse>(response: T): response
|
|
|
3201
2382
|
*
|
|
3202
2383
|
* @public
|
|
3203
2384
|
*/
|
|
3204
|
-
export declare type IsEsimSupportedResponse =
|
|
3205
|
-
|
|
3206
|
-
/**
|
|
3207
|
-
* Valibot schema for {@link IsEsimSupportedResponse}.
|
|
3208
|
-
*
|
|
3209
|
-
* @group Modules
|
|
3210
|
-
* @category Device
|
|
3211
|
-
*
|
|
3212
|
-
* @public
|
|
3213
|
-
*/
|
|
3214
|
-
export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3215
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3216
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
3217
|
-
}, undefined>, v.ObjectSchema<{
|
|
3218
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
3219
|
-
readonly error: v.StringSchema<undefined>;
|
|
3220
|
-
}, undefined>, v.ObjectSchema<{
|
|
3221
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
3222
|
-
readonly error: v.StringSchema<undefined>;
|
|
3223
|
-
}, undefined>, v.ObjectSchema<{
|
|
3224
|
-
readonly status_code: v.LiteralSchema<426, undefined>;
|
|
3225
|
-
readonly error: v.StringSchema<undefined>;
|
|
3226
|
-
}, undefined>, v.ObjectSchema<{
|
|
3227
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
3228
|
-
readonly error: v.StringSchema<undefined>;
|
|
3229
|
-
}, undefined>, v.ObjectSchema<{
|
|
3230
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
3231
|
-
readonly error: v.StringSchema<undefined>;
|
|
3232
|
-
}, undefined>], undefined>;
|
|
2385
|
+
export declare type IsEsimSupportedResponse = SDKOkResponse<IsEsimSupportedResult> | SDKErrorResponse<403> | SDKErrorResponse<424> | SDKErrorResponse<426> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
3233
2386
|
|
|
3234
2387
|
/**
|
|
3235
2388
|
* Result indicating whether the current device supports eSIM.
|
|
@@ -3249,129 +2402,148 @@ export declare const IsEsimSupportedResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
3249
2402
|
*
|
|
3250
2403
|
* @public
|
|
3251
2404
|
*/
|
|
3252
|
-
export declare type IsEsimSupportedResult =
|
|
3253
|
-
|
|
3254
|
-
/**
|
|
3255
|
-
* Valibot schema for {@link IsEsimSupportedResult}.
|
|
3256
|
-
*
|
|
3257
|
-
* @group Modules
|
|
3258
|
-
* @category Device
|
|
3259
|
-
*
|
|
3260
|
-
* @public
|
|
3261
|
-
*/
|
|
3262
|
-
export declare const IsEsimSupportedResultSchema: v.BooleanSchema<undefined>;
|
|
2405
|
+
export declare type IsEsimSupportedResult = boolean;
|
|
3263
2406
|
|
|
3264
2407
|
/**
|
|
3265
|
-
* Type guard to check if
|
|
2408
|
+
* Type guard to check if an SDK response has a `302` status code.
|
|
3266
2409
|
*
|
|
3267
2410
|
* @group Type Guards
|
|
3268
2411
|
*
|
|
3269
|
-
* @param response - The
|
|
3270
|
-
* @returns
|
|
2412
|
+
* @param response - The SDK response to check
|
|
2413
|
+
* @returns `true` if the response has `302` status code, `false` otherwise
|
|
2414
|
+
*
|
|
2415
|
+
* @example
|
|
2416
|
+
* ```typescript
|
|
2417
|
+
* const response = await someBridgeMethod();
|
|
2418
|
+
* if (isFound(response)) {
|
|
2419
|
+
* // response narrowed to status code `302` variant
|
|
2420
|
+
* console.log('Redirecting...');
|
|
2421
|
+
* }
|
|
2422
|
+
* ```
|
|
3271
2423
|
*
|
|
3272
2424
|
* @public
|
|
3273
2425
|
*/
|
|
3274
|
-
export declare function isFound<T extends
|
|
2426
|
+
export declare function isFound<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3275
2427
|
status_code: 302;
|
|
3276
2428
|
}>;
|
|
3277
2429
|
|
|
3278
2430
|
/**
|
|
3279
|
-
* Type guard to check if
|
|
2431
|
+
* Type guard to check if an SDK response has a `204` status code.
|
|
3280
2432
|
*
|
|
3281
2433
|
* @group Type Guards
|
|
3282
2434
|
*
|
|
3283
|
-
* @param response - The
|
|
3284
|
-
* @returns
|
|
2435
|
+
* @param response - The SDK response to check
|
|
2436
|
+
* @returns `true` if the response has `204` status code, `false` otherwise
|
|
2437
|
+
*
|
|
2438
|
+
* @example
|
|
2439
|
+
* ```typescript
|
|
2440
|
+
* const response = await someBridgeMethod();
|
|
2441
|
+
* if (isNoContent(response)) {
|
|
2442
|
+
* // response narrowed to status code `204` variant, `result` is not available
|
|
2443
|
+
* console.log('No content');
|
|
2444
|
+
* }
|
|
2445
|
+
* ```
|
|
3285
2446
|
*
|
|
3286
2447
|
* @public
|
|
3287
2448
|
*/
|
|
3288
|
-
export declare function isNoContent<T extends
|
|
2449
|
+
export declare function isNoContent<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3289
2450
|
status_code: 204;
|
|
3290
2451
|
}>;
|
|
3291
2452
|
|
|
3292
2453
|
/**
|
|
3293
|
-
* Type guard to check if
|
|
2454
|
+
* Type guard to check if an SDK response has a `200` status code.
|
|
3294
2455
|
*
|
|
3295
2456
|
* @group Type Guards
|
|
3296
2457
|
*
|
|
3297
|
-
* @param response - The
|
|
3298
|
-
* @returns
|
|
2458
|
+
* @param response - The SDK response to check
|
|
2459
|
+
* @returns `true` if the response has `200` status code, `false` otherwise
|
|
2460
|
+
*
|
|
2461
|
+
* @example
|
|
2462
|
+
* ```typescript
|
|
2463
|
+
* const response = await someBridgeMethod();
|
|
2464
|
+
* if (isOk(response)) {
|
|
2465
|
+
* // response narrowed to status code `200` variant, `result` is available
|
|
2466
|
+
* console.log(response.result);
|
|
2467
|
+
* }
|
|
2468
|
+
* ```
|
|
3299
2469
|
*
|
|
3300
2470
|
* @public
|
|
3301
2471
|
*/
|
|
3302
|
-
export declare function isOk<T extends
|
|
2472
|
+
export declare function isOk<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3303
2473
|
status_code: 200;
|
|
3304
2474
|
}>;
|
|
3305
2475
|
|
|
3306
2476
|
/**
|
|
3307
|
-
* Type guard to check if
|
|
2477
|
+
* Type guard to check if an SDK response has a `302` status code.
|
|
3308
2478
|
*
|
|
3309
2479
|
* @group Type Guards
|
|
3310
2480
|
*
|
|
3311
|
-
* @param response - The
|
|
3312
|
-
* @returns
|
|
2481
|
+
* @param response - The SDK response to check
|
|
2482
|
+
* @returns `true` if the response is a redirect, `false` otherwise
|
|
3313
2483
|
*
|
|
3314
2484
|
* @example
|
|
3315
2485
|
* ```typescript
|
|
3316
2486
|
* const response = await someBridgeMethod();
|
|
3317
2487
|
* if (isRedirection(response)) {
|
|
2488
|
+
* // response narrowed to status code `302` variant
|
|
3318
2489
|
* console.log('Redirecting...');
|
|
3319
2490
|
* }
|
|
3320
2491
|
* ```
|
|
3321
2492
|
*
|
|
3322
2493
|
* @public
|
|
3323
2494
|
*/
|
|
3324
|
-
export declare function isRedirection<T extends
|
|
2495
|
+
export declare function isRedirection<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3325
2496
|
status_code: 302;
|
|
3326
2497
|
}>;
|
|
3327
2498
|
|
|
3328
2499
|
/**
|
|
3329
|
-
* Type guard to check if
|
|
2500
|
+
* Type guard to check if an SDK response has a server error status code (`500`, `501`).
|
|
3330
2501
|
*
|
|
3331
2502
|
* @group Type Guards
|
|
3332
2503
|
*
|
|
3333
|
-
* @param response - The
|
|
3334
|
-
* @returns
|
|
2504
|
+
* @param response - The SDK response to check
|
|
2505
|
+
* @returns `true` if the response is a server error, `false` otherwise
|
|
3335
2506
|
*
|
|
3336
2507
|
* @example
|
|
3337
2508
|
* ```typescript
|
|
3338
2509
|
* const response = await someBridgeMethod();
|
|
3339
2510
|
* if (isServerError(response)) {
|
|
3340
|
-
*
|
|
2511
|
+
* // response narrowed to server error variants, `error` is available
|
|
2512
|
+
* console.error(response.error);
|
|
3341
2513
|
* }
|
|
3342
2514
|
* ```
|
|
3343
2515
|
*
|
|
3344
2516
|
* @public
|
|
3345
2517
|
*/
|
|
3346
|
-
export declare function isServerError<T extends
|
|
2518
|
+
export declare function isServerError<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3347
2519
|
status_code: 500 | 501;
|
|
3348
2520
|
}>;
|
|
3349
2521
|
|
|
3350
2522
|
/**
|
|
3351
|
-
* Type guard to check if
|
|
2523
|
+
* Type guard to check if an SDK response has a success status code (`200`, `204`).
|
|
3352
2524
|
*
|
|
3353
2525
|
* @group Type Guards
|
|
3354
2526
|
*
|
|
3355
|
-
* @param response - The
|
|
3356
|
-
* @returns
|
|
2527
|
+
* @param response - The SDK response to check
|
|
2528
|
+
* @returns `true` if the response is successful, `false` otherwise
|
|
3357
2529
|
*
|
|
3358
2530
|
* @example
|
|
3359
2531
|
* ```typescript
|
|
3360
2532
|
* const response = await someBridgeMethod();
|
|
3361
2533
|
* if (isSuccess(response)) {
|
|
3362
|
-
* // response narrowed to success variants
|
|
3363
|
-
* console.log(response
|
|
2534
|
+
* // response narrowed to success variants
|
|
2535
|
+
* console.log(response);
|
|
3364
2536
|
* }
|
|
3365
2537
|
* ```
|
|
3366
2538
|
*
|
|
3367
2539
|
* @public
|
|
3368
2540
|
*/
|
|
3369
|
-
export declare function isSuccess<T extends
|
|
2541
|
+
export declare function isSuccess<T extends SDKResponse>(response: T): response is Extract<T, {
|
|
3370
2542
|
status_code: 200 | 204;
|
|
3371
2543
|
}>;
|
|
3372
2544
|
|
|
3373
2545
|
/**
|
|
3374
|
-
*
|
|
2546
|
+
* SDK module for accessing device locale settings via `JSBridge`.
|
|
3375
2547
|
*
|
|
3376
2548
|
* @group Modules
|
|
3377
2549
|
* @category Locale
|
|
@@ -3433,7 +2605,7 @@ export declare class LocaleModule extends BaseModule {
|
|
|
3433
2605
|
}
|
|
3434
2606
|
|
|
3435
2607
|
/**
|
|
3436
|
-
*
|
|
2608
|
+
* SDK module for accessing device location services via `JSBridge`.
|
|
3437
2609
|
*
|
|
3438
2610
|
* @group Modules
|
|
3439
2611
|
* @category Location
|
|
@@ -3507,11 +2679,11 @@ export declare class LocationModule extends BaseModule {
|
|
|
3507
2679
|
* @requiredOAuthScope mobile.geolocation
|
|
3508
2680
|
*
|
|
3509
2681
|
* @remarks
|
|
3510
|
-
* This method returns
|
|
2682
|
+
* This method returns an `SDKStream` that continuously emits location updates.
|
|
3511
2683
|
* Remember to call `unsubscribe()` on the subscription when you no longer need updates
|
|
3512
2684
|
* to conserve battery and free resources.
|
|
3513
2685
|
*
|
|
3514
|
-
* @returns
|
|
2686
|
+
* @returns An `SDKStream` that emits location updates as the device location changes.
|
|
3515
2687
|
* Use `subscribe()` to listen for updates, or `await` to get the first value only. See {@link ObserveLocationChangeResponse}.
|
|
3516
2688
|
*
|
|
3517
2689
|
* @example
|
|
@@ -3608,7 +2780,7 @@ export declare class Logger {
|
|
|
3608
2780
|
}
|
|
3609
2781
|
|
|
3610
2782
|
/**
|
|
3611
|
-
*
|
|
2783
|
+
* SDK module for playing DRM-protected media content via `JSBridge`.
|
|
3612
2784
|
*
|
|
3613
2785
|
* @group Modules
|
|
3614
2786
|
* @category Media
|
|
@@ -3729,7 +2901,21 @@ export declare class MediaModule extends BaseModule {
|
|
|
3729
2901
|
}
|
|
3730
2902
|
|
|
3731
2903
|
/**
|
|
3732
|
-
*
|
|
2904
|
+
* Options for invoking an SDK method.
|
|
2905
|
+
*
|
|
2906
|
+
* @group Core
|
|
2907
|
+
*
|
|
2908
|
+
* @public
|
|
2909
|
+
*/
|
|
2910
|
+
export declare interface ModuleInvokeOptions {
|
|
2911
|
+
/** The name of the SDK method to invoke */
|
|
2912
|
+
method: string;
|
|
2913
|
+
/** The parameters to pass to the method */
|
|
2914
|
+
params?: unknown;
|
|
2915
|
+
}
|
|
2916
|
+
|
|
2917
|
+
/**
|
|
2918
|
+
* SDK module for making network requests through the native layer via `JSBridge`.
|
|
3733
2919
|
*
|
|
3734
2920
|
* @group Modules
|
|
3735
2921
|
* @category Network
|
|
@@ -3762,7 +2948,7 @@ export declare class MediaModule extends BaseModule {
|
|
|
3762
2948
|
export declare class NetworkModule extends BaseModule {
|
|
3763
2949
|
constructor();
|
|
3764
2950
|
/**
|
|
3765
|
-
* Sends a network request
|
|
2951
|
+
* Sends a network request through `JSBridge`.
|
|
3766
2952
|
*
|
|
3767
2953
|
* @param request - The network request parameters including endpoint, method, headers, query, body, and timeout. See {@link SendRequest}.
|
|
3768
2954
|
*
|
|
@@ -3807,37 +2993,15 @@ export declare class NetworkModule extends BaseModule {
|
|
|
3807
2993
|
* @category Media
|
|
3808
2994
|
*
|
|
3809
2995
|
* @remarks
|
|
3810
|
-
* This is
|
|
2996
|
+
* This is an `SDKStream` that can be:
|
|
3811
2997
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
3812
2998
|
* - Awaited via `await` to get the first value only
|
|
3813
2999
|
*
|
|
3814
|
-
* The stream can emit status codes 200 (event data), 500 (server error), or 501 (not implemented).
|
|
3000
|
+
* The stream can emit status codes `200` (event data), `500` (server error), or `501` (not implemented).
|
|
3815
3001
|
*
|
|
3816
3002
|
* @public
|
|
3817
3003
|
*/
|
|
3818
|
-
export declare type ObserveDRMPlaybackResponse =
|
|
3819
|
-
|
|
3820
|
-
/**
|
|
3821
|
-
* @group Modules
|
|
3822
|
-
* @category Media
|
|
3823
|
-
*
|
|
3824
|
-
* @public
|
|
3825
|
-
*/
|
|
3826
|
-
export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3827
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3828
|
-
readonly result: v.ObjectSchema<{
|
|
3829
|
-
readonly type: v.PicklistSchema<["START_PLAYBACK", "PROGRESS_PLAYBACK", "START_SEEK", "STOP_SEEK", "STOP_PLAYBACK", "CLOSE_PLAYBACK", "PAUSE_PLAYBACK", "RESUME_PLAYBACK", "FAST_FORWARD_PLAYBACK", "REWIND_PLAYBACK", "ERROR_PLAYBACK", "CHANGE_VOLUME"], undefined>;
|
|
3830
|
-
readonly titleId: v.StringSchema<undefined>;
|
|
3831
|
-
readonly position: v.NumberSchema<undefined>;
|
|
3832
|
-
readonly length: v.NumberSchema<undefined>;
|
|
3833
|
-
}, undefined>;
|
|
3834
|
-
}, undefined>, v.ObjectSchema<{
|
|
3835
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
3836
|
-
readonly error: v.StringSchema<undefined>;
|
|
3837
|
-
}, undefined>, v.ObjectSchema<{
|
|
3838
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
3839
|
-
readonly error: v.StringSchema<undefined>;
|
|
3840
|
-
}, undefined>], undefined>;
|
|
3004
|
+
export declare type ObserveDRMPlaybackResponse = SDKStream<SDKOkResponse<DRMPlaybackEvent> | SDKErrorResponse<500> | SDKErrorResponse<501>>;
|
|
3841
3005
|
|
|
3842
3006
|
/**
|
|
3843
3007
|
* Response when observing the device coordinates.
|
|
@@ -3846,15 +3010,15 @@ export declare const ObserveDRMPlaybackResponseSchema: v.UnionSchema<[v.ObjectSc
|
|
|
3846
3010
|
* @category Location
|
|
3847
3011
|
*
|
|
3848
3012
|
* @remarks
|
|
3849
|
-
* This is
|
|
3013
|
+
* This is an `SDKStream` that can be:
|
|
3850
3014
|
* - Subscribed to via `.subscribe()` for continuous updates
|
|
3851
3015
|
* - Awaited via `await` to get the first value only
|
|
3852
3016
|
*
|
|
3853
|
-
* The stream can emit
|
|
3017
|
+
* The stream can emit `200`, `400`, `403`, `424`, `500`, and `501` status codes.
|
|
3854
3018
|
*
|
|
3855
3019
|
* @public
|
|
3856
3020
|
*/
|
|
3857
|
-
export declare type ObserveLocationChangeResponse =
|
|
3021
|
+
export declare type ObserveLocationChangeResponse = SDKStream<SDKOkResponse<GetCoordinateResult> | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>>;
|
|
3858
3022
|
|
|
3859
3023
|
/**
|
|
3860
3024
|
* Response when notifying content loaded.
|
|
@@ -3871,28 +3035,7 @@ export declare type ObserveLocationChangeResponse = BridgeStream<GetCoordinateRe
|
|
|
3871
3035
|
*
|
|
3872
3036
|
* @public
|
|
3873
3037
|
*/
|
|
3874
|
-
export declare type OnContentLoadedResponse =
|
|
3875
|
-
|
|
3876
|
-
/**
|
|
3877
|
-
* Valibot schema for {@link OnContentLoadedResponse}.
|
|
3878
|
-
*
|
|
3879
|
-
* @group Modules
|
|
3880
|
-
* @category Container
|
|
3881
|
-
*
|
|
3882
|
-
* @public
|
|
3883
|
-
*/
|
|
3884
|
-
export declare const OnContentLoadedResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3885
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3886
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
3887
|
-
}, undefined>, v.ObjectSchema<{
|
|
3888
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
3889
|
-
}, undefined>, v.ObjectSchema<{
|
|
3890
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
3891
|
-
readonly error: v.StringSchema<undefined>;
|
|
3892
|
-
}, undefined>, v.ObjectSchema<{
|
|
3893
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
3894
|
-
readonly error: v.StringSchema<undefined>;
|
|
3895
|
-
}, undefined>], undefined>;
|
|
3038
|
+
export declare type OnContentLoadedResponse = SDKOkResponse<boolean> | SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
3896
3039
|
|
|
3897
3040
|
/**
|
|
3898
3041
|
* Result when notifying content loaded.
|
|
@@ -3934,26 +3077,7 @@ export declare type OnCtaTapRequest = string;
|
|
|
3934
3077
|
*
|
|
3935
3078
|
* @public
|
|
3936
3079
|
*/
|
|
3937
|
-
export declare type OnCtaTapResponse =
|
|
3938
|
-
|
|
3939
|
-
/**
|
|
3940
|
-
* Valibot schema for {@link OnCtaTapResponse}.
|
|
3941
|
-
*
|
|
3942
|
-
* @group Modules
|
|
3943
|
-
* @category Container
|
|
3944
|
-
*
|
|
3945
|
-
* @public
|
|
3946
|
-
*/
|
|
3947
|
-
export declare const OnCtaTapResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
3948
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
3949
|
-
readonly result: v.BooleanSchema<undefined>;
|
|
3950
|
-
}, undefined>, v.ObjectSchema<{
|
|
3951
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
3952
|
-
readonly error: v.StringSchema<undefined>;
|
|
3953
|
-
}, undefined>, v.ObjectSchema<{
|
|
3954
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
3955
|
-
readonly error: v.StringSchema<undefined>;
|
|
3956
|
-
}, undefined>], undefined>;
|
|
3080
|
+
export declare type OnCtaTapResponse = SDKOkResponse<boolean> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
3957
3081
|
|
|
3958
3082
|
/**
|
|
3959
3083
|
* Result when notifying CTA tap.
|
|
@@ -3996,28 +3120,7 @@ export declare type OpenExternalLinkRequest = string;
|
|
|
3996
3120
|
*
|
|
3997
3121
|
* @public
|
|
3998
3122
|
*/
|
|
3999
|
-
export declare type OpenExternalLinkResponse =
|
|
4000
|
-
|
|
4001
|
-
/**
|
|
4002
|
-
* Valibot schema for {@link OpenExternalLinkResponse}.
|
|
4003
|
-
*
|
|
4004
|
-
* @group Modules
|
|
4005
|
-
* @category Container
|
|
4006
|
-
*
|
|
4007
|
-
* @public
|
|
4008
|
-
*/
|
|
4009
|
-
export declare const OpenExternalLinkResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4010
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4011
|
-
}, undefined>, v.ObjectSchema<{
|
|
4012
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4013
|
-
readonly error: v.StringSchema<undefined>;
|
|
4014
|
-
}, undefined>, v.ObjectSchema<{
|
|
4015
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4016
|
-
readonly error: v.StringSchema<undefined>;
|
|
4017
|
-
}, undefined>, v.ObjectSchema<{
|
|
4018
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4019
|
-
readonly error: v.StringSchema<undefined>;
|
|
4020
|
-
}, undefined>], undefined>;
|
|
3123
|
+
export declare type OpenExternalLinkResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4021
3124
|
|
|
4022
3125
|
/**
|
|
4023
3126
|
* Result when opening an external link.
|
|
@@ -4040,7 +3143,7 @@ export declare type OpenExternalLinkResult = void;
|
|
|
4040
3143
|
export declare type Platform = 'Android' | 'iOS';
|
|
4041
3144
|
|
|
4042
3145
|
/**
|
|
4043
|
-
*
|
|
3146
|
+
* SDK module for controlling platform navigation via `JSBridge`.
|
|
4044
3147
|
*
|
|
4045
3148
|
* @group Modules
|
|
4046
3149
|
* @category Platform
|
|
@@ -4117,39 +3220,7 @@ export declare class PlatformModule extends BaseModule {
|
|
|
4117
3220
|
*
|
|
4118
3221
|
* @public
|
|
4119
3222
|
*/
|
|
4120
|
-
export declare type PlayDRMContentResponse =
|
|
4121
|
-
|
|
4122
|
-
/**
|
|
4123
|
-
* Valibot schema for {@link PlayDRMContentResponse}.
|
|
4124
|
-
*
|
|
4125
|
-
* @group Modules
|
|
4126
|
-
* @category Media
|
|
4127
|
-
*
|
|
4128
|
-
* @public
|
|
4129
|
-
*/
|
|
4130
|
-
export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4131
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4132
|
-
readonly result: v.ObjectSchema<{
|
|
4133
|
-
readonly type: v.PicklistSchema<["START_PLAYBACK", "PROGRESS_PLAYBACK", "START_SEEK", "STOP_SEEK", "STOP_PLAYBACK", "CLOSE_PLAYBACK", "PAUSE_PLAYBACK", "RESUME_PLAYBACK", "FAST_FORWARD_PLAYBACK", "REWIND_PLAYBACK", "ERROR_PLAYBACK", "CHANGE_VOLUME"], undefined>;
|
|
4134
|
-
readonly titleId: v.StringSchema<undefined>;
|
|
4135
|
-
readonly position: v.NumberSchema<undefined>;
|
|
4136
|
-
readonly length: v.NumberSchema<undefined>;
|
|
4137
|
-
}, undefined>;
|
|
4138
|
-
}, undefined>, v.ObjectSchema<{
|
|
4139
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4140
|
-
}, undefined>, v.ObjectSchema<{
|
|
4141
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4142
|
-
readonly error: v.StringSchema<undefined>;
|
|
4143
|
-
}, undefined>, v.ObjectSchema<{
|
|
4144
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4145
|
-
readonly error: v.StringSchema<undefined>;
|
|
4146
|
-
}, undefined>, v.ObjectSchema<{
|
|
4147
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4148
|
-
readonly error: v.StringSchema<undefined>;
|
|
4149
|
-
}, undefined>, v.ObjectSchema<{
|
|
4150
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4151
|
-
readonly error: v.StringSchema<undefined>;
|
|
4152
|
-
}, undefined>], undefined>;
|
|
3223
|
+
export declare type PlayDRMContentResponse = SDKOkResponse<PlayDRMContentResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4153
3224
|
|
|
4154
3225
|
/**
|
|
4155
3226
|
* Result object for DRM content playback initiation.
|
|
@@ -4160,10 +3231,10 @@ export declare const PlayDRMContentResponseSchema: v.UnionSchema<[v.ObjectSchema
|
|
|
4160
3231
|
*
|
|
4161
3232
|
* @public
|
|
4162
3233
|
*/
|
|
4163
|
-
export declare type PlayDRMContentResult =
|
|
3234
|
+
export declare type PlayDRMContentResult = DRMPlaybackEvent;
|
|
4164
3235
|
|
|
4165
3236
|
/**
|
|
4166
|
-
*
|
|
3237
|
+
* SDK module for accessing user profile information via `JSBridge`.
|
|
4167
3238
|
*
|
|
4168
3239
|
* @group Modules
|
|
4169
3240
|
* @category Profile
|
|
@@ -4323,19 +3394,9 @@ export declare class ProfileModule extends BaseModule {
|
|
|
4323
3394
|
*
|
|
4324
3395
|
* @public
|
|
4325
3396
|
*/
|
|
4326
|
-
export declare type RedirectToSystemWebViewRequest =
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
* Valibot schema for {@link RedirectToSystemWebViewRequest}.
|
|
4330
|
-
*
|
|
4331
|
-
* @group Modules
|
|
4332
|
-
* @category System WebView Kit
|
|
4333
|
-
*
|
|
4334
|
-
* @public
|
|
4335
|
-
*/
|
|
4336
|
-
export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
4337
|
-
readonly url: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>;
|
|
4338
|
-
}, undefined>;
|
|
3397
|
+
export declare type RedirectToSystemWebViewRequest = {
|
|
3398
|
+
url: string;
|
|
3399
|
+
};
|
|
4339
3400
|
|
|
4340
3401
|
/**
|
|
4341
3402
|
* Response when redirecting to the system web view.
|
|
@@ -4353,43 +3414,17 @@ export declare const RedirectToSystemWebViewRequestSchema: v.ObjectSchema<{
|
|
|
4353
3414
|
*
|
|
4354
3415
|
* @public
|
|
4355
3416
|
*/
|
|
4356
|
-
export declare type RedirectToSystemWebViewResponse =
|
|
4357
|
-
|
|
4358
|
-
/**
|
|
4359
|
-
* Valibot schema for {@link RedirectToSystemWebViewResponse}.
|
|
4360
|
-
*
|
|
4361
|
-
* @group Modules
|
|
4362
|
-
* @category System WebView Kit
|
|
4363
|
-
*
|
|
4364
|
-
* @public
|
|
4365
|
-
*/
|
|
4366
|
-
export declare const RedirectToSystemWebViewResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4367
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4368
|
-
readonly result: v.StringSchema<undefined>;
|
|
4369
|
-
}, undefined>, v.ObjectSchema<{
|
|
4370
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4371
|
-
readonly error: v.StringSchema<undefined>;
|
|
4372
|
-
}, undefined>, v.ObjectSchema<{
|
|
4373
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4374
|
-
readonly error: v.StringSchema<undefined>;
|
|
4375
|
-
}, undefined>, v.ObjectSchema<{
|
|
4376
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4377
|
-
readonly error: v.StringSchema<undefined>;
|
|
4378
|
-
}, undefined>, v.ObjectSchema<{
|
|
4379
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4380
|
-
readonly error: v.StringSchema<undefined>;
|
|
4381
|
-
}, undefined>], undefined>;
|
|
3417
|
+
export declare type RedirectToSystemWebViewResponse = SDKOkResponse<RedirectToSystemWebViewResult> | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4382
3418
|
|
|
4383
3419
|
/**
|
|
4384
|
-
* Result
|
|
4385
|
-
* This operation returns no data on success.
|
|
3420
|
+
* Result payload returned when redirecting to the system web view.
|
|
4386
3421
|
*
|
|
4387
3422
|
* @group Modules
|
|
4388
3423
|
* @category System WebView Kit
|
|
4389
3424
|
*
|
|
4390
3425
|
* @public
|
|
4391
3426
|
*/
|
|
4392
|
-
export declare type RedirectToSystemWebViewResult =
|
|
3427
|
+
export declare type RedirectToSystemWebViewResult = string;
|
|
4393
3428
|
|
|
4394
3429
|
/**
|
|
4395
3430
|
* Response when reloading consented scopes.
|
|
@@ -4406,28 +3441,7 @@ export declare type RedirectToSystemWebViewResult = void;
|
|
|
4406
3441
|
*
|
|
4407
3442
|
* @public
|
|
4408
3443
|
*/
|
|
4409
|
-
export declare type ReloadScopesResponse =
|
|
4410
|
-
|
|
4411
|
-
/**
|
|
4412
|
-
* Valibot schema for {@link ReloadScopesResponse}.
|
|
4413
|
-
*
|
|
4414
|
-
* @group Modules
|
|
4415
|
-
* @category Scope
|
|
4416
|
-
*
|
|
4417
|
-
* @public
|
|
4418
|
-
*/
|
|
4419
|
-
export declare const ReloadScopesResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4420
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4421
|
-
}, undefined>, v.ObjectSchema<{
|
|
4422
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4423
|
-
readonly error: v.StringSchema<undefined>;
|
|
4424
|
-
}, undefined>, v.ObjectSchema<{
|
|
4425
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4426
|
-
readonly error: v.StringSchema<undefined>;
|
|
4427
|
-
}, undefined>, v.ObjectSchema<{
|
|
4428
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4429
|
-
readonly error: v.StringSchema<undefined>;
|
|
4430
|
-
}, undefined>], undefined>;
|
|
3444
|
+
export declare type ReloadScopesResponse = SDKNoContentResponse | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4431
3445
|
|
|
4432
3446
|
/**
|
|
4433
3447
|
* Result object for reloading scopes.
|
|
@@ -4455,28 +3469,7 @@ export declare type ReloadScopesResult = void;
|
|
|
4455
3469
|
*
|
|
4456
3470
|
* @public
|
|
4457
3471
|
*/
|
|
4458
|
-
export declare type RemoveAllResponse =
|
|
4459
|
-
|
|
4460
|
-
/**
|
|
4461
|
-
* Valibot schema for {@link RemoveAllResponse}.
|
|
4462
|
-
*
|
|
4463
|
-
* @group Modules
|
|
4464
|
-
* @category Storage
|
|
4465
|
-
*
|
|
4466
|
-
* @public
|
|
4467
|
-
*/
|
|
4468
|
-
export declare const RemoveAllResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4469
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4470
|
-
}, undefined>, v.ObjectSchema<{
|
|
4471
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4472
|
-
readonly error: v.StringSchema<undefined>;
|
|
4473
|
-
}, undefined>, v.ObjectSchema<{
|
|
4474
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4475
|
-
readonly error: v.StringSchema<undefined>;
|
|
4476
|
-
}, undefined>, v.ObjectSchema<{
|
|
4477
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4478
|
-
readonly error: v.StringSchema<undefined>;
|
|
4479
|
-
}, undefined>], undefined>;
|
|
3472
|
+
export declare type RemoveAllResponse = SDKNoContentResponse | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4480
3473
|
|
|
4481
3474
|
/**
|
|
4482
3475
|
* Result object for removing all values.
|
|
@@ -4505,31 +3498,7 @@ export declare type RemoveAllResult = void;
|
|
|
4505
3498
|
*
|
|
4506
3499
|
* @public
|
|
4507
3500
|
*/
|
|
4508
|
-
export declare type RemoveResponse =
|
|
4509
|
-
|
|
4510
|
-
/**
|
|
4511
|
-
* Valibot schema for {@link RemoveResponse}.
|
|
4512
|
-
*
|
|
4513
|
-
* @group Modules
|
|
4514
|
-
* @category Storage
|
|
4515
|
-
*
|
|
4516
|
-
* @public
|
|
4517
|
-
*/
|
|
4518
|
-
export declare const RemoveResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4519
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4520
|
-
}, undefined>, v.ObjectSchema<{
|
|
4521
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4522
|
-
readonly error: v.StringSchema<undefined>;
|
|
4523
|
-
}, undefined>, v.ObjectSchema<{
|
|
4524
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4525
|
-
readonly error: v.StringSchema<undefined>;
|
|
4526
|
-
}, undefined>, v.ObjectSchema<{
|
|
4527
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4528
|
-
readonly error: v.StringSchema<undefined>;
|
|
4529
|
-
}, undefined>, v.ObjectSchema<{
|
|
4530
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4531
|
-
readonly error: v.StringSchema<undefined>;
|
|
4532
|
-
}, undefined>], undefined>;
|
|
3501
|
+
export declare type RemoveResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4533
3502
|
|
|
4534
3503
|
/**
|
|
4535
3504
|
* Result object for removing a value.
|
|
@@ -4562,19 +3531,9 @@ export declare type RemoveResult = void;
|
|
|
4562
3531
|
*
|
|
4563
3532
|
* @public
|
|
4564
3533
|
*/
|
|
4565
|
-
export declare type ScanQRCodeRequest =
|
|
4566
|
-
|
|
4567
|
-
|
|
4568
|
-
* Valibot schema for {@link ScanQRCodeRequest}.
|
|
4569
|
-
*
|
|
4570
|
-
* @group Modules
|
|
4571
|
-
* @category Camera
|
|
4572
|
-
*
|
|
4573
|
-
* @public
|
|
4574
|
-
*/
|
|
4575
|
-
export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
4576
|
-
readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
4577
|
-
}, undefined>;
|
|
3534
|
+
export declare type ScanQRCodeRequest = {
|
|
3535
|
+
title?: string;
|
|
3536
|
+
};
|
|
4578
3537
|
|
|
4579
3538
|
/**
|
|
4580
3539
|
* Response when scanning a QR code.
|
|
@@ -4593,36 +3552,7 @@ export declare const ScanQRCodeRequestSchema: v.ObjectSchema<{
|
|
|
4593
3552
|
*
|
|
4594
3553
|
* @public
|
|
4595
3554
|
*/
|
|
4596
|
-
export declare type ScanQRCodeResponse =
|
|
4597
|
-
|
|
4598
|
-
/**
|
|
4599
|
-
* Valibot schema for {@link ScanQRCodeResponse}.
|
|
4600
|
-
*
|
|
4601
|
-
* @group Modules
|
|
4602
|
-
* @category Camera
|
|
4603
|
-
*
|
|
4604
|
-
* @public
|
|
4605
|
-
*/
|
|
4606
|
-
export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4607
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4608
|
-
readonly result: v.ObjectSchema<{
|
|
4609
|
-
readonly qrCode: v.StringSchema<undefined>;
|
|
4610
|
-
}, undefined>;
|
|
4611
|
-
}, undefined>, v.ObjectSchema<{
|
|
4612
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4613
|
-
}, undefined>, v.ObjectSchema<{
|
|
4614
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4615
|
-
readonly error: v.StringSchema<undefined>;
|
|
4616
|
-
}, undefined>, v.ObjectSchema<{
|
|
4617
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
4618
|
-
readonly error: v.StringSchema<undefined>;
|
|
4619
|
-
}, undefined>, v.ObjectSchema<{
|
|
4620
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4621
|
-
readonly error: v.StringSchema<undefined>;
|
|
4622
|
-
}, undefined>, v.ObjectSchema<{
|
|
4623
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4624
|
-
readonly error: v.StringSchema<undefined>;
|
|
4625
|
-
}, undefined>], undefined>;
|
|
3555
|
+
export declare type ScanQRCodeResponse = SDKOkResponse<ScanQRCodeResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4626
3556
|
|
|
4627
3557
|
/**
|
|
4628
3558
|
* Result object containing the scanned QR code data.
|
|
@@ -4637,22 +3567,12 @@ export declare const ScanQRCodeResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4637
3567
|
*
|
|
4638
3568
|
* @public
|
|
4639
3569
|
*/
|
|
4640
|
-
export declare type ScanQRCodeResult =
|
|
4641
|
-
|
|
4642
|
-
|
|
4643
|
-
* Valibot schema for {@link ScanQRCodeResult}.
|
|
4644
|
-
*
|
|
4645
|
-
* @group Modules
|
|
4646
|
-
* @category Camera
|
|
4647
|
-
*
|
|
4648
|
-
* @public
|
|
4649
|
-
*/
|
|
4650
|
-
export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
4651
|
-
readonly qrCode: v.StringSchema<undefined>;
|
|
4652
|
-
}, undefined>;
|
|
3570
|
+
export declare type ScanQRCodeResult = {
|
|
3571
|
+
qrCode: string;
|
|
3572
|
+
};
|
|
4653
3573
|
|
|
4654
3574
|
/**
|
|
4655
|
-
*
|
|
3575
|
+
* SDK module for checking and refreshing API access permissions via `JSBridge`.
|
|
4656
3576
|
*
|
|
4657
3577
|
* @group Modules
|
|
4658
3578
|
* @category Scope
|
|
@@ -4683,9 +3603,9 @@ export declare const ScanQRCodeResultSchema: v.ObjectSchema<{
|
|
|
4683
3603
|
export declare class ScopeModule extends BaseModule {
|
|
4684
3604
|
constructor();
|
|
4685
3605
|
/**
|
|
4686
|
-
* Checks if the current client has access to a specific JSBridge API method.
|
|
3606
|
+
* Checks if the current client has access to a specific `JSBridge` API method.
|
|
4687
3607
|
*
|
|
4688
|
-
* @param module - The name of the
|
|
3608
|
+
* @param module - The name of the SDK module to check access for (e.g., 'CameraModule').
|
|
4689
3609
|
* @param method - The method name within the module to check access for (e.g., 'scanQRCode').
|
|
4690
3610
|
*
|
|
4691
3611
|
* @returns Whether the MiniApp has permission to access the specified method. See {@link HasAccessToResponse}.
|
|
@@ -4746,6 +3666,143 @@ export declare class ScopeModule extends BaseModule {
|
|
|
4746
3666
|
reloadScopes(): Promise<ReloadScopesResponse>;
|
|
4747
3667
|
}
|
|
4748
3668
|
|
|
3669
|
+
/**
|
|
3670
|
+
* Client error status codes for SDK error responses.
|
|
3671
|
+
*
|
|
3672
|
+
* @group Core
|
|
3673
|
+
*
|
|
3674
|
+
* @public
|
|
3675
|
+
*/
|
|
3676
|
+
export declare type SDKClientErrorStatusCode = 400 | 401 | 403 | 404 | 424 | 426;
|
|
3677
|
+
|
|
3678
|
+
/**
|
|
3679
|
+
* SDK error status code response with a `error` message.
|
|
3680
|
+
*
|
|
3681
|
+
* @group Core
|
|
3682
|
+
*
|
|
3683
|
+
* @public
|
|
3684
|
+
*/
|
|
3685
|
+
export declare interface SDKErrorResponse<C extends SDKErrorStatusCode> {
|
|
3686
|
+
readonly status_code: C;
|
|
3687
|
+
readonly error: string;
|
|
3688
|
+
}
|
|
3689
|
+
|
|
3690
|
+
/**
|
|
3691
|
+
* Error status codes for SDK error responses.
|
|
3692
|
+
*
|
|
3693
|
+
* @group Core
|
|
3694
|
+
*
|
|
3695
|
+
* @public
|
|
3696
|
+
*/
|
|
3697
|
+
export declare type SDKErrorStatusCode = SDKClientErrorStatusCode | SDKServerErrorStatusCode;
|
|
3698
|
+
|
|
3699
|
+
/**
|
|
3700
|
+
* SDK `204` status code response.
|
|
3701
|
+
*
|
|
3702
|
+
* @group Core
|
|
3703
|
+
*
|
|
3704
|
+
* @public
|
|
3705
|
+
*/
|
|
3706
|
+
export declare interface SDKNoContentResponse {
|
|
3707
|
+
readonly status_code: 204;
|
|
3708
|
+
}
|
|
3709
|
+
|
|
3710
|
+
/**
|
|
3711
|
+
* SDK `200` status code response with a typed `result` payload.
|
|
3712
|
+
*
|
|
3713
|
+
* @group Core
|
|
3714
|
+
*
|
|
3715
|
+
* @public
|
|
3716
|
+
*/
|
|
3717
|
+
export declare interface SDKOkResponse<T> {
|
|
3718
|
+
readonly status_code: 200;
|
|
3719
|
+
readonly result: T;
|
|
3720
|
+
}
|
|
3721
|
+
|
|
3722
|
+
/**
|
|
3723
|
+
* SDK `302` status code response.
|
|
3724
|
+
*
|
|
3725
|
+
* @group Core
|
|
3726
|
+
*
|
|
3727
|
+
* @public
|
|
3728
|
+
*/
|
|
3729
|
+
export declare interface SDKRedirectResponse {
|
|
3730
|
+
readonly status_code: 302;
|
|
3731
|
+
}
|
|
3732
|
+
|
|
3733
|
+
/**
|
|
3734
|
+
* Base SDK response shape.
|
|
3735
|
+
*
|
|
3736
|
+
* @group Core
|
|
3737
|
+
*
|
|
3738
|
+
* @remarks
|
|
3739
|
+
* Use the type guards to narrow to a specific shape.
|
|
3740
|
+
*
|
|
3741
|
+
* @public
|
|
3742
|
+
*/
|
|
3743
|
+
export declare type SDKResponse = {
|
|
3744
|
+
/** HTTP-style status code indicating the outcome of the SDK method call */
|
|
3745
|
+
status_code: number;
|
|
3746
|
+
/** The result data from the SDK method, present on 200 status code responses */
|
|
3747
|
+
result?: unknown;
|
|
3748
|
+
/** Error message, present on error status code responses */
|
|
3749
|
+
error?: string;
|
|
3750
|
+
};
|
|
3751
|
+
|
|
3752
|
+
/**
|
|
3753
|
+
* Server error status codes for SDK error responses.
|
|
3754
|
+
*
|
|
3755
|
+
* @group Core
|
|
3756
|
+
*
|
|
3757
|
+
* @public
|
|
3758
|
+
*/
|
|
3759
|
+
export declare type SDKServerErrorStatusCode = 500 | 501;
|
|
3760
|
+
|
|
3761
|
+
/**
|
|
3762
|
+
* A stream for receiving continuous data from SDK methods (e.g., location updates).
|
|
3763
|
+
*
|
|
3764
|
+
* @group Core
|
|
3765
|
+
*
|
|
3766
|
+
* @remarks
|
|
3767
|
+
* Provides both Observable-like and Promise-like interfaces:
|
|
3768
|
+
* - Use `subscribe()` to receive all values over time
|
|
3769
|
+
* - Use `then()` or `await` to receive only the first value
|
|
3770
|
+
*
|
|
3771
|
+
* Note: Each `subscribe()` call creates a fresh subscription, allowing multiple independent listeners.
|
|
3772
|
+
*
|
|
3773
|
+
* @typeParam T - The response type emitted by the stream.
|
|
3774
|
+
*
|
|
3775
|
+
* @public
|
|
3776
|
+
*/
|
|
3777
|
+
export declare type SDKStream<T extends SDKResponse = SDKResponse> = Readonly<{
|
|
3778
|
+
/**
|
|
3779
|
+
* Subscribe to receive stream data.
|
|
3780
|
+
*
|
|
3781
|
+
* @param handlers - Optional callbacks for data (`next`) and completion (`complete`).
|
|
3782
|
+
* @returns A `Subscription` to terminate the stream when needed.
|
|
3783
|
+
*/
|
|
3784
|
+
subscribe: (handlers?: SDKStreamHandlers<T>) => Subscription;
|
|
3785
|
+
}> & PromiseLike<T>;
|
|
3786
|
+
|
|
3787
|
+
/**
|
|
3788
|
+
* Callbacks for handling stream events.
|
|
3789
|
+
*
|
|
3790
|
+
* @group Core
|
|
3791
|
+
*
|
|
3792
|
+
* @remarks
|
|
3793
|
+
* Pass these to `subscribe()` to receive data via `next` and completion via `complete`.
|
|
3794
|
+
*
|
|
3795
|
+
* @typeParam T - The response type emitted by the stream.
|
|
3796
|
+
*
|
|
3797
|
+
* @public
|
|
3798
|
+
*/
|
|
3799
|
+
export declare type SDKStreamHandlers<T extends SDKResponse = SDKResponse> = Readonly<{
|
|
3800
|
+
/** Called with each new value from the stream. */
|
|
3801
|
+
next?: (data: T) => unknown;
|
|
3802
|
+
/** Called when the stream ends and no more data will arrive. */
|
|
3803
|
+
complete?: () => unknown;
|
|
3804
|
+
}>;
|
|
3805
|
+
|
|
4749
3806
|
/**
|
|
4750
3807
|
* Request parameters for sending analytics events.
|
|
4751
3808
|
*
|
|
@@ -4778,21 +3835,11 @@ export declare class ScopeModule extends BaseModule {
|
|
|
4778
3835
|
*
|
|
4779
3836
|
* @public
|
|
4780
3837
|
*/
|
|
4781
|
-
export declare type SendAnalyticsEventRequest =
|
|
4782
|
-
|
|
4783
|
-
|
|
4784
|
-
|
|
4785
|
-
|
|
4786
|
-
* @group Modules
|
|
4787
|
-
* @category Container
|
|
4788
|
-
*
|
|
4789
|
-
* @public
|
|
4790
|
-
*/
|
|
4791
|
-
export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
4792
|
-
readonly state: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
4793
|
-
readonly name: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
4794
|
-
readonly data: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, undefined>;
|
|
4795
|
-
}, undefined>;
|
|
3838
|
+
export declare type SendAnalyticsEventRequest = {
|
|
3839
|
+
state: string;
|
|
3840
|
+
name: string;
|
|
3841
|
+
data?: Record<string, unknown>;
|
|
3842
|
+
};
|
|
4796
3843
|
|
|
4797
3844
|
/**
|
|
4798
3845
|
* Response when sending analytics events.
|
|
@@ -4809,28 +3856,7 @@ export declare const SendAnalyticsEventRequestSchema: v.ObjectSchema<{
|
|
|
4809
3856
|
*
|
|
4810
3857
|
* @public
|
|
4811
3858
|
*/
|
|
4812
|
-
export declare type SendAnalyticsEventResponse =
|
|
4813
|
-
|
|
4814
|
-
/**
|
|
4815
|
-
* Valibot schema for {@link SendAnalyticsEventResponse}.
|
|
4816
|
-
*
|
|
4817
|
-
* @group Modules
|
|
4818
|
-
* @category Container
|
|
4819
|
-
*
|
|
4820
|
-
* @public
|
|
4821
|
-
*/
|
|
4822
|
-
export declare const SendAnalyticsEventResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4823
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4824
|
-
}, undefined>, v.ObjectSchema<{
|
|
4825
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4826
|
-
readonly error: v.StringSchema<undefined>;
|
|
4827
|
-
}, undefined>, v.ObjectSchema<{
|
|
4828
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4829
|
-
readonly error: v.StringSchema<undefined>;
|
|
4830
|
-
}, undefined>, v.ObjectSchema<{
|
|
4831
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4832
|
-
readonly error: v.StringSchema<undefined>;
|
|
4833
|
-
}, undefined>], undefined>;
|
|
3859
|
+
export declare type SendAnalyticsEventResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4834
3860
|
|
|
4835
3861
|
/**
|
|
4836
3862
|
* Result when sending analytics events.
|
|
@@ -4883,33 +3909,14 @@ export declare type SendAnalyticsEventResult = void;
|
|
|
4883
3909
|
*
|
|
4884
3910
|
* @public
|
|
4885
3911
|
*/
|
|
4886
|
-
export declare type SendRequest =
|
|
4887
|
-
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
|
-
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
* @remarks
|
|
4895
|
-
* This schema defines the structure of a network request with the following properties:
|
|
4896
|
-
* - `endpoint`: API endpoint URL to send the request to
|
|
4897
|
-
* - `method`: HTTP method (e.g., 'GET', 'POST', 'PUT', 'DELETE')
|
|
4898
|
-
* - `headers`: Optional HTTP headers to include in the request
|
|
4899
|
-
* - `query`: Optional query parameters to append to the URL
|
|
4900
|
-
* - `body`: Optional request body data
|
|
4901
|
-
* - `timeout`: Optional timeout in seconds (default is 60 seconds)
|
|
4902
|
-
*
|
|
4903
|
-
* @public
|
|
4904
|
-
*/
|
|
4905
|
-
export declare const SendRequestSchema: v.ObjectSchema<{
|
|
4906
|
-
readonly endpoint: v.StringSchema<undefined>;
|
|
4907
|
-
readonly method: v.PicklistSchema<["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"], undefined>;
|
|
4908
|
-
readonly headers: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
|
|
4909
|
-
readonly query: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>, undefined>;
|
|
4910
|
-
readonly body: v.OptionalSchema<v.UnknownSchema, undefined>;
|
|
4911
|
-
readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
|
|
4912
|
-
}, undefined>;
|
|
3912
|
+
export declare type SendRequest = {
|
|
3913
|
+
body?: unknown;
|
|
3914
|
+
endpoint: string;
|
|
3915
|
+
headers?: Record<string, string>;
|
|
3916
|
+
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
3917
|
+
query?: Record<string, string>;
|
|
3918
|
+
timeout?: number;
|
|
3919
|
+
};
|
|
4913
3920
|
|
|
4914
3921
|
/**
|
|
4915
3922
|
* Response when sending a network request.
|
|
@@ -4926,46 +3933,7 @@ export declare const SendRequestSchema: v.ObjectSchema<{
|
|
|
4926
3933
|
*
|
|
4927
3934
|
* @public
|
|
4928
3935
|
*/
|
|
4929
|
-
export declare type SendResponse =
|
|
4930
|
-
|
|
4931
|
-
/**
|
|
4932
|
-
* Valibot schema for {@link SendResponse}.
|
|
4933
|
-
*
|
|
4934
|
-
* @group Modules
|
|
4935
|
-
* @category Network
|
|
4936
|
-
*
|
|
4937
|
-
* @public
|
|
4938
|
-
*/
|
|
4939
|
-
export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
4940
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
4941
|
-
readonly result: v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>;
|
|
4942
|
-
}, undefined>, v.ObjectSchema<{
|
|
4943
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
4944
|
-
}, undefined>, v.ObjectSchema<{
|
|
4945
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
4946
|
-
readonly error: v.StringSchema<undefined>;
|
|
4947
|
-
}, undefined>, v.ObjectSchema<{
|
|
4948
|
-
readonly status_code: v.LiteralSchema<401, undefined>;
|
|
4949
|
-
readonly error: v.StringSchema<undefined>;
|
|
4950
|
-
}, undefined>, v.ObjectSchema<{
|
|
4951
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
4952
|
-
readonly error: v.StringSchema<undefined>;
|
|
4953
|
-
}, undefined>, v.ObjectSchema<{
|
|
4954
|
-
readonly status_code: v.LiteralSchema<404, undefined>;
|
|
4955
|
-
readonly error: v.StringSchema<undefined>;
|
|
4956
|
-
}, undefined>, v.ObjectSchema<{
|
|
4957
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
4958
|
-
readonly error: v.StringSchema<undefined>;
|
|
4959
|
-
}, undefined>, v.ObjectSchema<{
|
|
4960
|
-
readonly status_code: v.LiteralSchema<426, undefined>;
|
|
4961
|
-
readonly error: v.StringSchema<undefined>;
|
|
4962
|
-
}, undefined>, v.ObjectSchema<{
|
|
4963
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
4964
|
-
readonly error: v.StringSchema<undefined>;
|
|
4965
|
-
}, undefined>, v.ObjectSchema<{
|
|
4966
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
4967
|
-
readonly error: v.StringSchema<undefined>;
|
|
4968
|
-
}, undefined>], undefined>;
|
|
3936
|
+
export declare type SendResponse = SDKOkResponse<SendResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<401> | SDKErrorResponse<403> | SDKErrorResponse<404> | SDKErrorResponse<424> | SDKErrorResponse<426> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
4969
3937
|
|
|
4970
3938
|
/**
|
|
4971
3939
|
* Result object containing the network response data.
|
|
@@ -4975,22 +3943,12 @@ export declare const SendResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
4975
3943
|
*
|
|
4976
3944
|
* @remarks
|
|
4977
3945
|
* The result type is `Record<string, unknown>` as response bodies are always
|
|
4978
|
-
* returned as objects. String responses from
|
|
3946
|
+
* returned as objects. String responses from `JSBridge` are automatically
|
|
4979
3947
|
* parsed to JSON.
|
|
4980
3948
|
*
|
|
4981
3949
|
* @public
|
|
4982
3950
|
*/
|
|
4983
|
-
export declare type SendResult =
|
|
4984
|
-
|
|
4985
|
-
/**
|
|
4986
|
-
* Valibot schema for {@link SendResult}.
|
|
4987
|
-
*
|
|
4988
|
-
* @group Modules
|
|
4989
|
-
* @category Network
|
|
4990
|
-
*
|
|
4991
|
-
* @public
|
|
4992
|
-
*/
|
|
4993
|
-
export declare const SendResultSchema: v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>;
|
|
3951
|
+
export declare type SendResult = Record<string, unknown>;
|
|
4994
3952
|
|
|
4995
3953
|
/**
|
|
4996
3954
|
* Request parameters for setting the background color.
|
|
@@ -5022,28 +3980,7 @@ export declare type SetBackgroundColorRequest = string;
|
|
|
5022
3980
|
*
|
|
5023
3981
|
* @public
|
|
5024
3982
|
*/
|
|
5025
|
-
export declare type SetBackgroundColorResponse =
|
|
5026
|
-
|
|
5027
|
-
/**
|
|
5028
|
-
* Valibot schema for {@link SetBackgroundColorResponse}.
|
|
5029
|
-
*
|
|
5030
|
-
* @group Modules
|
|
5031
|
-
* @category Container
|
|
5032
|
-
*
|
|
5033
|
-
* @public
|
|
5034
|
-
*/
|
|
5035
|
-
export declare const SetBackgroundColorResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5036
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5037
|
-
}, undefined>, v.ObjectSchema<{
|
|
5038
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5039
|
-
readonly error: v.StringSchema<undefined>;
|
|
5040
|
-
}, undefined>, v.ObjectSchema<{
|
|
5041
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5042
|
-
readonly error: v.StringSchema<undefined>;
|
|
5043
|
-
}, undefined>, v.ObjectSchema<{
|
|
5044
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5045
|
-
readonly error: v.StringSchema<undefined>;
|
|
5046
|
-
}, undefined>], undefined>;
|
|
3983
|
+
export declare type SetBackgroundColorResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5047
3984
|
|
|
5048
3985
|
/**
|
|
5049
3986
|
* Result when setting the background color.
|
|
@@ -5069,20 +4006,10 @@ export declare type SetBackgroundColorResult = void;
|
|
|
5069
4006
|
*
|
|
5070
4007
|
* @public
|
|
5071
4008
|
*/
|
|
5072
|
-
export declare type SetBooleanRequest =
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
*
|
|
5077
|
-
* @group Modules
|
|
5078
|
-
* @category Storage
|
|
5079
|
-
*
|
|
5080
|
-
* @public
|
|
5081
|
-
*/
|
|
5082
|
-
export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
5083
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
5084
|
-
readonly value: v.BooleanSchema<undefined>;
|
|
5085
|
-
}, undefined>;
|
|
4009
|
+
export declare type SetBooleanRequest = {
|
|
4010
|
+
key: string;
|
|
4011
|
+
value: boolean;
|
|
4012
|
+
};
|
|
5086
4013
|
|
|
5087
4014
|
/**
|
|
5088
4015
|
* Response when setting a boolean value.
|
|
@@ -5100,31 +4027,7 @@ export declare const SetBooleanRequestSchema: v.ObjectSchema<{
|
|
|
5100
4027
|
*
|
|
5101
4028
|
* @public
|
|
5102
4029
|
*/
|
|
5103
|
-
export declare type SetBooleanResponse =
|
|
5104
|
-
|
|
5105
|
-
/**
|
|
5106
|
-
* Valibot schema for {@link SetBooleanResponse}.
|
|
5107
|
-
*
|
|
5108
|
-
* @group Modules
|
|
5109
|
-
* @category Storage
|
|
5110
|
-
*
|
|
5111
|
-
* @public
|
|
5112
|
-
*/
|
|
5113
|
-
export declare const SetBooleanResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5114
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5115
|
-
}, undefined>, v.ObjectSchema<{
|
|
5116
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5117
|
-
readonly error: v.StringSchema<undefined>;
|
|
5118
|
-
}, undefined>, v.ObjectSchema<{
|
|
5119
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
5120
|
-
readonly error: v.StringSchema<undefined>;
|
|
5121
|
-
}, undefined>, v.ObjectSchema<{
|
|
5122
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5123
|
-
readonly error: v.StringSchema<undefined>;
|
|
5124
|
-
}, undefined>, v.ObjectSchema<{
|
|
5125
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5126
|
-
readonly error: v.StringSchema<undefined>;
|
|
5127
|
-
}, undefined>], undefined>;
|
|
4030
|
+
export declare type SetBooleanResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5128
4031
|
|
|
5129
4032
|
/**
|
|
5130
4033
|
* Result object for setting a boolean value.
|
|
@@ -5150,20 +4053,10 @@ export declare type SetBooleanResult = void;
|
|
|
5150
4053
|
*
|
|
5151
4054
|
* @public
|
|
5152
4055
|
*/
|
|
5153
|
-
export declare type SetDoubleRequest =
|
|
5154
|
-
|
|
5155
|
-
|
|
5156
|
-
|
|
5157
|
-
*
|
|
5158
|
-
* @group Modules
|
|
5159
|
-
* @category Storage
|
|
5160
|
-
*
|
|
5161
|
-
* @public
|
|
5162
|
-
*/
|
|
5163
|
-
export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
5164
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
5165
|
-
readonly value: v.NumberSchema<undefined>;
|
|
5166
|
-
}, undefined>;
|
|
4056
|
+
export declare type SetDoubleRequest = {
|
|
4057
|
+
key: string;
|
|
4058
|
+
value: number;
|
|
4059
|
+
};
|
|
5167
4060
|
|
|
5168
4061
|
/**
|
|
5169
4062
|
* Response when setting a double value.
|
|
@@ -5181,31 +4074,7 @@ export declare const SetDoubleRequestSchema: v.ObjectSchema<{
|
|
|
5181
4074
|
*
|
|
5182
4075
|
* @public
|
|
5183
4076
|
*/
|
|
5184
|
-
export declare type SetDoubleResponse =
|
|
5185
|
-
|
|
5186
|
-
/**
|
|
5187
|
-
* Valibot schema for {@link SetDoubleResponse}.
|
|
5188
|
-
*
|
|
5189
|
-
* @group Modules
|
|
5190
|
-
* @category Storage
|
|
5191
|
-
*
|
|
5192
|
-
* @public
|
|
5193
|
-
*/
|
|
5194
|
-
export declare const SetDoubleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5195
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5196
|
-
}, undefined>, v.ObjectSchema<{
|
|
5197
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5198
|
-
readonly error: v.StringSchema<undefined>;
|
|
5199
|
-
}, undefined>, v.ObjectSchema<{
|
|
5200
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
5201
|
-
readonly error: v.StringSchema<undefined>;
|
|
5202
|
-
}, undefined>, v.ObjectSchema<{
|
|
5203
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5204
|
-
readonly error: v.StringSchema<undefined>;
|
|
5205
|
-
}, undefined>, v.ObjectSchema<{
|
|
5206
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5207
|
-
readonly error: v.StringSchema<undefined>;
|
|
5208
|
-
}, undefined>], undefined>;
|
|
4077
|
+
export declare type SetDoubleResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5209
4078
|
|
|
5210
4079
|
/**
|
|
5211
4080
|
* Result object for setting a double value.
|
|
@@ -5231,20 +4100,10 @@ export declare type SetDoubleResult = void;
|
|
|
5231
4100
|
*
|
|
5232
4101
|
* @public
|
|
5233
4102
|
*/
|
|
5234
|
-
export declare type SetIntRequest =
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
|
|
5238
|
-
*
|
|
5239
|
-
* @group Modules
|
|
5240
|
-
* @category Storage
|
|
5241
|
-
*
|
|
5242
|
-
* @public
|
|
5243
|
-
*/
|
|
5244
|
-
export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
5245
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
5246
|
-
readonly value: v.NumberSchema<undefined>;
|
|
5247
|
-
}, undefined>;
|
|
4103
|
+
export declare type SetIntRequest = {
|
|
4104
|
+
key: string;
|
|
4105
|
+
value: number;
|
|
4106
|
+
};
|
|
5248
4107
|
|
|
5249
4108
|
/**
|
|
5250
4109
|
* Response when setting an integer value.
|
|
@@ -5262,31 +4121,7 @@ export declare const SetIntRequestSchema: v.ObjectSchema<{
|
|
|
5262
4121
|
*
|
|
5263
4122
|
* @public
|
|
5264
4123
|
*/
|
|
5265
|
-
export declare type SetIntResponse =
|
|
5266
|
-
|
|
5267
|
-
/**
|
|
5268
|
-
* Valibot schema for {@link SetIntResponse}.
|
|
5269
|
-
*
|
|
5270
|
-
* @group Modules
|
|
5271
|
-
* @category Storage
|
|
5272
|
-
*
|
|
5273
|
-
* @public
|
|
5274
|
-
*/
|
|
5275
|
-
export declare const SetIntResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5276
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5277
|
-
}, undefined>, v.ObjectSchema<{
|
|
5278
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5279
|
-
readonly error: v.StringSchema<undefined>;
|
|
5280
|
-
}, undefined>, v.ObjectSchema<{
|
|
5281
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
5282
|
-
readonly error: v.StringSchema<undefined>;
|
|
5283
|
-
}, undefined>, v.ObjectSchema<{
|
|
5284
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5285
|
-
readonly error: v.StringSchema<undefined>;
|
|
5286
|
-
}, undefined>, v.ObjectSchema<{
|
|
5287
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5288
|
-
readonly error: v.StringSchema<undefined>;
|
|
5289
|
-
}, undefined>], undefined>;
|
|
4124
|
+
export declare type SetIntResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5290
4125
|
|
|
5291
4126
|
/**
|
|
5292
4127
|
* Result object for setting an integer value.
|
|
@@ -5312,20 +4147,10 @@ export declare type SetIntResult = void;
|
|
|
5312
4147
|
*
|
|
5313
4148
|
* @public
|
|
5314
4149
|
*/
|
|
5315
|
-
export declare type SetStringRequest =
|
|
5316
|
-
|
|
5317
|
-
|
|
5318
|
-
|
|
5319
|
-
*
|
|
5320
|
-
* @group Modules
|
|
5321
|
-
* @category Storage
|
|
5322
|
-
*
|
|
5323
|
-
* @public
|
|
5324
|
-
*/
|
|
5325
|
-
export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
5326
|
-
readonly key: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>;
|
|
5327
|
-
readonly value: v.StringSchema<undefined>;
|
|
5328
|
-
}, undefined>;
|
|
4150
|
+
export declare type SetStringRequest = {
|
|
4151
|
+
key: string;
|
|
4152
|
+
value: string;
|
|
4153
|
+
};
|
|
5329
4154
|
|
|
5330
4155
|
/**
|
|
5331
4156
|
* Response when setting a string value.
|
|
@@ -5343,31 +4168,7 @@ export declare const SetStringRequestSchema: v.ObjectSchema<{
|
|
|
5343
4168
|
*
|
|
5344
4169
|
* @public
|
|
5345
4170
|
*/
|
|
5346
|
-
export declare type SetStringResponse =
|
|
5347
|
-
|
|
5348
|
-
/**
|
|
5349
|
-
* Valibot schema for {@link SetStringResponse}.
|
|
5350
|
-
*
|
|
5351
|
-
* @group Modules
|
|
5352
|
-
* @category Storage
|
|
5353
|
-
*
|
|
5354
|
-
* @public
|
|
5355
|
-
*/
|
|
5356
|
-
export declare const SetStringResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5357
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5358
|
-
}, undefined>, v.ObjectSchema<{
|
|
5359
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5360
|
-
readonly error: v.StringSchema<undefined>;
|
|
5361
|
-
}, undefined>, v.ObjectSchema<{
|
|
5362
|
-
readonly status_code: v.LiteralSchema<424, undefined>;
|
|
5363
|
-
readonly error: v.StringSchema<undefined>;
|
|
5364
|
-
}, undefined>, v.ObjectSchema<{
|
|
5365
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5366
|
-
readonly error: v.StringSchema<undefined>;
|
|
5367
|
-
}, undefined>, v.ObjectSchema<{
|
|
5368
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5369
|
-
readonly error: v.StringSchema<undefined>;
|
|
5370
|
-
}, undefined>], undefined>;
|
|
4171
|
+
export declare type SetStringResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<424> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5371
4172
|
|
|
5372
4173
|
/**
|
|
5373
4174
|
* Result object for setting a string value.
|
|
@@ -5410,28 +4211,7 @@ export declare type SetTitleRequest = string;
|
|
|
5410
4211
|
*
|
|
5411
4212
|
* @public
|
|
5412
4213
|
*/
|
|
5413
|
-
export declare type SetTitleResponse =
|
|
5414
|
-
|
|
5415
|
-
/**
|
|
5416
|
-
* Valibot schema for {@link SetTitleResponse}.
|
|
5417
|
-
*
|
|
5418
|
-
* @group Modules
|
|
5419
|
-
* @category Container
|
|
5420
|
-
*
|
|
5421
|
-
* @public
|
|
5422
|
-
*/
|
|
5423
|
-
export declare const SetTitleResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5424
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5425
|
-
}, undefined>, v.ObjectSchema<{
|
|
5426
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
5427
|
-
readonly error: v.StringSchema<undefined>;
|
|
5428
|
-
}, undefined>, v.ObjectSchema<{
|
|
5429
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5430
|
-
readonly error: v.StringSchema<undefined>;
|
|
5431
|
-
}, undefined>, v.ObjectSchema<{
|
|
5432
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5433
|
-
readonly error: v.StringSchema<undefined>;
|
|
5434
|
-
}, undefined>], undefined>;
|
|
4214
|
+
export declare type SetTitleResponse = SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5435
4215
|
|
|
5436
4216
|
/**
|
|
5437
4217
|
* Result when setting the title.
|
|
@@ -5458,25 +4238,7 @@ export declare type SetTitleResult = void;
|
|
|
5458
4238
|
*
|
|
5459
4239
|
* @public
|
|
5460
4240
|
*/
|
|
5461
|
-
export declare type ShowBackButtonResponse =
|
|
5462
|
-
|
|
5463
|
-
/**
|
|
5464
|
-
* Valibot schema for {@link ShowBackButtonResponse}.
|
|
5465
|
-
*
|
|
5466
|
-
* @group Modules
|
|
5467
|
-
* @category Container
|
|
5468
|
-
*
|
|
5469
|
-
* @public
|
|
5470
|
-
*/
|
|
5471
|
-
export declare const ShowBackButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5472
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5473
|
-
}, undefined>, v.ObjectSchema<{
|
|
5474
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5475
|
-
readonly error: v.StringSchema<undefined>;
|
|
5476
|
-
}, undefined>, v.ObjectSchema<{
|
|
5477
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5478
|
-
readonly error: v.StringSchema<undefined>;
|
|
5479
|
-
}, undefined>], undefined>;
|
|
4241
|
+
export declare type ShowBackButtonResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5480
4242
|
|
|
5481
4243
|
/**
|
|
5482
4244
|
* Result when showing the back button.
|
|
@@ -5503,25 +4265,7 @@ export declare type ShowBackButtonResult = void;
|
|
|
5503
4265
|
*
|
|
5504
4266
|
* @public
|
|
5505
4267
|
*/
|
|
5506
|
-
export declare type ShowLoaderResponse =
|
|
5507
|
-
|
|
5508
|
-
/**
|
|
5509
|
-
* Valibot schema for {@link ShowLoaderResponse}.
|
|
5510
|
-
*
|
|
5511
|
-
* @group Modules
|
|
5512
|
-
* @category Container
|
|
5513
|
-
*
|
|
5514
|
-
* @public
|
|
5515
|
-
*/
|
|
5516
|
-
export declare const ShowLoaderResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5517
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5518
|
-
}, undefined>, v.ObjectSchema<{
|
|
5519
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5520
|
-
readonly error: v.StringSchema<undefined>;
|
|
5521
|
-
}, undefined>, v.ObjectSchema<{
|
|
5522
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5523
|
-
readonly error: v.StringSchema<undefined>;
|
|
5524
|
-
}, undefined>], undefined>;
|
|
4268
|
+
export declare type ShowLoaderResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5525
4269
|
|
|
5526
4270
|
/**
|
|
5527
4271
|
* Result when showing the loader.
|
|
@@ -5548,25 +4292,7 @@ export declare type ShowLoaderResult = void;
|
|
|
5548
4292
|
*
|
|
5549
4293
|
* @public
|
|
5550
4294
|
*/
|
|
5551
|
-
export declare type ShowRefreshButtonResponse =
|
|
5552
|
-
|
|
5553
|
-
/**
|
|
5554
|
-
* Valibot schema for {@link ShowRefreshButtonResponse}.
|
|
5555
|
-
*
|
|
5556
|
-
* @group Modules
|
|
5557
|
-
* @category Container
|
|
5558
|
-
*
|
|
5559
|
-
* @public
|
|
5560
|
-
*/
|
|
5561
|
-
export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
5562
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
5563
|
-
}, undefined>, v.ObjectSchema<{
|
|
5564
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
5565
|
-
readonly error: v.StringSchema<undefined>;
|
|
5566
|
-
}, undefined>, v.ObjectSchema<{
|
|
5567
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
5568
|
-
readonly error: v.StringSchema<undefined>;
|
|
5569
|
-
}, undefined>], undefined>;
|
|
4295
|
+
export declare type ShowRefreshButtonResponse = SDKNoContentResponse | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
5570
4296
|
|
|
5571
4297
|
/**
|
|
5572
4298
|
* Result when showing the refresh button.
|
|
@@ -5580,7 +4306,7 @@ export declare const ShowRefreshButtonResponseSchema: v.UnionSchema<[v.ObjectSch
|
|
|
5580
4306
|
export declare type ShowRefreshButtonResult = void;
|
|
5581
4307
|
|
|
5582
4308
|
/**
|
|
5583
|
-
*
|
|
4309
|
+
* SDK module for controlling the native splash / Lottie loading screen via `JSBridge`.
|
|
5584
4310
|
*
|
|
5585
4311
|
* @group Modules
|
|
5586
4312
|
* @category Splash Screen
|
|
@@ -5636,7 +4362,7 @@ export declare class SplashScreenModule extends BaseModule {
|
|
|
5636
4362
|
}
|
|
5637
4363
|
|
|
5638
4364
|
/**
|
|
5639
|
-
*
|
|
4365
|
+
* SDK module for persisting key-value data to native storage via `JSBridge`.
|
|
5640
4366
|
*
|
|
5641
4367
|
* @group Modules
|
|
5642
4368
|
* @category Storage
|
|
@@ -6018,7 +4744,7 @@ export declare class StorageModule extends BaseModule {
|
|
|
6018
4744
|
}
|
|
6019
4745
|
|
|
6020
4746
|
/**
|
|
6021
|
-
* Controls an active stream subscription.
|
|
4747
|
+
* Controls an active stream subscription.
|
|
6022
4748
|
*
|
|
6023
4749
|
* @group Core
|
|
6024
4750
|
*
|
|
@@ -6029,14 +4755,14 @@ export declare class StorageModule extends BaseModule {
|
|
|
6029
4755
|
* @public
|
|
6030
4756
|
*/
|
|
6031
4757
|
export declare type Subscription = Readonly<{
|
|
6032
|
-
/** Returns true if this subscription has been terminated. */
|
|
4758
|
+
/** Returns `true` if this subscription has been terminated. */
|
|
6033
4759
|
isUnsubscribed: () => boolean;
|
|
6034
4760
|
/** Terminates the subscription. No further data will be received. */
|
|
6035
4761
|
unsubscribe: () => unknown;
|
|
6036
4762
|
}>;
|
|
6037
4763
|
|
|
6038
4764
|
/**
|
|
6039
|
-
*
|
|
4765
|
+
* SDK module for opening URLs in the device's system browser via `JSBridge`.
|
|
6040
4766
|
*
|
|
6041
4767
|
* @group Modules
|
|
6042
4768
|
* @category System WebView Kit
|
|
@@ -6126,20 +4852,7 @@ export declare class SystemWebViewKitModule extends BaseModule {
|
|
|
6126
4852
|
*
|
|
6127
4853
|
* @public
|
|
6128
4854
|
*/
|
|
6129
|
-
export declare type TriggerCheckoutRequest =
|
|
6130
|
-
|
|
6131
|
-
/**
|
|
6132
|
-
* Valibot schema for {@link TriggerCheckoutRequest}.
|
|
6133
|
-
*
|
|
6134
|
-
* @group Modules
|
|
6135
|
-
* @category Checkout
|
|
6136
|
-
*
|
|
6137
|
-
* @remarks
|
|
6138
|
-
* The checkout parameters vary depending on the specific payment flow and partner requirements.
|
|
6139
|
-
*
|
|
6140
|
-
* @public
|
|
6141
|
-
*/
|
|
6142
|
-
export declare const TriggerCheckoutRequestSchema: v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>;
|
|
4855
|
+
export declare type TriggerCheckoutRequest = Record<string, unknown>;
|
|
6143
4856
|
|
|
6144
4857
|
/**
|
|
6145
4858
|
* Response when triggering the checkout flow.
|
|
@@ -6156,42 +4869,7 @@ export declare const TriggerCheckoutRequestSchema: v.RecordSchema<v.StringSchema
|
|
|
6156
4869
|
*
|
|
6157
4870
|
* @public
|
|
6158
4871
|
*/
|
|
6159
|
-
export declare type TriggerCheckoutResponse =
|
|
6160
|
-
|
|
6161
|
-
/**
|
|
6162
|
-
* Valibot schema for {@link TriggerCheckoutResponse}.
|
|
6163
|
-
*
|
|
6164
|
-
* @group Modules
|
|
6165
|
-
* @category Checkout
|
|
6166
|
-
*
|
|
6167
|
-
* @public
|
|
6168
|
-
*/
|
|
6169
|
-
export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
6170
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
6171
|
-
readonly result: v.VariantSchema<"status", [v.ObjectSchema<{
|
|
6172
|
-
readonly status: v.LiteralSchema<"success", undefined>;
|
|
6173
|
-
readonly transactionID: v.StringSchema<undefined>;
|
|
6174
|
-
}, undefined>, v.ObjectSchema<{
|
|
6175
|
-
readonly status: v.LiteralSchema<"failure", undefined>;
|
|
6176
|
-
readonly transactionID: v.StringSchema<undefined>;
|
|
6177
|
-
readonly errorMessage: v.StringSchema<undefined>;
|
|
6178
|
-
readonly errorCode: v.StringSchema<undefined>;
|
|
6179
|
-
}, undefined>, v.ObjectSchema<{
|
|
6180
|
-
readonly status: v.LiteralSchema<"pending", undefined>;
|
|
6181
|
-
readonly transactionID: v.StringSchema<undefined>;
|
|
6182
|
-
}, undefined>, v.ObjectSchema<{
|
|
6183
|
-
readonly status: v.LiteralSchema<"userInitiatedCancel", undefined>;
|
|
6184
|
-
}, undefined>], undefined>;
|
|
6185
|
-
}, undefined>, v.ObjectSchema<{
|
|
6186
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
6187
|
-
readonly error: v.StringSchema<undefined>;
|
|
6188
|
-
}, undefined>, v.ObjectSchema<{
|
|
6189
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
6190
|
-
readonly error: v.StringSchema<undefined>;
|
|
6191
|
-
}, undefined>, v.ObjectSchema<{
|
|
6192
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
6193
|
-
readonly error: v.StringSchema<undefined>;
|
|
6194
|
-
}, undefined>], undefined>;
|
|
4872
|
+
export declare type TriggerCheckoutResponse = SDKOkResponse<TriggerCheckoutResult> | SDKErrorResponse<400> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
6195
4873
|
|
|
6196
4874
|
/**
|
|
6197
4875
|
* Result object containing the checkout transaction details.
|
|
@@ -6244,33 +4922,23 @@ export declare const TriggerCheckoutResponseSchema: v.UnionSchema<[v.ObjectSchem
|
|
|
6244
4922
|
*
|
|
6245
4923
|
* @public
|
|
6246
4924
|
*/
|
|
6247
|
-
export declare type TriggerCheckoutResult =
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6252
|
-
|
|
6253
|
-
|
|
6254
|
-
|
|
6255
|
-
|
|
6256
|
-
|
|
6257
|
-
|
|
6258
|
-
|
|
6259
|
-
|
|
6260
|
-
}
|
|
6261
|
-
readonly status: v.LiteralSchema<"failure", undefined>;
|
|
6262
|
-
readonly transactionID: v.StringSchema<undefined>;
|
|
6263
|
-
readonly errorMessage: v.StringSchema<undefined>;
|
|
6264
|
-
readonly errorCode: v.StringSchema<undefined>;
|
|
6265
|
-
}, undefined>, v.ObjectSchema<{
|
|
6266
|
-
readonly status: v.LiteralSchema<"pending", undefined>;
|
|
6267
|
-
readonly transactionID: v.StringSchema<undefined>;
|
|
6268
|
-
}, undefined>, v.ObjectSchema<{
|
|
6269
|
-
readonly status: v.LiteralSchema<"userInitiatedCancel", undefined>;
|
|
6270
|
-
}, undefined>], undefined>;
|
|
4925
|
+
export declare type TriggerCheckoutResult = {
|
|
4926
|
+
status: 'success';
|
|
4927
|
+
transactionID: string;
|
|
4928
|
+
} | {
|
|
4929
|
+
status: 'failure';
|
|
4930
|
+
transactionID: string;
|
|
4931
|
+
errorMessage: string;
|
|
4932
|
+
errorCode: string;
|
|
4933
|
+
} | {
|
|
4934
|
+
status: 'pending';
|
|
4935
|
+
transactionID: string;
|
|
4936
|
+
} | {
|
|
4937
|
+
status: 'userInitiatedCancel';
|
|
4938
|
+
};
|
|
6271
4939
|
|
|
6272
4940
|
/**
|
|
6273
|
-
*
|
|
4941
|
+
* SDK module for reading user-related attributes from native code via `JSBridge`.
|
|
6274
4942
|
*
|
|
6275
4943
|
* @group Modules
|
|
6276
4944
|
* @category User Attributes
|
|
@@ -6358,20 +5026,10 @@ export declare class UserAttributesModule extends BaseModule {
|
|
|
6358
5026
|
*
|
|
6359
5027
|
* @public
|
|
6360
5028
|
*/
|
|
6361
|
-
export declare type VerifyEmailRequest =
|
|
6362
|
-
|
|
6363
|
-
|
|
6364
|
-
|
|
6365
|
-
*
|
|
6366
|
-
* @group Modules
|
|
6367
|
-
* @category Profile
|
|
6368
|
-
*
|
|
6369
|
-
* @public
|
|
6370
|
-
*/
|
|
6371
|
-
export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
6372
|
-
readonly email: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 1, undefined>]>, undefined>;
|
|
6373
|
-
readonly skipUserInput: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
|
|
6374
|
-
}, undefined>;
|
|
5029
|
+
export declare type VerifyEmailRequest = {
|
|
5030
|
+
email?: string;
|
|
5031
|
+
skipUserInput?: boolean;
|
|
5032
|
+
};
|
|
6375
5033
|
|
|
6376
5034
|
/**
|
|
6377
5035
|
* Response when verifying the user's email.
|
|
@@ -6406,39 +5064,7 @@ export declare const VerifyEmailRequestSchema: v.ObjectSchema<{
|
|
|
6406
5064
|
*
|
|
6407
5065
|
* @public
|
|
6408
5066
|
*/
|
|
6409
|
-
export declare type VerifyEmailResponse =
|
|
6410
|
-
|
|
6411
|
-
/**
|
|
6412
|
-
* Valibot schema for {@link VerifyEmailResponse}.
|
|
6413
|
-
*
|
|
6414
|
-
* @group Modules
|
|
6415
|
-
* @category Profile
|
|
6416
|
-
*
|
|
6417
|
-
* @public
|
|
6418
|
-
*/
|
|
6419
|
-
export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
6420
|
-
readonly status_code: v.LiteralSchema<200, undefined>;
|
|
6421
|
-
readonly result: v.ObjectSchema<{
|
|
6422
|
-
readonly email: v.StringSchema<undefined>;
|
|
6423
|
-
}, undefined>;
|
|
6424
|
-
}, undefined>, v.ObjectSchema<{
|
|
6425
|
-
readonly status_code: v.LiteralSchema<204, undefined>;
|
|
6426
|
-
}, undefined>, v.ObjectSchema<{
|
|
6427
|
-
readonly status_code: v.LiteralSchema<400, undefined>;
|
|
6428
|
-
readonly error: v.StringSchema<undefined>;
|
|
6429
|
-
}, undefined>, v.ObjectSchema<{
|
|
6430
|
-
readonly status_code: v.LiteralSchema<403, undefined>;
|
|
6431
|
-
readonly error: v.StringSchema<undefined>;
|
|
6432
|
-
}, undefined>, v.ObjectSchema<{
|
|
6433
|
-
readonly status_code: v.LiteralSchema<426, undefined>;
|
|
6434
|
-
readonly error: v.StringSchema<undefined>;
|
|
6435
|
-
}, undefined>, v.ObjectSchema<{
|
|
6436
|
-
readonly status_code: v.LiteralSchema<500, undefined>;
|
|
6437
|
-
readonly error: v.StringSchema<undefined>;
|
|
6438
|
-
}, undefined>, v.ObjectSchema<{
|
|
6439
|
-
readonly status_code: v.LiteralSchema<501, undefined>;
|
|
6440
|
-
readonly error: v.StringSchema<undefined>;
|
|
6441
|
-
}, undefined>], undefined>;
|
|
5067
|
+
export declare type VerifyEmailResponse = SDKOkResponse<VerifyEmailResult> | SDKNoContentResponse | SDKErrorResponse<400> | SDKErrorResponse<403> | SDKErrorResponse<426> | SDKErrorResponse<500> | SDKErrorResponse<501>;
|
|
6442
5068
|
|
|
6443
5069
|
/**
|
|
6444
5070
|
* Result object for verifying the user's email.
|
|
@@ -6453,19 +5079,9 @@ export declare const VerifyEmailResponseSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
6453
5079
|
*
|
|
6454
5080
|
* @public
|
|
6455
5081
|
*/
|
|
6456
|
-
export declare type VerifyEmailResult =
|
|
6457
|
-
|
|
6458
|
-
|
|
6459
|
-
* Valibot schema for {@link VerifyEmailResult}.
|
|
6460
|
-
*
|
|
6461
|
-
* @group Modules
|
|
6462
|
-
* @category Profile
|
|
6463
|
-
*
|
|
6464
|
-
* @public
|
|
6465
|
-
*/
|
|
6466
|
-
export declare const VerifyEmailResultSchema: v.ObjectSchema<{
|
|
6467
|
-
readonly email: v.StringSchema<undefined>;
|
|
6468
|
-
}, undefined>;
|
|
5082
|
+
export declare type VerifyEmailResult = {
|
|
5083
|
+
email: string;
|
|
5084
|
+
};
|
|
6469
5085
|
|
|
6470
5086
|
/**
|
|
6471
5087
|
* Represents a semantic version with major, minor, and patch components.
|
|
@@ -6481,14 +5097,14 @@ export declare interface Version {
|
|
|
6481
5097
|
}
|
|
6482
5098
|
|
|
6483
5099
|
/**
|
|
6484
|
-
* Generic interface for all
|
|
5100
|
+
* Generic interface for all SDK module wrappers exposed through `JSBridge`.
|
|
6485
5101
|
*
|
|
6486
5102
|
* @group Core
|
|
6487
5103
|
*
|
|
6488
5104
|
* @public
|
|
6489
5105
|
*/
|
|
6490
5106
|
export declare interface WrappedModule {
|
|
6491
|
-
invoke(method: string, params?: unknown):
|
|
5107
|
+
invoke(method: string, params?: unknown): SDKStream | Promise<SDKResponse>;
|
|
6492
5108
|
}
|
|
6493
5109
|
|
|
6494
5110
|
export { }
|