Skip to content

feat(account/v2): deprecate in favor of upcoming v3 #767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2023
Merged

feat(account/v2): deprecate in favor of upcoming v3 #767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions packages/clients/src/api/account/v2/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ const jsonContentHeaders = {
*/
export class API extends ParentAPI {
/**
* Create a new Project for an Organization. Generate a new Project for an
* Organization, specifying its configuration including name and description.
* Create a new Project for an Organization. Deprecated in favor of Account
* API v3. Generate a new Project for an Organization, specifying its
* configuration including name and description.
*
* @deprecated
* @param request - The request {@link CreateProjectRequest}
* @returns A Promise of Project
*/
Expand Down Expand Up @@ -79,22 +81,26 @@ export class API extends ParentAPI {
)

/**
* List all Projects of an Organization. List all Projects of an Organization.
* The response will include the total number of Projects as well as their
* associated Organizations, names and IDs. Other information include the
* creation and update date of the Project.
* List all Projects of an Organization. Deprecated in favor of Account API
* v3. List all Projects of an Organization. The response will include the
* total number of Projects as well as their associated Organizations, names
* and IDs. Other information include the creation and update date of the
* Project.
*
* @deprecated
* @param request - The request {@link ListProjectsRequest}
* @returns A Promise of ListProjectsResponse
*/
listProjects = (request: Readonly<ListProjectsRequest> = {}) =>
enrichForPagination('projects', this.pageOfListProjects, request)

/**
* Get an existing Project. Retrieve information about an existing Project,
* specified by its Project ID. Its full details, including ID, name and
* description, are returned in the response object.
* Get an existing Project. Deprecated in favor of Account API v3. Retrieve
* information about an existing Project, specified by its Project ID. Its
* full details, including ID, name and description, are returned in the
* response object.
*
* @deprecated
* @param request - The request {@link GetProjectRequest}
* @returns A Promise of Project
*/
Expand All @@ -111,11 +117,13 @@ export class API extends ParentAPI {
)

/**
* Delete an existing Project. Delete an existing Project, specified by its
* Project ID. The Project needs to be empty (meaning there are no resources
* left in it) to be deleted effectively. Note that deleting a Project is
* permanent, and cannot be undone.
* Delete an existing Project. Deprecated in favor of Account API v3. Delete
* an existing Project, specified by its Project ID. The Project needs to be
* empty (meaning there are no resources left in it) to be deleted
* effectively. Note that deleting a Project is permanent, and cannot be
* undone.
*
* @deprecated
* @param request - The request {@link DeleteProjectRequest}
*/
deleteProject = (request: Readonly<DeleteProjectRequest> = {}) =>
Expand All @@ -128,9 +136,11 @@ export class API extends ParentAPI {
})

/**
* Update Project. Update the parameters of an existing Project, specified by
* its Project ID. These parameters include the name and description.
* Update Project. Deprecated in favor of Account API v3. Update the
* parameters of an existing Project, specified by its Project ID. These
* parameters include the name and description.
*
* @deprecated
* @param request - The request {@link UpdateProjectRequest}
* @returns A Promise of Project
*/
Expand Down