Skip to content

Commit 1b5c2ee

Browse files
authored
feat(account/v2): deprecate in favor of upcoming v3 (#767)
1 parent 3e5285d commit 1b5c2ee

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

packages/clients/src/api/account/v2/api.gen.ts

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ const jsonContentHeaders = {
3333
*/
3434
export class API extends ParentAPI {
3535
/**
36-
* Create a new Project for an Organization. Generate a new Project for an
37-
* Organization, specifying its configuration including name and description.
36+
* Create a new Project for an Organization. Deprecated in favor of Account
37+
* API v3. Generate a new Project for an Organization, specifying its
38+
* configuration including name and description.
3839
*
40+
* @deprecated
3941
* @param request - The request {@link CreateProjectRequest}
4042
* @returns A Promise of Project
4143
*/
@@ -79,22 +81,26 @@ export class API extends ParentAPI {
7981
)
8082

8183
/**
82-
* List all Projects of an Organization. List all Projects of an Organization.
83-
* The response will include the total number of Projects as well as their
84-
* associated Organizations, names and IDs. Other information include the
85-
* creation and update date of the Project.
84+
* List all Projects of an Organization. Deprecated in favor of Account API
85+
* v3. List all Projects of an Organization. The response will include the
86+
* total number of Projects as well as their associated Organizations, names
87+
* and IDs. Other information include the creation and update date of the
88+
* Project.
8689
*
90+
* @deprecated
8791
* @param request - The request {@link ListProjectsRequest}
8892
* @returns A Promise of ListProjectsResponse
8993
*/
9094
listProjects = (request: Readonly<ListProjectsRequest> = {}) =>
9195
enrichForPagination('projects', this.pageOfListProjects, request)
9296

9397
/**
94-
* Get an existing Project. Retrieve information about an existing Project,
95-
* specified by its Project ID. Its full details, including ID, name and
96-
* description, are returned in the response object.
98+
* Get an existing Project. Deprecated in favor of Account API v3. Retrieve
99+
* information about an existing Project, specified by its Project ID. Its
100+
* full details, including ID, name and description, are returned in the
101+
* response object.
97102
*
103+
* @deprecated
98104
* @param request - The request {@link GetProjectRequest}
99105
* @returns A Promise of Project
100106
*/
@@ -111,11 +117,13 @@ export class API extends ParentAPI {
111117
)
112118

113119
/**
114-
* Delete an existing Project. Delete an existing Project, specified by its
115-
* Project ID. The Project needs to be empty (meaning there are no resources
116-
* left in it) to be deleted effectively. Note that deleting a Project is
117-
* permanent, and cannot be undone.
120+
* Delete an existing Project. Deprecated in favor of Account API v3. Delete
121+
* an existing Project, specified by its Project ID. The Project needs to be
122+
* empty (meaning there are no resources left in it) to be deleted
123+
* effectively. Note that deleting a Project is permanent, and cannot be
124+
* undone.
118125
*
126+
* @deprecated
119127
* @param request - The request {@link DeleteProjectRequest}
120128
*/
121129
deleteProject = (request: Readonly<DeleteProjectRequest> = {}) =>
@@ -128,9 +136,11 @@ export class API extends ParentAPI {
128136
})
129137

130138
/**
131-
* Update Project. Update the parameters of an existing Project, specified by
132-
* its Project ID. These parameters include the name and description.
139+
* Update Project. Deprecated in favor of Account API v3. Update the
140+
* parameters of an existing Project, specified by its Project ID. These
141+
* parameters include the name and description.
133142
*
143+
* @deprecated
134144
* @param request - The request {@link UpdateProjectRequest}
135145
* @returns A Promise of Project
136146
*/

0 commit comments

Comments
 (0)