@scaleway/sdk-account 1.0.1

package/dist/v3/marshalling.gen.js

@@ -0,0 +1,314 @@
+import randomName from "@scaleway/random-name";
+import { resolveOneOf, isJSONObject, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+const unmarshalContract = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Contract' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at),
+    version: data.version
+  };
+};
+const unmarshalContractSignature = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ContractSignature' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    contract: data.contract ? unmarshalContract(data.contract) : void 0,
+    createdAt: unmarshalDate(data.created_at),
+    expiresAt: unmarshalDate(data.expires_at),
+    id: data.id,
+    organizationId: data.organization_id,
+    signedAt: unmarshalDate(data.signed_at)
+  };
+};
+const unmarshalQualificationAiMachine = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationAiMachine' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationArchiveData = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationArchiveData' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationContainer = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationContainer' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationDeploySoftware = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationDeploySoftware' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationHostApplication = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationHostApplication' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationHostWebsite = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationHostWebsite' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationOtherUseCase = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationOtherUseCase' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationSetScalewayEnvironment = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationSetScalewayEnvironment' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualificationShareData = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'QualificationShareData' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    subUseCase: data.sub_use_case
+  };
+};
+const unmarshalQualification = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Qualification' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    aiMachine: data.ai_machine ? unmarshalQualificationAiMachine(data.ai_machine) : void 0,
+    architectureType: data.architecture_type,
+    archiveData: data.archive_data ? unmarshalQualificationArchiveData(data.archive_data) : void 0,
+    container: data.container ? unmarshalQualificationContainer(data.container) : void 0,
+    deploySoftware: data.deploy_software ? unmarshalQualificationDeploySoftware(data.deploy_software) : void 0,
+    hostApplication: data.host_application ? unmarshalQualificationHostApplication(data.host_application) : void 0,
+    hostWebsite: data.host_website ? unmarshalQualificationHostWebsite(data.host_website) : void 0,
+    otherUseCase: data.other_use_case ? unmarshalQualificationOtherUseCase(data.other_use_case) : void 0,
+    setScalewayEnvironment: data.set_scaleway_environment ? unmarshalQualificationSetScalewayEnvironment(
+      data.set_scaleway_environment
+    ) : void 0,
+    shareData: data.share_data ? unmarshalQualificationShareData(data.share_data) : void 0
+  };
+};
+const unmarshalProject = (data) => {
+  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,
+    qualification: data.qualification ? unmarshalQualification(data.qualification) : void 0,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalCheckContractSignatureResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'CheckContractSignatureResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    created: data.created,
+    validated: data.validated
+  };
+};
+const unmarshalListContractSignaturesResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListContractSignaturesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    contractSignatures: unmarshalArrayOfObject(
+      data.contract_signatures,
+      unmarshalContractSignature
+    ),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListProjectsResponse = (data) => {
+  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
+  };
+};
+const unmarshalProjectQualification = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ProjectQualification' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    projectId: data.project_id,
+    qualification: data.qualification ? unmarshalQualification(data.qualification) : void 0
+  };
+};
+const marshalContractApiCheckContractSignatureRequest = (request, defaults) => ({
+  contract_name: request.contractName,
+  contract_type: request.contractType,
+  organization_id: request.organizationId ?? defaults.defaultOrganizationId
+});
+const marshalContractApiCreateContractSignatureRequest = (request, defaults) => ({
+  contract_name: request.contractName,
+  contract_type: request.contractType,
+  organization_id: request.organizationId ?? defaults.defaultOrganizationId,
+  validated: request.validated
+});
+const marshalProjectApiCreateProjectRequest = (request, defaults) => ({
+  description: request.description,
+  name: request.name || randomName("proj"),
+  organization_id: request.organizationId ?? defaults.defaultOrganizationId
+});
+const marshalQualificationAiMachine = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationArchiveData = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationContainer = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationDeploySoftware = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationHostApplication = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationHostWebsite = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationOtherUseCase = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationSetScalewayEnvironment = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualificationShareData = (request, defaults) => ({
+  sub_use_case: request.subUseCase
+});
+const marshalQualification = (request, defaults) => ({
+  architecture_type: request.architectureType,
+  ...resolveOneOf([
+    {
+      param: "host_website",
+      value: request.hostWebsite !== void 0 ? marshalQualificationHostWebsite(request.hostWebsite) : void 0
+    },
+    {
+      param: "host_application",
+      value: request.hostApplication !== void 0 ? marshalQualificationHostApplication(
+        request.hostApplication
+      ) : void 0
+    },
+    {
+      param: "deploy_software",
+      value: request.deploySoftware !== void 0 ? marshalQualificationDeploySoftware(request.deploySoftware) : void 0
+    },
+    {
+      param: "set_scaleway_environment",
+      value: request.setScalewayEnvironment !== void 0 ? marshalQualificationSetScalewayEnvironment(
+        request.setScalewayEnvironment
+      ) : void 0
+    },
+    {
+      param: "ai_machine",
+      value: request.aiMachine !== void 0 ? marshalQualificationAiMachine(request.aiMachine) : void 0
+    },
+    {
+      param: "container",
+      value: request.container !== void 0 ? marshalQualificationContainer(request.container) : void 0
+    },
+    {
+      param: "archive_data",
+      value: request.archiveData !== void 0 ? marshalQualificationArchiveData(request.archiveData) : void 0
+    },
+    {
+      param: "share_data",
+      value: request.shareData !== void 0 ? marshalQualificationShareData(request.shareData) : void 0
+    },
+    {
+      param: "other_use_case",
+      value: request.otherUseCase !== void 0 ? marshalQualificationOtherUseCase(request.otherUseCase) : void 0
+    }
+  ])
+});
+const marshalProjectApiSetProjectQualificationRequest = (request, defaults) => ({
+  qualification: request.qualification !== void 0 ? marshalQualification(request.qualification) : void 0
+});
+const marshalProjectApiUpdateProjectRequest = (request, defaults) => ({
+  description: request.description,
+  name: request.name
+});
+export {
+  marshalContractApiCheckContractSignatureRequest,
+  marshalContractApiCreateContractSignatureRequest,
+  marshalProjectApiCreateProjectRequest,
+  marshalProjectApiSetProjectQualificationRequest,
+  marshalProjectApiUpdateProjectRequest,
+  unmarshalCheckContractSignatureResponse,
+  unmarshalContractSignature,
+  unmarshalListContractSignaturesResponse,
+  unmarshalListProjectsResponse,
+  unmarshalProject,
+  unmarshalProjectQualification
+};

package/dist/v3/types.gen.d.ts

@@ -0,0 +1,356 @@
+import type { LanguageCode as StdLanguageCode } from '@scaleway/sdk-std';
+export type ContractType = 'unknown_type' | 'global' | 'k8s' | 'instance' | 'container' | 'baremetal';
+export type ListContractSignaturesRequestOrderBy = 'signed_at_asc' | 'signed_at_desc' | 'expires_at_asc' | 'expires_at_desc' | 'name_asc' | 'name_desc';
+export type ListProjectsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export type QualificationAiMachineSubUseCase = 'unknown_sub_use_case';
+export type QualificationArchitectureType = 'unknown_architecture_type' | 'object_storage' | 'web_hosting' | 'instance' | 'elastic' | 'kubernetes' | 'serverless' | 'dedicated_server' | 'other_architecture_type';
+export type QualificationArchiveDataSubUseCase = 'unknown_sub_use_case';
+export type QualificationContainerSubUseCase = 'unknown_sub_use_case';
+export type QualificationDeploySoftwareSubUseCase = 'unknown_sub_use_case';
+export type QualificationHostApplicationSubUseCase = 'unknown_sub_use_case' | 'saas_app' | 'government_app';
+export type QualificationHostWebsiteSubUseCase = 'unknown_sub_use_case' | 'information_website' | 'ecommerce_website' | 'high_website' | 'other_sub_use_case';
+export type QualificationOtherUseCaseSubUseCase = 'unknown_sub_use_case';
+export type QualificationSetScalewayEnvironmentSubUseCase = 'unknown_sub_use_case';
+export type QualificationShareDataSubUseCase = 'unknown_sub_use_case';
+export interface QualificationAiMachine {
+    subUseCase: QualificationAiMachineSubUseCase;
+}
+export interface QualificationArchiveData {
+    subUseCase: QualificationArchiveDataSubUseCase;
+}
+export interface QualificationContainer {
+    subUseCase: QualificationContainerSubUseCase;
+}
+export interface QualificationDeploySoftware {
+    subUseCase: QualificationDeploySoftwareSubUseCase;
+}
+export interface QualificationHostApplication {
+    subUseCase: QualificationHostApplicationSubUseCase;
+}
+export interface QualificationHostWebsite {
+    subUseCase: QualificationHostWebsiteSubUseCase;
+}
+export interface QualificationOtherUseCase {
+    subUseCase: QualificationOtherUseCaseSubUseCase;
+}
+export interface QualificationSetScalewayEnvironment {
+    subUseCase: QualificationSetScalewayEnvironmentSubUseCase;
+}
+export interface QualificationShareData {
+    subUseCase: QualificationShareDataSubUseCase;
+}
+export interface Contract {
+    /**
+     * ID of the contract.
+     */
+    id: string;
+    /**
+     * The type of the contract.
+     */
+    type: ContractType;
+    /**
+     * The name of the contract.
+     */
+    name: string;
+    /**
+     * The version of the contract.
+     */
+    version: number;
+    /**
+     * The creation date of the contract.
+     */
+    createdAt?: Date;
+    /**
+     * The last modification date of the contract.
+     */
+    updatedAt?: Date;
+}
+export interface Qualification {
+    /**
+     * Architecture type of the qualification.
+     */
+    architectureType: QualificationArchitectureType;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    hostWebsite?: QualificationHostWebsite;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    hostApplication?: QualificationHostApplication;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    deploySoftware?: QualificationDeploySoftware;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    setScalewayEnvironment?: QualificationSetScalewayEnvironment;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    aiMachine?: QualificationAiMachine;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    container?: QualificationContainer;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    archiveData?: QualificationArchiveData;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    shareData?: QualificationShareData;
+    /**
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
+     */
+    otherUseCase?: QualificationOtherUseCase;
+}
+export interface ContractSignature {
+    /**
+     * ID of the contract signature.
+     */
+    id: string;
+    /**
+     * The Organization ID which signed the contract.
+     */
+    organizationId: string;
+    /**
+     * The creation date of the contract signature.
+     */
+    createdAt?: Date;
+    /**
+     * The signing date of the contract signature.
+     */
+    signedAt?: Date;
+    /**
+     * The expiration date of the contract signature.
+     */
+    expiresAt?: Date;
+    /**
+     * The contract signed.
+     */
+    contract?: Contract;
+}
+export interface Project {
+    /**
+     * ID of the Project.
+     */
+    id: string;
+    /**
+     * Name of the Project.
+     */
+    name: string;
+    /**
+     * Organization ID of the Project.
+     */
+    organizationId: string;
+    /**
+     * Creation date of the Project.
+     */
+    createdAt?: Date;
+    /**
+     * Update date of the Project.
+     */
+    updatedAt?: Date;
+    /**
+     * Description of the Project.
+     */
+    description: string;
+    /**
+     * Qualification of the Project.
+     */
+    qualification?: Qualification;
+}
+export interface CheckContractSignatureResponse {
+    /**
+     * Whether a signature has been requested for this contract.
+     */
+    created: boolean;
+    /**
+     * Whether the signature for this contract has been validated.
+     */
+    validated: boolean;
+}
+export type ContractApiCheckContractSignatureRequest = {
+    /**
+     * ID of the Organization to check the contract signature for.
+     */
+    organizationId?: string;
+    /**
+     * Filter on contract type.
+     */
+    contractType?: ContractType;
+    /**
+     * Filter on contract name.
+     */
+    contractName: string;
+};
+export type ContractApiCreateContractSignatureRequest = {
+    /**
+     * The type of the contract.
+     */
+    contractType?: ContractType;
+    /**
+     * The name of the contract.
+     */
+    contractName: string;
+    /**
+     * Whether the contract is validated at creation.
+     */
+    validated: boolean;
+    /**
+     * ID of the Organization.
+     */
+    organizationId?: string;
+};
+export type ContractApiDownloadContractSignatureRequest = {
+    /**
+     * The contract signature ID.
+     */
+    contractSignatureId: string;
+    /**
+     * The locale requested for the content of the contract.
+     */
+    locale?: StdLanguageCode;
+};
+export type ContractApiListContractSignaturesRequest = {
+    /**
+     * The page number for the returned contracts.
+     */
+    page?: number;
+    /**
+     * The maximum number of contracts per page.
+     */
+    pageSize?: number;
+    /**
+     * How the contracts are ordered in the response.
+     */
+    orderBy?: ListContractSignaturesRequestOrderBy;
+    /**
+     * Filter on Organization ID.
+     */
+    organizationId?: string;
+};
+export type ContractApiValidateContractSignatureRequest = {
+    /**
+     * The contract linked to your Organization you want to sign.
+     */
+    contractSignatureId: string;
+};
+export interface ListContractSignaturesResponse {
+    /**
+     * The total number of contract signatures.
+     */
+    totalCount: number;
+    /**
+     * The paginated returned contract signatures.
+     */
+    contractSignatures: ContractSignature[];
+}
+export interface ListProjectsResponse {
+    /**
+     * Total number of Projects.
+     */
+    totalCount: number;
+    /**
+     * Paginated returned Projects.
+     */
+    projects: Project[];
+}
+export type ProjectApiCreateProjectRequest = {
+    /**
+     * Name of the Project.
+     */
+    name?: string;
+    /**
+     * Organization ID of the Project.
+     */
+    organizationId?: string;
+    /**
+     * Description of the Project.
+     */
+    description: string;
+};
+export type ProjectApiDeleteProjectRequest = {
+    /**
+     * Project ID of the Project.
+     */
+    projectId?: string;
+};
+export type ProjectApiGetProjectRequest = {
+    /**
+     * Project ID of the Project.
+     */
+    projectId?: string;
+};
+export type ProjectApiListProjectsRequest = {
+    /**
+     * Organization ID of the Project.
+     */
+    organizationId?: string;
+    /**
+     * Name of the Project.
+     */
+    name?: string;
+    /**
+     * Page number for the returned Projects.
+     */
+    page?: number;
+    /**
+     * Maximum number of Project per page.
+     */
+    pageSize?: number;
+    /**
+     * Sort order of the returned Projects.
+     */
+    orderBy?: ListProjectsRequestOrderBy;
+    /**
+     * Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
+     */
+    projectIds?: string[];
+};
+export type ProjectApiSetProjectQualificationRequest = {
+    /**
+     * Project ID.
+     */
+    projectId?: string;
+    /**
+     * Use case chosen for the Project.
+     */
+    qualification?: Qualification;
+};
+export type ProjectApiUpdateProjectRequest = {
+    /**
+     * Project ID of the Project.
+     */
+    projectId?: string;
+    /**
+     * Name of the Project.
+     */
+    name?: string;
+    /**
+     * Description of the Project.
+     */
+    description?: string;
+};
+export interface ProjectQualification {
+    /**
+     * Project ID.
+     */
+    projectId: string;
+    /**
+     * Qualification of the Project.
+     */
+    qualification?: Qualification;
+}