@qlik/api 1.29.0 → 1.31.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 (86) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +5 -13
  4. package/apps.js +2 -2
  5. package/audits.d.ts +2 -2
  6. package/audits.js +2 -2
  7. package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
  8. package/auth.d.ts +27 -3
  9. package/auth.js +8 -4
  10. package/automations.d.ts +38 -38
  11. package/automations.js +2 -2
  12. package/brands.d.ts +2 -2
  13. package/brands.js +2 -2
  14. package/chunks/{2BRBIRM2.js → 6ZONDHRN.js} +1 -1
  15. package/chunks/{2B7YWDQC.js → DLKLPD7T.js} +3 -3
  16. package/chunks/ETNHFALU.js +61 -0
  17. package/chunks/{NBW6PHZU.js → FKDGGR2O.js} +158 -45
  18. package/chunks/{KYCIMQ4L.js → GUU3KZGK.js} +11 -1
  19. package/chunks/{5XNSGPGZ.js → KBSD75QL.js} +1 -1
  20. package/chunks/{4D5NADHK.js → LY7RP2HA.js} +7 -3
  21. package/chunks/{QOOCP2TS.js → M64RLKVG.js} +2074 -12
  22. package/chunks/{5MRIMVKS.js → PLVPW5IR.js} +17 -20
  23. package/chunks/{MGXEGSJC.js → UZTIZ4H5.js} +392 -372
  24. package/chunks/{WQYEWU54.js → YKZ2QYHN.js} +2 -2
  25. package/collections.d.ts +3 -3
  26. package/collections.js +2 -2
  27. package/csp-origins.d.ts +2 -2
  28. package/csp-origins.js +2 -2
  29. package/data-assets.d.ts +2 -2
  30. package/data-assets.js +2 -2
  31. package/data-connections.d.ts +8 -8
  32. package/data-connections.js +2 -2
  33. package/data-credentials.d.ts +2 -2
  34. package/data-credentials.js +2 -2
  35. package/data-files.d.ts +2 -2
  36. package/data-files.js +2 -2
  37. package/docs/authentication.md +47 -0
  38. package/extensions.d.ts +2 -2
  39. package/extensions.js +2 -2
  40. package/glossaries.d.ts +22 -15
  41. package/glossaries.js +2 -2
  42. package/groups.d.ts +5 -4
  43. package/groups.js +2 -2
  44. package/identity-providers.d.ts +2 -2
  45. package/identity-providers.js +2 -2
  46. package/index.d.ts +10 -4
  47. package/index.js +29 -4
  48. package/interceptors.d.ts +2 -2
  49. package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
  50. package/items.d.ts +3 -3
  51. package/items.js +2 -2
  52. package/licenses.d.ts +5 -2
  53. package/licenses.js +2 -2
  54. package/oauth-clients.d.ts +521 -0
  55. package/oauth-clients.js +112 -0
  56. package/package.json +4 -2
  57. package/qix.d.ts +422 -27
  58. package/qix.js +2 -2
  59. package/quotas.d.ts +2 -2
  60. package/quotas.js +2 -2
  61. package/reload-tasks.d.ts +4 -2
  62. package/reload-tasks.js +2 -2
  63. package/reloads.d.ts +6 -2
  64. package/reloads.js +2 -2
  65. package/reports.d.ts +4 -2
  66. package/reports.js +2 -2
  67. package/roles.d.ts +14 -4
  68. package/roles.js +2 -2
  69. package/spaces.d.ts +3 -7
  70. package/spaces.js +2 -2
  71. package/temp-contents.d.ts +2 -2
  72. package/temp-contents.js +2 -2
  73. package/tenants.d.ts +2 -2
  74. package/tenants.js +2 -2
  75. package/themes.d.ts +2 -2
  76. package/themes.js +2 -2
  77. package/transports.d.ts +2 -2
  78. package/transports.js +2 -2
  79. package/users.d.ts +2 -2
  80. package/users.js +2 -2
  81. package/web-integrations.d.ts +2 -2
  82. package/web-integrations.js +2 -2
  83. package/web-notifications.d.ts +2 -2
  84. package/web-notifications.js +2 -2
  85. package/webhooks.d.ts +2 -2
  86. package/webhooks.js +2 -2
@@ -1,4 +1,4 @@
1
- import { H as HostConfig } from './auth-types-PkN9CAF_.js';
1
+ import { H as HostConfig } from './auth-types-DqfMuSRX.js';
2
2
 
3
3
  /** ApiKey Auth Configuration for a HostConfig */
4
4
  type ApiKeyAuthConfig = {
@@ -82,6 +82,11 @@ type AnonymousAuthConfig = {
82
82
  /** client id of oauth client created by tenant admin */
83
83
  clientId: string;
84
84
  };
85
+ /** Used to reference a registered host config as a single string */
86
+ type ReferenceConfig = {
87
+ /** The name of the registered host config to reference */
88
+ reference: string;
89
+ };
85
90
  declare global {
86
91
  /**
87
92
  * QlikAuthModules is a global interface that can be extended to add custom auth modules.
@@ -102,6 +107,9 @@ declare global {
102
107
  windowscookie: {
103
108
  config: WindowsCookieAuthConfig;
104
109
  };
110
+ reference: {
111
+ config: ReferenceConfig;
112
+ };
105
113
  none: {
106
114
  config: object;
107
115
  };
@@ -160,7 +168,7 @@ type ApiCallOptions = {
160
168
  */
161
169
  useCacheIfAfter?: Date;
162
170
  /**
163
- * Specify if another host than `globalThis.location` is to be used. Typically used in embedding and mashups
171
+ * Specify the host configif the api call is a cross-domain request. Typically used in embedding and mashups
164
172
  */
165
173
  hostConfig?: HostConfig;
166
174
  /**
package/items.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  type CollectionTypes = "private" | "public" | "publicgoverned";
5
5
  type ErrorResponseBody = {
@@ -129,7 +129,7 @@ type ItemMetaResponseBody = {
129
129
  /**
130
130
  * The case-sensitive string defining the item's type.
131
131
  */
132
- type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
132
+ type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment" | "assistant" | "dataproduct" | "dataqualityrule" | "glossary" | "knowledgebase" | "script";
133
133
  /**
134
134
  * An item.
135
135
  */
package/items.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/WQYEWU54.js";
5
- import "./chunks/2B7YWDQC.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/items.ts
package/licenses.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
2
- import './auth-types-PkN9CAF_.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
3
 
4
4
  /**
5
5
  * @example
@@ -367,6 +367,7 @@ type LicenseOverview = {
367
367
  /**
368
368
  * @example
369
369
  * {
370
+ * extensionStatus: "Unavailable",
370
371
  * origin: "Internal",
371
372
  * product: "Qlik Sense Business",
372
373
  * status: "Ok",
@@ -376,6 +377,8 @@ type LicenseOverview = {
376
377
  * }
377
378
  */
378
379
  type LicenseStatus = {
380
+ /** Enum with extension status of license. access. */
381
+ extensionStatus: "Unavailable" | "Pending" | "Available";
379
382
  /** Origin of license key. */
380
383
  origin: "Internal" | "External";
381
384
  /** The product the license is valid for. */
package/licenses.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/WQYEWU54.js";
5
- import "./chunks/2B7YWDQC.js";
4
+ } from "./chunks/YKZ2QYHN.js";
5
+ import "./chunks/DLKLPD7T.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/licenses.ts
@@ -0,0 +1,521 @@
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
2
+ import './auth-types-DqfMuSRX.js';
3
+
4
+ /**
5
+ * Hints of any client application secrets
6
+ */
7
+ type ClientSecrets = {
8
+ /** The timestamp for when the client-secret record was created. */
9
+ createdAt?: string;
10
+ /** The identifier for the user that created the client-secret record. */
11
+ createdBy?: string;
12
+ /** Hint of a client application secret */
13
+ hint: string;
14
+ }[];
15
+ /**
16
+ * Response schema for reading a connection config
17
+ */
18
+ type ConnectionConfigReadResponse = {
19
+ /** Consent method */
20
+ readonly consentMethod: string;
21
+ /** OAuth client has been deleted by owning tenant, only applies for published clients. */
22
+ readonly deletedByOwner?: boolean;
23
+ /** Status */
24
+ readonly status?: string;
25
+ };
26
+ type Error = {
27
+ /** The unique code for the error */
28
+ code: string;
29
+ /** Additional details about the error */
30
+ detail?: string;
31
+ /** A summary of the error */
32
+ title: string;
33
+ };
34
+ type ErrorResponse = {
35
+ errors?: Error[];
36
+ };
37
+ type Link = {
38
+ /** URL that defines the resource */
39
+ href: string;
40
+ };
41
+ type Links = {
42
+ next?: Link;
43
+ prev?: Link;
44
+ self?: Link;
45
+ };
46
+ /**
47
+ * Schema for a OAuth client when listing as an admin user
48
+ */
49
+ type OAuthClientAdminListItem = {
50
+ /** List of allowed origins for client */
51
+ allowedOrigins?: string[];
52
+ /** Client application id */
53
+ readonly clientId: string;
54
+ /** Response schema for reading a connection config */
55
+ connectionConfig?: ConnectionConfigReadResponse;
56
+ /** List of allowed redirect URIs for login */
57
+ redirectUris?: string[];
58
+ } & OAuthClientBase;
59
+ /**
60
+ * Response schema for listing OAuth clients as an admin user
61
+ */
62
+ type OAuthClientAdminListResponse = {
63
+ data: OAuthClientAdminListItem[];
64
+ links: Links;
65
+ /** Total number of oauth clients, included only if `totalResults` query parameter is set to true. */
66
+ totalResults?: number;
67
+ };
68
+ /**
69
+ * Response schema for reading an OAuth client as an admin user
70
+ */
71
+ type OAuthClientAdminReadResponse = {
72
+ /** List of allowed origins for client */
73
+ allowedOrigins?: string[];
74
+ /** Client application id */
75
+ readonly clientId: string;
76
+ /** Hints of any client application secrets */
77
+ readonly clientSecrets?: ClientSecrets;
78
+ /** List of allowed redirect URIs for login */
79
+ redirectUris?: string[];
80
+ } & OAuthClientBase;
81
+ /**
82
+ * Base schema for OAuth client requests and responses
83
+ */
84
+ type OAuthClientBase = {
85
+ /** Allowed grant types, only for use with appType: 'web' */
86
+ allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
87
+ /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
88
+ allowedScopes?: string[];
89
+ /** Application type */
90
+ appType: "web" | "native" | "spa" | "anonymous-embed";
91
+ /** Client application name */
92
+ clientName: string;
93
+ /** URI for homepage of client */
94
+ clientUri?: string;
95
+ /** The timestamp for when the oauth-clients record was created. */
96
+ createdAt: string;
97
+ /** The timestamp for when the oauth-clients record was deleted. */
98
+ deletedAt?: string;
99
+ /** Client description */
100
+ description?: string;
101
+ /** Is set if client disabled */
102
+ readonly disableTag?: string;
103
+ /** URI for logo of client */
104
+ logoUri?: string;
105
+ /** The timestamp which is set, if the client is published. */
106
+ publishedAt?: string;
107
+ /** The timestamp for when the oauth-clients record was updated. */
108
+ updatedAt?: string;
109
+ };
110
+ /**
111
+ * Request schema for OAuth client creation
112
+ */
113
+ type OAuthClientCreateRequest = {
114
+ /** Allowed grant types, only for use with appType: 'web' */
115
+ allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
116
+ /** List of allowed origins for this client, only available with SPA application type */
117
+ allowedOrigins?: string[];
118
+ /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
119
+ allowedScopes?: string[];
120
+ /** Application type */
121
+ appType: "web" | "native" | "spa" | "anonymous-embed";
122
+ /** Client application name */
123
+ clientName: string;
124
+ /** URI for homepage of client */
125
+ clientUri?: string;
126
+ /** Optional settings for configuring the client connection. */
127
+ connectionConfig?: {
128
+ /** Specifies the consent method for the connection. The only allowed value is "trusted." */
129
+ consentMethod?: "trusted";
130
+ };
131
+ /** Client description */
132
+ description?: string;
133
+ /** URI for logo of client */
134
+ logoUri?: string;
135
+ /** List of allowed redirect URIs for login */
136
+ redirectUris?: string[];
137
+ };
138
+ /**
139
+ * Response schema for OAuth client creation
140
+ */
141
+ type OAuthClientCreateResponse = {
142
+ /** List of allowed redirect URIs for login */
143
+ allowedOrigins?: string[];
144
+ /** Client application id */
145
+ readonly clientId: string;
146
+ /** Client application secret */
147
+ readonly clientSecret: string;
148
+ /** List of allowed redirect URIs for login */
149
+ redirectUris?: string[];
150
+ } & OAuthClientBase;
151
+ /**
152
+ * Response schema for listing OAuth clients
153
+ */
154
+ type OAuthClientListResponse = {
155
+ data: OAuthClientReadResponse[];
156
+ links: Links;
157
+ };
158
+ /**
159
+ * Response schema for successfully publishing an OAuth client
160
+ */
161
+ type OAuthClientPublishResponse = {
162
+ /** The timestamp which is set, if the client is published. */
163
+ publishedAt: string;
164
+ };
165
+ /**
166
+ * Response schema for reading an OAuth client
167
+ */
168
+ type OAuthClientReadResponse = {
169
+ /** Client application id */
170
+ readonly clientId: string;
171
+ } & OAuthClientBase;
172
+ /**
173
+ * Response schema for creating an OAuth client application secret
174
+ */
175
+ type OAuthClientSecretResponse = {
176
+ /** Client application id */
177
+ readonly clientId: string;
178
+ /** Client application secret */
179
+ readonly clientSecret: string;
180
+ /** The timestamp for when the client-secret record was created. */
181
+ createdAt?: string;
182
+ /** The identifier for the user that created the client-secret record. */
183
+ createdBy?: string;
184
+ /** Client application hint */
185
+ readonly hint: string;
186
+ };
187
+ /**
188
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
189
+ */
190
+ type OAuthClientUpdate = {
191
+ /** The operation to be performed */
192
+ op: "add" | "remove" | "replace";
193
+ /** The path for the given resource field to patch */
194
+ path: "/allowedOrigins" | "/clientName" | "/clientUri" | "/description" | "/logoUri" | "/redirectUris" | "/allowedScopes" | "/allowedGrantTypes";
195
+ /** The value to be used for this operation. */
196
+ value?: string | string[];
197
+ };
198
+ /**
199
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
200
+ */
201
+ type OAuthConnectionConfigUpdate = {
202
+ /** The operation to be performed */
203
+ op: "replace";
204
+ /** The path for the given resource field to patch */
205
+ path: "/consentMethod";
206
+ /** The value to be used for this operation. */
207
+ value: "required" | "trusted";
208
+ };
209
+ /**
210
+ * Retrieve all OAuth clients.
211
+ * @example
212
+ * getOAuthClients(
213
+ * {
214
+ * filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
215
+ * totalResults: true
216
+ * }
217
+ * )
218
+ *
219
+ * @param query an object with query parameters
220
+ * @throws GetOAuthClientsHttpError
221
+ */
222
+ declare const getOAuthClients: (query: {
223
+ /** The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are `clientId`, `clientName`, `appType`, and `tenantId`. */
224
+ filter?: string;
225
+ /** The number of OAuth client entries to retrieve. */
226
+ limit?: number;
227
+ /** The next page cursor */
228
+ next?: string;
229
+ /** The previous page cursor */
230
+ prev?: string;
231
+ /** The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId, createdAt, updatedAt. */
232
+ sort?: string;
233
+ /** Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the `totalResults` field. If false or not included in the query, `totalResults` will be excluded from the response. */
234
+ totalResults?: boolean;
235
+ }, options?: ApiCallOptions) => Promise<GetOAuthClientsHttpResponse>;
236
+ type GetOAuthClientsHttpResponse = {
237
+ data: OAuthClientAdminListResponse | OAuthClientListResponse;
238
+ headers: Headers;
239
+ status: 200;
240
+ };
241
+ type GetOAuthClientsHttpError = {
242
+ data: ErrorResponse;
243
+ headers: Headers;
244
+ status: 401 | 403 | 500 | 503;
245
+ };
246
+ /**
247
+ * Create a new OAuth client. Requires `TenantAdmin` role when created in-tenant. `appType` cannot be changed after creation. Consent method and published state can be changed after creation. For supported `appType`, use `PATCH /oauth-clients/{id}/connection-configs/me` to change consent method, and `POST /oauth-clients/{id}/actions/publish` to change the client to published after creation.
248
+ *
249
+ * @param body an object with the body content
250
+ * @throws CreateOAuthClientHttpError
251
+ */
252
+ declare const createOAuthClient: (body: OAuthClientCreateRequest, options?: ApiCallOptions) => Promise<CreateOAuthClientHttpResponse>;
253
+ type CreateOAuthClientHttpResponse = {
254
+ data: OAuthClientCreateResponse;
255
+ headers: Headers;
256
+ status: 201;
257
+ };
258
+ type CreateOAuthClientHttpError = {
259
+ data: ErrorResponse;
260
+ headers: Headers;
261
+ status: 400 | 401 | 403 | 500 | 503;
262
+ };
263
+ /**
264
+ * Delete the specified OAuth client.
265
+ *
266
+ * @param id The unique identifier for the OAuth client
267
+ * @throws DeleteOAuthClientHttpError
268
+ */
269
+ declare const deleteOAuthClient: (id: string, options?: ApiCallOptions) => Promise<DeleteOAuthClientHttpResponse>;
270
+ type DeleteOAuthClientHttpResponse = {
271
+ data: void;
272
+ headers: Headers;
273
+ status: 204;
274
+ };
275
+ type DeleteOAuthClientHttpError = {
276
+ data: ErrorResponse;
277
+ headers: Headers;
278
+ status: 400 | 401 | 403 | 404 | 500 | 503;
279
+ };
280
+ /**
281
+ * Retrieves the specified OAuth client.
282
+ *
283
+ * @param id The unique identifier for the OAuth client
284
+ * @throws GetOAuthClientHttpError
285
+ */
286
+ declare const getOAuthClient: (id: string, options?: ApiCallOptions) => Promise<GetOAuthClientHttpResponse>;
287
+ type GetOAuthClientHttpResponse = {
288
+ data: OAuthClientAdminReadResponse | OAuthClientReadResponse;
289
+ headers: Headers;
290
+ status: 200;
291
+ };
292
+ type GetOAuthClientHttpError = {
293
+ data: ErrorResponse;
294
+ headers: Headers;
295
+ status: 400 | 401 | 403 | 404 | 500 | 503;
296
+ };
297
+ /**
298
+ * Updates the specified OAuth client.
299
+ *
300
+ * @param id The unique identifier for the OAuth client
301
+ * @param body an object with the body content
302
+ * @throws PatchOAuthClientHttpError
303
+ */
304
+ declare const patchOAuthClient: (id: string, body: OAuthClientUpdate[], options?: ApiCallOptions) => Promise<PatchOAuthClientHttpResponse>;
305
+ type PatchOAuthClientHttpResponse = {
306
+ data: void;
307
+ headers: Headers;
308
+ status: 204;
309
+ };
310
+ type PatchOAuthClientHttpError = {
311
+ data: ErrorResponse;
312
+ headers: Headers;
313
+ status: 400 | 401 | 403 | 404 | 500 | 503;
314
+ };
315
+ /**
316
+ * Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Third-party applications connecting to Qlik Cloud can then have the same client ID for all Qlik Cloud tenants.
317
+ *
318
+ * @param id The unique identifier for the OAuth client
319
+ * @throws PublishOAuthClientHttpError
320
+ */
321
+ declare const publishOAuthClient: (id: string, options?: ApiCallOptions) => Promise<PublishOAuthClientHttpResponse>;
322
+ type PublishOAuthClientHttpResponse = {
323
+ data: OAuthClientPublishResponse;
324
+ headers: Headers;
325
+ status: 201;
326
+ };
327
+ type PublishOAuthClientHttpError = {
328
+ data: ErrorResponse;
329
+ headers: Headers;
330
+ status: 400 | 401 | 403 | 404 | 500 | 503;
331
+ };
332
+ /**
333
+ * Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time.
334
+ *
335
+ * @param id The unique identifier for the OAuth client
336
+ * @throws CreateOAuthClientSecretHttpError
337
+ */
338
+ declare const createOAuthClientSecret: (id: string, options?: ApiCallOptions) => Promise<CreateOAuthClientSecretHttpResponse>;
339
+ type CreateOAuthClientSecretHttpResponse = {
340
+ data: OAuthClientSecretResponse;
341
+ headers: Headers;
342
+ status: 201;
343
+ };
344
+ type CreateOAuthClientSecretHttpError = {
345
+ data: ErrorResponse;
346
+ headers: Headers;
347
+ status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
348
+ };
349
+ /**
350
+ * Deletes a specific client secret for an OAuth client.
351
+ *
352
+ * @param id The unique identifier for the OAuth client
353
+ * @param hint The unique identifier for the OAuth secret
354
+ * @throws DeleteOAuthClientSecretHttpError
355
+ */
356
+ declare const deleteOAuthClientSecret: (id: string, hint: string, options?: ApiCallOptions) => Promise<DeleteOAuthClientSecretHttpResponse>;
357
+ type DeleteOAuthClientSecretHttpResponse = {
358
+ data: void;
359
+ headers: Headers;
360
+ status: 204;
361
+ };
362
+ type DeleteOAuthClientSecretHttpError = {
363
+ data: ErrorResponse;
364
+ headers: Headers;
365
+ status: 400 | 401 | 403 | 404 | 500 | 503;
366
+ };
367
+ /**
368
+ * Deletes the connection config for the calling tenant, related to the supplied client id.
369
+ *
370
+ * @param id The unique identifier for the OAuth client
371
+ * @throws DeleteOAuthClientConnectionConfigHttpError
372
+ */
373
+ declare const deleteOAuthClientConnectionConfig: (id: string, options?: ApiCallOptions) => Promise<DeleteOAuthClientConnectionConfigHttpResponse>;
374
+ type DeleteOAuthClientConnectionConfigHttpResponse = {
375
+ data: void;
376
+ headers: Headers;
377
+ status: 204;
378
+ };
379
+ type DeleteOAuthClientConnectionConfigHttpError = {
380
+ data: ErrorResponse;
381
+ headers: Headers;
382
+ status: 400 | 401 | 403 | 404 | 500 | 503;
383
+ };
384
+ /**
385
+ * Get configuration for consent method and status.
386
+ *
387
+ * @param id The unique identifier for an OAuth client
388
+ * @throws GetOAuthClientConnectionConfigHttpError
389
+ */
390
+ declare const getOAuthClientConnectionConfig: (id: string, options?: ApiCallOptions) => Promise<GetOAuthClientConnectionConfigHttpResponse>;
391
+ type GetOAuthClientConnectionConfigHttpResponse = {
392
+ data: ConnectionConfigReadResponse;
393
+ headers: Headers;
394
+ status: 200;
395
+ };
396
+ type GetOAuthClientConnectionConfigHttpError = {
397
+ data: ErrorResponse;
398
+ headers: Headers;
399
+ status: 400 | 401 | 403 | 404 | 500 | 503;
400
+ };
401
+ /**
402
+ * Updates the consent method for the specified OAuth client.
403
+ *
404
+ * @param id The unique identifier for the OAuth client
405
+ * @param body an object with the body content
406
+ * @throws PatchOAuthClientConnectionConfigHttpError
407
+ */
408
+ declare const patchOAuthClientConnectionConfig: (id: string, body: OAuthConnectionConfigUpdate[], options?: ApiCallOptions) => Promise<PatchOAuthClientConnectionConfigHttpResponse>;
409
+ type PatchOAuthClientConnectionConfigHttpResponse = {
410
+ data: void;
411
+ headers: Headers;
412
+ status: 204;
413
+ };
414
+ type PatchOAuthClientConnectionConfigHttpError = {
415
+ data: ErrorResponse;
416
+ headers: Headers;
417
+ status: 400 | 401 | 403 | 404 | 500 | 503;
418
+ };
419
+ /**
420
+ * Clears the cache for oauth-clients api requests.
421
+ */
422
+ declare function clearCache(): void;
423
+ interface OauthClientsAPI {
424
+ /**
425
+ * Retrieve all OAuth clients.
426
+ * @example
427
+ * getOAuthClients(
428
+ * {
429
+ * filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
430
+ * totalResults: true
431
+ * }
432
+ * )
433
+ *
434
+ * @param query an object with query parameters
435
+ * @throws GetOAuthClientsHttpError
436
+ */
437
+ getOAuthClients: typeof getOAuthClients;
438
+ /**
439
+ * Create a new OAuth client. Requires `TenantAdmin` role when created in-tenant. `appType` cannot be changed after creation. Consent method and published state can be changed after creation. For supported `appType`, use `PATCH /oauth-clients/{id}/connection-configs/me` to change consent method, and `POST /oauth-clients/{id}/actions/publish` to change the client to published after creation.
440
+ *
441
+ * @param body an object with the body content
442
+ * @throws CreateOAuthClientHttpError
443
+ */
444
+ createOAuthClient: typeof createOAuthClient;
445
+ /**
446
+ * Delete the specified OAuth client.
447
+ *
448
+ * @param id The unique identifier for the OAuth client
449
+ * @throws DeleteOAuthClientHttpError
450
+ */
451
+ deleteOAuthClient: typeof deleteOAuthClient;
452
+ /**
453
+ * Retrieves the specified OAuth client.
454
+ *
455
+ * @param id The unique identifier for the OAuth client
456
+ * @throws GetOAuthClientHttpError
457
+ */
458
+ getOAuthClient: typeof getOAuthClient;
459
+ /**
460
+ * Updates the specified OAuth client.
461
+ *
462
+ * @param id The unique identifier for the OAuth client
463
+ * @param body an object with the body content
464
+ * @throws PatchOAuthClientHttpError
465
+ */
466
+ patchOAuthClient: typeof patchOAuthClient;
467
+ /**
468
+ * Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Third-party applications connecting to Qlik Cloud can then have the same client ID for all Qlik Cloud tenants.
469
+ *
470
+ * @param id The unique identifier for the OAuth client
471
+ * @throws PublishOAuthClientHttpError
472
+ */
473
+ publishOAuthClient: typeof publishOAuthClient;
474
+ /**
475
+ * Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time.
476
+ *
477
+ * @param id The unique identifier for the OAuth client
478
+ * @throws CreateOAuthClientSecretHttpError
479
+ */
480
+ createOAuthClientSecret: typeof createOAuthClientSecret;
481
+ /**
482
+ * Deletes a specific client secret for an OAuth client.
483
+ *
484
+ * @param id The unique identifier for the OAuth client
485
+ * @param hint The unique identifier for the OAuth secret
486
+ * @throws DeleteOAuthClientSecretHttpError
487
+ */
488
+ deleteOAuthClientSecret: typeof deleteOAuthClientSecret;
489
+ /**
490
+ * Deletes the connection config for the calling tenant, related to the supplied client id.
491
+ *
492
+ * @param id The unique identifier for the OAuth client
493
+ * @throws DeleteOAuthClientConnectionConfigHttpError
494
+ */
495
+ deleteOAuthClientConnectionConfig: typeof deleteOAuthClientConnectionConfig;
496
+ /**
497
+ * Get configuration for consent method and status.
498
+ *
499
+ * @param id The unique identifier for an OAuth client
500
+ * @throws GetOAuthClientConnectionConfigHttpError
501
+ */
502
+ getOAuthClientConnectionConfig: typeof getOAuthClientConnectionConfig;
503
+ /**
504
+ * Updates the consent method for the specified OAuth client.
505
+ *
506
+ * @param id The unique identifier for the OAuth client
507
+ * @param body an object with the body content
508
+ * @throws PatchOAuthClientConnectionConfigHttpError
509
+ */
510
+ patchOAuthClientConnectionConfig: typeof patchOAuthClientConnectionConfig;
511
+ /**
512
+ * Clears the cache for oauth-clients api requests.
513
+ */
514
+ clearCache: typeof clearCache;
515
+ }
516
+ /**
517
+ * Functions for the oauth-clients api
518
+ */
519
+ declare const oauthClientsExport: OauthClientsAPI;
520
+
521
+ export { type ClientSecrets, type ConnectionConfigReadResponse, type CreateOAuthClientHttpError, type CreateOAuthClientHttpResponse, type CreateOAuthClientSecretHttpError, type CreateOAuthClientSecretHttpResponse, type DeleteOAuthClientConnectionConfigHttpError, type DeleteOAuthClientConnectionConfigHttpResponse, type DeleteOAuthClientHttpError, type DeleteOAuthClientHttpResponse, type DeleteOAuthClientSecretHttpError, type DeleteOAuthClientSecretHttpResponse, type Error, type ErrorResponse, type GetOAuthClientConnectionConfigHttpError, type GetOAuthClientConnectionConfigHttpResponse, type GetOAuthClientHttpError, type GetOAuthClientHttpResponse, type GetOAuthClientsHttpError, type GetOAuthClientsHttpResponse, type Link, type Links, type OAuthClientAdminListItem, type OAuthClientAdminListResponse, type OAuthClientAdminReadResponse, type OAuthClientBase, type OAuthClientCreateRequest, type OAuthClientCreateResponse, type OAuthClientListResponse, type OAuthClientPublishResponse, type OAuthClientReadResponse, type OAuthClientSecretResponse, type OAuthClientUpdate, type OAuthConnectionConfigUpdate, type OauthClientsAPI, type PatchOAuthClientConnectionConfigHttpError, type PatchOAuthClientConnectionConfigHttpResponse, type PatchOAuthClientHttpError, type PatchOAuthClientHttpResponse, type PublishOAuthClientHttpError, type PublishOAuthClientHttpResponse, clearCache, createOAuthClient, createOAuthClientSecret, oauthClientsExport as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };