@scaleway/sdk 2.11.0 → 2.12.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
@@ -2859,19 +2859,19 @@ declare namespace index$v {
2859
2859
  export { index$w as v1 };
2860
2860
  }
2861
2861
 
2862
- type DiscountDiscountMode = 'unknown_discount_mode' | 'discount_mode_rate' | 'discount_mode_value' | 'discount_mode_splittable';
2863
- type DiscountFilterType = 'unknown_type' | 'product_category' | 'product' | 'product_offer' | 'product_reference' | 'region' | 'zone';
2862
+ type DiscountDiscountMode$1 = 'unknown_discount_mode' | 'discount_mode_rate' | 'discount_mode_value' | 'discount_mode_splittable';
2863
+ type DiscountFilterType$1 = 'unknown_type' | 'product_category' | 'product' | 'product_offer' | 'product_reference' | 'region' | 'zone';
2864
2864
  type DownloadInvoiceRequestFileType$1 = 'pdf';
2865
2865
  type InvoiceType$1 = 'unknown_type' | 'periodic' | 'purchase';
2866
- type ListDiscountsRequestOrderBy = 'creation_date_desc' | 'creation_date_asc';
2866
+ type ListDiscountsRequestOrderBy$1 = 'creation_date_desc' | 'creation_date_asc';
2867
2867
  type ListInvoicesRequestOrderBy$1 = 'invoice_number_desc' | 'invoice_number_asc' | 'start_date_desc' | 'start_date_asc' | 'issued_date_desc' | 'issued_date_asc' | 'due_date_desc' | 'due_date_asc' | 'total_untaxed_desc' | 'total_untaxed_asc' | 'total_taxed_desc' | 'total_taxed_asc' | 'invoice_type_desc' | 'invoice_type_asc';
2868
- interface DiscountCoupon {
2868
+ interface DiscountCoupon$1 {
2869
2869
  /** The description of the coupon. */
2870
2870
  description?: string;
2871
2871
  }
2872
- interface DiscountFilter {
2872
+ interface DiscountFilter$1 {
2873
2873
  /** Type of the filter. */
2874
- type: DiscountFilterType;
2874
+ type: DiscountFilterType$1;
2875
2875
  /** Value of filter, it can be a product/range/region/zone value. */
2876
2876
  value: string;
2877
2877
  }
@@ -2887,7 +2887,7 @@ interface GetConsumptionResponseConsumption {
2887
2887
  /** Unique identifier of the product. */
2888
2888
  operationPath: string;
2889
2889
  }
2890
- interface Discount {
2890
+ interface Discount$1 {
2891
2891
  /** The ID of the discount. */
2892
2892
  id: string;
2893
2893
  /** The creation date of the discount. */
@@ -2903,15 +2903,15 @@ interface Discount {
2903
2903
  /** The remaining value of the discount. */
2904
2904
  valueRemaining: number;
2905
2905
  /** The mode of the discount. */
2906
- mode: DiscountDiscountMode;
2906
+ mode: DiscountDiscountMode$1;
2907
2907
  /** The start date of the discount. */
2908
2908
  startDate?: Date;
2909
2909
  /** The stop date of the discount. */
2910
2910
  stopDate?: Date;
2911
2911
  /** The description of the coupon. */
2912
- coupon?: DiscountCoupon;
2912
+ coupon?: DiscountCoupon$1;
2913
2913
  /** List of products/ranges/regions/zones to limit the usability of discounts. */
2914
- filters: DiscountFilter[];
2914
+ filters: DiscountFilter$1[];
2915
2915
  }
2916
2916
  interface Invoice$1 {
2917
2917
  /** Invoice ID. */
@@ -2947,9 +2947,9 @@ interface GetConsumptionResponse {
2947
2947
  /** Last consumption update date. */
2948
2948
  updatedAt?: Date;
2949
2949
  }
2950
- type ListDiscountsRequest = {
2950
+ type ListDiscountsRequest$1 = {
2951
2951
  /** Order discounts in the response by their description. */
2952
- orderBy?: ListDiscountsRequestOrderBy;
2952
+ orderBy?: ListDiscountsRequestOrderBy$1;
2953
2953
  /** Positive integer to choose the page to return. */
2954
2954
  page?: number;
2955
2955
  /**
@@ -2960,11 +2960,11 @@ type ListDiscountsRequest = {
2960
2960
  /** ID of the organization. */
2961
2961
  organizationId?: string;
2962
2962
  };
2963
- interface ListDiscountsResponse {
2963
+ interface ListDiscountsResponse$1 {
2964
2964
  /** Total number of discounts. */
2965
2965
  totalCount: number;
2966
2966
  /** Paginated returned discounts. */
2967
- discounts: Discount[];
2967
+ discounts: Discount$1[];
2968
2968
  }
2969
2969
  type ListInvoicesRequest$1 = {
2970
2970
  /**
@@ -3029,7 +3029,7 @@ declare class API$t extends API$x {
3029
3029
  * @returns A Promise of Blob
3030
3030
  */
3031
3031
  downloadInvoice: (request: Readonly<DownloadInvoiceRequest$1>) => Promise<Blob>;
3032
- protected pageOfListDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse>;
3032
+ protected pageOfListDiscounts: (request?: Readonly<ListDiscountsRequest$1>) => Promise<ListDiscountsResponse$1>;
3033
3033
  /**
3034
3034
  * List all user's discounts. List all discounts for an organization and
3035
3035
  * usable categories/products/offers/references/regions/zones where the
@@ -3038,34 +3038,42 @@ declare class API$t extends API$x {
3038
3038
  * @param request - The request {@link ListDiscountsRequest}
3039
3039
  * @returns A Promise of ListDiscountsResponse
3040
3040
  */
3041
- listDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse> & {
3042
- all: () => Promise<Discount[]>;
3043
- [Symbol.asyncIterator]: () => AsyncGenerator<Discount[], void, void>;
3041
+ listDiscounts: (request?: Readonly<ListDiscountsRequest$1>) => Promise<ListDiscountsResponse$1> & {
3042
+ all: () => Promise<Discount$1[]>;
3043
+ [Symbol.asyncIterator]: () => AsyncGenerator<Discount$1[], void, void>;
3044
3044
  };
3045
3045
  }
3046
3046
 
3047
- type index_gen$s_Discount = Discount;
3048
- type index_gen$s_DiscountCoupon = DiscountCoupon;
3049
- type index_gen$s_DiscountDiscountMode = DiscountDiscountMode;
3050
- type index_gen$s_DiscountFilter = DiscountFilter;
3051
- type index_gen$s_DiscountFilterType = DiscountFilterType;
3052
3047
  type index_gen$s_GetConsumptionRequest = GetConsumptionRequest;
3053
3048
  type index_gen$s_GetConsumptionResponse = GetConsumptionResponse;
3054
3049
  type index_gen$s_GetConsumptionResponseConsumption = GetConsumptionResponseConsumption;
3055
- type index_gen$s_ListDiscountsRequest = ListDiscountsRequest;
3056
- type index_gen$s_ListDiscountsRequestOrderBy = ListDiscountsRequestOrderBy;
3057
- type index_gen$s_ListDiscountsResponse = ListDiscountsResponse;
3058
3050
  declare namespace index_gen$s {
3059
- export { API$t as API, type index_gen$s_Discount as Discount, type index_gen$s_DiscountCoupon as DiscountCoupon, type index_gen$s_DiscountDiscountMode as DiscountDiscountMode, type index_gen$s_DiscountFilter as DiscountFilter, type index_gen$s_DiscountFilterType as DiscountFilterType, type DownloadInvoiceRequest$1 as DownloadInvoiceRequest, type DownloadInvoiceRequestFileType$1 as DownloadInvoiceRequestFileType, type index_gen$s_GetConsumptionRequest as GetConsumptionRequest, type index_gen$s_GetConsumptionResponse as GetConsumptionResponse, type index_gen$s_GetConsumptionResponseConsumption as GetConsumptionResponseConsumption, type Invoice$1 as Invoice, type InvoiceType$1 as InvoiceType, type index_gen$s_ListDiscountsRequest as ListDiscountsRequest, type index_gen$s_ListDiscountsRequestOrderBy as ListDiscountsRequestOrderBy, type index_gen$s_ListDiscountsResponse as ListDiscountsResponse, type ListInvoicesRequest$1 as ListInvoicesRequest, type ListInvoicesRequestOrderBy$1 as ListInvoicesRequestOrderBy, type ListInvoicesResponse$1 as ListInvoicesResponse };
3051
+ export { API$t as API, type Discount$1 as Discount, type DiscountCoupon$1 as DiscountCoupon, type DiscountDiscountMode$1 as DiscountDiscountMode, type DiscountFilter$1 as DiscountFilter, type DiscountFilterType$1 as DiscountFilterType, type DownloadInvoiceRequest$1 as DownloadInvoiceRequest, type DownloadInvoiceRequestFileType$1 as DownloadInvoiceRequestFileType, type index_gen$s_GetConsumptionRequest as GetConsumptionRequest, type index_gen$s_GetConsumptionResponse as GetConsumptionResponse, type index_gen$s_GetConsumptionResponseConsumption as GetConsumptionResponseConsumption, type Invoice$1 as Invoice, type InvoiceType$1 as InvoiceType, type ListDiscountsRequest$1 as ListDiscountsRequest, type ListDiscountsRequestOrderBy$1 as ListDiscountsRequestOrderBy, type ListDiscountsResponse$1 as ListDiscountsResponse, type ListInvoicesRequest$1 as ListInvoicesRequest, type ListInvoicesRequestOrderBy$1 as ListInvoicesRequestOrderBy, type ListInvoicesResponse$1 as ListInvoicesResponse };
3060
3052
  }
3061
3053
 
3054
+ type DiscountDiscountMode = 'unknown_discount_mode' | 'discount_mode_rate' | 'discount_mode_value' | 'discount_mode_splittable';
3055
+ type DiscountFilterType = 'unknown_type' | 'category_name' | 'product_name' | 'product_range' | 'resource_name' | 'region' | 'zone';
3062
3056
  type DownloadInvoiceRequestFileType = 'pdf';
3063
3057
  type ExportInvoicesRequestFileType = 'csv';
3064
3058
  type ExportInvoicesRequestOrderBy = 'invoice_number_desc' | 'invoice_number_asc' | 'start_date_desc' | 'start_date_asc' | 'issued_date_desc' | 'issued_date_asc' | 'due_date_desc' | 'due_date_asc' | 'total_untaxed_desc' | 'total_untaxed_asc' | 'total_taxed_desc' | 'total_taxed_asc' | 'invoice_type_desc' | 'invoice_type_asc';
3065
3059
  type InvoiceType = 'unknown_type' | 'periodic' | 'purchase';
3066
- type ListConsumptionsRequestOrderBy = 'updated_at_date_desc' | 'updated_at_date_asc' | 'category_name_desc' | 'category_name_asc';
3060
+ type ListConsumptionsRequestOrderBy = 'updated_at_desc' | 'updated_at_asc' | 'category_name_desc' | 'category_name_asc';
3061
+ type ListDiscountsRequestOrderBy = 'creation_date_desc' | 'creation_date_asc';
3067
3062
  type ListInvoicesRequestOrderBy = 'invoice_number_desc' | 'invoice_number_asc' | 'start_date_desc' | 'start_date_asc' | 'issued_date_desc' | 'issued_date_asc' | 'due_date_desc' | 'due_date_asc' | 'total_untaxed_desc' | 'total_untaxed_asc' | 'total_taxed_desc' | 'total_taxed_asc' | 'invoice_type_desc' | 'invoice_type_asc';
3068
- type ListTaxesRequestOrderBy = 'updated_at_date_desc' | 'updated_at_date_asc' | 'category_name_desc' | 'category_name_asc';
3063
+ type ListTaxesRequestOrderBy = 'updated_at_desc' | 'updated_at_asc' | 'category_name_desc' | 'category_name_asc';
3064
+ interface DiscountCoupon {
3065
+ /** The description of the coupon. */
3066
+ description?: string;
3067
+ }
3068
+ interface DiscountFilter {
3069
+ /**
3070
+ * Type of the filter (category name, product name, product range, resource
3071
+ * name, region or zone).
3072
+ */
3073
+ type: DiscountFilterType;
3074
+ /** Value of filter. */
3075
+ value: string;
3076
+ }
3069
3077
  interface ListConsumptionsResponseConsumption {
3070
3078
  /** Monetary value of the consumption. */
3071
3079
  value?: Money;
@@ -3082,6 +3090,36 @@ interface ListConsumptionsResponseConsumption {
3082
3090
  projectId: string;
3083
3091
  /** Name of consumption category. */
3084
3092
  categoryName: string;
3093
+ /** Unit of consumed quantity. */
3094
+ unit: string;
3095
+ /** Consumed quantity. */
3096
+ billedQuantity: string;
3097
+ }
3098
+ interface Discount {
3099
+ /** The ID of the discount. */
3100
+ id: string;
3101
+ /** The creation date of the discount. */
3102
+ creationDate?: Date;
3103
+ /** The organization ID of the discount. */
3104
+ organizationId: string;
3105
+ /** The description of the discount. */
3106
+ description: string;
3107
+ /** The initial value of the discount. */
3108
+ value: number;
3109
+ /** The value indicating how much of the discount has been used. */
3110
+ valueUsed: number;
3111
+ /** The remaining value of the discount. */
3112
+ valueRemaining: number;
3113
+ /** The mode of the discount. */
3114
+ mode: DiscountDiscountMode;
3115
+ /** The start date of the discount. */
3116
+ startDate?: Date;
3117
+ /** The stop date of the discount. */
3118
+ stopDate?: Date;
3119
+ /** The description of the coupon. */
3120
+ coupon?: DiscountCoupon;
3121
+ /** List of the discount scopes. */
3122
+ filters: DiscountFilter[];
3085
3123
  }
3086
3124
  interface Invoice {
3087
3125
  /** Invoice ID. */
@@ -3113,9 +3151,8 @@ interface Invoice {
3113
3151
  state: string;
3114
3152
  /** Invoice number. */
3115
3153
  number: number;
3154
+ /** The name of the seller (Scaleway). */
3116
3155
  sellerName: string;
3117
- /** Customer name associated to this organization. */
3118
- customerName: string;
3119
3156
  }
3120
3157
  interface ListTaxesResponseTax {
3121
3158
  /** Description of the tax applied. */
@@ -3209,6 +3246,25 @@ interface ListConsumptionsResponse {
3209
3246
  /** Last consumption update date. */
3210
3247
  updatedAt?: Date;
3211
3248
  }
3249
+ type ListDiscountsRequest = {
3250
+ /** Order discounts in the response by their description. */
3251
+ orderBy?: ListDiscountsRequestOrderBy;
3252
+ /** Positive integer to choose the page to return. */
3253
+ page?: number;
3254
+ /**
3255
+ * Positive integer lower or equal to 100 to select the number of items to
3256
+ * return.
3257
+ */
3258
+ pageSize?: number;
3259
+ /** ID of the organization. */
3260
+ organizationId?: string;
3261
+ };
3262
+ interface ListDiscountsResponse {
3263
+ /** Total number of discounts. */
3264
+ totalCount: number;
3265
+ /** Paginated returned discounts. */
3266
+ discounts: Discount[];
3267
+ }
3212
3268
  type ListInvoicesRequest = {
3213
3269
  /**
3214
3270
  * Organization ID. If specified, only invoices from this Organization will be
@@ -3327,8 +3383,18 @@ declare class API$s extends API$x {
3327
3383
  * @returns A Promise of Blob
3328
3384
  */
3329
3385
  downloadInvoice: (request: Readonly<DownloadInvoiceRequest>) => Promise<Blob>;
3386
+ protected pageOfListDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse>;
3387
+ listDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse> & {
3388
+ all: () => Promise<Discount[]>;
3389
+ [Symbol.asyncIterator]: () => AsyncGenerator<Discount[], void, void>;
3390
+ };
3330
3391
  }
3331
3392
 
3393
+ type index_gen$r_Discount = Discount;
3394
+ type index_gen$r_DiscountCoupon = DiscountCoupon;
3395
+ type index_gen$r_DiscountDiscountMode = DiscountDiscountMode;
3396
+ type index_gen$r_DiscountFilter = DiscountFilter;
3397
+ type index_gen$r_DiscountFilterType = DiscountFilterType;
3332
3398
  type index_gen$r_DownloadInvoiceRequest = DownloadInvoiceRequest;
3333
3399
  type index_gen$r_DownloadInvoiceRequestFileType = DownloadInvoiceRequestFileType;
3334
3400
  type index_gen$r_ExportInvoicesRequest = ExportInvoicesRequest;
@@ -3341,6 +3407,9 @@ type index_gen$r_ListConsumptionsRequest = ListConsumptionsRequest;
3341
3407
  type index_gen$r_ListConsumptionsRequestOrderBy = ListConsumptionsRequestOrderBy;
3342
3408
  type index_gen$r_ListConsumptionsResponse = ListConsumptionsResponse;
3343
3409
  type index_gen$r_ListConsumptionsResponseConsumption = ListConsumptionsResponseConsumption;
3410
+ type index_gen$r_ListDiscountsRequest = ListDiscountsRequest;
3411
+ type index_gen$r_ListDiscountsRequestOrderBy = ListDiscountsRequestOrderBy;
3412
+ type index_gen$r_ListDiscountsResponse = ListDiscountsResponse;
3344
3413
  type index_gen$r_ListInvoicesRequest = ListInvoicesRequest;
3345
3414
  type index_gen$r_ListInvoicesRequestOrderBy = ListInvoicesRequestOrderBy;
3346
3415
  type index_gen$r_ListInvoicesResponse = ListInvoicesResponse;
@@ -3349,7 +3418,7 @@ type index_gen$r_ListTaxesRequestOrderBy = ListTaxesRequestOrderBy;
3349
3418
  type index_gen$r_ListTaxesResponse = ListTaxesResponse;
3350
3419
  type index_gen$r_ListTaxesResponseTax = ListTaxesResponseTax;
3351
3420
  declare namespace index_gen$r {
3352
- export { API$s as API, type index_gen$r_DownloadInvoiceRequest as DownloadInvoiceRequest, type index_gen$r_DownloadInvoiceRequestFileType as DownloadInvoiceRequestFileType, type index_gen$r_ExportInvoicesRequest as ExportInvoicesRequest, type index_gen$r_ExportInvoicesRequestFileType as ExportInvoicesRequestFileType, type index_gen$r_ExportInvoicesRequestOrderBy as ExportInvoicesRequestOrderBy, type index_gen$r_GetInvoiceRequest as GetInvoiceRequest, type index_gen$r_Invoice as Invoice, type index_gen$r_InvoiceType as InvoiceType, type index_gen$r_ListConsumptionsRequest as ListConsumptionsRequest, type index_gen$r_ListConsumptionsRequestOrderBy as ListConsumptionsRequestOrderBy, type index_gen$r_ListConsumptionsResponse as ListConsumptionsResponse, type index_gen$r_ListConsumptionsResponseConsumption as ListConsumptionsResponseConsumption, type index_gen$r_ListInvoicesRequest as ListInvoicesRequest, type index_gen$r_ListInvoicesRequestOrderBy as ListInvoicesRequestOrderBy, type index_gen$r_ListInvoicesResponse as ListInvoicesResponse, type index_gen$r_ListTaxesRequest as ListTaxesRequest, type index_gen$r_ListTaxesRequestOrderBy as ListTaxesRequestOrderBy, type index_gen$r_ListTaxesResponse as ListTaxesResponse, type index_gen$r_ListTaxesResponseTax as ListTaxesResponseTax };
3421
+ export { API$s as API, type index_gen$r_Discount as Discount, type index_gen$r_DiscountCoupon as DiscountCoupon, type index_gen$r_DiscountDiscountMode as DiscountDiscountMode, type index_gen$r_DiscountFilter as DiscountFilter, type index_gen$r_DiscountFilterType as DiscountFilterType, type index_gen$r_DownloadInvoiceRequest as DownloadInvoiceRequest, type index_gen$r_DownloadInvoiceRequestFileType as DownloadInvoiceRequestFileType, type index_gen$r_ExportInvoicesRequest as ExportInvoicesRequest, type index_gen$r_ExportInvoicesRequestFileType as ExportInvoicesRequestFileType, type index_gen$r_ExportInvoicesRequestOrderBy as ExportInvoicesRequestOrderBy, type index_gen$r_GetInvoiceRequest as GetInvoiceRequest, type index_gen$r_Invoice as Invoice, type index_gen$r_InvoiceType as InvoiceType, type index_gen$r_ListConsumptionsRequest as ListConsumptionsRequest, type index_gen$r_ListConsumptionsRequestOrderBy as ListConsumptionsRequestOrderBy, type index_gen$r_ListConsumptionsResponse as ListConsumptionsResponse, type index_gen$r_ListConsumptionsResponseConsumption as ListConsumptionsResponseConsumption, type index_gen$r_ListDiscountsRequest as ListDiscountsRequest, type index_gen$r_ListDiscountsRequestOrderBy as ListDiscountsRequestOrderBy, type index_gen$r_ListDiscountsResponse as ListDiscountsResponse, type index_gen$r_ListInvoicesRequest as ListInvoicesRequest, type index_gen$r_ListInvoicesRequestOrderBy as ListInvoicesRequestOrderBy, type index_gen$r_ListInvoicesResponse as ListInvoicesResponse, type index_gen$r_ListTaxesRequest as ListTaxesRequest, type index_gen$r_ListTaxesRequestOrderBy as ListTaxesRequestOrderBy, type index_gen$r_ListTaxesResponse as ListTaxesResponse, type index_gen$r_ListTaxesResponseTax as ListTaxesResponseTax };
3353
3422
  }
3354
3423
 
3355
3424
  declare namespace index$u {
@@ -4271,20 +4340,20 @@ type TriggerTestAlertRequest = {
4271
4340
  /**
4272
4341
  * Cockpit API.
4273
4342
  *
4274
- * Cockpit's API allows you to activate your Cockpit on your Projects.
4275
- * Scaleway's Cockpit stores metrics and logs and provides a dedicated Grafana
4276
- * for dashboarding to visualize them.
4343
+ * The Cockpit API allows you to activate your Cockpit to store metrics and
4344
+ * logs. It also provides you with a dedicated Grafana for dashboarding to
4345
+ * visualize your metrics and logs.
4277
4346
  */
4278
4347
  declare class API$q extends API$x {
4279
4348
  /**
4280
- * Activate the Cockpit of the specified Project ID.
4349
+ * Activate the Cockpit of a given Project specified by the Project ID.
4281
4350
  *
4282
4351
  * @param request - The request {@link ActivateCockpitRequest}
4283
4352
  * @returns A Promise of Cockpit
4284
4353
  */
4285
4354
  activateCockpit: (request?: Readonly<ActivateCockpitRequest>) => Promise<Cockpit>;
4286
4355
  /**
4287
- * Retrieve the Cockpit of the specified Project ID.
4356
+ * Retrieve the Cockpit of a given Project specified by the Project ID.
4288
4357
  *
4289
4358
  * @param request - The request {@link GetCockpitRequest}
4290
4359
  * @returns A Promise of Cockpit
@@ -4299,35 +4368,37 @@ declare class API$q extends API$x {
4299
4368
  */
4300
4369
  waitForCockpit: (request?: Readonly<GetCockpitRequest>, options?: Readonly<WaitForOptions<Cockpit>>) => Promise<Cockpit>;
4301
4370
  /**
4302
- * Get metrics from your Cockpit with the specified Project ID.
4371
+ * Retrieve metrics from your Cockpit specified by the ID of the Project the
4372
+ * Cockpit belongs to.
4303
4373
  *
4304
4374
  * @param request - The request {@link GetCockpitMetricsRequest}
4305
4375
  * @returns A Promise of CockpitMetrics
4306
4376
  */
4307
4377
  getCockpitMetrics: (request?: Readonly<GetCockpitMetricsRequest>) => Promise<CockpitMetrics>;
4308
4378
  /**
4309
- * Deactivate the Cockpit of the specified Project ID.
4379
+ * Deactivate the Cockpit of a given Project specified by the Project ID.
4310
4380
  *
4311
4381
  * @param request - The request {@link DeactivateCockpitRequest}
4312
4382
  * @returns A Promise of Cockpit
4313
4383
  */
4314
4384
  deactivateCockpit: (request?: Readonly<DeactivateCockpitRequest>) => Promise<Cockpit>;
4315
4385
  /**
4316
- * Create a datasource for the specified Project ID and the given type.
4386
+ * Create a data source for a given Project specified by the Project ID and
4387
+ * the data source type.
4317
4388
  *
4318
4389
  * @param request - The request {@link CreateDatasourceRequest}
4319
4390
  * @returns A Promise of Datasource
4320
4391
  */
4321
4392
  createDatasource: (request: Readonly<CreateDatasourceRequest>) => Promise<Datasource>;
4322
4393
  /**
4323
- * Delete the datasource associated with the specified datasource ID.
4394
+ * Delete a given data source specified by the data source ID.
4324
4395
  *
4325
4396
  * @param request - The request {@link DeleteDatasourceRequest}
4326
4397
  */
4327
4398
  deleteDatasource: (request: Readonly<DeleteDatasourceRequest>) => Promise<void>;
4328
4399
  protected pageOfListDatasources: (request?: Readonly<ListDatasourcesRequest>) => Promise<ListDatasourcesResponse>;
4329
4400
  /**
4330
- * Get a list of datasources for the specified Project ID.
4401
+ * Get a list of data sources for the specified Project ID.
4331
4402
  *
4332
4403
  * @param request - The request {@link ListDatasourcesRequest}
4333
4404
  * @returns A Promise of ListDatasourcesResponse
@@ -4337,7 +4408,7 @@ declare class API$q extends API$x {
4337
4408
  [Symbol.asyncIterator]: () => AsyncGenerator<Datasource[], void, void>;
4338
4409
  };
4339
4410
  /**
4340
- * Create a token associated with the specified Project ID.
4411
+ * Create a token in a given Project specified by the Project ID.
4341
4412
  *
4342
4413
  * @param request - The request {@link CreateTokenRequest}
4343
4414
  * @returns A Promise of Token
@@ -4345,7 +4416,7 @@ declare class API$q extends API$x {
4345
4416
  createToken: (request?: Readonly<CreateTokenRequest$2>) => Promise<Token$2>;
4346
4417
  protected pageOfListTokens: (request?: Readonly<ListTokensRequest$2>) => Promise<ListTokensResponse$2>;
4347
4418
  /**
4348
- * Get a list of tokens associated with the specified Project ID.
4419
+ * Get a list of tokens in a given Project specified by the Project ID.
4349
4420
  *
4350
4421
  * @param request - The request {@link ListTokensRequest}
4351
4422
  * @returns A Promise of ListTokensResponse
@@ -4355,20 +4426,21 @@ declare class API$q extends API$x {
4355
4426
  [Symbol.asyncIterator]: () => AsyncGenerator<Token$2[], void, void>;
4356
4427
  };
4357
4428
  /**
4358
- * Retrieve the token associated with the specified token ID.
4429
+ * Retrieve a given token specified by the token ID.
4359
4430
  *
4360
4431
  * @param request - The request {@link GetTokenRequest}
4361
4432
  * @returns A Promise of Token
4362
4433
  */
4363
4434
  getToken: (request: Readonly<GetTokenRequest$2>) => Promise<Token$2>;
4364
4435
  /**
4365
- * Delete the token associated with the specified token ID.
4436
+ * Delete a given token specified by the token ID.
4366
4437
  *
4367
4438
  * @param request - The request {@link DeleteTokenRequest}
4368
4439
  */
4369
4440
  deleteToken: (request: Readonly<DeleteTokenRequest$2>) => Promise<void>;
4370
4441
  /**
4371
- * Create a contact point to receive alerts for the default receiver.
4442
+ * Create a contact point associated with the default receiver, to receive
4443
+ * alerts.
4372
4444
  *
4373
4445
  * @param request - The request {@link CreateContactPointRequest}
4374
4446
  * @returns A Promise of ContactPoint
@@ -4376,8 +4448,8 @@ declare class API$q extends API$x {
4376
4448
  createContactPoint: (request?: Readonly<CreateContactPointRequest>) => Promise<ContactPoint>;
4377
4449
  protected pageOfListContactPoints: (request?: Readonly<ListContactPointsRequest>) => Promise<ListContactPointsResponse>;
4378
4450
  /**
4379
- * Get a list of contact points for the Cockpit associated with the specified
4380
- * Project ID.
4451
+ * Get a list of contact points created for a given Cockpit, specified by the
4452
+ * ID of the Project the Cockpit belongs to.
4381
4453
  *
4382
4454
  * @param request - The request {@link ListContactPointsRequest}
4383
4455
  * @returns A Promise of ListContactPointsResponse
@@ -4387,32 +4459,35 @@ declare class API$q extends API$x {
4387
4459
  [Symbol.asyncIterator]: () => AsyncGenerator<ContactPoint[], void, void>;
4388
4460
  };
4389
4461
  /**
4390
- * Delete a contact point for the default receiver.
4462
+ * Delete a contact point associated with the default receiver.
4391
4463
  *
4392
4464
  * @param request - The request {@link DeleteContactPointRequest}
4393
4465
  */
4394
4466
  deleteContactPoint: (request?: Readonly<DeleteContactPointRequest>) => Promise<void>;
4395
4467
  /**
4396
- * Enable the sending of managed alerts for the specified Project's Cockpit.
4468
+ * Enable the sending of managed alerts for a given Cockpit, specified by the
4469
+ * ID of the Project the Cockpit belongs to.
4397
4470
  *
4398
4471
  * @param request - The request {@link EnableManagedAlertsRequest}
4399
4472
  */
4400
4473
  enableManagedAlerts: (request?: Readonly<EnableManagedAlertsRequest>) => Promise<void>;
4401
4474
  /**
4402
- * Disable the sending of managed alerts for the specified Project's Cockpit.
4475
+ * Disable the sending of managed alerts for a given Cockpit, specified by the
4476
+ * ID of the Project the Cockpit belongs to.
4403
4477
  *
4404
4478
  * @param request - The request {@link DisableManagedAlertsRequest}
4405
4479
  */
4406
4480
  disableManagedAlerts: (request?: Readonly<DisableManagedAlertsRequest>) => Promise<void>;
4407
4481
  /**
4408
- * Trigger a test alert to all of the Cockpit's receivers.
4482
+ * Send a test alert to make sure your contact points get notified when an
4483
+ * actual alert is triggered.
4409
4484
  *
4410
4485
  * @param request - The request {@link TriggerTestAlertRequest}
4411
4486
  */
4412
4487
  triggerTestAlert: (request?: Readonly<TriggerTestAlertRequest>) => Promise<void>;
4413
4488
  /**
4414
- * Create a Grafana user for your Cockpit's Grafana instance. Make sure you
4415
- * save the automatically-generated password and the Grafana user ID.
4489
+ * Create a Grafana user for your Cockpit's Grafana. Make sure you save the
4490
+ * automatically-generated password and the Grafana user ID.
4416
4491
  *
4417
4492
  * @param request - The request {@link CreateGrafanaUserRequest}
4418
4493
  * @returns A Promise of GrafanaUser
@@ -4420,8 +4495,7 @@ declare class API$q extends API$x {
4420
4495
  createGrafanaUser: (request: Readonly<CreateGrafanaUserRequest>) => Promise<GrafanaUser>;
4421
4496
  protected pageOfListGrafanaUsers: (request?: Readonly<ListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse>;
4422
4497
  /**
4423
- * Get a list of Grafana users who are able to connect to the Cockpit's
4424
- * Grafana instance.
4498
+ * Get a list of all Grafana users created in your Cockpit's Grafana.
4425
4499
  *
4426
4500
  * @param request - The request {@link ListGrafanaUsersRequest}
4427
4501
  * @returns A Promise of ListGrafanaUsersResponse
@@ -4431,15 +4505,15 @@ declare class API$q extends API$x {
4431
4505
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
4432
4506
  };
4433
4507
  /**
4434
- * Delete a Grafana user from a Grafana instance, specified by the Cockpit's
4435
- * Project ID and the Grafana user ID.
4508
+ * Delete a Grafana user from your Cockpit's Grafana, specified by the ID of
4509
+ * the Project the Cockpit belongs to, and the ID of the Grafana user.
4436
4510
  *
4437
4511
  * @param request - The request {@link DeleteGrafanaUserRequest}
4438
4512
  */
4439
4513
  deleteGrafanaUser: (request: Readonly<DeleteGrafanaUserRequest>) => Promise<void>;
4440
4514
  /**
4441
- * Reset a Grafana user's password specified by the Cockpit's Project ID and
4442
- * the Grafana user ID.
4515
+ * Reset the password of a Grafana user, specified by the ID of the Project
4516
+ * the Cockpit belongs to, and the ID of the Grafana user.
4443
4517
  *
4444
4518
  * @param request - The request {@link ResetGrafanaUserPasswordRequest}
4445
4519
  * @returns A Promise of GrafanaUser
@@ -11500,7 +11574,7 @@ type ListAPIKeysRequest$1 = {
11500
11574
  editable?: boolean;
11501
11575
  /** Defines whether to filter out expired API keys or not. */
11502
11576
  expired?: boolean;
11503
- /** Filter by access key. */
11577
+ /** @deprecated Filter by access key (deprecated in favor of `access_keys`). */
11504
11578
  accessKey?: string;
11505
11579
  /** Filter by description. */
11506
11580
  description?: string;
@@ -11508,6 +11582,8 @@ type ListAPIKeysRequest$1 = {
11508
11582
  bearerId?: string;
11509
11583
  /** Filter by type of bearer. */
11510
11584
  bearerType?: BearerType;
11585
+ /** Filter by a list of access keys. */
11586
+ accessKeys?: string[];
11511
11587
  };
11512
11588
  interface ListAPIKeysResponse {
11513
11589
  /** List of API keys. */
@@ -11646,6 +11722,8 @@ type ListPoliciesRequest$1 = {
11646
11722
  policyName?: string;
11647
11723
  /** Filter by tags containing a given string. */
11648
11724
  tag?: string;
11725
+ /** Filter by a list of IDs. */
11726
+ policyIds?: string[];
11649
11727
  };
11650
11728
  interface ListPoliciesResponse {
11651
11729
  /** List of policies. */
@@ -12821,6 +12899,7 @@ interface ServerLocation {
12821
12899
  }
12822
12900
  interface ServerMaintenance {
12823
12901
  reason: string;
12902
+ startDate?: Date;
12824
12903
  }
12825
12904
  interface VolumeServer {
12826
12905
  id: string;
@@ -17618,6 +17697,8 @@ interface JobRun {
17618
17697
  errorMessage: string;
17619
17698
  cpuLimit: number;
17620
17699
  memoryLimit: number;
17700
+ command: string;
17701
+ environmentVariables: Record<string, string>;
17621
17702
  /**
17622
17703
  * Region to target. If none is passed will use default region from the
17623
17704
  * config.
@@ -17720,6 +17801,12 @@ type StartJobDefinitionRequest = {
17720
17801
  region?: Region;
17721
17802
  /** UUID of the job definition to start. */
17722
17803
  jobDefinitionId: string;
17804
+ /** Contextual startup command for this specific job run. */
17805
+ command?: string;
17806
+ /** Contextual environment variables for this specific job run. */
17807
+ environmentVariables?: Record<string, string>;
17808
+ /** Number of jobs to run. */
17809
+ replicas?: number;
17723
17810
  };
17724
17811
  type StopJobRunRequest = {
17725
17812
  /**
@@ -18734,6 +18821,8 @@ type GetClusterKubeConfigRequest$1 = {
18734
18821
  region?: Region;
18735
18822
  /** Cluster ID for which to download the kubeconfig. */
18736
18823
  clusterId: string;
18824
+ /** Hide the legacy token from the kubeconfig. */
18825
+ redacted?: boolean;
18737
18826
  };
18738
18827
  type GetClusterRequest$1 = {
18739
18828
  /**
@@ -29144,6 +29233,10 @@ type ListDatabaseBackupsRequest$1 = {
29144
29233
  * config.
29145
29234
  */
29146
29235
  region?: Region;
29236
+ /** Filter by the UUID of the Scaleway organization. */
29237
+ organizationId?: string;
29238
+ /** Filter by the UUID of the Scaleway project. */
29239
+ projectId?: string;
29147
29240
  /** Filter by the UUID of the Serverless SQL Database. */
29148
29241
  databaseId: string;
29149
29242
  /** Page number. */
@@ -29165,6 +29258,8 @@ type ListDatabasesRequest$1 = {
29165
29258
  * config.
29166
29259
  */
29167
29260
  region?: Region;
29261
+ /** Filter by the UUID of the Scaleway organization. */
29262
+ organizationId?: string;
29168
29263
  /** UUID of the Scaleway project. */
29169
29264
  projectId?: string;
29170
29265
  /** Page number. */
@@ -1,4 +1,4 @@
1
- const version = 'v2.10.0';
1
+ const version = 'v2.11.0';
2
2
  const userAgent = `scaleway-sdk-js/${version}`;
3
3
 
4
4
  export { userAgent, version };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk",
3
- "version": "2.11.0",
3
+ "version": "2.12.0",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Scaleway SDK.",
6
6
  "keywords": [
@@ -35,5 +35,5 @@
35
35
  "bundledDependencies": [
36
36
  "@scaleway/random-name"
37
37
  ],
38
- "gitHead": "1aa52ce703d68142224ea32eb4d27a69ad69c2c6"
38
+ "gitHead": "ad877a275c5598c7328f6b4edf92d7cc8c8f06e5"
39
39
  }