@scaleway/sdk 1.31.0 → 1.32.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
@@ -2981,6 +2981,7 @@ declare namespace index$p {
2981
2981
  }
2982
2982
 
2983
2983
  type CockpitStatus = 'unknown_status' | 'creating' | 'ready' | 'deleting' | 'updating' | 'error';
2984
+ type DatasourceType = 'unknown_datasource_type' | 'metrics' | 'logs' | 'traces' | 'alerts';
2984
2985
  type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
2985
2986
  type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
2986
2987
  type ListPlansRequestOrderBy = 'name_asc' | 'name_desc';
@@ -3031,6 +3032,19 @@ interface ContactPoint {
3031
3032
  interface ContactPointEmail {
3032
3033
  to: string;
3033
3034
  }
3035
+ /** Datasource. */
3036
+ interface Datasource {
3037
+ /** ID of the datasource. */
3038
+ id: string;
3039
+ /** ID of the Project the Cockpit belongs to. */
3040
+ projectId: string;
3041
+ /** Datasource name. */
3042
+ name: string;
3043
+ /** Datasource URL. */
3044
+ url: string;
3045
+ /** Datasource type. */
3046
+ type: DatasourceType;
3047
+ }
3034
3048
  /** Grafana user. */
3035
3049
  interface GrafanaUser {
3036
3050
  /** ID of the Grafana user. */
@@ -3161,6 +3175,14 @@ type ResetCockpitGrafanaRequest = {
3161
3175
  /** ID of the Project the Cockpit belongs to. */
3162
3176
  projectId?: string;
3163
3177
  };
3178
+ type CreateDatasourceRequest = {
3179
+ /** ID of the Project the Cockpit belongs to. */
3180
+ projectId?: string;
3181
+ /** Datasource name. */
3182
+ name: string;
3183
+ /** Datasource type. */
3184
+ type?: DatasourceType;
3185
+ };
3164
3186
  type CreateTokenRequest$2 = {
3165
3187
  /** ID of the Project. */
3166
3188
  projectId?: string;
@@ -3263,20 +3285,20 @@ type SelectPlanRequest = {
3263
3285
  /**
3264
3286
  * Cockpit API.
3265
3287
  *
3266
- * Cockpit API. Cockpit's API allows you to activate your Cockpit on your
3267
- * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
3268
- * Grafana for dashboarding to visualize them.
3288
+ * Cockpit's API allows you to activate your Cockpit on your Projects.
3289
+ * Scaleway's Cockpit stores metrics and logs and provides a dedicated Grafana
3290
+ * for dashboarding to visualize them. Cockpit API.
3269
3291
  */
3270
3292
  declare class API$n extends API$s {
3271
3293
  /**
3272
- * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
3294
+ * Activate the Cockpit of the specified Project ID.
3273
3295
  *
3274
3296
  * @param request - The request {@link ActivateCockpitRequest}
3275
3297
  * @returns A Promise of Cockpit
3276
3298
  */
3277
3299
  activateCockpit: (request?: Readonly<ActivateCockpitRequest>) => Promise<Cockpit>;
3278
3300
  /**
3279
- * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
3301
+ * Retrieve the Cockpit of the specified Project ID.
3280
3302
  *
3281
3303
  * @param request - The request {@link GetCockpitRequest}
3282
3304
  * @returns A Promise of Cockpit
@@ -3291,30 +3313,35 @@ declare class API$n extends API$s {
3291
3313
  */
3292
3314
  waitForCockpit: (request?: Readonly<GetCockpitRequest>, options?: Readonly<WaitForOptions<Cockpit>>) => Promise<Cockpit>;
3293
3315
  /**
3294
- * Get Cockpit metrics. Get metrics from your Cockpit with the specified
3295
- * Project ID.
3316
+ * Get metrics from your Cockpit with the specified Project ID.
3296
3317
  *
3297
3318
  * @param request - The request {@link GetCockpitMetricsRequest}
3298
3319
  * @returns A Promise of CockpitMetrics
3299
3320
  */
3300
3321
  getCockpitMetrics: (request?: Readonly<GetCockpitMetricsRequest>) => Promise<CockpitMetrics>;
3301
3322
  /**
3302
- * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
3323
+ * Deactivate the Cockpit of the specified Project ID.
3303
3324
  *
3304
3325
  * @param request - The request {@link DeactivateCockpitRequest}
3305
3326
  * @returns A Promise of Cockpit
3306
3327
  */
3307
3328
  deactivateCockpit: (request?: Readonly<DeactivateCockpitRequest>) => Promise<Cockpit>;
3308
3329
  /**
3309
- * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
3310
- * Project ID.
3330
+ * Reset your Cockpit's Grafana associated with the specified Project ID.
3311
3331
  *
3312
3332
  * @param request - The request {@link ResetCockpitGrafanaRequest}
3313
3333
  * @returns A Promise of Cockpit
3314
3334
  */
3315
3335
  resetCockpitGrafana: (request?: Readonly<ResetCockpitGrafanaRequest>) => Promise<Cockpit>;
3316
3336
  /**
3317
- * Create a token. Create a token associated with the specified Project ID.
3337
+ * Create a datasource for the specified Project ID and the given type.
3338
+ *
3339
+ * @param request - The request {@link CreateDatasourceRequest}
3340
+ * @returns A Promise of Datasource
3341
+ */
3342
+ createDatasource: (request: Readonly<CreateDatasourceRequest>) => Promise<Datasource>;
3343
+ /**
3344
+ * Create a token associated with the specified Project ID.
3318
3345
  *
3319
3346
  * @param request - The request {@link CreateTokenRequest}
3320
3347
  * @returns A Promise of Token
@@ -3322,7 +3349,7 @@ declare class API$n extends API$s {
3322
3349
  createToken: (request?: Readonly<CreateTokenRequest$2>) => Promise<Token$2>;
3323
3350
  protected pageOfListTokens: (request?: Readonly<ListTokensRequest$2>) => Promise<ListTokensResponse$2>;
3324
3351
  /**
3325
- * List tokens. Get a list of tokens associated with the specified Project ID.
3352
+ * Get a list of tokens associated with the specified Project ID.
3326
3353
  *
3327
3354
  * @param request - The request {@link ListTokensRequest}
3328
3355
  * @returns A Promise of ListTokensResponse
@@ -3332,21 +3359,20 @@ declare class API$n extends API$s {
3332
3359
  [Symbol.asyncIterator]: () => AsyncGenerator<Token$2[], void, void>;
3333
3360
  };
3334
3361
  /**
3335
- * Get a token. Retrieve the token associated with the specified token ID.
3362
+ * Retrieve the token associated with the specified token ID.
3336
3363
  *
3337
3364
  * @param request - The request {@link GetTokenRequest}
3338
3365
  * @returns A Promise of Token
3339
3366
  */
3340
3367
  getToken: (request: Readonly<GetTokenRequest$2>) => Promise<Token$2>;
3341
3368
  /**
3342
- * Delete a token. Delete the token associated with the specified token ID.
3369
+ * Delete the token associated with the specified token ID.
3343
3370
  *
3344
3371
  * @param request - The request {@link DeleteTokenRequest}
3345
3372
  */
3346
3373
  deleteToken: (request: Readonly<DeleteTokenRequest$2>) => Promise<void>;
3347
3374
  /**
3348
- * Create a contact point. Create a contact point to receive alerts for the
3349
- * default receiver.
3375
+ * Create a contact point to receive alerts for the default receiver.
3350
3376
  *
3351
3377
  * @param request - The request {@link CreateContactPointRequest}
3352
3378
  * @returns A Promise of ContactPoint
@@ -3354,8 +3380,8 @@ declare class API$n extends API$s {
3354
3380
  createContactPoint: (request?: Readonly<CreateContactPointRequest>) => Promise<ContactPoint>;
3355
3381
  protected pageOfListContactPoints: (request?: Readonly<ListContactPointsRequest>) => Promise<ListContactPointsResponse>;
3356
3382
  /**
3357
- * List contact points. Get a list of contact points for the Cockpit
3358
- * associated with the specified Project ID.
3383
+ * Get a list of contact points for the Cockpit associated with the specified
3384
+ * Project ID.
3359
3385
  *
3360
3386
  * @param request - The request {@link ListContactPointsRequest}
3361
3387
  * @returns A Promise of ListContactPointsResponse
@@ -3365,37 +3391,32 @@ declare class API$n extends API$s {
3365
3391
  [Symbol.asyncIterator]: () => AsyncGenerator<ContactPoint[], void, void>;
3366
3392
  };
3367
3393
  /**
3368
- * Delete an alert contact point. Delete a contact point for the default
3369
- * receiver.
3394
+ * Delete a contact point for the default receiver.
3370
3395
  *
3371
3396
  * @param request - The request {@link DeleteContactPointRequest}
3372
3397
  */
3373
3398
  deleteContactPoint: (request?: Readonly<DeleteContactPointRequest>) => Promise<void>;
3374
3399
  /**
3375
- * Enable managed alerts. Enable the sending of managed alerts for the
3376
- * specified Project's Cockpit.
3400
+ * Enable the sending of managed alerts for the specified Project's Cockpit.
3377
3401
  *
3378
3402
  * @param request - The request {@link EnableManagedAlertsRequest}
3379
3403
  */
3380
3404
  enableManagedAlerts: (request?: Readonly<EnableManagedAlertsRequest>) => Promise<void>;
3381
3405
  /**
3382
- * Disable managed alerts. Disable the sending of managed alerts for the
3383
- * specified Project's Cockpit.
3406
+ * Disable the sending of managed alerts for the specified Project's Cockpit.
3384
3407
  *
3385
3408
  * @param request - The request {@link DisableManagedAlertsRequest}
3386
3409
  */
3387
3410
  disableManagedAlerts: (request?: Readonly<DisableManagedAlertsRequest>) => Promise<void>;
3388
3411
  /**
3389
- * Trigger a test alert. Trigger a test alert to all of the Cockpit's
3390
- * receivers.
3412
+ * Trigger a test alert to all of the Cockpit's receivers.
3391
3413
  *
3392
3414
  * @param request - The request {@link TriggerTestAlertRequest}
3393
3415
  */
3394
3416
  triggerTestAlert: (request?: Readonly<TriggerTestAlertRequest>) => Promise<void>;
3395
3417
  /**
3396
- * Create a Grafana user. Create a Grafana user for your Cockpit's Grafana
3397
- * instance. Make sure you save the automatically-generated password and the
3398
- * Grafana user ID.
3418
+ * Create a Grafana user for your Cockpit's Grafana instance. Make sure you
3419
+ * save the automatically-generated password and the Grafana user ID.
3399
3420
  *
3400
3421
  * @param request - The request {@link CreateGrafanaUserRequest}
3401
3422
  * @returns A Promise of GrafanaUser
@@ -3403,8 +3424,8 @@ declare class API$n extends API$s {
3403
3424
  createGrafanaUser: (request: Readonly<CreateGrafanaUserRequest>) => Promise<GrafanaUser>;
3404
3425
  protected pageOfListGrafanaUsers: (request?: Readonly<ListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse>;
3405
3426
  /**
3406
- * List Grafana users. Get a list of Grafana users who are able to connect to
3407
- * the Cockpit's Grafana instance.
3427
+ * Get a list of Grafana users who are able to connect to the Cockpit's
3428
+ * Grafana instance.
3408
3429
  *
3409
3430
  * @param request - The request {@link ListGrafanaUsersRequest}
3410
3431
  * @returns A Promise of ListGrafanaUsersResponse
@@ -3414,15 +3435,15 @@ declare class API$n extends API$s {
3414
3435
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
3415
3436
  };
3416
3437
  /**
3417
- * Delete a Grafana user. Delete a Grafana user from a Grafana instance,
3418
- * specified by the Cockpit's Project ID and the Grafana user ID.
3438
+ * Delete a Grafana user from a Grafana instance, specified by the Cockpit's
3439
+ * Project ID and the Grafana user ID.
3419
3440
  *
3420
3441
  * @param request - The request {@link DeleteGrafanaUserRequest}
3421
3442
  */
3422
3443
  deleteGrafanaUser: (request: Readonly<DeleteGrafanaUserRequest>) => Promise<void>;
3423
3444
  /**
3424
- * Reset a Grafana user's password. Reset a Grafana user's password specified
3425
- * by the Cockpit's Project ID and the Grafana user ID.
3445
+ * Reset a Grafana user's password specified by the Cockpit's Project ID and
3446
+ * the Grafana user ID.
3426
3447
  *
3427
3448
  * @param request - The request {@link ResetGrafanaUserPasswordRequest}
3428
3449
  * @returns A Promise of GrafanaUser
@@ -3430,7 +3451,7 @@ declare class API$n extends API$s {
3430
3451
  resetGrafanaUserPassword: (request: Readonly<ResetGrafanaUserPasswordRequest>) => Promise<GrafanaUser>;
3431
3452
  protected pageOfListPlans: (request?: Readonly<ListPlansRequest>) => Promise<ListPlansResponse>;
3432
3453
  /**
3433
- * List pricing plans. Get a list of all pricing plans available.
3454
+ * Get a list of all pricing plans available.
3434
3455
  *
3435
3456
  * @param request - The request {@link ListPlansRequest}
3436
3457
  * @returns A Promise of ListPlansResponse
@@ -3440,9 +3461,8 @@ declare class API$n extends API$s {
3440
3461
  [Symbol.asyncIterator]: () => AsyncGenerator<Plan[], void, void>;
3441
3462
  };
3442
3463
  /**
3443
- * Select pricing plan. Select your chosen pricing plan for your Cockpit,
3444
- * specifying the Cockpit's Project ID and the pricing plan's ID in the
3445
- * request.
3464
+ * Select your chosen pricing plan for your Cockpit, specifying the Cockpit's
3465
+ * Project ID and the pricing plan's ID in the request.
3446
3466
  *
3447
3467
  * @param request - The request {@link SelectPlanRequest}
3448
3468
  * @returns A Promise of SelectPlanResponse
@@ -3462,7 +3482,10 @@ type index_gen$k_CockpitStatus = CockpitStatus;
3462
3482
  type index_gen$k_ContactPoint = ContactPoint;
3463
3483
  type index_gen$k_ContactPointEmail = ContactPointEmail;
3464
3484
  type index_gen$k_CreateContactPointRequest = CreateContactPointRequest;
3485
+ type index_gen$k_CreateDatasourceRequest = CreateDatasourceRequest;
3465
3486
  type index_gen$k_CreateGrafanaUserRequest = CreateGrafanaUserRequest;
3487
+ type index_gen$k_Datasource = Datasource;
3488
+ type index_gen$k_DatasourceType = DatasourceType;
3466
3489
  type index_gen$k_DeactivateCockpitRequest = DeactivateCockpitRequest;
3467
3490
  type index_gen$k_DeleteContactPointRequest = DeleteContactPointRequest;
3468
3491
  type index_gen$k_DeleteGrafanaUserRequest = DeleteGrafanaUserRequest;
@@ -3489,7 +3512,7 @@ type index_gen$k_SelectPlanResponse = SelectPlanResponse;
3489
3512
  type index_gen$k_TokenScopes = TokenScopes;
3490
3513
  type index_gen$k_TriggerTestAlertRequest = TriggerTestAlertRequest;
3491
3514
  declare namespace index_gen$k {
3492
- export { API$n as API, type index_gen$k_ActivateCockpitRequest as ActivateCockpitRequest, index_gen$k_COCKPIT_TRANSIENT_STATUSES as COCKPIT_TRANSIENT_STATUSES, type index_gen$k_Cockpit as Cockpit, type index_gen$k_CockpitEndpoints as CockpitEndpoints, type index_gen$k_CockpitMetrics as CockpitMetrics, type index_gen$k_CockpitStatus as CockpitStatus, type index_gen$k_ContactPoint as ContactPoint, type index_gen$k_ContactPointEmail as ContactPointEmail, type index_gen$k_CreateContactPointRequest as CreateContactPointRequest, type index_gen$k_CreateGrafanaUserRequest as CreateGrafanaUserRequest, type CreateTokenRequest$2 as CreateTokenRequest, type index_gen$k_DeactivateCockpitRequest as DeactivateCockpitRequest, type index_gen$k_DeleteContactPointRequest as DeleteContactPointRequest, type index_gen$k_DeleteGrafanaUserRequest as DeleteGrafanaUserRequest, type DeleteTokenRequest$2 as DeleteTokenRequest, type index_gen$k_DisableManagedAlertsRequest as DisableManagedAlertsRequest, type index_gen$k_EnableManagedAlertsRequest as EnableManagedAlertsRequest, type index_gen$k_GetCockpitMetricsRequest as GetCockpitMetricsRequest, type index_gen$k_GetCockpitRequest as GetCockpitRequest, type GetTokenRequest$2 as GetTokenRequest, type index_gen$k_GrafanaUser as GrafanaUser, type index_gen$k_GrafanaUserRole as GrafanaUserRole, type index_gen$k_ListContactPointsRequest as ListContactPointsRequest, type index_gen$k_ListContactPointsResponse as ListContactPointsResponse, type index_gen$k_ListGrafanaUsersRequest as ListGrafanaUsersRequest, type index_gen$k_ListGrafanaUsersRequestOrderBy as ListGrafanaUsersRequestOrderBy, type index_gen$k_ListGrafanaUsersResponse as ListGrafanaUsersResponse, type index_gen$k_ListPlansRequest as ListPlansRequest, type index_gen$k_ListPlansRequestOrderBy as ListPlansRequestOrderBy, type index_gen$k_ListPlansResponse as ListPlansResponse, type ListTokensRequest$2 as ListTokensRequest, type ListTokensRequestOrderBy$2 as ListTokensRequestOrderBy, type ListTokensResponse$2 as ListTokensResponse, type index_gen$k_Plan as Plan, type index_gen$k_PlanName as PlanName, type index_gen$k_ResetCockpitGrafanaRequest as ResetCockpitGrafanaRequest, type index_gen$k_ResetGrafanaUserPasswordRequest as ResetGrafanaUserPasswordRequest, type index_gen$k_SelectPlanRequest as SelectPlanRequest, type index_gen$k_SelectPlanResponse as SelectPlanResponse, type Token$2 as Token, type index_gen$k_TokenScopes as TokenScopes, type index_gen$k_TriggerTestAlertRequest as TriggerTestAlertRequest };
3515
+ export { API$n as API, type index_gen$k_ActivateCockpitRequest as ActivateCockpitRequest, index_gen$k_COCKPIT_TRANSIENT_STATUSES as COCKPIT_TRANSIENT_STATUSES, type index_gen$k_Cockpit as Cockpit, type index_gen$k_CockpitEndpoints as CockpitEndpoints, type index_gen$k_CockpitMetrics as CockpitMetrics, type index_gen$k_CockpitStatus as CockpitStatus, type index_gen$k_ContactPoint as ContactPoint, type index_gen$k_ContactPointEmail as ContactPointEmail, type index_gen$k_CreateContactPointRequest as CreateContactPointRequest, type index_gen$k_CreateDatasourceRequest as CreateDatasourceRequest, type index_gen$k_CreateGrafanaUserRequest as CreateGrafanaUserRequest, type CreateTokenRequest$2 as CreateTokenRequest, type index_gen$k_Datasource as Datasource, type index_gen$k_DatasourceType as DatasourceType, type index_gen$k_DeactivateCockpitRequest as DeactivateCockpitRequest, type index_gen$k_DeleteContactPointRequest as DeleteContactPointRequest, type index_gen$k_DeleteGrafanaUserRequest as DeleteGrafanaUserRequest, type DeleteTokenRequest$2 as DeleteTokenRequest, type index_gen$k_DisableManagedAlertsRequest as DisableManagedAlertsRequest, type index_gen$k_EnableManagedAlertsRequest as EnableManagedAlertsRequest, type index_gen$k_GetCockpitMetricsRequest as GetCockpitMetricsRequest, type index_gen$k_GetCockpitRequest as GetCockpitRequest, type GetTokenRequest$2 as GetTokenRequest, type index_gen$k_GrafanaUser as GrafanaUser, type index_gen$k_GrafanaUserRole as GrafanaUserRole, type index_gen$k_ListContactPointsRequest as ListContactPointsRequest, type index_gen$k_ListContactPointsResponse as ListContactPointsResponse, type index_gen$k_ListGrafanaUsersRequest as ListGrafanaUsersRequest, type index_gen$k_ListGrafanaUsersRequestOrderBy as ListGrafanaUsersRequestOrderBy, type index_gen$k_ListGrafanaUsersResponse as ListGrafanaUsersResponse, type index_gen$k_ListPlansRequest as ListPlansRequest, type index_gen$k_ListPlansRequestOrderBy as ListPlansRequestOrderBy, type index_gen$k_ListPlansResponse as ListPlansResponse, type ListTokensRequest$2 as ListTokensRequest, type ListTokensRequestOrderBy$2 as ListTokensRequestOrderBy, type ListTokensResponse$2 as ListTokensResponse, type index_gen$k_Plan as Plan, type index_gen$k_PlanName as PlanName, type index_gen$k_ResetCockpitGrafanaRequest as ResetCockpitGrafanaRequest, type index_gen$k_ResetGrafanaUserPasswordRequest as ResetGrafanaUserPasswordRequest, type index_gen$k_SelectPlanRequest as SelectPlanRequest, type index_gen$k_SelectPlanResponse as SelectPlanResponse, type Token$2 as Token, type index_gen$k_TokenScopes as TokenScopes, type index_gen$k_TriggerTestAlertRequest as TriggerTestAlertRequest };
3493
3516
  }
3494
3517
 
3495
3518
  declare namespace index$o {
@@ -10417,12 +10440,23 @@ type DeleteImageRequest$1 = {
10417
10440
  type ListSnapshotsRequest$1 = {
10418
10441
  /** Zone to target. If none is passed will use default zone from the config. */
10419
10442
  zone?: Zone;
10443
+ /** List snapshots only for this Organization ID. */
10420
10444
  organization?: string;
10445
+ /** List snapshots only for this Project ID. */
10446
+ project?: string;
10447
+ /**
10448
+ * Number of snapshots returned per page (positive integer lower or equal to
10449
+ * 100).
10450
+ */
10421
10451
  perPage?: number;
10452
+ /** Page to be returned. */
10422
10453
  page?: number;
10454
+ /** List snapshots of the requested name. */
10423
10455
  name?: string;
10424
- project?: string;
10456
+ /** List snapshots that have the requested tag. */
10425
10457
  tags?: string;
10458
+ /** List snapshots originating only from this volume. */
10459
+ baseVolumeId?: string;
10426
10460
  };
10427
10461
  type CreateSnapshotRequest$1 = {
10428
10462
  /** Zone to target. If none is passed will use default zone from the config. */
@@ -13546,24 +13580,10 @@ declare namespace index$g {
13546
13580
  export { index_gen$e as v1 };
13547
13581
  }
13548
13582
 
13549
- type ListNamesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
13550
13583
  type ListPinsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
13551
13584
  type ListVolumesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
13552
- type NameStatus = 'unknown_status' | 'queued' | 'publishing' | 'failed' | 'published';
13553
13585
  type PinDetails = 'unknown_details' | 'pinning_looking_for_provider' | 'pinning_in_progress' | 'pinning_blocks_fetched' | 'pinning_fetching_url_data' | 'pinned_ok' | 'unpinned_ok' | 'unpinning_in_progress' | 'failed_contains_banned_cid' | 'failed_pinning' | 'failed_pinning_no_provider' | 'failed_pinning_bad_cid_format' | 'failed_pinning_timeout' | 'failed_pinning_too_big_content' | 'failed_pinning_unreachable_url' | 'failed_pinning_bad_url_format' | 'failed_pinning_no_url_content_length' | 'failed_pinning_bad_url_status_code' | 'failed_unpinning' | 'checking_coherence' | 'rescheduled';
13554
13586
  type PinStatus = 'unknown_status' | 'queued' | 'pinning' | 'failed' | 'pinned';
13555
- interface ExportKeyNameResponse {
13556
- nameId: string;
13557
- projectId: string;
13558
- createdAt?: Date;
13559
- updatedAt?: Date;
13560
- publicKey: string;
13561
- privateKey: string;
13562
- }
13563
- interface ListNamesResponse {
13564
- names: Name[];
13565
- totalCount: number;
13566
- }
13567
13587
  interface ListPinsResponse {
13568
13588
  totalCount: number;
13569
13589
  pins: Pin[];
@@ -13572,17 +13592,6 @@ interface ListVolumesResponse {
13572
13592
  volumes: Volume$1[];
13573
13593
  totalCount: number;
13574
13594
  }
13575
- interface Name {
13576
- nameId: string;
13577
- projectId: string;
13578
- createdAt?: Date;
13579
- updatedAt?: Date;
13580
- tags: string[];
13581
- name: string;
13582
- key: string;
13583
- status: NameStatus;
13584
- value: string;
13585
- }
13586
13595
  interface Pin {
13587
13596
  pinId: string;
13588
13597
  status: PinStatus;
@@ -13739,74 +13748,6 @@ type DeletePinRequest = {
13739
13748
  pinId: string;
13740
13749
  volumeId: string;
13741
13750
  };
13742
- type CreateNameRequest = {
13743
- /**
13744
- * Region to target. If none is passed will use default region from the
13745
- * config.
13746
- */
13747
- region?: Region;
13748
- projectId?: string;
13749
- name: string;
13750
- value: string;
13751
- };
13752
- type GetNameRequest = {
13753
- /**
13754
- * Region to target. If none is passed will use default region from the
13755
- * config.
13756
- */
13757
- region?: Region;
13758
- nameId: string;
13759
- };
13760
- type DeleteNameRequest = {
13761
- /**
13762
- * Region to target. If none is passed will use default region from the
13763
- * config.
13764
- */
13765
- region?: Region;
13766
- nameId: string;
13767
- };
13768
- type ListNamesRequest = {
13769
- /**
13770
- * Region to target. If none is passed will use default region from the
13771
- * config.
13772
- */
13773
- region?: Region;
13774
- page?: number;
13775
- pageSize?: number;
13776
- orderBy?: ListNamesRequestOrderBy;
13777
- projectId?: string;
13778
- organizationId?: string;
13779
- };
13780
- type UpdateNameRequest = {
13781
- /**
13782
- * Region to target. If none is passed will use default region from the
13783
- * config.
13784
- */
13785
- region?: Region;
13786
- nameId: string;
13787
- name?: string;
13788
- tags?: string[];
13789
- value?: string;
13790
- };
13791
- type ExportKeyNameRequest = {
13792
- /**
13793
- * Region to target. If none is passed will use default region from the
13794
- * config.
13795
- */
13796
- region?: Region;
13797
- nameId: string;
13798
- };
13799
- type ImportKeyNameRequest = {
13800
- /**
13801
- * Region to target. If none is passed will use default region from the
13802
- * config.
13803
- */
13804
- region?: Region;
13805
- projectId?: string;
13806
- name: string;
13807
- privateKey: string;
13808
- value: string;
13809
- };
13810
13751
 
13811
13752
  /** IPFS Pinning service API. */
13812
13753
  declare class API$f extends API$s {
@@ -13921,100 +13862,24 @@ declare class API$f extends API$s {
13921
13862
  * @param request - The request {@link DeletePinRequest}
13922
13863
  */
13923
13864
  deletePin: (request: Readonly<DeletePinRequest>) => Promise<void>;
13924
- /**
13925
- * Create a new name. You can use the `ipfs key` command to list and generate
13926
- * more names and their respective keys.
13927
- *
13928
- * @param request - The request {@link CreateNameRequest}
13929
- * @returns A Promise of Name
13930
- */
13931
- createName: (request: Readonly<CreateNameRequest>) => Promise<Name>;
13932
- /**
13933
- * Get information about a name. Retrieve information about a specific name.
13934
- *
13935
- * @param request - The request {@link GetNameRequest}
13936
- * @returns A Promise of Name
13937
- */
13938
- getName: (request: Readonly<GetNameRequest>) => Promise<Name>;
13939
- /**
13940
- * Waits for {@link Name} to be in a final state.
13941
- *
13942
- * @param request - The request {@link GetNameRequest}
13943
- * @param options - The waiting options
13944
- * @returns A Promise of Name
13945
- */
13946
- waitForName: (request: Readonly<GetNameRequest>, options?: Readonly<WaitForOptions<Name>>) => Promise<Name>;
13947
- /**
13948
- * Delete an existing name. Delete a name by its ID.
13949
- *
13950
- * @param request - The request {@link DeleteNameRequest}
13951
- */
13952
- deleteName: (request: Readonly<DeleteNameRequest>) => Promise<void>;
13953
- protected pageOfListNames: (request?: Readonly<ListNamesRequest>) => Promise<ListNamesResponse>;
13954
- /**
13955
- * List all names by a Project ID. Retrieve information about all names from a
13956
- * Project ID.
13957
- *
13958
- * @param request - The request {@link ListNamesRequest}
13959
- * @returns A Promise of ListNamesResponse
13960
- */
13961
- listNames: (request?: Readonly<ListNamesRequest>) => Promise<ListNamesResponse> & {
13962
- all: () => Promise<Name[]>;
13963
- [Symbol.asyncIterator]: () => AsyncGenerator<Name[], void, void>;
13964
- };
13965
- /**
13966
- * Update name information. Update name information (CID, tag, name...).
13967
- *
13968
- * @param request - The request {@link UpdateNameRequest}
13969
- * @returns A Promise of Name
13970
- */
13971
- updateName: (request: Readonly<UpdateNameRequest>) => Promise<Name>;
13972
- /**
13973
- * Export your private key. Export a private key by its ID.
13974
- *
13975
- * @param request - The request {@link ExportKeyNameRequest}
13976
- * @returns A Promise of ExportKeyNameResponse
13977
- */
13978
- exportKeyName: (request: Readonly<ExportKeyNameRequest>) => Promise<ExportKeyNameResponse>;
13979
- /**
13980
- * Import your private key. Import a private key.
13981
- *
13982
- * @param request - The request {@link ImportKeyNameRequest}
13983
- * @returns A Promise of Name
13984
- */
13985
- importKeyName: (request: Readonly<ImportKeyNameRequest>) => Promise<Name>;
13986
13865
  }
13987
13866
 
13988
- /** Lists transient statutes of the enum {@link NameStatus}. */
13989
- declare const NAME_TRANSIENT_STATUSES: NameStatus[];
13990
13867
  /** Lists transient statutes of the enum {@link PinStatus}. */
13991
13868
  declare const PIN_TRANSIENT_STATUSES: PinStatus[];
13992
13869
 
13993
- type index_gen$d_CreateNameRequest = CreateNameRequest;
13994
13870
  type index_gen$d_CreatePinByCIDRequest = CreatePinByCIDRequest;
13995
13871
  type index_gen$d_CreatePinByURLRequest = CreatePinByURLRequest;
13996
13872
  type index_gen$d_CreateVolumeRequest = CreateVolumeRequest;
13997
- type index_gen$d_DeleteNameRequest = DeleteNameRequest;
13998
13873
  type index_gen$d_DeletePinRequest = DeletePinRequest;
13999
13874
  type index_gen$d_DeleteVolumeRequest = DeleteVolumeRequest;
14000
- type index_gen$d_ExportKeyNameRequest = ExportKeyNameRequest;
14001
- type index_gen$d_ExportKeyNameResponse = ExportKeyNameResponse;
14002
- type index_gen$d_GetNameRequest = GetNameRequest;
14003
13875
  type index_gen$d_GetPinRequest = GetPinRequest;
14004
13876
  type index_gen$d_GetVolumeRequest = GetVolumeRequest;
14005
- type index_gen$d_ImportKeyNameRequest = ImportKeyNameRequest;
14006
- type index_gen$d_ListNamesRequest = ListNamesRequest;
14007
- type index_gen$d_ListNamesRequestOrderBy = ListNamesRequestOrderBy;
14008
- type index_gen$d_ListNamesResponse = ListNamesResponse;
14009
13877
  type index_gen$d_ListPinsRequest = ListPinsRequest;
14010
13878
  type index_gen$d_ListPinsRequestOrderBy = ListPinsRequestOrderBy;
14011
13879
  type index_gen$d_ListPinsResponse = ListPinsResponse;
14012
13880
  type index_gen$d_ListVolumesRequest = ListVolumesRequest;
14013
13881
  type index_gen$d_ListVolumesRequestOrderBy = ListVolumesRequestOrderBy;
14014
13882
  type index_gen$d_ListVolumesResponse = ListVolumesResponse;
14015
- declare const index_gen$d_NAME_TRANSIENT_STATUSES: typeof NAME_TRANSIENT_STATUSES;
14016
- type index_gen$d_Name = Name;
14017
- type index_gen$d_NameStatus = NameStatus;
14018
13883
  declare const index_gen$d_PIN_TRANSIENT_STATUSES: typeof PIN_TRANSIENT_STATUSES;
14019
13884
  type index_gen$d_Pin = Pin;
14020
13885
  type index_gen$d_PinCID = PinCID;
@@ -14025,10 +13890,9 @@ type index_gen$d_PinOptions = PinOptions;
14025
13890
  type index_gen$d_PinStatus = PinStatus;
14026
13891
  type index_gen$d_ReplacePinRequest = ReplacePinRequest;
14027
13892
  type index_gen$d_ReplacePinResponse = ReplacePinResponse;
14028
- type index_gen$d_UpdateNameRequest = UpdateNameRequest;
14029
13893
  type index_gen$d_UpdateVolumeRequest = UpdateVolumeRequest;
14030
13894
  declare namespace index_gen$d {
14031
- export { API$f as API, type index_gen$d_CreateNameRequest as CreateNameRequest, type index_gen$d_CreatePinByCIDRequest as CreatePinByCIDRequest, type index_gen$d_CreatePinByURLRequest as CreatePinByURLRequest, type index_gen$d_CreateVolumeRequest as CreateVolumeRequest, type index_gen$d_DeleteNameRequest as DeleteNameRequest, type index_gen$d_DeletePinRequest as DeletePinRequest, type index_gen$d_DeleteVolumeRequest as DeleteVolumeRequest, type index_gen$d_ExportKeyNameRequest as ExportKeyNameRequest, type index_gen$d_ExportKeyNameResponse as ExportKeyNameResponse, type index_gen$d_GetNameRequest as GetNameRequest, type index_gen$d_GetPinRequest as GetPinRequest, type index_gen$d_GetVolumeRequest as GetVolumeRequest, type index_gen$d_ImportKeyNameRequest as ImportKeyNameRequest, type index_gen$d_ListNamesRequest as ListNamesRequest, type index_gen$d_ListNamesRequestOrderBy as ListNamesRequestOrderBy, type index_gen$d_ListNamesResponse as ListNamesResponse, type index_gen$d_ListPinsRequest as ListPinsRequest, type index_gen$d_ListPinsRequestOrderBy as ListPinsRequestOrderBy, type index_gen$d_ListPinsResponse as ListPinsResponse, type index_gen$d_ListVolumesRequest as ListVolumesRequest, type index_gen$d_ListVolumesRequestOrderBy as ListVolumesRequestOrderBy, type index_gen$d_ListVolumesResponse as ListVolumesResponse, index_gen$d_NAME_TRANSIENT_STATUSES as NAME_TRANSIENT_STATUSES, type index_gen$d_Name as Name, type index_gen$d_NameStatus as NameStatus, index_gen$d_PIN_TRANSIENT_STATUSES as PIN_TRANSIENT_STATUSES, type index_gen$d_Pin as Pin, type index_gen$d_PinCID as PinCID, type index_gen$d_PinCIDMeta as PinCIDMeta, type index_gen$d_PinDetails as PinDetails, type index_gen$d_PinInfo as PinInfo, type index_gen$d_PinOptions as PinOptions, type index_gen$d_PinStatus as PinStatus, type index_gen$d_ReplacePinRequest as ReplacePinRequest, type index_gen$d_ReplacePinResponse as ReplacePinResponse, type index_gen$d_UpdateNameRequest as UpdateNameRequest, type index_gen$d_UpdateVolumeRequest as UpdateVolumeRequest, type Volume$1 as Volume };
13895
+ export { API$f as API, type index_gen$d_CreatePinByCIDRequest as CreatePinByCIDRequest, type index_gen$d_CreatePinByURLRequest as CreatePinByURLRequest, type index_gen$d_CreateVolumeRequest as CreateVolumeRequest, type index_gen$d_DeletePinRequest as DeletePinRequest, type index_gen$d_DeleteVolumeRequest as DeleteVolumeRequest, type index_gen$d_GetPinRequest as GetPinRequest, type index_gen$d_GetVolumeRequest as GetVolumeRequest, type index_gen$d_ListPinsRequest as ListPinsRequest, type index_gen$d_ListPinsRequestOrderBy as ListPinsRequestOrderBy, type index_gen$d_ListPinsResponse as ListPinsResponse, type index_gen$d_ListVolumesRequest as ListVolumesRequest, type index_gen$d_ListVolumesRequestOrderBy as ListVolumesRequestOrderBy, type index_gen$d_ListVolumesResponse as ListVolumesResponse, index_gen$d_PIN_TRANSIENT_STATUSES as PIN_TRANSIENT_STATUSES, type index_gen$d_Pin as Pin, type index_gen$d_PinCID as PinCID, type index_gen$d_PinCIDMeta as PinCIDMeta, type index_gen$d_PinDetails as PinDetails, type index_gen$d_PinInfo as PinInfo, type index_gen$d_PinOptions as PinOptions, type index_gen$d_PinStatus as PinStatus, type index_gen$d_ReplacePinRequest as ReplacePinRequest, type index_gen$d_ReplacePinResponse as ReplacePinResponse, type index_gen$d_UpdateVolumeRequest as UpdateVolumeRequest, type Volume$1 as Volume };
14032
13896
  }
14033
13897
 
14034
13898
  declare namespace index$f {
@@ -14685,6 +14549,11 @@ type ListClustersRequest$2 = {
14685
14549
  status?: ClusterStatus$1;
14686
14550
  /** Type to filter on, only clusters with this type will be returned. */
14687
14551
  type?: string;
14552
+ /**
14553
+ * Private Network ID to filter on, only clusters within this Private Network
14554
+ * will be returned.
14555
+ */
14556
+ privateNetworkId?: string;
14688
14557
  };
14689
14558
  type CreateClusterRequest$2 = {
14690
14559
  /**
@@ -16240,6 +16109,8 @@ interface ListSubscriberResponse {
16240
16109
  interface PrivateNetwork$3 {
16241
16110
  /** Load Balancer object which is attached to the Private Network. */
16242
16111
  lb?: Lb;
16112
+ /** IPAM IDs of the booked IP addresses. */
16113
+ ipamIds: string[];
16243
16114
  /**
16244
16115
  * @deprecated Object containing an array of a local IP address for the Load
16245
16116
  * Balancer on this Private Network.
@@ -16249,10 +16120,10 @@ interface PrivateNetwork$3 {
16249
16120
  */
16250
16121
  staticConfig?: PrivateNetworkStaticConfig;
16251
16122
  /**
16252
- * Object containing DHCP-assigned IP addresses.
16123
+ * @deprecated Object containing DHCP-assigned IP addresses.
16253
16124
  *
16254
- * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
16255
- * 'ipamConfig' could be set.
16125
+ * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
16126
+ * 'ipamConfig' could be set.
16256
16127
  */
16257
16128
  dhcpConfig?: PrivateNetworkDHCPConfig;
16258
16129
  /**
@@ -16272,6 +16143,7 @@ interface PrivateNetwork$3 {
16272
16143
  updatedAt?: Date;
16273
16144
  }
16274
16145
  interface PrivateNetworkDHCPConfig {
16146
+ /** @deprecated */
16275
16147
  ipId?: string;
16276
16148
  }
16277
16149
  interface PrivateNetworkIpamConfig {
@@ -17395,10 +17267,10 @@ type AttachPrivateNetworkRequest = {
17395
17267
  */
17396
17268
  staticConfig?: PrivateNetworkStaticConfig;
17397
17269
  /**
17398
- * Defines whether to let DHCP assign IP addresses.
17270
+ * @deprecated Defines whether to let DHCP assign IP addresses.
17399
17271
  *
17400
- * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
17401
- * 'ipamConfig' could be set.
17272
+ * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
17273
+ * 'ipamConfig' could be set.
17402
17274
  */
17403
17275
  dhcpConfig?: PrivateNetworkDHCPConfig;
17404
17276
  /**
@@ -18308,10 +18180,10 @@ type ZonedApiAttachPrivateNetworkRequest = {
18308
18180
  */
18309
18181
  staticConfig?: PrivateNetworkStaticConfig;
18310
18182
  /**
18311
- * Defines whether to let DHCP assign IP addresses.
18183
+ * @deprecated Defines whether to let DHCP assign IP addresses.
18312
18184
  *
18313
- * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
18314
- * 'ipamConfig' could be set.
18185
+ * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig',
18186
+ * 'ipamConfig' could be set.
18315
18187
  */
18316
18188
  dhcpConfig?: PrivateNetworkDHCPConfig;
18317
18189
  /**
@@ -20341,7 +20213,7 @@ type Permission = 'readonly' | 'readwrite' | 'all' | 'custom' | 'none';
20341
20213
  /** Read replica. status. */
20342
20214
  type ReadReplicaStatus = 'unknown' | 'provisioning' | 'initializing' | 'ready' | 'deleting' | 'error' | 'locked' | 'configuring' | 'promoting';
20343
20215
  type SnapshotStatus = 'unknown' | 'creating' | 'ready' | 'restoring' | 'deleting' | 'error' | 'locked';
20344
- type VolumeType = 'lssd' | 'bssd';
20216
+ type VolumeType = 'lssd' | 'bssd' | 'sbs';
20345
20217
  interface ACLRule$1 {
20346
20218
  ip: string;
20347
20219
  /** @deprecated */
@@ -24042,7 +23914,7 @@ type ListFoldersRequest = {
24042
23914
  * config.
24043
23915
  */
24044
23916
  region?: Region;
24045
- /** ID of the Project. */
23917
+ /** Filter by Project ID (optional). */
24046
23918
  projectId?: string;
24047
23919
  /** Filter by path (optional). */
24048
23920
  path?: string;
@@ -24182,7 +24054,11 @@ type GetSecretVersionRequest = {
24182
24054
  secretId: string;
24183
24055
  /**
24184
24056
  * Version number. The first version of the secret is numbered 1, and all
24185
- * subsequent revisions augment by 1. Value can be a number or "latest".
24057
+ * subsequent revisions augment by 1. Value can be either:
24058
+ *
24059
+ * - A number (the revision number)
24060
+ * - "latest" (the latest revision)
24061
+ * - "latest_enabled" (the latest enabled revision).
24186
24062
  */
24187
24063
  revision: string;
24188
24064
  };
@@ -24196,7 +24072,11 @@ type GetSecretVersionByNameRequest = {
24196
24072
  secretName: string;
24197
24073
  /**
24198
24074
  * Version number. The first version of the secret is numbered 1, and all
24199
- * subsequent revisions augment by 1. Value can be a number or "latest".
24075
+ * subsequent revisions augment by 1. Value can be either:
24076
+ *
24077
+ * - A number (the revision number)
24078
+ * - "latest" (the latest revision)
24079
+ * - "latest_enabled" (the latest enabled revision).
24200
24080
  */
24201
24081
  revision: string;
24202
24082
  /**
@@ -24215,7 +24095,11 @@ type UpdateSecretVersionRequest = {
24215
24095
  secretId: string;
24216
24096
  /**
24217
24097
  * Version number. The first version of the secret is numbered 1, and all
24218
- * subsequent revisions augment by 1. Value can be a number or "latest".
24098
+ * subsequent revisions augment by 1. Value can be either:
24099
+ *
24100
+ * - A number (the revision number)
24101
+ * - "latest" (the latest revision)
24102
+ * - "latest_enabled" (the latest enabled revision).
24219
24103
  */
24220
24104
  revision: string;
24221
24105
  /** Description of the version. */
@@ -24262,7 +24146,11 @@ type EnableSecretVersionRequest = {
24262
24146
  secretId: string;
24263
24147
  /**
24264
24148
  * Version number. The first version of the secret is numbered 1, and all
24265
- * subsequent revisions augment by 1. Value can be a number or "latest".
24149
+ * subsequent revisions augment by 1. Value can be either:
24150
+ *
24151
+ * - A number (the revision number)
24152
+ * - "latest" (the latest revision)
24153
+ * - "latest_enabled" (the latest enabled revision).
24266
24154
  */
24267
24155
  revision: string;
24268
24156
  };
@@ -24276,7 +24164,11 @@ type DisableSecretVersionRequest = {
24276
24164
  secretId: string;
24277
24165
  /**
24278
24166
  * Version number. The first version of the secret is numbered 1, and all
24279
- * subsequent revisions augment by 1. Value can be a number or "latest".
24167
+ * subsequent revisions augment by 1. Value can be either:
24168
+ *
24169
+ * - A number (the revision number)
24170
+ * - "latest" (the latest revision)
24171
+ * - "latest_enabled" (the latest enabled revision).
24280
24172
  */
24281
24173
  revision: string;
24282
24174
  };
@@ -24290,7 +24182,11 @@ type AccessSecretVersionRequest = {
24290
24182
  secretId: string;
24291
24183
  /**
24292
24184
  * Version number. The first version of the secret is numbered 1, and all
24293
- * subsequent revisions augment by 1. Value can be a number or "latest".
24185
+ * subsequent revisions augment by 1. Value can be either:
24186
+ *
24187
+ * - A number (the revision number)
24188
+ * - "latest" (the latest revision)
24189
+ * - "latest_enabled" (the latest enabled revision).
24294
24190
  */
24295
24191
  revision: string;
24296
24192
  };
@@ -24304,7 +24200,11 @@ type AccessSecretVersionByNameRequest = {
24304
24200
  secretName: string;
24305
24201
  /**
24306
24202
  * Version number. The first version of the secret is numbered 1, and all
24307
- * subsequent revisions augment by 1. Value can be a number or "latest".
24203
+ * subsequent revisions augment by 1. Value can be either:
24204
+ *
24205
+ * - A number (the revision number)
24206
+ * - "latest" (the latest revision)
24207
+ * - "latest_enabled" (the latest enabled revision).
24308
24208
  */
24309
24209
  revision: string;
24310
24210
  /**
@@ -24323,7 +24223,11 @@ type DestroySecretVersionRequest = {
24323
24223
  secretId: string;
24324
24224
  /**
24325
24225
  * Version number. The first version of the secret is numbered 1, and all
24326
- * subsequent revisions augment by 1. Value can be a number or "latest".
24226
+ * subsequent revisions augment by 1. Value can be either:
24227
+ *
24228
+ * - A number (the revision number)
24229
+ * - "latest" (the latest revision)
24230
+ * - "latest_enabled" (the latest enabled revision).
24327
24231
  */
24328
24232
  revision: string;
24329
24233
  };
@@ -24411,7 +24315,7 @@ declare class API$6 extends API$s {
24411
24315
  };
24412
24316
  protected pageOfListFolders: (request?: Readonly<ListFoldersRequest>) => Promise<ListFoldersResponse>;
24413
24317
  /**
24414
- * List secrets. Retrieve the list of folders created within a Project.
24318
+ * List folders. Retrieve the list of folders created within a Project.
24415
24319
  *
24416
24320
  * @param request - The request {@link ListFoldersRequest}
24417
24321
  * @returns A Promise of ListFoldersResponse