UNPKG

@unkey/api

Version:

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

github.com/unkeyed/unkey-ts

unkeyed/unkey-ts

87 lines (62 loc) • 6.43 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Identities (*identities*) ## Overview ### Available Operations * [createIdentity](#createidentity) ## createIdentity ### Example Usage ```typescript import { Unkey } from "@unkey/api"; const unkey = new Unkey({ rootKey: "UNKEY_ROOT_KEY", }); async function run() { const result = await unkey.identities.createIdentity({ externalId: "user_123", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { UnkeyCore } from "@unkey/api/core.js"; import { identitiesCreateIdentity } from "@unkey/api/funcs/identitiesCreateIdentity.js"; // Use `UnkeyCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const unkey = new UnkeyCore({ rootKey: "UNKEY_ROOT_KEY", }); async function run() { const res = await identitiesCreateIdentity(unkey, { externalId: "user_123", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.V2IdentitiesCreateIdentityRequestBody](../../models/components/v2identitiescreateidentityrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.V2IdentitiesCreateIdentityResponseBody](../../models/components/v2identitiescreateidentityresponsebody.md)\>** ### Errors | Error Type | Status Code | Content Type | | ---------------------------------- | ---------------------------------- | ---------------------------------- | | errors.BadRequestErrorResponse | 400 | application/problem+json | | errors.UnauthorizedErrorResponse | 401 | application/problem+json | | errors.ForbiddenErrorResponse | 403 | application/problem+json | | errors.ConflictErrorResponse | 409 | application/problem+json | | errors.InternalServerErrorResponse | 500 | application/problem+json | | errors.APIError | 4XX, 5XX | \*/\* |