@katerai/sdk 0.6.0 → 0.7.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.
- package/CHANGELOG.md +23 -0
- package/README.md +23 -16
- package/client.d.mts +10 -13
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -13
- package/client.d.ts.map +1 -1
- package/client.js +37 -15
- package/client.js.map +1 -1
- package/client.mjs +37 -15
- package/client.mjs.map +1 -1
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js +2 -1
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +2 -1
- package/internal/utils/log.mjs.map +1 -1
- package/package.json +2 -2
- package/resources/index.d.mts +0 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +0 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +1 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -2
- package/resources/index.mjs.map +1 -1
- package/resources/v1/connections.d.mts +216 -1
- package/resources/v1/connections.d.mts.map +1 -1
- package/resources/v1/connections.d.ts +216 -1
- package/resources/v1/connections.d.ts.map +1 -1
- package/resources/v1/connections.js +22 -2
- package/resources/v1/connections.js.map +1 -1
- package/resources/v1/connections.mjs +20 -1
- package/resources/v1/connections.mjs.map +1 -1
- package/resources/v1/index.d.mts +2 -6
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +2 -6
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +5 -13
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +2 -6
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/tenants.d.mts +125 -1
- package/resources/v1/tenants.d.mts.map +1 -1
- package/resources/v1/tenants.d.ts +125 -1
- package/resources/v1/tenants.d.ts.map +1 -1
- package/resources/v1/tenants.js +46 -2
- package/resources/v1/tenants.js.map +1 -1
- package/resources/v1/tenants.mjs +44 -1
- package/resources/v1/tenants.mjs.map +1 -1
- package/resources/v1/v1.d.mts +6 -22
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +6 -22
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -20
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -20
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +48 -23
- package/src/internal/utils/log.ts +1 -0
- package/src/resources/index.ts +0 -2
- package/src/resources/v1/connections.ts +277 -1
- package/src/resources/v1/index.ts +7 -44
- package/src/resources/v1/tenants.ts +162 -1
- package/src/resources/v1/v1.ts +14 -104
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/healthz.d.mts +0 -16
- package/resources/healthz.d.mts.map +0 -1
- package/resources/healthz.d.ts +0 -16
- package/resources/healthz.d.ts.map +0 -1
- package/resources/healthz.js +0 -15
- package/resources/healthz.js.map +0 -1
- package/resources/healthz.mjs +0 -11
- package/resources/healthz.mjs.map +0 -1
- package/resources/readyz.d.mts +0 -16
- package/resources/readyz.d.mts.map +0 -1
- package/resources/readyz.d.ts +0 -16
- package/resources/readyz.d.ts.map +0 -1
- package/resources/readyz.js +0 -15
- package/resources/readyz.js.map +0 -1
- package/resources/readyz.mjs +0 -11
- package/resources/readyz.mjs.map +0 -1
- package/resources/v1/connections/connections.d.mts +0 -1470
- package/resources/v1/connections/connections.d.mts.map +0 -1
- package/resources/v1/connections/connections.d.ts +0 -1470
- package/resources/v1/connections/connections.d.ts.map +0 -1
- package/resources/v1/connections/connections.js +0 -163
- package/resources/v1/connections/connections.js.map +0 -1
- package/resources/v1/connections/connections.mjs +0 -158
- package/resources/v1/connections/connections.mjs.map +0 -1
- package/resources/v1/connections/databases.d.mts +0 -25
- package/resources/v1/connections/databases.d.mts.map +0 -1
- package/resources/v1/connections/databases.d.ts +0 -25
- package/resources/v1/connections/databases.d.ts.map +0 -1
- package/resources/v1/connections/databases.js +0 -26
- package/resources/v1/connections/databases.js.map +0 -1
- package/resources/v1/connections/databases.mjs +0 -22
- package/resources/v1/connections/databases.mjs.map +0 -1
- package/resources/v1/connections/index.d.mts +0 -5
- package/resources/v1/connections/index.d.mts.map +0 -1
- package/resources/v1/connections/index.d.ts +0 -5
- package/resources/v1/connections/index.d.ts.map +0 -1
- package/resources/v1/connections/index.js +0 -13
- package/resources/v1/connections/index.js.map +0 -1
- package/resources/v1/connections/index.mjs +0 -6
- package/resources/v1/connections/index.mjs.map +0 -1
- package/resources/v1/connections/views.d.mts +0 -77
- package/resources/v1/connections/views.d.mts.map +0 -1
- package/resources/v1/connections/views.d.ts +0 -77
- package/resources/v1/connections/views.d.ts.map +0 -1
- package/resources/v1/connections/views.js +0 -24
- package/resources/v1/connections/views.js.map +0 -1
- package/resources/v1/connections/views.mjs +0 -20
- package/resources/v1/connections/views.mjs.map +0 -1
- package/resources/v1/connections/yaml.d.mts +0 -57
- package/resources/v1/connections/yaml.d.mts.map +0 -1
- package/resources/v1/connections/yaml.d.ts +0 -57
- package/resources/v1/connections/yaml.d.ts.map +0 -1
- package/resources/v1/connections/yaml.js +0 -22
- package/resources/v1/connections/yaml.js.map +0 -1
- package/resources/v1/connections/yaml.mjs +0 -18
- package/resources/v1/connections/yaml.mjs.map +0 -1
- package/resources/v1/github/github.d.mts +0 -99
- package/resources/v1/github/github.d.mts.map +0 -1
- package/resources/v1/github/github.d.ts +0 -99
- package/resources/v1/github/github.d.ts.map +0 -1
- package/resources/v1/github/github.js +0 -49
- package/resources/v1/github/github.js.map +0 -1
- package/resources/v1/github/github.mjs +0 -44
- package/resources/v1/github/github.mjs.map +0 -1
- package/resources/v1/github/index.d.mts +0 -5
- package/resources/v1/github/index.d.mts.map +0 -1
- package/resources/v1/github/index.d.ts +0 -5
- package/resources/v1/github/index.d.ts.map +0 -1
- package/resources/v1/github/index.js +0 -13
- package/resources/v1/github/index.js.map +0 -1
- package/resources/v1/github/index.mjs +0 -6
- package/resources/v1/github/index.mjs.map +0 -1
- package/resources/v1/github/repos.d.mts +0 -54
- package/resources/v1/github/repos.d.mts.map +0 -1
- package/resources/v1/github/repos.d.ts +0 -54
- package/resources/v1/github/repos.d.ts.map +0 -1
- package/resources/v1/github/repos.js +0 -22
- package/resources/v1/github/repos.js.map +0 -1
- package/resources/v1/github/repos.mjs +0 -18
- package/resources/v1/github/repos.mjs.map +0 -1
- package/resources/v1/github/scaffold.d.mts +0 -29
- package/resources/v1/github/scaffold.d.mts.map +0 -1
- package/resources/v1/github/scaffold.d.ts +0 -29
- package/resources/v1/github/scaffold.d.ts.map +0 -1
- package/resources/v1/github/scaffold.js +0 -21
- package/resources/v1/github/scaffold.js.map +0 -1
- package/resources/v1/github/scaffold.mjs +0 -17
- package/resources/v1/github/scaffold.mjs.map +0 -1
- package/resources/v1/github/webhooks.d.mts +0 -28
- package/resources/v1/github/webhooks.d.mts.map +0 -1
- package/resources/v1/github/webhooks.d.ts +0 -28
- package/resources/v1/github/webhooks.d.ts.map +0 -1
- package/resources/v1/github/webhooks.js +0 -27
- package/resources/v1/github/webhooks.js.map +0 -1
- package/resources/v1/github/webhooks.mjs +0 -23
- package/resources/v1/github/webhooks.mjs.map +0 -1
- package/resources/v1/github.d.mts +0 -2
- package/resources/v1/github.d.mts.map +0 -1
- package/resources/v1/github.d.ts +0 -2
- package/resources/v1/github.d.ts.map +0 -1
- package/resources/v1/github.js +0 -6
- package/resources/v1/github.js.map +0 -1
- package/resources/v1/github.mjs +0 -3
- package/resources/v1/github.mjs.map +0 -1
- package/resources/v1/groups/groups.d.mts +0 -162
- package/resources/v1/groups/groups.d.mts.map +0 -1
- package/resources/v1/groups/groups.d.ts +0 -162
- package/resources/v1/groups/groups.d.ts.map +0 -1
- package/resources/v1/groups/groups.js +0 -81
- package/resources/v1/groups/groups.js.map +0 -1
- package/resources/v1/groups/groups.mjs +0 -76
- package/resources/v1/groups/groups.mjs.map +0 -1
- package/resources/v1/groups/index.d.mts +0 -3
- package/resources/v1/groups/index.d.mts.map +0 -1
- package/resources/v1/groups/index.d.ts +0 -3
- package/resources/v1/groups/index.d.ts.map +0 -1
- package/resources/v1/groups/index.js +0 -9
- package/resources/v1/groups/index.js.map +0 -1
- package/resources/v1/groups/index.mjs +0 -4
- package/resources/v1/groups/index.mjs.map +0 -1
- package/resources/v1/groups/tenants.d.mts +0 -55
- package/resources/v1/groups/tenants.d.mts.map +0 -1
- package/resources/v1/groups/tenants.d.ts +0 -55
- package/resources/v1/groups/tenants.d.ts.map +0 -1
- package/resources/v1/groups/tenants.js +0 -39
- package/resources/v1/groups/tenants.js.map +0 -1
- package/resources/v1/groups/tenants.mjs +0 -35
- package/resources/v1/groups/tenants.mjs.map +0 -1
- package/resources/v1/groups.d.mts +0 -2
- package/resources/v1/groups.d.mts.map +0 -1
- package/resources/v1/groups.d.ts +0 -2
- package/resources/v1/groups.d.ts.map +0 -1
- package/resources/v1/groups.js +0 -6
- package/resources/v1/groups.js.map +0 -1
- package/resources/v1/groups.mjs +0 -3
- package/resources/v1/groups.mjs.map +0 -1
- package/resources/v1/me.d.mts +0 -43
- package/resources/v1/me.d.mts.map +0 -1
- package/resources/v1/me.d.ts +0 -43
- package/resources/v1/me.d.ts.map +0 -1
- package/resources/v1/me.js +0 -20
- package/resources/v1/me.js.map +0 -1
- package/resources/v1/me.mjs +0 -16
- package/resources/v1/me.mjs.map +0 -1
- package/resources/v1/org/client.d.mts +0 -53
- package/resources/v1/org/client.d.mts.map +0 -1
- package/resources/v1/org/client.d.ts +0 -53
- package/resources/v1/org/client.d.ts.map +0 -1
- package/resources/v1/org/client.js +0 -25
- package/resources/v1/org/client.js.map +0 -1
- package/resources/v1/org/client.mjs +0 -21
- package/resources/v1/org/client.mjs.map +0 -1
- package/resources/v1/org/index.d.mts +0 -4
- package/resources/v1/org/index.d.mts.map +0 -1
- package/resources/v1/org/index.d.ts +0 -4
- package/resources/v1/org/index.d.ts.map +0 -1
- package/resources/v1/org/index.js +0 -11
- package/resources/v1/org/index.js.map +0 -1
- package/resources/v1/org/index.mjs +0 -5
- package/resources/v1/org/index.mjs.map +0 -1
- package/resources/v1/org/org.d.mts +0 -14
- package/resources/v1/org/org.d.mts.map +0 -1
- package/resources/v1/org/org.d.ts +0 -14
- package/resources/v1/org/org.d.ts.map +0 -1
- package/resources/v1/org/org.js +0 -21
- package/resources/v1/org/org.js.map +0 -1
- package/resources/v1/org/org.mjs +0 -16
- package/resources/v1/org/org.mjs.map +0 -1
- package/resources/v1/org/users.d.mts +0 -87
- package/resources/v1/org/users.d.mts.map +0 -1
- package/resources/v1/org/users.d.ts +0 -87
- package/resources/v1/org/users.d.ts.map +0 -1
- package/resources/v1/org/users.js +0 -60
- package/resources/v1/org/users.js.map +0 -1
- package/resources/v1/org/users.mjs +0 -56
- package/resources/v1/org/users.mjs.map +0 -1
- package/resources/v1/org.d.mts +0 -2
- package/resources/v1/org.d.mts.map +0 -1
- package/resources/v1/org.d.ts +0 -2
- package/resources/v1/org.d.ts.map +0 -1
- package/resources/v1/org.js +0 -6
- package/resources/v1/org.js.map +0 -1
- package/resources/v1/org.mjs +0 -3
- package/resources/v1/org.mjs.map +0 -1
- package/resources/v1/tenants/batch.d.mts +0 -159
- package/resources/v1/tenants/batch.d.mts.map +0 -1
- package/resources/v1/tenants/batch.d.ts +0 -159
- package/resources/v1/tenants/batch.d.ts.map +0 -1
- package/resources/v1/tenants/batch.js +0 -42
- package/resources/v1/tenants/batch.js.map +0 -1
- package/resources/v1/tenants/batch.mjs +0 -38
- package/resources/v1/tenants/batch.mjs.map +0 -1
- package/resources/v1/tenants/groups.d.mts +0 -43
- package/resources/v1/tenants/groups.d.mts.map +0 -1
- package/resources/v1/tenants/groups.d.ts +0 -43
- package/resources/v1/tenants/groups.d.ts.map +0 -1
- package/resources/v1/tenants/groups.js +0 -20
- package/resources/v1/tenants/groups.js.map +0 -1
- package/resources/v1/tenants/groups.mjs +0 -16
- package/resources/v1/tenants/groups.mjs.map +0 -1
- package/resources/v1/tenants/import.d.mts +0 -126
- package/resources/v1/tenants/import.d.mts.map +0 -1
- package/resources/v1/tenants/import.d.ts +0 -126
- package/resources/v1/tenants/import.d.ts.map +0 -1
- package/resources/v1/tenants/import.js +0 -50
- package/resources/v1/tenants/import.js.map +0 -1
- package/resources/v1/tenants/import.mjs +0 -46
- package/resources/v1/tenants/import.mjs.map +0 -1
- package/resources/v1/tenants/index.d.mts +0 -5
- package/resources/v1/tenants/index.d.mts.map +0 -1
- package/resources/v1/tenants/index.d.ts +0 -5
- package/resources/v1/tenants/index.d.ts.map +0 -1
- package/resources/v1/tenants/index.js +0 -13
- package/resources/v1/tenants/index.js.map +0 -1
- package/resources/v1/tenants/index.mjs +0 -6
- package/resources/v1/tenants/index.mjs.map +0 -1
- package/resources/v1/tenants/tenants.d.mts +0 -248
- package/resources/v1/tenants/tenants.d.mts.map +0 -1
- package/resources/v1/tenants/tenants.d.ts +0 -248
- package/resources/v1/tenants/tenants.d.ts.map +0 -1
- package/resources/v1/tenants/tenants.js +0 -113
- package/resources/v1/tenants/tenants.js.map +0 -1
- package/resources/v1/tenants/tenants.mjs +0 -108
- package/resources/v1/tenants/tenants.mjs.map +0 -1
- package/src/resources/healthz.ts +0 -20
- package/src/resources/readyz.ts +0 -20
- package/src/resources/v1/connections/connections.ts +0 -1905
- package/src/resources/v1/connections/databases.ts +0 -42
- package/src/resources/v1/connections/index.ts +0 -33
- package/src/resources/v1/connections/views.ts +0 -112
- package/src/resources/v1/connections/yaml.ts +0 -81
- package/src/resources/v1/github/github.ts +0 -165
- package/src/resources/v1/github/index.ts +0 -20
- package/src/resources/v1/github/repos.ts +0 -85
- package/src/resources/v1/github/scaffold.ts +0 -44
- package/src/resources/v1/github/webhooks.ts +0 -60
- package/src/resources/v1/github.ts +0 -3
- package/src/resources/v1/groups/groups.ts +0 -218
- package/src/resources/v1/groups/index.ts +0 -10
- package/src/resources/v1/groups/tenants.ts +0 -78
- package/src/resources/v1/groups.ts +0 -3
- package/src/resources/v1/me.ts +0 -62
- package/src/resources/v1/org/client.ts +0 -81
- package/src/resources/v1/org/index.ts +0 -11
- package/src/resources/v1/org/org.ts +0 -32
- package/src/resources/v1/org/users.ts +0 -127
- package/src/resources/v1/org.ts +0 -3
- package/src/resources/v1/tenants/batch.ts +0 -200
- package/src/resources/v1/tenants/groups.ts +0 -52
- package/src/resources/v1/tenants/import.ts +0 -158
- package/src/resources/v1/tenants/index.ts +0 -29
- package/src/resources/v1/tenants/tenants.ts +0 -344
|
@@ -1,344 +0,0 @@
|
|
|
1
|
-
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
3
|
-
import { APIResource } from '../../../core/resource';
|
|
4
|
-
import * as BatchAPI from './batch';
|
|
5
|
-
import {
|
|
6
|
-
Batch,
|
|
7
|
-
BatchCreateParams,
|
|
8
|
-
BatchCreateResponse,
|
|
9
|
-
BatchDeleteParams,
|
|
10
|
-
BatchDeleteResponse,
|
|
11
|
-
BatchTenantError,
|
|
12
|
-
BatchTenantSuccess,
|
|
13
|
-
BatchUpdateParams,
|
|
14
|
-
BatchUpdateResponse,
|
|
15
|
-
} from './batch';
|
|
16
|
-
import * as GroupsAPI from './groups';
|
|
17
|
-
import { GroupRetrieveSchemaResponse, Groups } from './groups';
|
|
18
|
-
import * as ImportAPI from './import';
|
|
19
|
-
import { Import, ImportFromCsvParams, ImportFromWarehouseParams, ImportTenants } from './import';
|
|
20
|
-
import { APIPromise } from '../../../core/api-promise';
|
|
21
|
-
import { buildHeaders } from '../../../internal/headers';
|
|
22
|
-
import { RequestOptions } from '../../../internal/request-options';
|
|
23
|
-
import { path } from '../../../internal/utils/path';
|
|
24
|
-
|
|
25
|
-
export class Tenants extends APIResource {
|
|
26
|
-
batch: BatchAPI.Batch = new BatchAPI.Batch(this._client);
|
|
27
|
-
import: ImportAPI.Import = new ImportAPI.Import(this._client);
|
|
28
|
-
groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* Create a new tenant.
|
|
32
|
-
*
|
|
33
|
-
* Validates the client's tenancy type and creates the tenant accordingly:
|
|
34
|
-
*
|
|
35
|
-
* - ROW tenancy: Creates tenant with optional group associations
|
|
36
|
-
* - DATABASE tenancy: Requires database_name, creates tenant with database
|
|
37
|
-
* association
|
|
38
|
-
* - NONE tenancy: Returns error (tenant creation not allowed)
|
|
39
|
-
*
|
|
40
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
41
|
-
*/
|
|
42
|
-
create(body: TenantCreateParams, options?: RequestOptions): APIPromise<Tenant> {
|
|
43
|
-
return this._client.post('/api/v1/tenants', { body, ...options });
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Get a single tenant by ID.
|
|
48
|
-
*
|
|
49
|
-
* Returns the tenant with associated groups and databases.
|
|
50
|
-
*
|
|
51
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
52
|
-
*
|
|
53
|
-
* Raises: TenantNotFoundError: If tenant doesn't exist (404)
|
|
54
|
-
*/
|
|
55
|
-
retrieve(tenantID: string, options?: RequestOptions): APIPromise<Tenant> {
|
|
56
|
-
return this._client.get(path`/api/v1/tenants/${tenantID}`, options);
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Update a tenant.
|
|
61
|
-
*
|
|
62
|
-
* Updates tenant metadata, group associations, and/or database associations. Group
|
|
63
|
-
* associations use replace semantics:
|
|
64
|
-
*
|
|
65
|
-
* - Omit group_names to leave existing associations unchanged
|
|
66
|
-
* - Pass empty list to remove all group associations
|
|
67
|
-
* - Pass list of names to replace all associations
|
|
68
|
-
*
|
|
69
|
-
* Database associations (DATABASE tenancy only):
|
|
70
|
-
*
|
|
71
|
-
* - Both connection_id and database_name must be provided together
|
|
72
|
-
* - Replaces existing database association
|
|
73
|
-
*
|
|
74
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
75
|
-
*
|
|
76
|
-
* Raises: TenantNotFoundError: If tenant doesn't exist (404)
|
|
77
|
-
*/
|
|
78
|
-
update(tenantID: string, body: TenantUpdateParams, options?: RequestOptions): APIPromise<Tenant> {
|
|
79
|
-
return this._client.patch(path`/api/v1/tenants/${tenantID}`, { body, ...options });
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* List all tenants for the client.
|
|
84
|
-
*
|
|
85
|
-
* Returns tenants with their associated groups and databases.
|
|
86
|
-
*
|
|
87
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
88
|
-
*/
|
|
89
|
-
list(options?: RequestOptions): APIPromise<TenantListResponse> {
|
|
90
|
-
return this._client.get('/api/v1/tenants', options);
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
* Delete a tenant.
|
|
95
|
-
*
|
|
96
|
-
* Soft-deletes the tenant and its group/database associations.
|
|
97
|
-
*
|
|
98
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
99
|
-
*
|
|
100
|
-
* Raises: TenantNotFoundError: If tenant doesn't exist (404)
|
|
101
|
-
*/
|
|
102
|
-
delete(tenantID: string, options?: RequestOptions): APIPromise<void> {
|
|
103
|
-
return this._client.delete(path`/api/v1/tenants/${tenantID}`, {
|
|
104
|
-
...options,
|
|
105
|
-
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Get all tenants as a TenantSchema object.
|
|
111
|
-
*
|
|
112
|
-
* Returns tenants in the YAML-compatible schema format with group references.
|
|
113
|
-
* Supports content negotiation: JSON by default, YAML with Accept:
|
|
114
|
-
* application/yaml.
|
|
115
|
-
*
|
|
116
|
-
* RLS: Filtered to current client (ClientRLSDB).
|
|
117
|
-
*/
|
|
118
|
-
retrieveSchema(options?: RequestOptions): APIPromise<TenantRetrieveSchemaResponse> {
|
|
119
|
-
return this._client.get('/api/v1/tenants/schema', options);
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* Request model for creating a single tenant.
|
|
125
|
-
*/
|
|
126
|
-
export interface CreateTenant {
|
|
127
|
-
/**
|
|
128
|
-
* Unique tenant identifier within the client
|
|
129
|
-
*/
|
|
130
|
-
tenant_key: string;
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* Connection ID (required for DATABASE tenancy type)
|
|
134
|
-
*/
|
|
135
|
-
connection_id?: string | null;
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Database name (required for DATABASE tenancy type)
|
|
139
|
-
*/
|
|
140
|
-
database_name?: string | null;
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* List of group names to associate with the tenant
|
|
144
|
-
*/
|
|
145
|
-
group_names?: Array<string> | null;
|
|
146
|
-
|
|
147
|
-
/**
|
|
148
|
-
* Human-readable tenant name
|
|
149
|
-
*/
|
|
150
|
-
tenant_name?: string | null;
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* Response model for a single tenant.
|
|
155
|
-
*/
|
|
156
|
-
export interface Tenant {
|
|
157
|
-
/**
|
|
158
|
-
* Tenant ID
|
|
159
|
-
*/
|
|
160
|
-
id: string;
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Creation timestamp
|
|
164
|
-
*/
|
|
165
|
-
created_at: string;
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
* Associated databases
|
|
169
|
-
*/
|
|
170
|
-
databases: Array<Tenant.Database>;
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* Associated groups
|
|
174
|
-
*/
|
|
175
|
-
groups: Array<Tenant.Group>;
|
|
176
|
-
|
|
177
|
-
/**
|
|
178
|
-
* Human-readable tenant name
|
|
179
|
-
*/
|
|
180
|
-
name: string | null;
|
|
181
|
-
|
|
182
|
-
/**
|
|
183
|
-
* Unique tenant identifier
|
|
184
|
-
*/
|
|
185
|
-
tenant_key: string;
|
|
186
|
-
|
|
187
|
-
/**
|
|
188
|
-
* Last update timestamp
|
|
189
|
-
*/
|
|
190
|
-
updated_at: string;
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
export namespace Tenant {
|
|
194
|
-
/**
|
|
195
|
-
* Database information in tenant responses.
|
|
196
|
-
*/
|
|
197
|
-
export interface Database {
|
|
198
|
-
/**
|
|
199
|
-
* Database ID
|
|
200
|
-
*/
|
|
201
|
-
id: string;
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* Database name
|
|
205
|
-
*/
|
|
206
|
-
name: string;
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Group information in tenant responses.
|
|
211
|
-
*/
|
|
212
|
-
export interface Group {
|
|
213
|
-
/**
|
|
214
|
-
* Group ID
|
|
215
|
-
*/
|
|
216
|
-
id: string;
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* Group name
|
|
220
|
-
*/
|
|
221
|
-
name: string;
|
|
222
|
-
}
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
export type TenantListResponse = Array<Tenant>;
|
|
226
|
-
|
|
227
|
-
/**
|
|
228
|
-
* Schema for tenant configuration files
|
|
229
|
-
*/
|
|
230
|
-
export interface TenantRetrieveSchemaResponse {
|
|
231
|
-
/**
|
|
232
|
-
* Array of tenant configurations
|
|
233
|
-
*/
|
|
234
|
-
tenants: Array<TenantRetrieveSchemaResponse.Tenant>;
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
export namespace TenantRetrieveSchemaResponse {
|
|
238
|
-
export interface Tenant {
|
|
239
|
-
/**
|
|
240
|
-
* Unique Kater identifier
|
|
241
|
-
*/
|
|
242
|
-
kater_id: string;
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* Unique key identifier for the tenant (e.g., 'acme_corp')
|
|
246
|
-
*/
|
|
247
|
-
tenant_key: string;
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
* References to tenant groups this tenant belongs to
|
|
251
|
-
*/
|
|
252
|
-
groups?: Array<string> | null;
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
* Human-readable display name for the tenant
|
|
256
|
-
*/
|
|
257
|
-
name?: string | null;
|
|
258
|
-
}
|
|
259
|
-
}
|
|
260
|
-
|
|
261
|
-
export interface TenantCreateParams {
|
|
262
|
-
/**
|
|
263
|
-
* Unique tenant identifier within the client
|
|
264
|
-
*/
|
|
265
|
-
tenant_key: string;
|
|
266
|
-
|
|
267
|
-
/**
|
|
268
|
-
* Connection ID (required for DATABASE tenancy type)
|
|
269
|
-
*/
|
|
270
|
-
connection_id?: string | null;
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Database name (required for DATABASE tenancy type)
|
|
274
|
-
*/
|
|
275
|
-
database_name?: string | null;
|
|
276
|
-
|
|
277
|
-
/**
|
|
278
|
-
* List of group names to associate with the tenant
|
|
279
|
-
*/
|
|
280
|
-
group_names?: Array<string> | null;
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
* Human-readable tenant name
|
|
284
|
-
*/
|
|
285
|
-
tenant_name?: string | null;
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
export interface TenantUpdateParams {
|
|
289
|
-
/**
|
|
290
|
-
* Connection ID for database association (required with database_name)
|
|
291
|
-
*/
|
|
292
|
-
connection_id?: string | null;
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
* Database name for association (required with connection_id)
|
|
296
|
-
*/
|
|
297
|
-
database_name?: string | null;
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* New list of group names (replaces all existing associations)
|
|
301
|
-
*/
|
|
302
|
-
group_names?: Array<string> | null;
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* New human-readable tenant name
|
|
306
|
-
*/
|
|
307
|
-
tenant_name?: string | null;
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
Tenants.Batch = Batch;
|
|
311
|
-
Tenants.Import = Import;
|
|
312
|
-
Tenants.Groups = Groups;
|
|
313
|
-
|
|
314
|
-
export declare namespace Tenants {
|
|
315
|
-
export {
|
|
316
|
-
type CreateTenant as CreateTenant,
|
|
317
|
-
type Tenant as Tenant,
|
|
318
|
-
type TenantListResponse as TenantListResponse,
|
|
319
|
-
type TenantRetrieveSchemaResponse as TenantRetrieveSchemaResponse,
|
|
320
|
-
type TenantCreateParams as TenantCreateParams,
|
|
321
|
-
type TenantUpdateParams as TenantUpdateParams,
|
|
322
|
-
};
|
|
323
|
-
|
|
324
|
-
export {
|
|
325
|
-
Batch as Batch,
|
|
326
|
-
type BatchTenantError as BatchTenantError,
|
|
327
|
-
type BatchTenantSuccess as BatchTenantSuccess,
|
|
328
|
-
type BatchCreateResponse as BatchCreateResponse,
|
|
329
|
-
type BatchUpdateResponse as BatchUpdateResponse,
|
|
330
|
-
type BatchDeleteResponse as BatchDeleteResponse,
|
|
331
|
-
type BatchCreateParams as BatchCreateParams,
|
|
332
|
-
type BatchUpdateParams as BatchUpdateParams,
|
|
333
|
-
type BatchDeleteParams as BatchDeleteParams,
|
|
334
|
-
};
|
|
335
|
-
|
|
336
|
-
export {
|
|
337
|
-
Import as Import,
|
|
338
|
-
type ImportTenants as ImportTenants,
|
|
339
|
-
type ImportFromCsvParams as ImportFromCsvParams,
|
|
340
|
-
type ImportFromWarehouseParams as ImportFromWarehouseParams,
|
|
341
|
-
};
|
|
342
|
-
|
|
343
|
-
export { Groups as Groups, type GroupRetrieveSchemaResponse as GroupRetrieveSchemaResponse };
|
|
344
|
-
}
|