@scaleway/sdk 1.33.0 → 1.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -2953,12 +2953,33 @@ type DownloadInvoiceRequest = {
2953
2953
  * This API allows you to query your consumption. Billing API.
2954
2954
  */
2955
2955
  declare class API$q extends API$u {
2956
+ /**
2957
+ * Get current month's consumption. The consumption reflects the amount of
2958
+ * money you have spent for the products you have used. The consumption value
2959
+ * is monetary and is not computed in real time.
2960
+ *
2961
+ * @param request - The request {@link GetConsumptionRequest}
2962
+ * @returns A Promise of GetConsumptionResponse
2963
+ */
2956
2964
  getConsumption: (request?: Readonly<GetConsumptionRequest>) => Promise<GetConsumptionResponse>;
2957
2965
  protected pageOfListInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse>;
2966
+ /**
2967
+ * List invoices. List all your invoices, filtering by `start_date` and
2968
+ * `invoice_type`. Each invoice has its own ID.
2969
+ *
2970
+ * @param request - The request {@link ListInvoicesRequest}
2971
+ * @returns A Promise of ListInvoicesResponse
2972
+ */
2958
2973
  listInvoices: (request?: Readonly<ListInvoicesRequest>) => Promise<ListInvoicesResponse> & {
2959
2974
  all: () => Promise<Invoice[]>;
2960
2975
  [Symbol.asyncIterator]: () => AsyncGenerator<Invoice[], void, void>;
2961
2976
  };
2977
+ /**
2978
+ * Download an invoice. Download a specific invoice, specified by its ID.
2979
+ *
2980
+ * @param request - The request {@link DownloadInvoiceRequest}
2981
+ * @returns A Promise of Blob
2982
+ */
2962
2983
  downloadInvoice: (request: Readonly<DownloadInvoiceRequest>) => Promise<Blob>;
2963
2984
  }
2964
2985
 
@@ -2991,7 +3012,7 @@ type VolumeStatus = 'unknown_status' | 'creating' | 'available' | 'in_use' | 'de
2991
3012
  interface CreateVolumeRequestFromEmpty {
2992
3013
  /**
2993
3014
  * Volume size in bytes, with a granularity of 1 GB (10^9 bytes). Must be
2994
- * compliant with the minimum and maximum allowed size.
3015
+ * compliant with the minimum (1 GB) and maximum (10 TB) allowed size.
2995
3016
  */
2996
3017
  size: number;
2997
3018
  }
@@ -2999,12 +3020,12 @@ interface CreateVolumeRequestFromEmpty {
2999
3020
  interface CreateVolumeRequestFromSnapshot {
3000
3021
  /**
3001
3022
  * Volume size in bytes, with a granularity of 1 GB (10^9 bytes). Must be
3002
- * compliant with the allowed minimum and maximum allowed size. Size is
3023
+ * compliant with the minimum (1 GB) and maximum (10 TB) allowed size. Size is
3003
3024
  * optional and is used only if a resize of the volume is requested, otherwise
3004
3025
  * original snapshot size will be used.
3005
3026
  */
3006
3027
  size?: number;
3007
- /** Source snapshot from which create a volume. */
3028
+ /** Source snapshot from which volume will be created. */
3008
3029
  snapshotId: string;
3009
3030
  }
3010
3031
  /** List snapshots response. */
@@ -3016,7 +3037,7 @@ interface ListSnapshotsResponse$3 {
3016
3037
  }
3017
3038
  /** List volume types response. */
3018
3039
  interface ListVolumeTypesResponse {
3019
- /** Paginated returned list of volume-types. */
3040
+ /** Returns paginated list of volume-types. */
3020
3041
  volumeTypes: VolumeType$3[];
3021
3042
  /** Total number of volume-types currently available in stock. */
3022
3043
  totalCount: number;
@@ -3032,7 +3053,7 @@ interface ListVolumesResponse$2 {
3032
3053
  interface Reference {
3033
3054
  /** UUID of the reference. */
3034
3055
  id: string;
3035
- /** Type of the resoruce the reference is associated (else snapshot or volume). */
3056
+ /** Type of resoruce to which the reference is associated (snapshot or volume). */
3036
3057
  productResourceType: string;
3037
3058
  /**
3038
3059
  * UUID of the volume or the snapshot it refers to (according to the
@@ -3041,9 +3062,9 @@ interface Reference {
3041
3062
  productResourceId: string;
3042
3063
  /** Creation date of the reference. */
3043
3064
  createdAt?: Date;
3044
- /** Type of the reference (link, exclusive, read_only). */
3065
+ /** Type of reference (link, exclusive, read_only). */
3045
3066
  type: ReferenceType;
3046
- /** Status of the reference (attaching, attached, detaching). */
3067
+ /** Status of reference (attaching, attached, detaching). */
3047
3068
  status: ReferenceStatus;
3048
3069
  }
3049
3070
  /** Snapshot. */
@@ -3053,8 +3074,8 @@ interface Snapshot$3 {
3053
3074
  /** Name of the snapshot. */
3054
3075
  name: string;
3055
3076
  /**
3056
- * Informations about the parent volume. If the parent volume has been
3057
- * deleted, value is null.
3077
+ * Information about the parent volume. If the parent volume was deleted,
3078
+ * value is null.
3058
3079
  */
3059
3080
  parentVolume?: SnapshotParentVolume;
3060
3081
  /** Size in bytes of the snapshot. */
@@ -3078,13 +3099,13 @@ interface Snapshot$3 {
3078
3099
  }
3079
3100
  /** Snapshot. parent volume. */
3080
3101
  interface SnapshotParentVolume {
3081
- /** Volume ID on which the snapshot is based. */
3102
+ /** Parent volume UUID (volume from which the snapshot originates). */
3082
3103
  id: string;
3083
- /** Name of the parent volume from which the snapshot has been taken. */
3104
+ /** Name of the parent volume. */
3084
3105
  name: string;
3085
- /** Volume type of the parent volume from which the snapshot has been taken. */
3106
+ /** Volume type of the parent volume. */
3086
3107
  type: string;
3087
- /** Current status the parent volume from which the snapshot has been taken. */
3108
+ /** Current status the parent volume. */
3088
3109
  status: VolumeStatus;
3089
3110
  }
3090
3111
  /** Snapshot summary. */
@@ -3098,7 +3119,7 @@ interface SnapshotSummary {
3098
3119
  * value is null.
3099
3120
  */
3100
3121
  parentVolume?: SnapshotParentVolume;
3101
- /** Size in bytes of the snapshot. */
3122
+ /** Size of the snapshot in bytes. */
3102
3123
  size: number;
3103
3124
  /** UUID of the project the snapshot belongs to. */
3104
3125
  projectId: string;
@@ -3110,7 +3131,7 @@ interface SnapshotSummary {
3110
3131
  status: SnapshotStatus$2;
3111
3132
  /** List of tags assigned to the volume. */
3112
3133
  tags: string[];
3113
- /** Snapshot zone. */
3134
+ /** Snapshot Availability Zone. */
3114
3135
  zone: Zone;
3115
3136
  /** Storage class of the snapshot. */
3116
3137
  class: StorageClass;
@@ -3121,15 +3142,15 @@ interface Volume$4 {
3121
3142
  id: string;
3122
3143
  /** Name of the volume. */
3123
3144
  name: string;
3124
- /** Type of the volume. */
3145
+ /** Volume type. */
3125
3146
  type: string;
3126
3147
  /** Volume size in bytes. */
3127
3148
  size: number;
3128
- /** UUID of the project the volume belongs to. */
3149
+ /** UUID of the project to which the volume belongs. */
3129
3150
  projectId: string;
3130
3151
  /** Creation date of the volume. */
3131
3152
  createdAt?: Date;
3132
- /** Last modification date of the properties of a volume. */
3153
+ /** Last update of the properties of a volume. */
3133
3154
  updatedAt?: Date;
3134
3155
  /** List of the references to the volume. */
3135
3156
  references: Reference[];
@@ -3144,7 +3165,7 @@ interface Volume$4 {
3144
3165
  tags: string[];
3145
3166
  /** Volume zone. */
3146
3167
  zone: Zone;
3147
- /** Volume specifications of the volume. */
3168
+ /** Specifications of the volume. */
3148
3169
  specs?: VolumeSpecifications;
3149
3170
  }
3150
3171
  /** Volume specifications. */
@@ -3159,7 +3180,7 @@ interface VolumeSpecifications {
3159
3180
  }
3160
3181
  /** Volume type. */
3161
3182
  interface VolumeType$3 {
3162
- /** Internal type of the volume. */
3183
+ /** Volume type. */
3163
3184
  type: string;
3164
3185
  /** Price of the volume billed in GB/hour. */
3165
3186
  pricing?: Money;
@@ -3171,40 +3192,40 @@ interface VolumeType$3 {
3171
3192
  type ListVolumeTypesRequest$1 = {
3172
3193
  /** Zone to target. If none is passed will use default zone from the config. */
3173
3194
  zone?: Zone;
3174
- /** Positive integer to choose the page to return. */
3195
+ /** Page number. */
3175
3196
  page?: number;
3176
3197
  /**
3177
- * Positive integer lower or equal to 100 to select the number of items to
3178
- * return.
3198
+ * Page size, defines how many entries are returned in one page, must be lower
3199
+ * or equal to 100.
3179
3200
  */
3180
3201
  pageSize?: number;
3181
3202
  };
3182
3203
  type ListVolumesRequest$3 = {
3183
3204
  /** Zone to target. If none is passed will use default zone from the config. */
3184
3205
  zone?: Zone;
3185
- /** Sort order of the returned volumes. */
3206
+ /** Criteria to use when ordering the list. */
3186
3207
  orderBy?: ListVolumesRequestOrderBy$1;
3187
- /** Only list volumes of this project ID. */
3208
+ /** Filter by Project ID. */
3188
3209
  projectId?: string;
3189
- /** Positive integer to choose the page to return. */
3210
+ /** Page number. */
3190
3211
  page?: number;
3191
3212
  /**
3192
- * Positive integer lower or equal to 100 to select the number of items to
3193
- * return.
3213
+ * Page size, defines how many entries are returned in one page, must be lower
3214
+ * or equal to 100.
3194
3215
  */
3195
3216
  pageSize?: number;
3196
3217
  /** Filter the return volumes by their names. */
3197
3218
  name?: string;
3198
3219
  /**
3199
- * Filter by a Product Resource Id linked to this volume (such as an Instance
3200
- * Server Id).
3220
+ * Filter by a product resource ID linked to this volume (such as an Instance
3221
+ * ID).
3201
3222
  */
3202
3223
  productResourceId?: string;
3203
3224
  };
3204
3225
  type CreateVolumeRequest$3 = {
3205
3226
  /** Zone to target. If none is passed will use default zone from the config. */
3206
3227
  zone?: Zone;
3207
- /** Name of the volume you want to create. */
3228
+ /** Name of the volume. */
3208
3229
  name: string;
3209
3230
  /**
3210
3231
  * The maximum IO/s expected, according to the different options available in
@@ -3216,13 +3237,13 @@ type CreateVolumeRequest$3 = {
3216
3237
  /** UUID of the project the volume belongs to. */
3217
3238
  projectId?: string;
3218
3239
  /**
3219
- * Create a new and empty volume.
3240
+ * Specify the size of the new volume if creating a new one from scratch.
3220
3241
  *
3221
3242
  * One-of ('from'): at most one of 'fromEmpty', 'fromSnapshot' could be set.
3222
3243
  */
3223
3244
  fromEmpty?: CreateVolumeRequestFromEmpty;
3224
3245
  /**
3225
- * Create a volume from an existing snapshot.
3246
+ * Specify the snapshot ID of the original snapshot.
3226
3247
  *
3227
3248
  * One-of ('from'): at most one of 'fromEmpty', 'fromSnapshot' could be set.
3228
3249
  */
@@ -3233,7 +3254,7 @@ type CreateVolumeRequest$3 = {
3233
3254
  type GetVolumeRequest$2 = {
3234
3255
  /** Zone to target. If none is passed will use default zone from the config. */
3235
3256
  zone?: Zone;
3236
- /** UUID of the volume you want to get. */
3257
+ /** UUID of the volume. */
3237
3258
  volumeId: string;
3238
3259
  };
3239
3260
  type DeleteVolumeRequest$2 = {
@@ -3250,37 +3271,38 @@ type UpdateVolumeRequest$2 = {
3250
3271
  /** When defined, is the new name of the volume. */
3251
3272
  name?: string;
3252
3273
  /**
3253
- * Optional field for growing a volume (size must be equal or larger than the
3254
- * current one). Size in bytes of the volume, with a granularity of 1 GB (10^9
3255
- * bytes). Must be compliant with the minimum and maximum allowed size.
3274
+ * Optional field for increasing the size of a volume (size must be equal or
3275
+ * larger than the current one). Size in bytes of the volume, with a
3276
+ * granularity of 1 GB (10^9 bytes). Must be compliant with the minimum (1GB)
3277
+ * and maximum (10TB) allowed size.
3256
3278
  */
3257
3279
  size?: number;
3258
3280
  /** List of tags assigned to the volume. */
3259
3281
  tags?: string[];
3260
3282
  /**
3261
3283
  * The maximum IO/s expected, according to the different options available in
3262
- * stock (`5000 | 15000`). The selected value must be available on the Storage
3263
- * Class where is currently located the volume.
3284
+ * stock (`5000 | 15000`). The selected value must be available for the
3285
+ * volume's current storage class.
3264
3286
  */
3265
3287
  perfIops?: number;
3266
3288
  };
3267
3289
  type ListSnapshotsRequest$4 = {
3268
3290
  /** Zone to target. If none is passed will use default zone from the config. */
3269
3291
  zone?: Zone;
3270
- /** Sort order of the returned snapshots. */
3292
+ /** Criteria to use when ordering the list. */
3271
3293
  orderBy?: ListSnapshotsRequestOrderBy$2;
3272
- /** Only list snapshots of this project ID. */
3294
+ /** Filter by Project ID. */
3273
3295
  projectId?: string;
3274
- /** Positive integer to choose the page to return. */
3296
+ /** Page number. */
3275
3297
  page?: number;
3276
3298
  /**
3277
- * Positive integer lower or equal to 100 to select the number of items to
3278
- * return.
3299
+ * Page size, defines how many entries are returned in one page, must be lower
3300
+ * or equal to 100.
3279
3301
  */
3280
3302
  pageSize?: number;
3281
- /** Filter the return snapshots by the volume it belongs to. */
3303
+ /** Filter snapshots by the ID of the original volume. */
3282
3304
  volumeId?: string;
3283
- /** Filter the return snapshots by their names. */
3305
+ /** Filter snapshots by their names. */
3284
3306
  name?: string;
3285
3307
  };
3286
3308
  type GetSnapshotRequest$3 = {
@@ -3292,11 +3314,11 @@ type GetSnapshotRequest$3 = {
3292
3314
  type CreateSnapshotRequest$4 = {
3293
3315
  /** Zone to target. If none is passed will use default zone from the config. */
3294
3316
  zone?: Zone;
3295
- /** UUID of the volume from which creates a snpashot. */
3317
+ /** UUID of the volume to snapshot. */
3296
3318
  volumeId: string;
3297
3319
  /** Name of the snapshot. */
3298
3320
  name: string;
3299
- /** UUID of the project the volume and the snapshot belong to. */
3321
+ /** UUID of the project to which the volume and the snapshot belong. */
3300
3322
  projectId?: string;
3301
3323
  /** List of tags assigned to the snapshot. */
3302
3324
  tags?: string[];
@@ -3319,10 +3341,10 @@ type UpdateSnapshotRequest$3 = {
3319
3341
  };
3320
3342
 
3321
3343
  /**
3322
- * Scaleway Block Storage (SBS) API.
3344
+ * Scaleway Block Storage API.
3323
3345
  *
3324
3346
  * This API allows you to use and manage your Block Storage volumes. Scaleway
3325
- * Block Storage (SBS) API.
3347
+ * Block Storage API.
3326
3348
  */
3327
3349
  declare class API$p extends API$u {
3328
3350
  /** Lists the available zones of the API. */
@@ -3342,8 +3364,8 @@ declare class API$p extends API$u {
3342
3364
  protected pageOfListVolumes: (request?: Readonly<ListVolumesRequest$3>) => Promise<ListVolumesResponse$2>;
3343
3365
  /**
3344
3366
  * List volumes. List all existing volumes in a specified zone. By default,
3345
- * the volume listed are ordered by creation date in ascending order. This can
3346
- * be modified via the `order_by` field.
3367
+ * the volumes listed are ordered by creation date in ascending order. This
3368
+ * can be modified via the `order_by` field.
3347
3369
  *
3348
3370
  * @param request - The request {@link ListVolumesRequest}
3349
3371
  * @returns A Promise of ListVolumesResponse
@@ -3353,13 +3375,12 @@ declare class API$p extends API$u {
3353
3375
  [Symbol.asyncIterator]: () => AsyncGenerator<Volume$4[], void, void>;
3354
3376
  };
3355
3377
  /**
3356
- * Create a new empty volume by specifying the `size`. To create a volume from
3357
- * an existing snapshot, specify the `snapshot_id` in the request payload
3378
+ * Create a volume. To create a new volume from scratch, you must specify
3379
+ * `from_empty` and the `size`. To create a volume from an existing snapshot,
3380
+ * specify `from_snapshot` and the `snapshot_id` in the request payload
3358
3381
  * instead, size is optional and can be specified if you need to extend the
3359
- * original size. In that case the created volume will have the same volume
3360
- * class (and underlying IOPS limitations) as the originating snapshot. You
3361
- * can specify the desired performance of the volume by setting `requirements`
3362
- * accordingly.
3382
+ * original size. The volume will take on the same volume class and underlying
3383
+ * IOPS limitations as the original snapshot.
3363
3384
  *
3364
3385
  * @param request - The request {@link CreateVolumeRequest}
3365
3386
  * @returns A Promise of Volume
@@ -3389,10 +3410,10 @@ declare class API$p extends API$u {
3389
3410
  */
3390
3411
  deleteVolume: (request: Readonly<DeleteVolumeRequest$2>) => Promise<void>;
3391
3412
  /**
3392
- * Update a volume. Update technical details about a volume, such as its name,
3393
- * tags, or its new size and `volume_type` (within the same Block Storage
3394
- * class). You can only resize a volume to a larger size. It is not possible
3395
- * for now to change your Block Storage Class.
3413
+ * Update a volume. Update the technical details of a volume, such as its
3414
+ * name, tags, or its new size and `volume_type` (within the same Block
3415
+ * Storage class). You can only resize a volume to a larger size. It is
3416
+ * currently not possible to change your Block Storage Class.
3396
3417
  *
3397
3418
  * @param request - The request {@link UpdateVolumeRequest}
3398
3419
  * @returns A Promise of Volume
@@ -3445,7 +3466,7 @@ declare class API$p extends API$u {
3445
3466
  */
3446
3467
  deleteSnapshot: (request: Readonly<DeleteSnapshotRequest$3>) => Promise<void>;
3447
3468
  /**
3448
- * Update a snapshot. Update name or tags of the snapshot.
3469
+ * Update a snapshot. Update the name or tags of the snapshot.
3449
3470
  *
3450
3471
  * @param request - The request {@link UpdateSnapshotRequest}
3451
3472
  * @returns A Promise of Snapshot
@@ -3526,6 +3547,7 @@ declare namespace index$q {
3526
3547
  type CockpitStatus = 'unknown_status' | 'creating' | 'ready' | 'deleting' | 'updating' | 'error';
3527
3548
  type DatasourceType = 'unknown_datasource_type' | 'metrics' | 'logs' | 'traces' | 'alerts';
3528
3549
  type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
3550
+ type ListDatasourcesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
3529
3551
  type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
3530
3552
  type ListPlansRequestOrderBy = 'name_asc' | 'name_desc';
3531
3553
  type ListTokensRequestOrderBy$2 = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
@@ -3613,6 +3635,13 @@ interface ListContactPointsResponse {
3613
3635
  /** Specifies whether there are unmanaged contact points. */
3614
3636
  hasAdditionalContactPoints: boolean;
3615
3637
  }
3638
+ /** List datasources response. */
3639
+ interface ListDatasourcesResponse {
3640
+ /** Count of all datasources corresponding to the request. */
3641
+ totalCount: number;
3642
+ /** List of the datasources within the pagination. */
3643
+ datasources: Datasource[];
3644
+ }
3616
3645
  /** Response returned when listing Grafana users. List grafana users response. */
3617
3646
  interface ListGrafanaUsersResponse {
3618
3647
  /** Count of all Grafana users. */
@@ -3726,6 +3755,18 @@ type CreateDatasourceRequest = {
3726
3755
  /** Datasource type. */
3727
3756
  type?: DatasourceType;
3728
3757
  };
3758
+ type ListDatasourcesRequest = {
3759
+ /** Page number. */
3760
+ page?: number;
3761
+ /** Page size. */
3762
+ pageSize?: number;
3763
+ /** How the response is ordered. */
3764
+ orderBy?: ListDatasourcesRequestOrderBy;
3765
+ /** ID of the Project. */
3766
+ projectId?: string;
3767
+ /** Filter by datasource types. */
3768
+ types?: DatasourceType[];
3769
+ };
3729
3770
  type CreateTokenRequest$2 = {
3730
3771
  /** ID of the Project. */
3731
3772
  projectId?: string;
@@ -3739,6 +3780,7 @@ type ListTokensRequest$2 = {
3739
3780
  page?: number;
3740
3781
  /** Page size. */
3741
3782
  pageSize?: number;
3783
+ /** How the response is ordered. */
3742
3784
  orderBy?: ListTokensRequestOrderBy$2;
3743
3785
  /** ID of the Project. */
3744
3786
  projectId?: string;
@@ -3883,6 +3925,17 @@ declare class API$o extends API$u {
3883
3925
  * @returns A Promise of Datasource
3884
3926
  */
3885
3927
  createDatasource: (request: Readonly<CreateDatasourceRequest>) => Promise<Datasource>;
3928
+ protected pageOfListDatasources: (request?: Readonly<ListDatasourcesRequest>) => Promise<ListDatasourcesResponse>;
3929
+ /**
3930
+ * Get a list of datasources for the specified Project ID.
3931
+ *
3932
+ * @param request - The request {@link ListDatasourcesRequest}
3933
+ * @returns A Promise of ListDatasourcesResponse
3934
+ */
3935
+ listDatasources: (request?: Readonly<ListDatasourcesRequest>) => Promise<ListDatasourcesResponse> & {
3936
+ all: () => Promise<Datasource[]>;
3937
+ [Symbol.asyncIterator]: () => AsyncGenerator<Datasource[], void, void>;
3938
+ };
3886
3939
  /**
3887
3940
  * Create a token associated with the specified Project ID.
3888
3941
  *
@@ -4040,6 +4093,9 @@ type index_gen$l_GrafanaUser = GrafanaUser;
4040
4093
  type index_gen$l_GrafanaUserRole = GrafanaUserRole;
4041
4094
  type index_gen$l_ListContactPointsRequest = ListContactPointsRequest;
4042
4095
  type index_gen$l_ListContactPointsResponse = ListContactPointsResponse;
4096
+ type index_gen$l_ListDatasourcesRequest = ListDatasourcesRequest;
4097
+ type index_gen$l_ListDatasourcesRequestOrderBy = ListDatasourcesRequestOrderBy;
4098
+ type index_gen$l_ListDatasourcesResponse = ListDatasourcesResponse;
4043
4099
  type index_gen$l_ListGrafanaUsersRequest = ListGrafanaUsersRequest;
4044
4100
  type index_gen$l_ListGrafanaUsersRequestOrderBy = ListGrafanaUsersRequestOrderBy;
4045
4101
  type index_gen$l_ListGrafanaUsersResponse = ListGrafanaUsersResponse;
@@ -4055,7 +4111,7 @@ type index_gen$l_SelectPlanResponse = SelectPlanResponse;
4055
4111
  type index_gen$l_TokenScopes = TokenScopes;
4056
4112
  type index_gen$l_TriggerTestAlertRequest = TriggerTestAlertRequest;
4057
4113
  declare namespace index_gen$l {
4058
- export { API$o as API, type index_gen$l_ActivateCockpitRequest as ActivateCockpitRequest, index_gen$l_COCKPIT_TRANSIENT_STATUSES as COCKPIT_TRANSIENT_STATUSES, type index_gen$l_Cockpit as Cockpit, type index_gen$l_CockpitEndpoints as CockpitEndpoints, type index_gen$l_CockpitMetrics as CockpitMetrics, type index_gen$l_CockpitStatus as CockpitStatus, type index_gen$l_ContactPoint as ContactPoint, type index_gen$l_ContactPointEmail as ContactPointEmail, type index_gen$l_CreateContactPointRequest as CreateContactPointRequest, type index_gen$l_CreateDatasourceRequest as CreateDatasourceRequest, type index_gen$l_CreateGrafanaUserRequest as CreateGrafanaUserRequest, type CreateTokenRequest$2 as CreateTokenRequest, type index_gen$l_Datasource as Datasource, type index_gen$l_DatasourceType as DatasourceType, type index_gen$l_DeactivateCockpitRequest as DeactivateCockpitRequest, type index_gen$l_DeleteContactPointRequest as DeleteContactPointRequest, type index_gen$l_DeleteGrafanaUserRequest as DeleteGrafanaUserRequest, type DeleteTokenRequest$2 as DeleteTokenRequest, type index_gen$l_DisableManagedAlertsRequest as DisableManagedAlertsRequest, type index_gen$l_EnableManagedAlertsRequest as EnableManagedAlertsRequest, type index_gen$l_GetCockpitMetricsRequest as GetCockpitMetricsRequest, type index_gen$l_GetCockpitRequest as GetCockpitRequest, type GetTokenRequest$2 as GetTokenRequest, type index_gen$l_GrafanaUser as GrafanaUser, type index_gen$l_GrafanaUserRole as GrafanaUserRole, type index_gen$l_ListContactPointsRequest as ListContactPointsRequest, type index_gen$l_ListContactPointsResponse as ListContactPointsResponse, type index_gen$l_ListGrafanaUsersRequest as ListGrafanaUsersRequest, type index_gen$l_ListGrafanaUsersRequestOrderBy as ListGrafanaUsersRequestOrderBy, type index_gen$l_ListGrafanaUsersResponse as ListGrafanaUsersResponse, type index_gen$l_ListPlansRequest as ListPlansRequest, type index_gen$l_ListPlansRequestOrderBy as ListPlansRequestOrderBy, type index_gen$l_ListPlansResponse as ListPlansResponse, type ListTokensRequest$2 as ListTokensRequest, type ListTokensRequestOrderBy$2 as ListTokensRequestOrderBy, type ListTokensResponse$2 as ListTokensResponse, type index_gen$l_Plan as Plan, type index_gen$l_PlanName as PlanName, type index_gen$l_ResetCockpitGrafanaRequest as ResetCockpitGrafanaRequest, type index_gen$l_ResetGrafanaUserPasswordRequest as ResetGrafanaUserPasswordRequest, type index_gen$l_SelectPlanRequest as SelectPlanRequest, type index_gen$l_SelectPlanResponse as SelectPlanResponse, type Token$2 as Token, type index_gen$l_TokenScopes as TokenScopes, type index_gen$l_TriggerTestAlertRequest as TriggerTestAlertRequest };
4114
+ export { API$o as API, type index_gen$l_ActivateCockpitRequest as ActivateCockpitRequest, index_gen$l_COCKPIT_TRANSIENT_STATUSES as COCKPIT_TRANSIENT_STATUSES, type index_gen$l_Cockpit as Cockpit, type index_gen$l_CockpitEndpoints as CockpitEndpoints, type index_gen$l_CockpitMetrics as CockpitMetrics, type index_gen$l_CockpitStatus as CockpitStatus, type index_gen$l_ContactPoint as ContactPoint, type index_gen$l_ContactPointEmail as ContactPointEmail, type index_gen$l_CreateContactPointRequest as CreateContactPointRequest, type index_gen$l_CreateDatasourceRequest as CreateDatasourceRequest, type index_gen$l_CreateGrafanaUserRequest as CreateGrafanaUserRequest, type CreateTokenRequest$2 as CreateTokenRequest, type index_gen$l_Datasource as Datasource, type index_gen$l_DatasourceType as DatasourceType, type index_gen$l_DeactivateCockpitRequest as DeactivateCockpitRequest, type index_gen$l_DeleteContactPointRequest as DeleteContactPointRequest, type index_gen$l_DeleteGrafanaUserRequest as DeleteGrafanaUserRequest, type DeleteTokenRequest$2 as DeleteTokenRequest, type index_gen$l_DisableManagedAlertsRequest as DisableManagedAlertsRequest, type index_gen$l_EnableManagedAlertsRequest as EnableManagedAlertsRequest, type index_gen$l_GetCockpitMetricsRequest as GetCockpitMetricsRequest, type index_gen$l_GetCockpitRequest as GetCockpitRequest, type GetTokenRequest$2 as GetTokenRequest, type index_gen$l_GrafanaUser as GrafanaUser, type index_gen$l_GrafanaUserRole as GrafanaUserRole, type index_gen$l_ListContactPointsRequest as ListContactPointsRequest, type index_gen$l_ListContactPointsResponse as ListContactPointsResponse, type index_gen$l_ListDatasourcesRequest as ListDatasourcesRequest, type index_gen$l_ListDatasourcesRequestOrderBy as ListDatasourcesRequestOrderBy, type index_gen$l_ListDatasourcesResponse as ListDatasourcesResponse, type index_gen$l_ListGrafanaUsersRequest as ListGrafanaUsersRequest, type index_gen$l_ListGrafanaUsersRequestOrderBy as ListGrafanaUsersRequestOrderBy, type index_gen$l_ListGrafanaUsersResponse as ListGrafanaUsersResponse, type index_gen$l_ListPlansRequest as ListPlansRequest, type index_gen$l_ListPlansRequestOrderBy as ListPlansRequestOrderBy, type index_gen$l_ListPlansResponse as ListPlansResponse, type ListTokensRequest$2 as ListTokensRequest, type ListTokensRequestOrderBy$2 as ListTokensRequestOrderBy, type ListTokensResponse$2 as ListTokensResponse, type index_gen$l_Plan as Plan, type index_gen$l_PlanName as PlanName, type index_gen$l_ResetCockpitGrafanaRequest as ResetCockpitGrafanaRequest, type index_gen$l_ResetGrafanaUserPasswordRequest as ResetGrafanaUserPasswordRequest, type index_gen$l_SelectPlanRequest as SelectPlanRequest, type index_gen$l_SelectPlanResponse as SelectPlanResponse, type Token$2 as Token, type index_gen$l_TokenScopes as TokenScopes, type index_gen$l_TriggerTestAlertRequest as TriggerTestAlertRequest };
4059
4115
  }
4060
4116
 
4061
4117
  declare namespace index$p {
@@ -4140,6 +4196,7 @@ interface CreateTriggerRequestMnqNatsClientConfig$1 {
4140
4196
  subject: string;
4141
4197
  mnqProjectId: string;
4142
4198
  mnqRegion: string;
4199
+ mnqNatsAccountId: string;
4143
4200
  }
4144
4201
  interface CreateTriggerRequestMnqSqsClientConfig$1 {
4145
4202
  mnqNamespaceId: string;
@@ -9139,6 +9196,7 @@ interface CreateTriggerRequestMnqNatsClientConfig {
9139
9196
  subject: string;
9140
9197
  mnqProjectId: string;
9141
9198
  mnqRegion: string;
9199
+ mnqNatsAccountId: string;
9142
9200
  }
9143
9201
  interface CreateTriggerRequestMnqSqsClientConfig {
9144
9202
  mnqNamespaceId: string;
@@ -12713,6 +12771,8 @@ type ListServersRequest = {
12713
12771
  privateNetworks?: string[];
12714
12772
  /** List Instances associated with the given private NIC MAC address. */
12715
12773
  privateNicMacAddress?: string;
12774
+ /** List Instances from these server ids (use commas to separate them). */
12775
+ servers?: string[];
12716
12776
  };
12717
12777
  type DeleteServerRequest = {
12718
12778
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -16023,7 +16083,9 @@ type CreateVolumeRequest = {
16023
16083
  * config.
16024
16084
  */
16025
16085
  region?: Region;
16086
+ /** Project ID. */
16026
16087
  projectId?: string;
16088
+ /** Volume name. */
16027
16089
  name: string;
16028
16090
  };
16029
16091
  type GetVolumeRequest = {
@@ -16032,6 +16094,7 @@ type GetVolumeRequest = {
16032
16094
  * config.
16033
16095
  */
16034
16096
  region?: Region;
16097
+ /** Volume ID. */
16035
16098
  volumeId: string;
16036
16099
  };
16037
16100
  type ListVolumesRequest = {
@@ -16040,10 +16103,14 @@ type ListVolumesRequest = {
16040
16103
  * config.
16041
16104
  */
16042
16105
  region?: Region;
16106
+ /** Project ID, only volumes belonging to this project will be listed. */
16043
16107
  projectId?: string;
16108
+ /** Sort the order of the returned volumes. */
16109
+ orderBy?: ListVolumesRequestOrderBy;
16110
+ /** Page number. */
16044
16111
  page?: number;
16112
+ /** Maximum number of volumes to return per page. */
16045
16113
  pageSize?: number;
16046
- orderBy?: ListVolumesRequestOrderBy;
16047
16114
  };
16048
16115
  type UpdateVolumeRequest = {
16049
16116
  /**
@@ -16051,8 +16118,11 @@ type UpdateVolumeRequest = {
16051
16118
  * config.
16052
16119
  */
16053
16120
  region?: Region;
16121
+ /** Volume ID. */
16054
16122
  volumeId: string;
16123
+ /** Volume name. */
16055
16124
  name?: string;
16125
+ /** Tags of the volume. */
16056
16126
  tags?: string[];
16057
16127
  };
16058
16128
  type DeleteVolumeRequest = {
@@ -16061,6 +16131,7 @@ type DeleteVolumeRequest = {
16061
16131
  * config.
16062
16132
  */
16063
16133
  region?: Region;
16134
+ /** Volume ID. */
16064
16135
  volumeId: string;
16065
16136
  };
16066
16137
  type CreatePinByURLRequest = {
@@ -16069,9 +16140,13 @@ type CreatePinByURLRequest = {
16069
16140
  * config.
16070
16141
  */
16071
16142
  region?: Region;
16143
+ /** Volume ID on which you want to pin your content. */
16072
16144
  volumeId: string;
16145
+ /** URL containing the content you want to pin. */
16073
16146
  url: string;
16147
+ /** Pin name. */
16074
16148
  name?: string;
16149
+ /** Pin options. */
16075
16150
  pinOptions?: PinOptions;
16076
16151
  };
16077
16152
  type CreatePinByCIDRequest = {
@@ -16080,10 +16155,15 @@ type CreatePinByCIDRequest = {
16080
16155
  * config.
16081
16156
  */
16082
16157
  region?: Region;
16158
+ /** Volume ID on which you want to pin your content. */
16083
16159
  volumeId: string;
16160
+ /** CID containing the content you want to pin. */
16084
16161
  cid: string;
16085
- name?: string;
16162
+ /** Node containing the content you want to pin. */
16086
16163
  origins?: string[];
16164
+ /** Pin name. */
16165
+ name?: string;
16166
+ /** Pin options. */
16087
16167
  pinOptions?: PinOptions;
16088
16168
  };
16089
16169
  type ReplacePinRequest = {
@@ -16092,11 +16172,17 @@ type ReplacePinRequest = {
16092
16172
  * config.
16093
16173
  */
16094
16174
  region?: Region;
16175
+ /** Pin ID whose information you wish to replace. */
16095
16176
  pinId: string;
16177
+ /** Volume ID. */
16096
16178
  volumeId: string;
16179
+ /** New CID you want to pin in place of the old one. */
16097
16180
  cid: string;
16181
+ /** New name to replace. */
16098
16182
  name?: string;
16183
+ /** Node containing the content you want to pin. */
16099
16184
  origins?: string[];
16185
+ /** Pin options. */
16100
16186
  pinOptions?: PinOptions;
16101
16187
  };
16102
16188
  type GetPinRequest = {
@@ -16105,7 +16191,9 @@ type GetPinRequest = {
16105
16191
  * config.
16106
16192
  */
16107
16193
  region?: Region;
16194
+ /** Pin ID of which you want to obtain information. */
16108
16195
  pinId: string;
16196
+ /** Volume ID. */
16109
16197
  volumeId: string;
16110
16198
  };
16111
16199
  type ListPinsRequest = {
@@ -16114,12 +16202,19 @@ type ListPinsRequest = {
16114
16202
  * config.
16115
16203
  */
16116
16204
  region?: Region;
16205
+ /** Volume ID of which you want to list the pins. */
16117
16206
  volumeId: string;
16207
+ /** Project ID. */
16118
16208
  projectId?: string;
16209
+ /** Organization ID. */
16119
16210
  organizationId?: string;
16211
+ /** Sort order of the returned Volume. */
16212
+ orderBy?: ListPinsRequestOrderBy;
16213
+ /** Page number. */
16120
16214
  page?: number;
16215
+ /** Maximum number of volumes to return per page. */
16121
16216
  pageSize?: number;
16122
- orderBy?: ListPinsRequestOrderBy;
16217
+ /** List pins by status. */
16123
16218
  status?: PinStatus;
16124
16219
  };
16125
16220
  type DeletePinRequest = {
@@ -16128,7 +16223,9 @@ type DeletePinRequest = {
16128
16223
  * config.
16129
16224
  */
16130
16225
  region?: Region;
16226
+ /** Pin ID you want to remove from the volume. */
16131
16227
  pinId: string;
16228
+ /** Volume ID. */
16132
16229
  volumeId: string;
16133
16230
  };
16134
16231
 
@@ -16611,6 +16708,12 @@ interface CreateClusterRequestPoolConfig$1 {
16611
16708
  rootVolumeType: PoolVolumeType;
16612
16709
  /** System volume disk size. */
16613
16710
  rootVolumeSize?: number;
16711
+ /**
16712
+ * Defines if the public IP should be removed from Nodes. To use this feature,
16713
+ * your Cluster must have an attached Private Network set up with a Public
16714
+ * Gateway.
16715
+ */
16716
+ publicIpDisabled: boolean;
16614
16717
  }
16615
16718
  /** Create cluster request. pool config. upgrade policy. */
16616
16719
  interface CreateClusterRequestPoolConfigUpgradePolicy {
@@ -16789,6 +16892,12 @@ interface Pool {
16789
16892
  rootVolumeType: PoolVolumeType;
16790
16893
  /** System volume disk size. */
16791
16894
  rootVolumeSize?: number;
16895
+ /**
16896
+ * Defines if the public IP should be removed from Nodes. To use this feature,
16897
+ * your Cluster must have an attached Private Network set up with a Public
16898
+ * Gateway.
16899
+ */
16900
+ publicIpDisabled: boolean;
16792
16901
  /** Cluster region of the pool. */
16793
16902
  region: Region;
16794
16903
  }
@@ -17235,6 +17344,12 @@ type CreatePoolRequest$1 = {
17235
17344
  rootVolumeType?: PoolVolumeType;
17236
17345
  /** System volume disk size. */
17237
17346
  rootVolumeSize?: number;
17347
+ /**
17348
+ * Defines if the public IP should be removed from Nodes. To use this feature,
17349
+ * your Cluster must have an attached Private Network set up with a Public
17350
+ * Gateway.
17351
+ */
17352
+ publicIpDisabled: boolean;
17238
17353
  };
17239
17354
  type GetPoolRequest = {
17240
17355
  /**
@@ -1,4 +1,4 @@
1
- const version = 'v1.32.1';
1
+ const version = 'v1.34.0';
2
2
  const userAgent = `scaleway-sdk-js/${version}`;
3
3
 
4
4
  export { userAgent, version };