@zephytiju/juntai-typescript-sdk 2.0.0 → 2.2.0

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.
Files changed (75) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +17 -1
  3. package/dist/clients/platform.account/index.d.ts +5 -0
  4. package/dist/clients/platform.account/index.js +4 -0
  5. package/dist/clients/platform.iam/index.d.ts +5 -0
  6. package/dist/clients/platform.iam/index.js +4 -0
  7. package/dist/generated/platform.account/client/client.gen.d.ts +2 -0
  8. package/dist/generated/platform.account/client/client.gen.js +216 -0
  9. package/dist/generated/platform.account/client/index.d.ts +10 -0
  10. package/dist/generated/platform.account/client/index.js +6 -0
  11. package/dist/generated/platform.account/client/types.gen.d.ts +120 -0
  12. package/dist/generated/platform.account/client/types.gen.js +2 -0
  13. package/dist/generated/platform.account/client/utils.gen.d.ts +37 -0
  14. package/dist/generated/platform.account/client/utils.gen.js +228 -0
  15. package/dist/generated/platform.account/client.gen.d.ts +12 -0
  16. package/dist/generated/platform.account/client.gen.js +3 -0
  17. package/dist/generated/platform.account/core/auth.gen.d.ts +25 -0
  18. package/dist/generated/platform.account/core/auth.gen.js +14 -0
  19. package/dist/generated/platform.account/core/bodySerializer.gen.d.ts +25 -0
  20. package/dist/generated/platform.account/core/bodySerializer.gen.js +57 -0
  21. package/dist/generated/platform.account/core/params.gen.d.ts +43 -0
  22. package/dist/generated/platform.account/core/params.gen.js +109 -0
  23. package/dist/generated/platform.account/core/pathSerializer.gen.d.ts +33 -0
  24. package/dist/generated/platform.account/core/pathSerializer.gen.js +106 -0
  25. package/dist/generated/platform.account/core/queryKeySerializer.gen.d.ts +18 -0
  26. package/dist/generated/platform.account/core/queryKeySerializer.gen.js +92 -0
  27. package/dist/generated/platform.account/core/serverSentEvents.gen.d.ts +71 -0
  28. package/dist/generated/platform.account/core/serverSentEvents.gen.js +132 -0
  29. package/dist/generated/platform.account/core/types.gen.d.ts +83 -0
  30. package/dist/generated/platform.account/core/types.gen.js +2 -0
  31. package/dist/generated/platform.account/core/utils.gen.d.ts +19 -0
  32. package/dist/generated/platform.account/core/utils.gen.js +87 -0
  33. package/dist/generated/platform.account/index.d.ts +2 -0
  34. package/dist/generated/platform.account/index.js +2 -0
  35. package/dist/generated/platform.account/sdk.gen.d.ts +31 -0
  36. package/dist/generated/platform.account/sdk.gen.js +54 -0
  37. package/dist/generated/platform.account/types.gen.d.ts +274 -0
  38. package/dist/generated/platform.account/types.gen.js +2 -0
  39. package/dist/generated/platform.iam/client/client.gen.d.ts +2 -0
  40. package/dist/generated/platform.iam/client/client.gen.js +216 -0
  41. package/dist/generated/platform.iam/client/index.d.ts +10 -0
  42. package/dist/generated/platform.iam/client/index.js +6 -0
  43. package/dist/generated/platform.iam/client/types.gen.d.ts +120 -0
  44. package/dist/generated/platform.iam/client/types.gen.js +2 -0
  45. package/dist/generated/platform.iam/client/utils.gen.d.ts +37 -0
  46. package/dist/generated/platform.iam/client/utils.gen.js +228 -0
  47. package/dist/generated/platform.iam/client.gen.d.ts +12 -0
  48. package/dist/generated/platform.iam/client.gen.js +3 -0
  49. package/dist/generated/platform.iam/core/auth.gen.d.ts +25 -0
  50. package/dist/generated/platform.iam/core/auth.gen.js +14 -0
  51. package/dist/generated/platform.iam/core/bodySerializer.gen.d.ts +25 -0
  52. package/dist/generated/platform.iam/core/bodySerializer.gen.js +57 -0
  53. package/dist/generated/platform.iam/core/params.gen.d.ts +43 -0
  54. package/dist/generated/platform.iam/core/params.gen.js +109 -0
  55. package/dist/generated/platform.iam/core/pathSerializer.gen.d.ts +33 -0
  56. package/dist/generated/platform.iam/core/pathSerializer.gen.js +106 -0
  57. package/dist/generated/platform.iam/core/queryKeySerializer.gen.d.ts +18 -0
  58. package/dist/generated/platform.iam/core/queryKeySerializer.gen.js +92 -0
  59. package/dist/generated/platform.iam/core/serverSentEvents.gen.d.ts +71 -0
  60. package/dist/generated/platform.iam/core/serverSentEvents.gen.js +132 -0
  61. package/dist/generated/platform.iam/core/types.gen.d.ts +83 -0
  62. package/dist/generated/platform.iam/core/types.gen.js +2 -0
  63. package/dist/generated/platform.iam/core/utils.gen.d.ts +19 -0
  64. package/dist/generated/platform.iam/core/utils.gen.js +87 -0
  65. package/dist/generated/platform.iam/index.d.ts +2 -0
  66. package/dist/generated/platform.iam/index.js +2 -0
  67. package/dist/generated/platform.iam/sdk.gen.d.ts +25 -0
  68. package/dist/generated/platform.iam/sdk.gen.js +12 -0
  69. package/dist/generated/platform.iam/types.gen.d.ts +239 -0
  70. package/dist/generated/platform.iam/types.gen.js +2 -0
  71. package/dist/index.d.ts +5 -1
  72. package/dist/index.js +5 -1
  73. package/dist/release-manifest.json +30 -2
  74. package/package.json +9 -1
  75. package/sources/openapi.lock.json +38 -0
@@ -0,0 +1,274 @@
1
+ export type ClientOptions = {
2
+ baseUrl: `${string}://${string}` | (string & {});
3
+ };
4
+ /**
5
+ * Account/v1
6
+ */
7
+ export type Account = {
8
+ account_id: string;
9
+ display_name: string;
10
+ lifecycle_state: 'active' | 'restricted' | 'suspended' | 'closed';
11
+ created_at: string;
12
+ updated_at: string;
13
+ version: number;
14
+ };
15
+ /**
16
+ * AccountProfile/v1
17
+ */
18
+ export type AccountProfile = {
19
+ display_name: string;
20
+ legal_name?: string;
21
+ contact_email?: string;
22
+ timezone?: string;
23
+ locale?: string;
24
+ version: number;
25
+ };
26
+ /**
27
+ * AccountProfileUpdate/v1
28
+ */
29
+ export type AccountProfileUpdate = {
30
+ display_name?: string;
31
+ legal_name?: string | null;
32
+ contact_email?: string | null;
33
+ timezone?: string | null;
34
+ locale?: string | null;
35
+ };
36
+ /**
37
+ * AccountIntegrationBinding/v1
38
+ */
39
+ export type AccountIntegrationBinding = {
40
+ binding_type: 'iam' | 'billing';
41
+ state: 'configured' | 'not_configured' | 'restricted' | 'stale' | 'unavailable';
42
+ external_ref: string;
43
+ observed_at: string;
44
+ reason_code?: string;
45
+ };
46
+ /**
47
+ * AccountIntegrationBindingList/v1
48
+ */
49
+ export type AccountIntegrationBindingList = {
50
+ items: Array<AccountIntegrationBinding>;
51
+ };
52
+ /**
53
+ * AccountError/v1
54
+ */
55
+ export type AccountError = {
56
+ code: 'UNAUTHENTICATED' | 'FORBIDDEN' | 'ACCOUNT_NOT_FOUND' | 'VALIDATION_FAILED' | 'VERSION_CONFLICT' | 'DEPENDENCY_UNAVAILABLE' | 'RATE_LIMITED' | 'INTERNAL';
57
+ message: string;
58
+ correlation_id: string;
59
+ retryable: boolean;
60
+ field_violations?: Array<{
61
+ field: string;
62
+ reason_code: string;
63
+ }>;
64
+ };
65
+ /**
66
+ * AccountAuthorizationAction/v1
67
+ */
68
+ export type AccountAuthorizationAction = 'account.read' | 'account.profile.read' | 'account.profile.update';
69
+ /**
70
+ * Opaque Account Service identifier.
71
+ */
72
+ export type AccountId = string;
73
+ export type GetAccountData = {
74
+ body?: never;
75
+ path: {
76
+ /**
77
+ * Opaque Account Service identifier.
78
+ */
79
+ accountId: string;
80
+ };
81
+ query?: never;
82
+ url: '/api/platform.account/v1/accounts/{accountId}';
83
+ };
84
+ export type GetAccountErrors = {
85
+ /**
86
+ * No authenticated principal
87
+ */
88
+ 401: AccountError;
89
+ /**
90
+ * Principal is not authorized for the Account action
91
+ */
92
+ 403: AccountError;
93
+ /**
94
+ * Account is unavailable without disclosing protected existence
95
+ */
96
+ 404: AccountError;
97
+ /**
98
+ * Account request was rate limited
99
+ */
100
+ 429: AccountError;
101
+ /**
102
+ * Unexpected Account failure
103
+ */
104
+ 500: AccountError;
105
+ /**
106
+ * A required Account dependency is unavailable
107
+ */
108
+ 503: AccountError;
109
+ };
110
+ export type GetAccountError = GetAccountErrors[keyof GetAccountErrors];
111
+ export type GetAccountResponses = {
112
+ /**
113
+ * Account
114
+ */
115
+ 200: Account;
116
+ };
117
+ export type GetAccountResponse = GetAccountResponses[keyof GetAccountResponses];
118
+ export type GetAccountProfileData = {
119
+ body?: never;
120
+ path: {
121
+ /**
122
+ * Opaque Account Service identifier.
123
+ */
124
+ accountId: string;
125
+ };
126
+ query?: never;
127
+ url: '/api/platform.account/v1/accounts/{accountId}/profile';
128
+ };
129
+ export type GetAccountProfileErrors = {
130
+ /**
131
+ * No authenticated principal
132
+ */
133
+ 401: AccountError;
134
+ /**
135
+ * Principal is not authorized for the Account action
136
+ */
137
+ 403: AccountError;
138
+ /**
139
+ * Account is unavailable without disclosing protected existence
140
+ */
141
+ 404: AccountError;
142
+ /**
143
+ * Account request was rate limited
144
+ */
145
+ 429: AccountError;
146
+ /**
147
+ * Unexpected Account failure
148
+ */
149
+ 500: AccountError;
150
+ /**
151
+ * A required Account dependency is unavailable
152
+ */
153
+ 503: AccountError;
154
+ };
155
+ export type GetAccountProfileError = GetAccountProfileErrors[keyof GetAccountProfileErrors];
156
+ export type GetAccountProfileResponses = {
157
+ /**
158
+ * Account profile
159
+ */
160
+ 200: AccountProfile;
161
+ };
162
+ export type GetAccountProfileResponse = GetAccountProfileResponses[keyof GetAccountProfileResponses];
163
+ export type UpdateAccountProfileData = {
164
+ body: AccountProfileUpdate;
165
+ headers: {
166
+ /**
167
+ * Opaque version tag returned by the latest profile read.
168
+ */
169
+ 'If-Match': string;
170
+ /**
171
+ * Stable identity for one logical profile mutation.
172
+ */
173
+ 'Idempotency-Key': string;
174
+ };
175
+ path: {
176
+ /**
177
+ * Opaque Account Service identifier.
178
+ */
179
+ accountId: string;
180
+ };
181
+ query?: never;
182
+ url: '/api/platform.account/v1/accounts/{accountId}/profile';
183
+ };
184
+ export type UpdateAccountProfileErrors = {
185
+ /**
186
+ * Profile validation failed
187
+ */
188
+ 400: AccountError;
189
+ /**
190
+ * No authenticated principal
191
+ */
192
+ 401: AccountError;
193
+ /**
194
+ * Principal is not authorized for the Account action
195
+ */
196
+ 403: AccountError;
197
+ /**
198
+ * Account is unavailable without disclosing protected existence
199
+ */
200
+ 404: AccountError;
201
+ /**
202
+ * If-Match does not name the latest profile version
203
+ */
204
+ 409: AccountError;
205
+ /**
206
+ * Profile validation failed
207
+ */
208
+ 422: AccountError;
209
+ /**
210
+ * Account request was rate limited
211
+ */
212
+ 429: AccountError;
213
+ /**
214
+ * Unexpected Account failure
215
+ */
216
+ 500: AccountError;
217
+ /**
218
+ * A required Account dependency is unavailable
219
+ */
220
+ 503: AccountError;
221
+ };
222
+ export type UpdateAccountProfileError = UpdateAccountProfileErrors[keyof UpdateAccountProfileErrors];
223
+ export type UpdateAccountProfileResponses = {
224
+ /**
225
+ * Updated account profile
226
+ */
227
+ 200: AccountProfile;
228
+ };
229
+ export type UpdateAccountProfileResponse = UpdateAccountProfileResponses[keyof UpdateAccountProfileResponses];
230
+ export type ListAccountIntegrationBindingsData = {
231
+ body?: never;
232
+ path: {
233
+ /**
234
+ * Opaque Account Service identifier.
235
+ */
236
+ accountId: string;
237
+ };
238
+ query?: never;
239
+ url: '/api/platform.account/v1/accounts/{accountId}/integration-bindings';
240
+ };
241
+ export type ListAccountIntegrationBindingsErrors = {
242
+ /**
243
+ * No authenticated principal
244
+ */
245
+ 401: AccountError;
246
+ /**
247
+ * Principal is not authorized for the Account action
248
+ */
249
+ 403: AccountError;
250
+ /**
251
+ * Account is unavailable without disclosing protected existence
252
+ */
253
+ 404: AccountError;
254
+ /**
255
+ * Account request was rate limited
256
+ */
257
+ 429: AccountError;
258
+ /**
259
+ * Unexpected Account failure
260
+ */
261
+ 500: AccountError;
262
+ /**
263
+ * A required Account dependency is unavailable
264
+ */
265
+ 503: AccountError;
266
+ };
267
+ export type ListAccountIntegrationBindingsError = ListAccountIntegrationBindingsErrors[keyof ListAccountIntegrationBindingsErrors];
268
+ export type ListAccountIntegrationBindingsResponses = {
269
+ /**
270
+ * Integration-binding summaries
271
+ */
272
+ 200: AccountIntegrationBindingList;
273
+ };
274
+ export type ListAccountIntegrationBindingsResponse = ListAccountIntegrationBindingsResponses[keyof ListAccountIntegrationBindingsResponses];
@@ -0,0 +1,2 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ export {};
@@ -0,0 +1,2 @@
1
+ import type { Client, Config } from './types.gen.js';
2
+ export declare const createClient: (config?: Config) => Client;
@@ -0,0 +1,216 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ import { createSseClient } from '../core/serverSentEvents.gen.js';
3
+ import { getValidRequestBody } from '../core/utils.gen.js';
4
+ import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from './utils.gen.js';
5
+ export const createClient = (config = {}) => {
6
+ let _config = mergeConfigs(createConfig(), config);
7
+ const getConfig = () => ({ ..._config });
8
+ const setConfig = (config) => {
9
+ _config = mergeConfigs(_config, config);
10
+ return getConfig();
11
+ };
12
+ const interceptors = createInterceptors();
13
+ const beforeRequest = async (options) => {
14
+ const opts = {
15
+ ..._config,
16
+ ...options,
17
+ fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
18
+ headers: mergeHeaders(_config.headers, options.headers),
19
+ serializedBody: undefined,
20
+ };
21
+ if (opts.security) {
22
+ await setAuthParams(opts);
23
+ }
24
+ if (opts.requestValidator) {
25
+ await opts.requestValidator(opts);
26
+ }
27
+ if (opts.body !== undefined && opts.bodySerializer) {
28
+ opts.serializedBody = opts.bodySerializer(opts.body);
29
+ }
30
+ // remove Content-Type header if body is empty to avoid sending invalid requests
31
+ if (opts.body === undefined || opts.serializedBody === '') {
32
+ opts.headers.delete('Content-Type');
33
+ }
34
+ const resolvedOpts = opts;
35
+ const url = buildUrl(resolvedOpts);
36
+ return { opts: resolvedOpts, url };
37
+ };
38
+ const request = async (options) => {
39
+ const throwOnError = options.throwOnError ?? _config.throwOnError;
40
+ const responseStyle = options.responseStyle ?? _config.responseStyle;
41
+ let request;
42
+ let response;
43
+ try {
44
+ const { opts, url } = await beforeRequest(options);
45
+ const requestInit = {
46
+ redirect: 'follow',
47
+ ...opts,
48
+ body: getValidRequestBody(opts),
49
+ };
50
+ request = new Request(url, requestInit);
51
+ for (const fn of interceptors.request.fns) {
52
+ if (fn) {
53
+ request = await fn(request, opts);
54
+ }
55
+ }
56
+ // fetch must be assigned here, otherwise it would throw the error:
57
+ // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
58
+ const _fetch = opts.fetch;
59
+ response = await _fetch(request);
60
+ for (const fn of interceptors.response.fns) {
61
+ if (fn) {
62
+ response = await fn(response, request, opts);
63
+ }
64
+ }
65
+ const result = {
66
+ request,
67
+ response,
68
+ };
69
+ if (response.ok) {
70
+ const parseAs = (opts.parseAs === 'auto'
71
+ ? getParseAs(response.headers.get('Content-Type'))
72
+ : opts.parseAs) ?? 'json';
73
+ if (response.status === 204 || response.headers.get('Content-Length') === '0') {
74
+ let emptyData;
75
+ switch (parseAs) {
76
+ case 'arrayBuffer':
77
+ case 'blob':
78
+ case 'text':
79
+ emptyData = await response[parseAs]();
80
+ break;
81
+ case 'formData':
82
+ emptyData = new FormData();
83
+ break;
84
+ case 'stream':
85
+ emptyData = response.body;
86
+ break;
87
+ case 'json':
88
+ default:
89
+ emptyData = {};
90
+ break;
91
+ }
92
+ return opts.responseStyle === 'data'
93
+ ? emptyData
94
+ : {
95
+ data: emptyData,
96
+ ...result,
97
+ };
98
+ }
99
+ let data;
100
+ switch (parseAs) {
101
+ case 'arrayBuffer':
102
+ case 'blob':
103
+ case 'formData':
104
+ case 'text':
105
+ data = await response[parseAs]();
106
+ break;
107
+ case 'json': {
108
+ // Some servers return 200 with no Content-Length and empty body.
109
+ // response.json() would throw; read as text and parse if non-empty.
110
+ const text = await response.text();
111
+ data = text ? JSON.parse(text) : {};
112
+ break;
113
+ }
114
+ case 'stream':
115
+ return opts.responseStyle === 'data'
116
+ ? response.body
117
+ : {
118
+ data: response.body,
119
+ ...result,
120
+ };
121
+ }
122
+ if (parseAs === 'json') {
123
+ if (opts.responseValidator) {
124
+ await opts.responseValidator(data);
125
+ }
126
+ if (opts.responseTransformer) {
127
+ data = await opts.responseTransformer(data);
128
+ }
129
+ }
130
+ return opts.responseStyle === 'data'
131
+ ? data
132
+ : {
133
+ data,
134
+ ...result,
135
+ };
136
+ }
137
+ const textError = await response.text();
138
+ let jsonError;
139
+ try {
140
+ jsonError = JSON.parse(textError);
141
+ }
142
+ catch {
143
+ // noop
144
+ }
145
+ throw jsonError ?? textError;
146
+ }
147
+ catch (error) {
148
+ let finalError = error;
149
+ for (const fn of interceptors.error.fns) {
150
+ if (fn) {
151
+ finalError = await fn(finalError, response, request, options);
152
+ }
153
+ }
154
+ finalError = finalError || {};
155
+ if (throwOnError) {
156
+ throw finalError;
157
+ }
158
+ // TODO: we probably want to return error and improve types
159
+ return responseStyle === 'data'
160
+ ? undefined
161
+ : {
162
+ error: finalError,
163
+ request,
164
+ response,
165
+ };
166
+ }
167
+ };
168
+ const makeMethodFn = (method) => (options) => request({ ...options, method });
169
+ const makeSseFn = (method) => async (options) => {
170
+ const { opts, url } = await beforeRequest(options);
171
+ return createSseClient({
172
+ ...opts,
173
+ body: opts.body,
174
+ method,
175
+ onRequest: async (url, init) => {
176
+ let request = new Request(url, init);
177
+ for (const fn of interceptors.request.fns) {
178
+ if (fn) {
179
+ request = await fn(request, opts);
180
+ }
181
+ }
182
+ return request;
183
+ },
184
+ serializedBody: getValidRequestBody(opts),
185
+ url,
186
+ });
187
+ };
188
+ const _buildUrl = (options) => buildUrl({ ..._config, ...options });
189
+ return {
190
+ buildUrl: _buildUrl,
191
+ connect: makeMethodFn('CONNECT'),
192
+ delete: makeMethodFn('DELETE'),
193
+ get: makeMethodFn('GET'),
194
+ getConfig,
195
+ head: makeMethodFn('HEAD'),
196
+ interceptors,
197
+ options: makeMethodFn('OPTIONS'),
198
+ patch: makeMethodFn('PATCH'),
199
+ post: makeMethodFn('POST'),
200
+ put: makeMethodFn('PUT'),
201
+ request,
202
+ setConfig,
203
+ sse: {
204
+ connect: makeSseFn('CONNECT'),
205
+ delete: makeSseFn('DELETE'),
206
+ get: makeSseFn('GET'),
207
+ head: makeSseFn('HEAD'),
208
+ options: makeSseFn('OPTIONS'),
209
+ patch: makeSseFn('PATCH'),
210
+ post: makeSseFn('POST'),
211
+ put: makeSseFn('PUT'),
212
+ trace: makeSseFn('TRACE'),
213
+ },
214
+ trace: makeMethodFn('TRACE'),
215
+ };
216
+ };
@@ -0,0 +1,10 @@
1
+ export type { Auth } from '../core/auth.gen.js';
2
+ export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
3
+ export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
4
+ export { buildClientParams } from '../core/params.gen.js';
5
+ export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
6
+ export type { ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
7
+ export type { ClientMeta } from '../core/types.gen.js';
8
+ export { createClient } from './client.gen.js';
9
+ export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen.js';
10
+ export { createConfig, mergeHeaders } from './utils.gen.js';
@@ -0,0 +1,6 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
3
+ export { buildClientParams } from '../core/params.gen.js';
4
+ export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
5
+ export { createClient } from './client.gen.js';
6
+ export { createConfig, mergeHeaders } from './utils.gen.js';
@@ -0,0 +1,120 @@
1
+ import type { Auth } from '../core/auth.gen.js';
2
+ import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
3
+ import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
4
+ import type { Middleware } from './utils.gen.js';
5
+ export type ResponseStyle = 'data' | 'fields';
6
+ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
7
+ /**
8
+ * Base URL for all requests made by this client.
9
+ */
10
+ baseUrl?: T['baseUrl'];
11
+ /**
12
+ * Fetch API implementation. You can use this option to provide a custom
13
+ * fetch instance.
14
+ *
15
+ * @default globalThis.fetch
16
+ */
17
+ fetch?: typeof fetch;
18
+ /**
19
+ * Please don't use the Fetch client for Next.js applications. The `next`
20
+ * options won't have any effect.
21
+ *
22
+ * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
23
+ */
24
+ next?: never;
25
+ /**
26
+ * Return the response data parsed in a specified format. By default, `auto`
27
+ * will infer the appropriate method from the `Content-Type` response header.
28
+ * You can override this behavior with any of the {@link Body} methods.
29
+ * Select `stream` if you don't want to parse response data at all.
30
+ *
31
+ * @default 'auto'
32
+ */
33
+ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
34
+ /**
35
+ * Should we return only data or multiple fields (data, error, response, etc.)?
36
+ *
37
+ * @default 'fields'
38
+ */
39
+ responseStyle?: ResponseStyle;
40
+ /**
41
+ * Throw an error instead of returning it in the response?
42
+ *
43
+ * @default false
44
+ */
45
+ throwOnError?: T['throwOnError'];
46
+ }
47
+ export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
48
+ responseStyle: TResponseStyle;
49
+ throwOnError: ThrowOnError;
50
+ }>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
51
+ /**
52
+ * Any body that you want to add to your request.
53
+ *
54
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
55
+ */
56
+ body?: unknown;
57
+ path?: Record<string, unknown>;
58
+ query?: Record<string, unknown>;
59
+ /**
60
+ * Security mechanism(s) to use for the request.
61
+ */
62
+ security?: ReadonlyArray<Auth>;
63
+ url: Url;
64
+ }
65
+ export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
66
+ headers: Headers;
67
+ serializedBody?: string;
68
+ }
69
+ export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
70
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
71
+ request: Request;
72
+ response: Response;
73
+ }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
74
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
75
+ error: undefined;
76
+ } | {
77
+ data: undefined;
78
+ error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
79
+ }) & {
80
+ /** request may be undefined, because error may be from building the request object itself */
81
+ request?: Request;
82
+ /** response may be undefined, because error may be from building the request object itself or from a network error */
83
+ response?: Response;
84
+ }>;
85
+ export interface ClientOptions {
86
+ baseUrl?: string;
87
+ responseStyle?: ResponseStyle;
88
+ throwOnError?: boolean;
89
+ }
90
+ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
91
+ type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
92
+ type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
93
+ type BuildUrlFn = <TData extends {
94
+ body?: unknown;
95
+ path?: Record<string, unknown>;
96
+ query?: Record<string, unknown>;
97
+ url: string;
98
+ }>(options: TData & Options<TData>) => string;
99
+ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
100
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
101
+ };
102
+ /**
103
+ * The `createClientConfig()` function will be called on client initialization
104
+ * and the returned object will become the client's initial configuration.
105
+ *
106
+ * You may want to initialize your client this way instead of calling
107
+ * `setConfig()`. This is useful for example if you're using Next.js
108
+ * to ensure your client always has the correct values.
109
+ */
110
+ export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
111
+ export interface TDataShape {
112
+ body?: unknown;
113
+ headers?: unknown;
114
+ path?: unknown;
115
+ query?: unknown;
116
+ url: string;
117
+ }
118
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
119
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
120
+ export {};
@@ -0,0 +1,2 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ export {};
@@ -0,0 +1,37 @@
1
+ import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
2
+ import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
3
+ export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => ((queryParams: T) => string);
4
+ /**
5
+ * Infers parseAs value from provided Content-Type header.
6
+ */
7
+ export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
8
+ export declare function setAuthParams(options: Pick<RequestOptions, 'auth' | 'query' | 'security'> & {
9
+ headers: Headers;
10
+ }): Promise<void>;
11
+ export declare const buildUrl: Client['buildUrl'];
12
+ export declare const mergeConfigs: (a: Config, b: Config) => Config;
13
+ export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
14
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
15
+ /** response may be undefined due to a network error where no response object is produced */
16
+ response: Res | undefined,
17
+ /** request may be undefined, because error may be from building the request object itself */
18
+ request: Req | undefined, options: Options) => Err | Promise<Err>;
19
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
20
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
21
+ declare class Interceptors<Interceptor> {
22
+ fns: Array<Interceptor | null>;
23
+ clear(): void;
24
+ eject(id: number | Interceptor): void;
25
+ exists(id: number | Interceptor): boolean;
26
+ getInterceptorIndex(id: number | Interceptor): number;
27
+ update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
28
+ use(fn: Interceptor): number;
29
+ }
30
+ export interface Middleware<Req, Res, Err, Options> {
31
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
32
+ request: Interceptors<ReqInterceptor<Req, Options>>;
33
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
34
+ }
35
+ export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
36
+ export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
37
+ export {};