diff --git a/packages/clients/src/api/mnq/v1beta1/api.gen.ts b/packages/clients/src/api/mnq/v1beta1/api.gen.ts index c25482eca..443c71a7b 100644 --- a/packages/clients/src/api/mnq/v1beta1/api.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/api.gen.ts @@ -73,9 +73,9 @@ const jsonContentHeaders = { } /** - * Messaging and Queuing NATS API. + * NATS API. * - * This API allows you to manage Scaleway Messaging and Queuing NATS accounts. + * This API allows you to manage Scaleway NATS accounts. */ export class NatsAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -285,19 +285,19 @@ export class NatsAPI extends ParentAPI { } /** - * Messaging and Queuing SNS API. + * Topics and Events API. * - * This API allows you to manage your Scaleway Messaging and Queuing SNS - * brokers. + * This API allows you to manage your Scaleway Topics and Events. */ export class SnsAPI extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams'] /** - * Activate SNS. Activate SNS for the specified Project ID. SNS must be - * activated before any usage. Activating SNS does not trigger any billing, - * and you can deactivate at any time. + * Activate Topics and Events. Activate Topics and Events for the specified + * Project ID. Topics and Events must be activated before any usage. + * Activating Topics and Events does not trigger any billing, and you can + * deactivate at any time. * * @param request - The request {@link SnsApiActivateSnsRequest} * @returns A Promise of SnsInfo @@ -316,8 +316,9 @@ export class SnsAPI extends ParentAPI { ) /** - * Get SNS info. Retrieve the SNS information of the specified Project ID. - * Informations include the activation status and the SNS API endpoint URL. + * Get Topics and Events info. Retrieve the Topics and Events information of + * the specified Project ID. Informations include the activation status and + * the Topics and Events API endpoint URL. * * @param request - The request {@link SnsApiGetSnsInfoRequest} * @returns A Promise of SnsInfo @@ -336,9 +337,9 @@ export class SnsAPI extends ParentAPI { ) /** - * Deactivate SNS. Deactivate SNS for the specified Project ID.You must delete - * all topics and credentials before this call or you need to set the - * force_delete parameter. + * Deactivate Topics and Events. Deactivate Topics and Events for the + * specified Project ID. You must delete all topics and credentials before + * this call or you need to set the force_delete parameter. * * @param request - The request {@link SnsApiDeactivateSnsRequest} * @returns A Promise of SnsInfo @@ -357,9 +358,9 @@ export class SnsAPI extends ParentAPI { ) /** - * Create SNS credentials. Create a set of credentials for SNS, specified by a - * Project ID. Credentials give the bearer access to topics, and the level of - * permissions can be defined granularly. + * Create Topics and Events credentials. Create a set of credentials for + * Topics and Events, specified by a Project ID. Credentials give the bearer + * access to topics, and the level of permissions can be defined granularly. * * @param request - The request {@link SnsApiCreateSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -383,9 +384,10 @@ export class SnsAPI extends ParentAPI { ) /** - * Delete SNS credentials. Delete a set of SNS credentials, specified by their - * credentials ID. Deleting credentials is irreversible and cannot be undone. - * The credentials can then no longer be used to access SNS. + * Delete Topics and Events credentials. Delete a set of Topics and Events + * credentials, specified by their credentials ID. Deleting credentials is + * irreversible and cannot be undone. The credentials can then no longer be + * used to access Topics and Events. * * @param request - The request {@link SnsApiDeleteSnsCredentialsRequest} */ @@ -398,8 +400,8 @@ export class SnsAPI extends ParentAPI { }) /** - * Update SNS credentials. Update a set of SNS credentials. You can update the - * credentials' name, or their permissions. + * Update Topics and Events credentials. Update a set of Topics and Events + * credentials. You can update the credentials' name, or their permissions. * * @param request - The request {@link SnsApiUpdateSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -423,9 +425,9 @@ export class SnsAPI extends ParentAPI { ) /** - * Get SNS credentials. Retrieve an existing set of credentials, identified by - * the `credentials_id`. The credentials themselves, as well as their metadata - * (name, project ID etc), are returned in the response. + * Get Topics and Events credentials. Retrieve an existing set of credentials, + * identified by the `credentials_id`. The credentials themselves, as well as + * their metadata (name, project ID etc), are returned in the response. * * @param request - The request {@link SnsApiGetSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -460,9 +462,9 @@ export class SnsAPI extends ParentAPI { ) /** - * List SNS credentials. List existing SNS credentials in the specified - * region. The response contains only the metadata for the credentials, not - * the credentials themselves. + * List Topics and Events credentials. List existing Topics and Events + * credentials in the specified region. The response contains only the + * metadata for the credentials, not the credentials themselves. * * @param request - The request {@link SnsApiListSnsCredentialsRequest} * @returns A Promise of ListSnsCredentialsResponse @@ -478,20 +480,19 @@ export class SnsAPI extends ParentAPI { } /** - * Messaging and Queuing SQS API. + * Queues API. * - * This API allows you to manage your Scaleway Messaging and Queuing SQS - * brokers. + * This API allows you to manage your Scaleway Queues. */ export class SqsAPI extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams'] /** - * Activate SQS. Activate SQS for the specified Project ID. SQS must be - * activated before any usage such as creating credentials and queues. - * Activating SQS does not trigger any billing, and you can deactivate at any - * time. + * Activate Queues. Activate Queues for the specified Project ID. Queues must + * be activated before any usage such as creating credentials and queues. + * Activating Queues does not trigger any billing, and you can deactivate at + * any time. * * @param request - The request {@link SqsApiActivateSqsRequest} * @returns A Promise of SqsInfo @@ -510,8 +511,9 @@ export class SqsAPI extends ParentAPI { ) /** - * Get SQS info. Retrieve the SQS information of the specified Project ID. - * Informations include the activation status and the SQS API endpoint URL. + * Get Queues info. Retrieve the Queues information of the specified Project + * ID. Informations include the activation status and the Queues API endpoint + * URL. * * @param request - The request {@link SqsApiGetSqsInfoRequest} * @returns A Promise of SqsInfo @@ -530,7 +532,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Deactivate SQS. Deactivate SQS for the specified Project ID. You must + * Deactivate Queues. Deactivate Queues for the specified Project ID. You must * delete all queues and credentials before this call or you need to set the * force_delete parameter. * @@ -551,9 +553,9 @@ export class SqsAPI extends ParentAPI { ) /** - * Create SQS credentials. Create a set of credentials for SQS, specified by a - * Project ID. Credentials give the bearer access to queues, and the level of - * permissions can be defined granularly. + * Create Queues credentials. Create a set of credentials for Queues, + * specified by a Project ID. Credentials give the bearer access to queues, + * and the level of permissions can be defined granularly. * * @param request - The request {@link SqsApiCreateSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -577,9 +579,9 @@ export class SqsAPI extends ParentAPI { ) /** - * Delete SQS credentials. Delete a set of SQS credentials, specified by their - * credentials ID. Deleting credentials is irreversible and cannot be undone. - * The credentials can then no longer be used to access SQS. + * Delete Queues credentials. Delete a set of Queues credentials, specified by + * their credentials ID. Deleting credentials is irreversible and cannot be + * undone. The credentials can then no longer be used to access Queues. * * @param request - The request {@link SqsApiDeleteSqsCredentialsRequest} */ @@ -592,8 +594,8 @@ export class SqsAPI extends ParentAPI { }) /** - * Update SQS credentials. Update a set of SQS credentials. You can update the - * credentials' name, or their permissions. + * Update Queues credentials. Update a set of Queues credentials. You can + * update the credentials' name, or their permissions. * * @param request - The request {@link SqsApiUpdateSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -617,9 +619,9 @@ export class SqsAPI extends ParentAPI { ) /** - * Get SQS credentials. Retrieve an existing set of credentials, identified by - * the `credentials_id`. The credentials themselves, as well as their metadata - * (name, project ID etc), are returned in the response. + * Get Queues credentials. Retrieve an existing set of credentials, identified + * by the `credentials_id`. The credentials themselves, as well as their + * metadata (name, project ID etc), are returned in the response. * * @param request - The request {@link SqsApiGetSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -654,7 +656,7 @@ export class SqsAPI extends ParentAPI { ) /** - * List SQS credentials. List existing SQS credentials in the specified + * List Queues credentials. List existing Queues credentials in the specified * region. The response contains only the metadata for the credentials, not * the credentials themselves. * diff --git a/packages/clients/src/api/mnq/v1beta1/types.gen.ts b/packages/clients/src/api/mnq/v1beta1/types.gen.ts index 398605069..09de3c093 100644 --- a/packages/clients/src/api/mnq/v1beta1/types.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/types.gen.ts @@ -48,7 +48,7 @@ export interface File { export interface SnsPermissions { /** * Defines whether the credentials bearer can publish messages to the service - * (publish to SNS topics). + * (publish to Topics and Events topics). */ canPublish?: boolean /** @@ -57,8 +57,8 @@ export interface SnsPermissions { */ canReceive?: boolean /** - * Defines whether the credentials bearer can manage the associated SNS topics - * or subscriptions. + * Defines whether the credentials bearer can manage the associated Topics and + * Events topics or subscriptions. */ canManage?: boolean } @@ -66,16 +66,16 @@ export interface SnsPermissions { export interface SqsPermissions { /** * Defines whether the credentials bearer can publish messages to the service - * (send messages to SQS queues). + * (send messages to Queues queues). */ canPublish?: boolean /** - * Defines whether the credentials bearer can receive messages from SQS + * Defines whether the credentials bearer can receive messages from Queues * queues. */ canReceive?: boolean /** - * Defines whether the credentials bearer can manage the associated SQS + * Defines whether the credentials bearer can manage the associated Queues * queues. */ canManage?: boolean @@ -133,7 +133,10 @@ export interface SnsCredentials { updatedAt?: Date /** Access key ID. */ accessKey: string - /** Secret key ID (Only returned by **Create SNS Credentials** call). */ + /** + * Secret key ID (Only returned by **Create Topics and Events Credentials** + * call). + */ secretKey: string /** Checksum of the Secret key. */ secretChecksum: string @@ -156,7 +159,7 @@ export interface SqsCredentials { updatedAt?: Date /** Access key ID. */ accessKey: string - /** Secret key ID (Only returned by **Create SQS Credentials** call). */ + /** Secret key ID (Only returned by **Create Queues Credentials** call). */ secretKey: string /** Checksum of the Secret key. */ secretChecksum: string @@ -181,14 +184,14 @@ export interface ListNatsCredentialsResponse { export interface ListSnsCredentialsResponse { /** Total count of existing credentials (matching any filters specified). */ totalCount: number - /** SNS credentials on this page. */ + /** Topics and Events credentials on this page. */ snsCredentials: SnsCredentials[] } export interface ListSqsCredentialsResponse { /** Total count of existing credentials (matching any filters specified). */ totalCount: number - /** SQS credentials on this page. */ + /** Queues credentials on this page. */ sqsCredentials: SqsCredentials[] } @@ -308,7 +311,7 @@ export type SnsApiActivateSnsRequest = { * config. */ region?: Region - /** Project on which to activate the SNS service. */ + /** Project on which to activate the Topics and Events service. */ projectId?: string } @@ -318,7 +321,7 @@ export type SnsApiCreateSnsCredentialsRequest = { * config. */ region?: Region - /** Project containing the SNS credentials. */ + /** Project containing the Topics and Events credentials. */ projectId?: string /** Name of the credentials. */ name?: string @@ -332,7 +335,7 @@ export type SnsApiDeactivateSnsRequest = { * config. */ region?: Region - /** Project on which to deactivate the SNS service. */ + /** Project on which to deactivate the Topics and Events service. */ projectId?: string } @@ -352,7 +355,7 @@ export type SnsApiGetSnsCredentialsRequest = { * config. */ region?: Region - /** ID of the SNS credentials to get. */ + /** ID of the Topics and Events credentials to get. */ snsCredentialsId: string } @@ -362,7 +365,7 @@ export type SnsApiGetSnsInfoRequest = { * config. */ region?: Region - /** Project to retrieve SNS info from. */ + /** Project to retrieve Topics and Events info from. */ projectId?: string } @@ -372,7 +375,7 @@ export type SnsApiListSnsCredentialsRequest = { * config. */ region?: Region - /** Include only SNS credentials in this Project. */ + /** Include only Topics and Events credentials in this Project. */ projectId?: string /** Page number to return. */ page?: number @@ -388,7 +391,7 @@ export type SnsApiUpdateSnsCredentialsRequest = { * config. */ region?: Region - /** ID of the SNS credentials to update. */ + /** ID of the Topics and Events credentials to update. */ snsCredentialsId: string /** Name of the credentials. */ name?: string @@ -401,13 +404,13 @@ export interface SnsInfo { projectId: string /** Region of the service. */ region: Region - /** SNS creation date. */ + /** Topics and Events creation date. */ createdAt?: Date - /** SNS last modification date. */ + /** Topics and Events last modification date. */ updatedAt?: Date - /** SNS activation status. */ + /** Topics and Events activation status. */ status: SnsInfoStatus - /** Endpoint of the SNS service for this region and project. */ + /** Endpoint of the Topics and Events service for this region and project. */ snsEndpointUrl: string } @@ -417,7 +420,7 @@ export type SqsApiActivateSqsRequest = { * config. */ region?: Region - /** Project on which to activate the SQS service. */ + /** Project on which to activate the Queues service. */ projectId?: string } @@ -427,7 +430,7 @@ export type SqsApiCreateSqsCredentialsRequest = { * config. */ region?: Region - /** Project containing the SQS credentials. */ + /** Project containing the Queues credentials. */ projectId?: string /** Name of the credentials. */ name?: string @@ -441,7 +444,7 @@ export type SqsApiDeactivateSqsRequest = { * config. */ region?: Region - /** Project on which to deactivate the SQS service. */ + /** Project on which to deactivate the Queues service. */ projectId?: string } @@ -461,7 +464,7 @@ export type SqsApiGetSqsCredentialsRequest = { * config. */ region?: Region - /** ID of the SQS credentials to get. */ + /** ID of the Queues credentials to get. */ sqsCredentialsId: string } @@ -471,7 +474,7 @@ export type SqsApiGetSqsInfoRequest = { * config. */ region?: Region - /** Project to retrieve SQS info from. */ + /** Project to retrieve Queues info from. */ projectId?: string } @@ -481,7 +484,7 @@ export type SqsApiListSqsCredentialsRequest = { * config. */ region?: Region - /** Include only SQS credentials in this Project. */ + /** Include only Queues credentials in this Project. */ projectId?: string /** Page number to return. */ page?: number @@ -497,7 +500,7 @@ export type SqsApiUpdateSqsCredentialsRequest = { * config. */ region?: Region - /** ID of the SQS credentials to update. */ + /** ID of the Queues credentials to update. */ sqsCredentialsId: string /** Name of the credentials. */ name?: string @@ -510,12 +513,12 @@ export interface SqsInfo { projectId: string /** Region of the service. */ region: Region - /** SQS creation date. */ + /** Queues creation date. */ createdAt?: Date - /** SQS last modification date. */ + /** Queues last modification date. */ updatedAt?: Date - /** SQS activation status. */ + /** Queues activation status. */ status: SqsInfoStatus - /** Endpoint of the SQS service for this region and project. */ + /** Endpoint of the Queues service for this region and project. */ sqsEndpointUrl: string }