@nirvana-labs/nirvana 1.46.2 → 1.47.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 +18 -0
- package/client.d.mts +5 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -5
- package/client.d.ts.map +1 -1
- package/client.js +12 -5
- package/client.js.map +1 -1
- package/client.mjs +12 -5
- package/client.mjs.map +1 -1
- package/internal/tslib.js +6 -6
- package/package.json +1 -1
- package/resources/api-keys/api-keys.d.mts +168 -0
- package/resources/api-keys/api-keys.d.mts.map +1 -0
- package/resources/api-keys/api-keys.d.ts +168 -0
- package/resources/api-keys/api-keys.d.ts.map +1 -0
- package/resources/api-keys/api-keys.js +76 -0
- package/resources/api-keys/api-keys.js.map +1 -0
- package/resources/api-keys/api-keys.mjs +72 -0
- package/resources/api-keys/api-keys.mjs.map +1 -0
- package/resources/api-keys/index.d.mts +2 -0
- package/resources/api-keys/index.d.mts.map +1 -0
- package/resources/api-keys/index.d.ts +2 -0
- package/resources/api-keys/index.d.ts.map +1 -0
- package/resources/api-keys/index.js +7 -0
- package/resources/api-keys/index.js.map +1 -0
- package/resources/api-keys/index.mjs +3 -0
- package/resources/api-keys/index.mjs.map +1 -0
- package/resources/api-keys.d.mts +1 -167
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +1 -167
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/api-keys.js +2 -72
- package/resources/api-keys.js.map +1 -1
- package/resources/api-keys.mjs +1 -70
- package/resources/api-keys.mjs.map +1 -1
- package/resources/compute/vms/vms.d.mts +1 -1
- package/resources/compute/vms/vms.d.mts.map +1 -1
- package/resources/compute/vms/vms.d.ts +1 -1
- package/resources/compute/vms/vms.d.ts.map +1 -1
- package/resources/compute/volumes/volumes.d.mts +1 -1
- package/resources/compute/volumes/volumes.d.mts.map +1 -1
- package/resources/compute/volumes/volumes.d.ts +1 -1
- package/resources/compute/volumes/volumes.d.ts.map +1 -1
- package/resources/networking/connect/connections.d.mts +1 -1
- package/resources/networking/connect/connections.d.mts.map +1 -1
- package/resources/networking/connect/connections.d.ts +1 -1
- package/resources/networking/connect/connections.d.ts.map +1 -1
- package/resources/networking/firewall-rules.d.mts +1 -1
- package/resources/networking/firewall-rules.d.mts.map +1 -1
- package/resources/networking/firewall-rules.d.ts +1 -1
- package/resources/networking/firewall-rules.d.ts.map +1 -1
- package/resources/networking/vpcs/vpcs.d.mts +1 -1
- package/resources/networking/vpcs/vpcs.d.mts.map +1 -1
- package/resources/networking/vpcs/vpcs.d.ts +1 -1
- package/resources/networking/vpcs/vpcs.d.ts.map +1 -1
- package/resources/operations/index.d.mts +2 -0
- package/resources/operations/index.d.mts.map +1 -0
- package/resources/operations/index.d.ts +2 -0
- package/resources/operations/index.d.ts.map +1 -0
- package/resources/operations/index.js +7 -0
- package/resources/operations/index.js.map +1 -0
- package/resources/operations/index.mjs +3 -0
- package/resources/operations/index.mjs.map +1 -0
- package/resources/operations/operations.d.mts +82 -0
- package/resources/operations/operations.d.mts.map +1 -0
- package/resources/operations/operations.d.ts +82 -0
- package/resources/operations/operations.d.ts.map +1 -0
- package/resources/operations/operations.js +23 -0
- package/resources/operations/operations.js.map +1 -0
- package/resources/operations/operations.mjs +19 -0
- package/resources/operations/operations.mjs.map +1 -0
- package/resources/operations.d.mts +1 -81
- package/resources/operations.d.mts.map +1 -1
- package/resources/operations.d.ts +1 -81
- package/resources/operations.d.ts.map +1 -1
- package/resources/operations.js +2 -19
- package/resources/operations.js.map +1 -1
- package/resources/operations.mjs +1 -17
- package/resources/operations.mjs.map +1 -1
- package/resources/organizations/index.d.mts +2 -0
- package/resources/organizations/index.d.mts.map +1 -0
- package/resources/organizations/index.d.ts +2 -0
- package/resources/organizations/index.d.ts.map +1 -0
- package/resources/organizations/index.js +7 -0
- package/resources/organizations/index.js.map +1 -0
- package/resources/organizations/index.mjs +3 -0
- package/resources/organizations/index.mjs.map +1 -0
- package/resources/organizations/organizations.d.mts +103 -0
- package/resources/organizations/organizations.d.mts.map +1 -0
- package/resources/organizations/organizations.d.ts +103 -0
- package/resources/organizations/organizations.d.ts.map +1 -0
- package/resources/organizations/organizations.js +64 -0
- package/resources/organizations/organizations.js.map +1 -0
- package/resources/organizations/organizations.mjs +60 -0
- package/resources/organizations/organizations.mjs.map +1 -0
- package/resources/organizations.d.mts +1 -102
- package/resources/organizations.d.mts.map +1 -1
- package/resources/organizations.d.ts +1 -102
- package/resources/organizations.d.ts.map +1 -1
- package/resources/organizations.js +2 -60
- package/resources/organizations.js.map +1 -1
- package/resources/organizations.mjs +1 -58
- package/resources/organizations.mjs.map +1 -1
- package/resources/projects/index.d.mts +2 -0
- package/resources/projects/index.d.mts.map +1 -0
- package/resources/projects/index.d.ts +2 -0
- package/resources/projects/index.d.ts.map +1 -0
- package/resources/projects/index.js +7 -0
- package/resources/projects/index.js.map +1 -0
- package/resources/projects/index.mjs +3 -0
- package/resources/projects/index.mjs.map +1 -0
- package/resources/projects/projects.d.mts +171 -0
- package/resources/projects/projects.d.mts.map +1 -0
- package/resources/projects/projects.d.ts +171 -0
- package/resources/projects/projects.d.ts.map +1 -0
- package/resources/projects/projects.js +75 -0
- package/resources/projects/projects.js.map +1 -0
- package/resources/projects/projects.mjs +71 -0
- package/resources/projects/projects.mjs.map +1 -0
- package/resources/projects.d.mts +1 -174
- package/resources/projects.d.mts.map +1 -1
- package/resources/projects.d.ts +1 -174
- package/resources/projects.d.ts.map +1 -1
- package/resources/projects.js +2 -71
- package/resources/projects.js.map +1 -1
- package/resources/projects.mjs +1 -69
- package/resources/projects.mjs.map +1 -1
- package/resources/regions/index.d.mts +2 -0
- package/resources/regions/index.d.mts.map +1 -0
- package/resources/regions/index.d.ts +2 -0
- package/resources/regions/index.d.ts.map +1 -0
- package/resources/regions/index.js +7 -0
- package/resources/regions/index.js.map +1 -0
- package/resources/regions/index.mjs +3 -0
- package/resources/regions/index.mjs.map +1 -0
- package/resources/regions/regions.d.mts +108 -0
- package/resources/regions/regions.d.mts.map +1 -0
- package/resources/regions/regions.d.ts +108 -0
- package/resources/regions/regions.d.ts.map +1 -0
- package/resources/regions/regions.js +36 -0
- package/resources/regions/regions.js.map +1 -0
- package/resources/regions/regions.mjs +32 -0
- package/resources/regions/regions.mjs.map +1 -0
- package/resources/regions.d.mts +1 -107
- package/resources/regions.d.mts.map +1 -1
- package/resources/regions.d.ts +1 -107
- package/resources/regions.d.ts.map +1 -1
- package/resources/regions.js +2 -32
- package/resources/regions.js.map +1 -1
- package/resources/regions.mjs +1 -30
- package/resources/regions.mjs.map +1 -1
- package/src/client.ts +13 -5
- package/src/resources/api-keys/api-keys.ts +223 -0
- package/src/resources/api-keys/api.md +14 -0
- package/src/resources/api-keys/index.ts +3 -0
- package/src/resources/api-keys.ts +1 -221
- package/src/resources/compute/api.md +68 -0
- package/src/resources/compute/vms/vms.ts +1 -1
- package/src/resources/compute/volumes/volumes.ts +1 -1
- package/src/resources/networking/api.md +67 -0
- package/src/resources/networking/connect/connections.ts +1 -1
- package/src/resources/networking/firewall-rules.ts +1 -1
- package/src/resources/networking/vpcs/vpcs.ts +1 -1
- package/src/resources/operations/api.md +14 -0
- package/src/resources/operations/index.ts +3 -0
- package/src/resources/operations/operations.ts +114 -0
- package/src/resources/operations.ts +1 -112
- package/src/resources/organizations/api.md +13 -0
- package/src/resources/organizations/index.ts +3 -0
- package/src/resources/organizations/organizations.ts +142 -0
- package/src/resources/organizations.ts +1 -140
- package/src/resources/projects/api.md +14 -0
- package/src/resources/projects/index.ts +3 -0
- package/src/resources/projects/projects.ts +224 -0
- package/src/resources/projects.ts +1 -227
- package/src/resources/regions/api.md +12 -0
- package/src/resources/regions/index.ts +3 -0
- package/src/resources/regions/regions.ts +140 -0
- package/src/resources/regions.ts +1 -138
- package/src/resources/rpc-nodes/api.md +44 -0
- package/src/resources/user/api.md +20 -0
- 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
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Organizations
|
|
2
|
+
|
|
3
|
+
Types:
|
|
4
|
+
|
|
5
|
+
- <code><a href="./src/resources/organizations.ts">Organization</a></code>
|
|
6
|
+
- <code><a href="./src/resources/organizations.ts">OrganizationList</a></code>
|
|
7
|
+
|
|
8
|
+
Methods:
|
|
9
|
+
|
|
10
|
+
- <code title="post /v1/organizations">client.organizations.<a href="./src/resources/organizations.ts">create</a>({ ...params }) -> Organization</code>
|
|
11
|
+
- <code title="patch /v1/organizations/{organization_id}">client.organizations.<a href="./src/resources/organizations.ts">update</a>(organizationID, { ...params }) -> Organization</code>
|
|
12
|
+
- <code title="get /v1/organizations">client.organizations.<a href="./src/resources/organizations.ts">list</a>({ ...params }) -> OrganizationsCursor</code>
|
|
13
|
+
- <code title="get /v1/organizations/{organization_id}">client.organizations.<a href="./src/resources/organizations.ts">get</a>(organizationID) -> Organization</code>
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as Shared from '../shared';
|
|
5
|
+
import { APIPromise } from '../../core/api-promise';
|
|
6
|
+
import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
|
|
7
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
8
|
+
import { path } from '../../internal/utils/path';
|
|
9
|
+
|
|
10
|
+
export class Organizations extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Create a new organization
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const organization = await client.organizations.create({
|
|
17
|
+
* name: 'My Organization',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
create(body: OrganizationCreateParams, options?: RequestOptions): APIPromise<Organization> {
|
|
22
|
+
return this._client.post('/v1/organizations', { body, ...options });
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Update an existing organization
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const organization = await client.organizations.update(
|
|
31
|
+
* 'organization_id',
|
|
32
|
+
* );
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
update(
|
|
36
|
+
organizationID: string,
|
|
37
|
+
body: OrganizationUpdateParams,
|
|
38
|
+
options?: RequestOptions,
|
|
39
|
+
): APIPromise<Organization> {
|
|
40
|
+
return this._client.patch(path`/v1/organizations/${organizationID}`, { body, ...options });
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* List organizations
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* // Automatically fetches more pages as needed.
|
|
49
|
+
* for await (const organization of client.organizations.list()) {
|
|
50
|
+
* // ...
|
|
51
|
+
* }
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
list(
|
|
55
|
+
query: OrganizationListParams | null | undefined = {},
|
|
56
|
+
options?: RequestOptions,
|
|
57
|
+
): PagePromise<OrganizationsCursor, Organization> {
|
|
58
|
+
return this._client.getAPIList('/v1/organizations', Cursor<Organization>, { query, ...options });
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Get details about an Organization
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const organization = await client.organizations.get(
|
|
67
|
+
* 'organization_id',
|
|
68
|
+
* );
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
get(organizationID: string, options?: RequestOptions): APIPromise<Organization> {
|
|
72
|
+
return this._client.get(path`/v1/organizations/${organizationID}`, options);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export type OrganizationsCursor = Cursor<Organization>;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Organization response.
|
|
80
|
+
*/
|
|
81
|
+
export interface Organization {
|
|
82
|
+
/**
|
|
83
|
+
* Organization ID.
|
|
84
|
+
*/
|
|
85
|
+
id: string;
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* When the Organization was created.
|
|
89
|
+
*/
|
|
90
|
+
created_at: string;
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Organization name.
|
|
94
|
+
*/
|
|
95
|
+
name: string;
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* When the Organization was updated.
|
|
99
|
+
*/
|
|
100
|
+
updated_at: string;
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Authentication provider organization ID.
|
|
104
|
+
*/
|
|
105
|
+
auth_id?: string;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface OrganizationList {
|
|
109
|
+
items: Array<Organization>;
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Pagination response details.
|
|
113
|
+
*/
|
|
114
|
+
pagination: Shared.Pagination;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export interface OrganizationCreateParams {
|
|
118
|
+
/**
|
|
119
|
+
* Organization name.
|
|
120
|
+
*/
|
|
121
|
+
name: string;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
export interface OrganizationUpdateParams {
|
|
125
|
+
/**
|
|
126
|
+
* Organization name.
|
|
127
|
+
*/
|
|
128
|
+
name?: string;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export interface OrganizationListParams extends CursorParams {}
|
|
132
|
+
|
|
133
|
+
export declare namespace Organizations {
|
|
134
|
+
export {
|
|
135
|
+
type Organization as Organization,
|
|
136
|
+
type OrganizationList as OrganizationList,
|
|
137
|
+
type OrganizationsCursor as OrganizationsCursor,
|
|
138
|
+
type OrganizationCreateParams as OrganizationCreateParams,
|
|
139
|
+
type OrganizationUpdateParams as OrganizationUpdateParams,
|
|
140
|
+
type OrganizationListParams as OrganizationListParams,
|
|
141
|
+
};
|
|
142
|
+
}
|
|
@@ -1,142 +1,3 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
import * as Shared from './shared';
|
|
5
|
-
import { APIPromise } from '../core/api-promise';
|
|
6
|
-
import { Cursor, type CursorParams, PagePromise } from '../core/pagination';
|
|
7
|
-
import { RequestOptions } from '../internal/request-options';
|
|
8
|
-
import { path } from '../internal/utils/path';
|
|
9
|
-
|
|
10
|
-
export class Organizations extends APIResource {
|
|
11
|
-
/**
|
|
12
|
-
* Create a new organization
|
|
13
|
-
*
|
|
14
|
-
* @example
|
|
15
|
-
* ```ts
|
|
16
|
-
* const organization = await client.organizations.create({
|
|
17
|
-
* name: 'My Organization',
|
|
18
|
-
* });
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
create(body: OrganizationCreateParams, options?: RequestOptions): APIPromise<Organization> {
|
|
22
|
-
return this._client.post('/v1/organizations', { body, ...options });
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Update an existing organization
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```ts
|
|
30
|
-
* const organization = await client.organizations.update(
|
|
31
|
-
* 'organization_id',
|
|
32
|
-
* );
|
|
33
|
-
* ```
|
|
34
|
-
*/
|
|
35
|
-
update(
|
|
36
|
-
organizationID: string,
|
|
37
|
-
body: OrganizationUpdateParams,
|
|
38
|
-
options?: RequestOptions,
|
|
39
|
-
): APIPromise<Organization> {
|
|
40
|
-
return this._client.patch(path`/v1/organizations/${organizationID}`, { body, ...options });
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* List organizations for the authenticated user
|
|
45
|
-
*
|
|
46
|
-
* @example
|
|
47
|
-
* ```ts
|
|
48
|
-
* // Automatically fetches more pages as needed.
|
|
49
|
-
* for await (const organization of client.organizations.list()) {
|
|
50
|
-
* // ...
|
|
51
|
-
* }
|
|
52
|
-
* ```
|
|
53
|
-
*/
|
|
54
|
-
list(
|
|
55
|
-
query: OrganizationListParams | null | undefined = {},
|
|
56
|
-
options?: RequestOptions,
|
|
57
|
-
): PagePromise<OrganizationsCursor, Organization> {
|
|
58
|
-
return this._client.getAPIList('/v1/organizations', Cursor<Organization>, { query, ...options });
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Get details about an Organization
|
|
63
|
-
*
|
|
64
|
-
* @example
|
|
65
|
-
* ```ts
|
|
66
|
-
* const organization = await client.organizations.get(
|
|
67
|
-
* 'organization_id',
|
|
68
|
-
* );
|
|
69
|
-
* ```
|
|
70
|
-
*/
|
|
71
|
-
get(organizationID: string, options?: RequestOptions): APIPromise<Organization> {
|
|
72
|
-
return this._client.get(path`/v1/organizations/${organizationID}`, options);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
export type OrganizationsCursor = Cursor<Organization>;
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Organization response.
|
|
80
|
-
*/
|
|
81
|
-
export interface Organization {
|
|
82
|
-
/**
|
|
83
|
-
* Organization ID.
|
|
84
|
-
*/
|
|
85
|
-
id: string;
|
|
86
|
-
|
|
87
|
-
/**
|
|
88
|
-
* When the Organization was created.
|
|
89
|
-
*/
|
|
90
|
-
created_at: string;
|
|
91
|
-
|
|
92
|
-
/**
|
|
93
|
-
* Organization name.
|
|
94
|
-
*/
|
|
95
|
-
name: string;
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* When the Organization was updated.
|
|
99
|
-
*/
|
|
100
|
-
updated_at: string;
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* Authentication provider organization ID.
|
|
104
|
-
*/
|
|
105
|
-
auth_id?: string;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
export interface OrganizationList {
|
|
109
|
-
items: Array<Organization>;
|
|
110
|
-
|
|
111
|
-
/**
|
|
112
|
-
* Pagination response details.
|
|
113
|
-
*/
|
|
114
|
-
pagination: Shared.Pagination;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
export interface OrganizationCreateParams {
|
|
118
|
-
/**
|
|
119
|
-
* Organization name.
|
|
120
|
-
*/
|
|
121
|
-
name: string;
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
export interface OrganizationUpdateParams {
|
|
125
|
-
/**
|
|
126
|
-
* Organization name.
|
|
127
|
-
*/
|
|
128
|
-
name?: string;
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
export interface OrganizationListParams extends CursorParams {}
|
|
132
|
-
|
|
133
|
-
export declare namespace Organizations {
|
|
134
|
-
export {
|
|
135
|
-
type Organization as Organization,
|
|
136
|
-
type OrganizationList as OrganizationList,
|
|
137
|
-
type OrganizationsCursor as OrganizationsCursor,
|
|
138
|
-
type OrganizationCreateParams as OrganizationCreateParams,
|
|
139
|
-
type OrganizationUpdateParams as OrganizationUpdateParams,
|
|
140
|
-
type OrganizationListParams as OrganizationListParams,
|
|
141
|
-
};
|
|
142
|
-
}
|
|
3
|
+
export * from './organizations/index';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Projects
|
|
2
|
+
|
|
3
|
+
Types:
|
|
4
|
+
|
|
5
|
+
- <code><a href="./src/resources/projects.ts">Project</a></code>
|
|
6
|
+
- <code><a href="./src/resources/projects.ts">ProjectList</a></code>
|
|
7
|
+
|
|
8
|
+
Methods:
|
|
9
|
+
|
|
10
|
+
- <code title="post /v1/projects">client.projects.<a href="./src/resources/projects.ts">create</a>({ ...params }) -> Project</code>
|
|
11
|
+
- <code title="patch /v1/projects/{project_id}">client.projects.<a href="./src/resources/projects.ts">update</a>(projectID, { ...params }) -> Project</code>
|
|
12
|
+
- <code title="get /v1/projects">client.projects.<a href="./src/resources/projects.ts">list</a>({ ...params }) -> ProjectsCursor</code>
|
|
13
|
+
- <code title="delete /v1/projects/{project_id}">client.projects.<a href="./src/resources/projects.ts">delete</a>(projectID) -> void</code>
|
|
14
|
+
- <code title="get /v1/projects/{project_id}">client.projects.<a href="./src/resources/projects.ts">get</a>(projectID) -> Project</code>
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as Shared from '../shared';
|
|
5
|
+
import { APIPromise } from '../../core/api-promise';
|
|
6
|
+
import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
|
|
7
|
+
import { buildHeaders } from '../../internal/headers';
|
|
8
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
9
|
+
import { path } from '../../internal/utils/path';
|
|
10
|
+
|
|
11
|
+
export class Projects extends APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Create a new project
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const project = await client.projects.create({
|
|
18
|
+
* name: 'My Project',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: ProjectCreateParams, options?: RequestOptions): APIPromise<Project> {
|
|
23
|
+
return this._client.post('/v1/projects', { body, ...options });
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Update an existing project
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const project = await client.projects.update('project_id');
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
update(projectID: string, body: ProjectUpdateParams, options?: RequestOptions): APIPromise<Project> {
|
|
35
|
+
return this._client.patch(path`/v1/projects/${projectID}`, { body, ...options });
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* List all projects
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* // Automatically fetches more pages as needed.
|
|
44
|
+
* for await (const project of client.projects.list()) {
|
|
45
|
+
* // ...
|
|
46
|
+
* }
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
list(
|
|
50
|
+
query: ProjectListParams | null | undefined = {},
|
|
51
|
+
options?: RequestOptions,
|
|
52
|
+
): PagePromise<ProjectsCursor, Project> {
|
|
53
|
+
return this._client.getAPIList('/v1/projects', Cursor<Project>, { query, ...options });
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Delete a project
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* await client.projects.delete('project_id');
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
delete(projectID: string, options?: RequestOptions): APIPromise<void> {
|
|
65
|
+
return this._client.delete(path`/v1/projects/${projectID}`, {
|
|
66
|
+
...options,
|
|
67
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Get details about a project
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```ts
|
|
76
|
+
* const project = await client.projects.get('project_id');
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
get(projectID: string, options?: RequestOptions): APIPromise<Project> {
|
|
80
|
+
return this._client.get(path`/v1/projects/${projectID}`, options);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export type ProjectsCursor = Cursor<Project>;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Project response.
|
|
88
|
+
*/
|
|
89
|
+
export interface Project {
|
|
90
|
+
/**
|
|
91
|
+
* Project ID.
|
|
92
|
+
*/
|
|
93
|
+
id: string;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* When the Project was created.
|
|
97
|
+
*/
|
|
98
|
+
created_at: string;
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Project name.
|
|
102
|
+
*/
|
|
103
|
+
name: string;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Resource counts for the project.
|
|
107
|
+
*/
|
|
108
|
+
resources: Project.Resources;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Tags attached to the Project.
|
|
112
|
+
*/
|
|
113
|
+
tags: Array<string>;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* When the Project was updated.
|
|
117
|
+
*/
|
|
118
|
+
updated_at: string;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export namespace Project {
|
|
122
|
+
/**
|
|
123
|
+
* Resource counts for the project.
|
|
124
|
+
*/
|
|
125
|
+
export interface Resources {
|
|
126
|
+
/**
|
|
127
|
+
* Blockchain resources.
|
|
128
|
+
*/
|
|
129
|
+
blockchain: Resources.Blockchain;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Cloud infrastructure resources.
|
|
133
|
+
*/
|
|
134
|
+
cloud: Resources.Cloud;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export namespace Resources {
|
|
138
|
+
/**
|
|
139
|
+
* Blockchain resources.
|
|
140
|
+
*/
|
|
141
|
+
export interface Blockchain {
|
|
142
|
+
/**
|
|
143
|
+
* Number of dedicated RPC nodes in the project.
|
|
144
|
+
*/
|
|
145
|
+
rpc_nodes_dedicated: number;
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Number of flex RPC nodes in the project.
|
|
149
|
+
*/
|
|
150
|
+
rpc_nodes_flex: number;
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Cloud infrastructure resources.
|
|
155
|
+
*/
|
|
156
|
+
export interface Cloud {
|
|
157
|
+
/**
|
|
158
|
+
* Number of Connect connections in the project.
|
|
159
|
+
*/
|
|
160
|
+
connect_connections: number;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Number of VMs in the project.
|
|
164
|
+
*/
|
|
165
|
+
vms: number;
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Number of volumes in the project.
|
|
169
|
+
*/
|
|
170
|
+
volumes: number;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Number of VPCs in the project.
|
|
174
|
+
*/
|
|
175
|
+
vpcs: number;
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
export interface ProjectList {
|
|
181
|
+
items: Array<Project>;
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* Pagination response details.
|
|
185
|
+
*/
|
|
186
|
+
pagination: Shared.Pagination;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
export interface ProjectCreateParams {
|
|
190
|
+
/**
|
|
191
|
+
* Project name.
|
|
192
|
+
*/
|
|
193
|
+
name: string;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Tags to attach to the Project.
|
|
197
|
+
*/
|
|
198
|
+
tags?: Array<string>;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
export interface ProjectUpdateParams {
|
|
202
|
+
/**
|
|
203
|
+
* Project name.
|
|
204
|
+
*/
|
|
205
|
+
name?: string;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* Tags to attach to the Project.
|
|
209
|
+
*/
|
|
210
|
+
tags?: Array<string>;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export interface ProjectListParams extends CursorParams {}
|
|
214
|
+
|
|
215
|
+
export declare namespace Projects {
|
|
216
|
+
export {
|
|
217
|
+
type Project as Project,
|
|
218
|
+
type ProjectList as ProjectList,
|
|
219
|
+
type ProjectsCursor as ProjectsCursor,
|
|
220
|
+
type ProjectCreateParams as ProjectCreateParams,
|
|
221
|
+
type ProjectUpdateParams as ProjectUpdateParams,
|
|
222
|
+
type ProjectListParams as ProjectListParams,
|
|
223
|
+
};
|
|
224
|
+
}
|