feat(account): add v2 (#15)

Author: scaleway-bot

packages/clients/src/api/account/index.ts

@@ -1 +1,2 @@
 export * as v2alpha1 from './v2alpha1'
+export * as v2 from './v2'

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

@@ -0,0 +1,141 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+import {
+  API,
+  enrichForPagination,
+  urlParams,
+  validatePathParam,
+} from '../../../bridge'
+import {
+  marshalCreateProjectRequest,
+  marshalUpdateProjectRequest,
+  unmarshalListProjectsResponse,
+  unmarshalProject,
+} from './marshalling.gen'
+import type {
+  CreateProjectRequest,
+  DeleteProjectRequest,
+  GetProjectRequest,
+  ListProjectsRequest,
+  ListProjectsResponse,
+  Project,
+  UpdateProjectRequest,
+} from './types.gen'
+
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8',
+}
+
+/**
+ * Account API.
+ *
+ * This API allows you to manage projects.
+ */
+export class AccountV2GenAPI extends API {
+  /**
+   * Create project
+   *
+   * @param request - The request {@link CreateProjectRequest}
+   * @returns A Promise of Project
+   */
+  createProject = (request: Readonly<CreateProjectRequest>) =>
+    this.client.fetch<Project>(
+      {
+        body: JSON.stringify(
+          marshalCreateProjectRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/account/v2/projects`,
+      },
+      unmarshalProject,
+    )
+
+  protected pageOfListProjects = (
+    request: Readonly<ListProjectsRequest> = {},
+  ) =>
+    this.client.fetch<ListProjectsResponse>(
+      {
+        method: 'GET',
+        path: `/account/v2/projects`,
+        urlParams: urlParams(
+          ['name', request.name],
+          ['order_by', request.orderBy ?? 'created_at_asc'],
+          [
+            'organization_id',
+            request.organizationId ??
+              this.client.settings.defaultOrganizationId,
+          ],
+          ['page', request.page],
+          [
+            'page_size',
+            request.pageSize ?? this.client.settings.defaultPageSize,
+          ],
+        ),
+      },
+      unmarshalListProjectsResponse,
+    )
+
+  /**
+   * List projects
+   *
+   * @param request - The request {@link ListProjectsRequest}
+   * @returns A Promise of ListProjectsResponse
+   */
+  listProjects = (request: Readonly<ListProjectsRequest> = {}) =>
+    enrichForPagination('projects', this.pageOfListProjects, request)
+
+  /**
+   * Get project
+   *
+   * @param request - The request {@link GetProjectRequest}
+   * @returns A Promise of Project
+   */
+  getProject = (request: Readonly<GetProjectRequest> = {}) =>
+    this.client.fetch<Project>(
+      {
+        method: 'GET',
+        path: `/account/v2/projects/${validatePathParam(
+          'projectId',
+          request.projectId ?? this.client.settings.defaultProjectId,
+        )}`,
+      },
+      unmarshalProject,
+    )
+
+  /**
+   * Delete project
+   *
+   * @param request - The request {@link DeleteProjectRequest}
+   */
+  deleteProject = (request: Readonly<DeleteProjectRequest> = {}) =>
+    this.client.fetch<void>({
+      method: 'DELETE',
+      path: `/account/v2/projects/${validatePathParam(
+        'projectId',
+        request.projectId ?? this.client.settings.defaultProjectId,
+      )}`,
+    })
+
+  /**
+   * Update project
+   *
+   * @param request - The request {@link UpdateProjectRequest}
+   * @returns A Promise of Project
+   */
+  updateProject = (request: Readonly<UpdateProjectRequest> = {}) =>
+    this.client.fetch<Project>(
+      {
+        body: JSON.stringify(
+          marshalUpdateProjectRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'PATCH',
+        path: `/account/v2/projects/${validatePathParam(
+          'projectId',
+          request.projectId ?? this.client.settings.defaultProjectId,
+        )}`,
+      },
+      unmarshalProject,
+    )
+}

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

@@ -0,0 +1,2 @@
+export { AccountV2GenAPI as API } from './api.gen'
+export * from './types.gen'

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

@@ -0,0 +1,61 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+import {
+  isJSONObject,
+  unmarshalArrayOfObject,
+  unmarshalDate,
+} from '../../../bridge'
+import type { DefaultValues } from '../../../bridge'
+import type {
+  CreateProjectRequest,
+  ListProjectsResponse,
+  Project,
+  UpdateProjectRequest,
+} from './types.gen'
+
+export const unmarshalProject = (data: unknown) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Project' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    description: data.description,
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    updatedAt: unmarshalDate(data.updated_at),
+  } as Project
+}
+
+export const unmarshalListProjectsResponse = (data: unknown) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    projects: unmarshalArrayOfObject(data.projects, unmarshalProject),
+    totalCount: data.total_count,
+  } as ListProjectsResponse
+}
+
+export const marshalCreateProjectRequest = (
+  request: CreateProjectRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  description: request.description,
+  name: request.name,
+  organization_id: request.organizationId ?? defaults.defaultOrganizationId,
+})
+
+export const marshalUpdateProjectRequest = (
+  request: UpdateProjectRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  description: request.description,
+  name: request.name,
+})

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

@@ -0,0 +1,73 @@
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+
+export type ListProjectsRequestOrderBy =
+  | 'created_at_asc'
+  | 'created_at_desc'
+  | 'name_asc'
+  | 'name_desc'
+
+/** List projects response */
+export interface ListProjectsResponse {
+  /** The total number of projects */
+  totalCount: number
+  /** The paginated returned projects */
+  projects: Array<Project>
+}
+
+/** Project */
+export interface Project {
+  /** The ID of the project */
+  id: string
+  /** The name of the project */
+  name: string
+  /** The organization ID of the project */
+  organizationId: string
+  /** The creation date of the project */
+  createdAt?: Date
+  /** The update date of the project */
+  updatedAt?: Date
+  /** The description of the project */
+  description: string
+}
+
+export type CreateProjectRequest = {
+  /** The name of the project */
+  name: string
+  /** The organization ID of the project */
+  organizationId?: string
+  /** The description of the project */
+  description?: string
+}
+
+export type ListProjectsRequest = {
+  /** The organization ID of the project */
+  organizationId?: string
+  /** The name of the project */
+  name?: string
+  /** The page number for the returned projects */
+  page?: number
+  /** The maximum number of project per page */
+  pageSize?: number
+  /** The sort order of the returned projects */
+  orderBy?: ListProjectsRequestOrderBy
+}
+
+export type GetProjectRequest = {
+  /** The project ID of the project */
+  projectId?: string
+}
+
+export type DeleteProjectRequest = {
+  /** The project ID of the project */
+  projectId?: string
+}
+
+export type UpdateProjectRequest = {
+  /** The project ID of the project */
+  projectId?: string
+  /** The name of the project */
+  name?: string
+  /** The description of the project */
+  description?: string
+}