@scaleway/sdk 1.6.0 → 1.7.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.
Files changed (36) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.js +1 -1
  2. package/dist/api/baremetal/v1/api.gen.js +1 -1
  3. package/dist/api/baremetal/v1/api.utils.js +1 -1
  4. package/dist/api/cockpit/v1beta1/api.gen.js +41 -31
  5. package/dist/api/container/v1beta1/api.gen.js +34 -28
  6. package/dist/api/container/v1beta1/marshalling.gen.js +1 -1
  7. package/dist/api/domain/v2beta1/api.gen.js +2 -2
  8. package/dist/api/flexibleip/v1alpha1/api.gen.js +1 -1
  9. package/dist/api/function/v1beta1/api.gen.js +39 -30
  10. package/dist/api/function/v1beta1/marshalling.gen.js +1 -0
  11. package/dist/api/iam/v1alpha1/api.gen.js +2 -3
  12. package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
  13. package/dist/api/instance/v1/api.utils.js +7 -13
  14. package/dist/api/iot/v1/api.gen.js +1 -1
  15. package/dist/api/k8s/v1/api.gen.js +3 -3
  16. package/dist/api/lb/v1/api.gen.js +4 -4
  17. package/dist/api/lb/v1/api.utils.js +4 -4
  18. package/dist/api/marketplace/v2/api.gen.js +46 -3
  19. package/dist/api/mnq/v1alpha1/api.gen.js +35 -12
  20. package/dist/api/rdb/v1/api.gen.js +5 -5
  21. package/dist/api/redis/v1/api.gen.js +1 -1
  22. package/dist/api/registry/v1/api.gen.js +3 -3
  23. package/dist/api/secret/v1alpha1/api.gen.js +26 -15
  24. package/dist/api/secret/v1alpha1/marshalling.gen.js +8 -1
  25. package/dist/api/tem/v1alpha1/api.gen.js +2 -2
  26. package/dist/api/test/v1/api.gen.js +1 -1
  27. package/dist/api/vpc/v1/api.gen.js +13 -5
  28. package/dist/api/vpcgw/v1/api.gen.js +2 -2
  29. package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
  30. package/dist/helpers/marshalling.js +1 -1
  31. package/dist/index.cjs +241 -117
  32. package/dist/index.d.ts +825 -257
  33. package/dist/internal/async/interval-retrier.js +2 -2
  34. package/dist/scw/constants.js +1 -1
  35. package/dist/scw/custom-marshalling.js +4 -7
  36. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -2840,37 +2840,41 @@ type ListTokensRequestOrderBy$2 = 'created_at_asc' | 'created_at_desc' | 'name_a
2840
2840
  type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
2841
2841
  /** Cockpit. */
2842
2842
  interface Cockpit {
2843
- /** Project ID. */
2843
+ /** ID of the Project the Cockpit belongs to. */
2844
2844
  projectId: string;
2845
- /** Created at. */
2845
+ /** Date and time of the Cockpit's creation. */
2846
2846
  createdAt?: Date;
2847
- /** Updated at. */
2847
+ /** Date and time of the Cockpit's last update. */
2848
2848
  updatedAt?: Date;
2849
- /** Endpoints. */
2849
+ /** Endpoints of the Cockpit. */
2850
2850
  endpoints?: CockpitEndpoints;
2851
- /** Status. */
2851
+ /** Status of the Cockpit. */
2852
2852
  status: CockpitStatus;
2853
- /** Managed alerts enabled. */
2853
+ /** Specifies whether managed alerts are enabled or disabled. */
2854
2854
  managedAlertsEnabled: boolean;
2855
- /** Pricing plan. */
2855
+ /** Pricing plan information. */
2856
2856
  plan?: Plan;
2857
2857
  }
2858
2858
  /** Cockpit. endpoints. */
2859
2859
  interface CockpitEndpoints {
2860
+ /** URL for metrics. */
2860
2861
  metricsUrl: string;
2862
+ /** URL for logs. */
2861
2863
  logsUrl: string;
2864
+ /** URL for the alert manager. */
2862
2865
  alertmanagerUrl: string;
2866
+ /** URL for the Grafana dashboard. */
2863
2867
  grafanaUrl: string;
2864
2868
  }
2865
- /** Cockpit metrics. */
2869
+ /** Metrics for a given Cockpit. Cockpit metrics. */
2866
2870
  interface CockpitMetrics {
2867
- /** Timeseries array. */
2871
+ /** Time series array. */
2868
2872
  timeseries: TimeSeries[];
2869
2873
  }
2870
- /** Alert contact point. Contact point. */
2874
+ /** Contact point. */
2871
2875
  interface ContactPoint {
2872
2876
  /**
2873
- * Alert contact point configuration.
2877
+ * Contact point configuration.
2874
2878
  *
2875
2879
  * One-of ('configuration'): at most one of 'email' could be set.
2876
2880
  */
@@ -2881,118 +2885,157 @@ interface ContactPointEmail {
2881
2885
  }
2882
2886
  /** Grafana user. */
2883
2887
  interface GrafanaUser {
2888
+ /** ID of the Grafana user. */
2884
2889
  id: number;
2890
+ /** Username of the Grafana user. */
2885
2891
  login: string;
2892
+ /** Role assigned to the Grafana user. */
2886
2893
  role: GrafanaUserRole;
2894
+ /** The Grafana user's password. */
2887
2895
  password?: string;
2888
2896
  }
2889
- /** List contact points response. */
2897
+ /** Response returned when listing contact points. List contact points response. */
2890
2898
  interface ListContactPointsResponse {
2891
- /** Total count of contact points. */
2899
+ /** Count of all contact points created. */
2892
2900
  totalCount: number;
2893
- /** Contact points array. */
2901
+ /** Array of contact points. */
2894
2902
  contactPoints: ContactPoint[];
2895
- /** Has receivers other than default. */
2903
+ /**
2904
+ * Specifies whether the contact point has other receivers than the default
2905
+ * receiver.
2906
+ */
2896
2907
  hasAdditionalReceivers: boolean;
2897
- /** Has unmanaged contact points. */
2908
+ /** Specifies whether there are unmanaged contact points. */
2898
2909
  hasAdditionalContactPoints: boolean;
2899
2910
  }
2900
- /** List grafana users response. */
2911
+ /** Response returned when listing Grafana users. List grafana users response. */
2901
2912
  interface ListGrafanaUsersResponse {
2913
+ /** Count of all Grafana users. */
2902
2914
  totalCount: number;
2915
+ /** Information on all Grafana users. */
2903
2916
  grafanaUsers: GrafanaUser[];
2904
2917
  }
2905
- /** List all pricing plans response. List plans response. */
2918
+ /** Response returned when listing all pricing plans. List plans response. */
2906
2919
  interface ListPlansResponse {
2920
+ /** Count of all pricing plans. */
2907
2921
  totalCount: number;
2922
+ /** Information on plans. */
2908
2923
  plans: Plan[];
2909
2924
  }
2910
2925
  /** List tokens response. */
2911
2926
  interface ListTokensResponse$2 {
2927
+ /** Count of all tokens created. */
2912
2928
  totalCount: number;
2929
+ /** List of all tokens created. */
2913
2930
  tokens: Token$2[];
2914
2931
  }
2915
- /** Plan. */
2932
+ /** Pricing plan. Plan. */
2916
2933
  interface Plan {
2917
- /** Plan id. */
2934
+ /** ID of a given pricing plan. */
2918
2935
  id: string;
2919
- /** Plan name. */
2936
+ /** Name of a given pricing plan. */
2920
2937
  name: PlanName;
2921
2938
  /** Retention for metrics. */
2922
2939
  retentionMetricsInterval?: string;
2923
2940
  /** Retention for logs. */
2924
2941
  retentionLogsInterval?: string;
2925
- /** Ingestion price for 1million samples in cents. */
2942
+ /** Ingestion price for 1 million samples in cents. */
2926
2943
  sampleIngestionPrice: number;
2927
- /** Ingestion price in cents for 1 Go of logs. */
2944
+ /** Ingestion price for 1 GB of logs in cents. */
2928
2945
  logsIngestionPrice: number;
2929
2946
  /** Retention price in euros per month. */
2930
2947
  retentionPrice: number;
2931
2948
  }
2932
- /** Select pricing plan response. Select plan response. */
2949
+ /** Response returned when selecting a pricing plan. Select plan response. */
2933
2950
  interface SelectPlanResponse {
2934
2951
  }
2935
2952
  /** Token. */
2936
2953
  interface Token$2 {
2954
+ /** ID of the token. */
2937
2955
  id: string;
2956
+ /** ID of the Project. */
2938
2957
  projectId: string;
2958
+ /** Name of the token. */
2939
2959
  name: string;
2960
+ /** Date and time of the token's creation. */
2940
2961
  createdAt?: Date;
2962
+ /** Date and time of the token's last update. */
2941
2963
  updatedAt?: Date;
2964
+ /** Token's permissions. */
2942
2965
  scopes?: TokenScopes;
2966
+ /** Token's secret key. */
2943
2967
  secretKey?: string;
2944
2968
  }
2945
2969
  /** Token scopes. */
2946
2970
  interface TokenScopes {
2971
+ /** Permission to fetch metrics. */
2947
2972
  queryMetrics: boolean;
2973
+ /** Permission to write metrics. */
2948
2974
  writeMetrics: boolean;
2975
+ /** Permission to setup metrics rules. */
2949
2976
  setupMetricsRules: boolean;
2977
+ /** Permission to fetch logs. */
2950
2978
  queryLogs: boolean;
2979
+ /** Permission to write logs. */
2951
2980
  writeLogs: boolean;
2981
+ /** Permission to setup logs rules. */
2952
2982
  setupLogsRules: boolean;
2983
+ /** Permission to setup alerts. */
2953
2984
  setupAlerts: boolean;
2954
2985
  }
2955
2986
  type ActivateCockpitRequest = {
2987
+ /** ID of the Project the Cockpit belongs to. */
2956
2988
  projectId?: string;
2957
2989
  };
2958
2990
  type GetCockpitRequest = {
2991
+ /** ID of the Project the Cockpit belongs to. */
2959
2992
  projectId?: string;
2960
2993
  };
2961
2994
  type GetCockpitMetricsRequest = {
2962
- /** Project ID. */
2995
+ /** ID of the Project the Cockpit belongs to. */
2963
2996
  projectId?: string;
2964
- /** Start date. */
2997
+ /** Desired time range's start date for the metrics. */
2965
2998
  startDate?: Date;
2966
- /** End date. */
2999
+ /** Desired time range's end date for the metrics. */
2967
3000
  endDate?: Date;
2968
- /** Metric name. */
3001
+ /** Name of the metric requested. */
2969
3002
  metricName?: string;
2970
3003
  };
2971
3004
  type DeactivateCockpitRequest = {
3005
+ /** ID of the Project the Cockpit belongs to. */
2972
3006
  projectId?: string;
2973
3007
  };
2974
3008
  type ResetCockpitGrafanaRequest = {
3009
+ /** ID of the Project the Cockpit belongs to. */
2975
3010
  projectId?: string;
2976
3011
  };
2977
3012
  type CreateTokenRequest$2 = {
3013
+ /** ID of the Project. */
2978
3014
  projectId?: string;
3015
+ /** Name of the token. */
2979
3016
  name?: string;
3017
+ /** Token's permissions. */
2980
3018
  scopes?: TokenScopes;
2981
3019
  };
2982
3020
  type ListTokensRequest$2 = {
3021
+ /** Page number. */
2983
3022
  page?: number;
3023
+ /** Page size. */
2984
3024
  pageSize?: number;
2985
3025
  orderBy?: ListTokensRequestOrderBy$2;
3026
+ /** ID of the Project. */
2986
3027
  projectId?: string;
2987
3028
  };
2988
3029
  type GetTokenRequest$2 = {
3030
+ /** ID of the token. */
2989
3031
  tokenId: string;
2990
3032
  };
2991
3033
  type DeleteTokenRequest$2 = {
3034
+ /** ID of the token. */
2992
3035
  tokenId: string;
2993
3036
  };
2994
3037
  type CreateContactPointRequest = {
2995
- /** Project ID. */
3038
+ /** ID of the Project in which to create the contact point. */
2996
3039
  projectId?: string;
2997
3040
  /** Contact point to create. */
2998
3041
  contactPoint?: ContactPoint;
@@ -3002,68 +3045,87 @@ type ListContactPointsRequest = {
3002
3045
  page?: number;
3003
3046
  /** Page size. */
3004
3047
  pageSize?: number;
3005
- /** Project ID. */
3048
+ /** ID of the Project from which to list the contact points. */
3006
3049
  projectId?: string;
3007
3050
  };
3008
3051
  type DeleteContactPointRequest = {
3052
+ /** ID of the Project. */
3009
3053
  projectId?: string;
3010
3054
  /** Contact point to delete. */
3011
3055
  contactPoint?: ContactPoint;
3012
3056
  };
3013
3057
  type EnableManagedAlertsRequest = {
3058
+ /** ID of the Project. */
3014
3059
  projectId?: string;
3015
3060
  };
3016
3061
  type DisableManagedAlertsRequest = {
3062
+ /** ID of the Project. */
3017
3063
  projectId?: string;
3018
3064
  };
3019
3065
  type TriggerTestAlertRequest = {
3020
3066
  projectId?: string;
3021
3067
  };
3022
3068
  type CreateGrafanaUserRequest = {
3069
+ /** ID of the Project. */
3023
3070
  projectId?: string;
3071
+ /** Username of the Grafana user. */
3024
3072
  login: string;
3073
+ /** Role assigned to the Grafana user. */
3025
3074
  role?: GrafanaUserRole;
3026
3075
  };
3027
3076
  type ListGrafanaUsersRequest = {
3077
+ /** Page number. */
3028
3078
  page?: number;
3079
+ /** Page size. */
3029
3080
  pageSize?: number;
3030
3081
  orderBy?: ListGrafanaUsersRequestOrderBy;
3082
+ /** ID of the Project. */
3031
3083
  projectId?: string;
3032
3084
  };
3033
3085
  type DeleteGrafanaUserRequest = {
3086
+ /** ID of the Grafana user. */
3034
3087
  grafanaUserId: number;
3088
+ /** ID of the Project. */
3035
3089
  projectId?: string;
3036
3090
  };
3037
3091
  type ResetGrafanaUserPasswordRequest = {
3092
+ /** ID of the Grafana user. */
3038
3093
  grafanaUserId: number;
3094
+ /** ID of the Project. */
3039
3095
  projectId?: string;
3040
3096
  };
3041
3097
  type ListPlansRequest = {
3098
+ /** Page number. */
3042
3099
  page?: number;
3100
+ /** Page size. */
3043
3101
  pageSize?: number;
3044
3102
  orderBy?: ListPlansRequestOrderBy;
3045
3103
  };
3046
3104
  type SelectPlanRequest = {
3105
+ /** ID of the Project. */
3047
3106
  projectId?: string;
3107
+ /** ID of the pricing plan. */
3048
3108
  planId: string;
3049
3109
  };
3050
3110
 
3051
3111
  /**
3052
- * Cockpit API.
3112
+ * Cockpit API documentation.
3053
3113
  *
3054
- * This API allows to manage Cockpits. Cockpit API.
3114
+ * Cockpit's API allows you to monitor your applications and their
3115
+ * infrastructure. Cockpit's API allows you to activate your Cockpit on your
3116
+ * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
3117
+ * Grafana for dashboarding to visualize them.
3055
3118
  */
3056
3119
  declare class API$l extends API$q {
3057
3120
  /**
3058
- * Activate a cockpit. Activate a cockpit associated with the given project
3059
- * ID.
3121
+ * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
3060
3122
  *
3061
3123
  * @param request - The request {@link ActivateCockpitRequest}
3062
3124
  * @returns A Promise of Cockpit
3063
3125
  */
3064
3126
  activateCockpit: (request?: Readonly<ActivateCockpitRequest>) => Promise<Cockpit>;
3065
3127
  /**
3066
- * Get cockpit. Get the cockpit associated with the given project ID.
3128
+ * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
3067
3129
  *
3068
3130
  * @param request - The request {@link GetCockpitRequest}
3069
3131
  * @returns A Promise of Cockpit
@@ -3078,30 +3140,30 @@ declare class API$l extends API$q {
3078
3140
  */
3079
3141
  waitForCockpit: (request?: Readonly<GetCockpitRequest>, options?: Readonly<WaitForOptions<Cockpit>>) => Promise<Cockpit>;
3080
3142
  /**
3081
- * Get cockpit metrics. Get the cockpit metrics with the given project ID.
3143
+ * Get Cockpit metrics. Get metrics from your Cockpit with the specified
3144
+ * Project ID.
3082
3145
  *
3083
3146
  * @param request - The request {@link GetCockpitMetricsRequest}
3084
3147
  * @returns A Promise of CockpitMetrics
3085
3148
  */
3086
3149
  getCockpitMetrics: (request?: Readonly<GetCockpitMetricsRequest>) => Promise<CockpitMetrics>;
3087
3150
  /**
3088
- * Deactivate a cockpit. Deactivate a cockpit associated with the given
3089
- * project ID.
3151
+ * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
3090
3152
  *
3091
3153
  * @param request - The request {@link DeactivateCockpitRequest}
3092
3154
  * @returns A Promise of Cockpit
3093
3155
  */
3094
3156
  deactivateCockpit: (request?: Readonly<DeactivateCockpitRequest>) => Promise<Cockpit>;
3095
3157
  /**
3096
- * Reset Grafana. Reset the Grafana of your cockpit associated with the given
3097
- * project ID.
3158
+ * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
3159
+ * Project ID.
3098
3160
  *
3099
3161
  * @param request - The request {@link ResetCockpitGrafanaRequest}
3100
3162
  * @returns A Promise of Cockpit
3101
3163
  */
3102
3164
  resetCockpitGrafana: (request?: Readonly<ResetCockpitGrafanaRequest>) => Promise<Cockpit>;
3103
3165
  /**
3104
- * Create a token. Create a token associated with the given project ID.
3166
+ * Create a token. Create a token associated with the specified Project ID.
3105
3167
  *
3106
3168
  * @param request - The request {@link CreateTokenRequest}
3107
3169
  * @returns A Promise of Token
@@ -3109,7 +3171,7 @@ declare class API$l extends API$q {
3109
3171
  createToken: (request?: Readonly<CreateTokenRequest$2>) => Promise<Token$2>;
3110
3172
  protected pageOfListTokens: (request?: Readonly<ListTokensRequest$2>) => Promise<ListTokensResponse$2>;
3111
3173
  /**
3112
- * List tokens. List tokens associated with the given project ID.
3174
+ * List tokens. Get a list of tokens associated with the specified Project ID.
3113
3175
  *
3114
3176
  * @param request - The request {@link ListTokensRequest}
3115
3177
  * @returns A Promise of ListTokensResponse
@@ -3119,20 +3181,20 @@ declare class API$l extends API$q {
3119
3181
  [Symbol.asyncIterator]: () => AsyncGenerator<Token$2[], void, void>;
3120
3182
  };
3121
3183
  /**
3122
- * Get token. Get the token associated with the given ID.
3184
+ * Get a token. Retrieve the token associated with the specified token ID.
3123
3185
  *
3124
3186
  * @param request - The request {@link GetTokenRequest}
3125
3187
  * @returns A Promise of Token
3126
3188
  */
3127
3189
  getToken: (request: Readonly<GetTokenRequest$2>) => Promise<Token$2>;
3128
3190
  /**
3129
- * Delete token. Delete the token associated with the given ID.
3191
+ * Delete a token. Delete the token associated with the specified token ID.
3130
3192
  *
3131
3193
  * @param request - The request {@link DeleteTokenRequest}
3132
3194
  */
3133
3195
  deleteToken: (request: Readonly<DeleteTokenRequest$2>) => Promise<void>;
3134
3196
  /**
3135
- * Create an alert contact point. Create an alert contact point for the
3197
+ * Create a contact point. Create a contact point to receive alerts for the
3136
3198
  * default receiver.
3137
3199
  *
3138
3200
  * @param request - The request {@link CreateContactPointRequest}
@@ -3141,8 +3203,8 @@ declare class API$l extends API$q {
3141
3203
  createContactPoint: (request?: Readonly<CreateContactPointRequest>) => Promise<ContactPoint>;
3142
3204
  protected pageOfListContactPoints: (request?: Readonly<ListContactPointsRequest>) => Promise<ListContactPointsResponse>;
3143
3205
  /**
3144
- * List alert contact points. List alert contact points associated with the
3145
- * given cockpit ID.
3206
+ * List contact points. Get a list of contact points for the Cockpit
3207
+ * associated with the specified Project ID.
3146
3208
  *
3147
3209
  * @param request - The request {@link ListContactPointsRequest}
3148
3210
  * @returns A Promise of ListContactPointsResponse
@@ -3152,32 +3214,37 @@ declare class API$l extends API$q {
3152
3214
  [Symbol.asyncIterator]: () => AsyncGenerator<ContactPoint[], void, void>;
3153
3215
  };
3154
3216
  /**
3155
- * Delete an alert contact point. Delete an alert contact point for the
3156
- * default receiver.
3217
+ * Delete an alert contact point. Delete a contact point for the default
3218
+ * receiver.
3157
3219
  *
3158
3220
  * @param request - The request {@link DeleteContactPointRequest}
3159
3221
  */
3160
3222
  deleteContactPoint: (request?: Readonly<DeleteContactPointRequest>) => Promise<void>;
3161
3223
  /**
3162
- * Enable managed alerts.
3224
+ * Enable managed alerts. Enable the sending of managed alerts for the
3225
+ * specified Project's Cockpit.
3163
3226
  *
3164
3227
  * @param request - The request {@link EnableManagedAlertsRequest}
3165
3228
  */
3166
3229
  enableManagedAlerts: (request?: Readonly<EnableManagedAlertsRequest>) => Promise<void>;
3167
3230
  /**
3168
- * Disable managed alerts.
3231
+ * Disable managed alerts. Disable the sending of managed alerts for the
3232
+ * specified Project's Cockpit.
3169
3233
  *
3170
3234
  * @param request - The request {@link DisableManagedAlertsRequest}
3171
3235
  */
3172
3236
  disableManagedAlerts: (request?: Readonly<DisableManagedAlertsRequest>) => Promise<void>;
3173
3237
  /**
3174
- * Trigger a test alert. Trigger a test alert to all receivers.
3238
+ * Trigger a test alert. Trigger a test alert to all of the Cockpit's
3239
+ * receivers.
3175
3240
  *
3176
3241
  * @param request - The request {@link TriggerTestAlertRequest}
3177
3242
  */
3178
3243
  triggerTestAlert: (request?: Readonly<TriggerTestAlertRequest>) => Promise<void>;
3179
3244
  /**
3180
- * Create a grafana user. Create a grafana user for your grafana instance.
3245
+ * Create a Grafana user. Create a Grafana user for your Cockpit's Grafana
3246
+ * instance. Make sure you save the automatically-generated password and the
3247
+ * Grafana user ID.
3181
3248
  *
3182
3249
  * @param request - The request {@link CreateGrafanaUserRequest}
3183
3250
  * @returns A Promise of GrafanaUser
@@ -3185,8 +3252,8 @@ declare class API$l extends API$q {
3185
3252
  createGrafanaUser: (request: Readonly<CreateGrafanaUserRequest>) => Promise<GrafanaUser>;
3186
3253
  protected pageOfListGrafanaUsers: (request?: Readonly<ListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse>;
3187
3254
  /**
3188
- * List grafana users. List grafana users who are able to connect to your
3189
- * grafana instance.
3255
+ * List Grafana users. Get a list of Grafana users who are able to connect to
3256
+ * the Cockpit's Grafana instance.
3190
3257
  *
3191
3258
  * @param request - The request {@link ListGrafanaUsersRequest}
3192
3259
  * @returns A Promise of ListGrafanaUsersResponse
@@ -3196,14 +3263,15 @@ declare class API$l extends API$q {
3196
3263
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
3197
3264
  };
3198
3265
  /**
3199
- * Delete a grafana user. Delete a grafana user from your grafana instance.
3266
+ * Delete a Grafana user. Delete a Grafana user from a Grafana instance,
3267
+ * specified by the Cockpit's Project ID and the Grafana user ID.
3200
3268
  *
3201
3269
  * @param request - The request {@link DeleteGrafanaUserRequest}
3202
3270
  */
3203
3271
  deleteGrafanaUser: (request: Readonly<DeleteGrafanaUserRequest>) => Promise<void>;
3204
3272
  /**
3205
- * Reset Grafana user password. Reset the Grafana user password from your
3206
- * grafana instance.
3273
+ * Reset a Grafana user's password. Reset a Grafana user's password specified
3274
+ * by the Cockpit's Project ID and the Grafana user ID.
3207
3275
  *
3208
3276
  * @param request - The request {@link ResetGrafanaUserPasswordRequest}
3209
3277
  * @returns A Promise of GrafanaUser
@@ -3211,7 +3279,7 @@ declare class API$l extends API$q {
3211
3279
  resetGrafanaUserPassword: (request: Readonly<ResetGrafanaUserPasswordRequest>) => Promise<GrafanaUser>;
3212
3280
  protected pageOfListPlans: (request?: Readonly<ListPlansRequest>) => Promise<ListPlansResponse>;
3213
3281
  /**
3214
- * List plans. List all pricing plans.
3282
+ * List pricing plans. Get a list of all pricing plans available.
3215
3283
  *
3216
3284
  * @param request - The request {@link ListPlansRequest}
3217
3285
  * @returns A Promise of ListPlansResponse
@@ -3221,7 +3289,9 @@ declare class API$l extends API$q {
3221
3289
  [Symbol.asyncIterator]: () => AsyncGenerator<Plan[], void, void>;
3222
3290
  };
3223
3291
  /**
3224
- * Select pricing plan. Select the wanted pricing plan.
3292
+ * Select pricing plan. Select your chosen pricing plan for your Cockpit,
3293
+ * specifying the Cockpit's Project ID and the pricing plan's ID in the
3294
+ * request.
3225
3295
  *
3226
3296
  * @param request - The request {@link SelectPlanRequest}
3227
3297
  * @returns A Promise of SelectPlanResponse
@@ -3339,66 +3409,107 @@ type NullValue$2 = 'NULL_VALUE';
3339
3409
  type TokenStatus$1 = 'unknown' | 'ready' | 'deleting' | 'error' | 'creating';
3340
3410
  /** Container. */
3341
3411
  interface Container {
3412
+ /** UUID of the container. */
3342
3413
  id: string;
3414
+ /** Name of the container. */
3343
3415
  name: string;
3416
+ /** UUID of the namespace the container belongs to. */
3344
3417
  namespaceId: string;
3418
+ /** Status of the container. */
3345
3419
  status: ContainerStatus;
3420
+ /** Environment variables of the container. */
3346
3421
  environmentVariables: Record<string, string>;
3422
+ /** Minimum number of instances to scale the container to. */
3347
3423
  minScale: number;
3424
+ /** Maximum number of instances to scale the container to. */
3348
3425
  maxScale: number;
3426
+ /** Memory limit of the container in MB. */
3349
3427
  memoryLimit: number;
3428
+ /** CPU limit of the container. */
3350
3429
  cpuLimit: number;
3430
+ /** Processing time limit for the container. */
3351
3431
  timeout?: string;
3432
+ /** Last error message of the container. */
3352
3433
  errorMessage?: string;
3434
+ /** Privacy setting of the container. */
3353
3435
  privacy: ContainerPrivacy;
3436
+ /** Description of the container. */
3354
3437
  description?: string;
3438
+ /**
3439
+ * Name of the registry image (e.g.
3440
+ * "rg.fr-par.scw.cloud/something/image:tag").
3441
+ */
3355
3442
  registryImage: string;
3443
+ /** Number of maximum concurrent executions of the container. */
3356
3444
  maxConcurrency: number;
3445
+ /** Domain name attributed to the contaioner. */
3357
3446
  domainName: string;
3447
+ /** Protocol the container uses. */
3358
3448
  protocol: ContainerProtocol;
3449
+ /** Port the container listens on. */
3359
3450
  port: number;
3451
+ /** Secret environment variables of the container. */
3360
3452
  secretEnvironmentVariables: SecretHashedValue$1[];
3361
3453
  /**
3362
- * Configure how HTTP and HTTPS requests are handled. Possible values:
3454
+ * Configuration for the handling of HTTP and HTTPS requests. Possible values:
3363
3455
  *
3364
3456
  * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients
3365
3457
  * to use HTTPS.
3366
3458
  * - Enabled: Serve both HTTP and HTTPS traffic.
3367
3459
  */
3368
3460
  httpOption: ContainerHttpOption;
3461
+ /** Region in which the container will be deployed. */
3369
3462
  region: Region;
3370
3463
  }
3371
3464
  /** Cron. */
3372
3465
  interface Cron$1 {
3466
+ /** UUID of the cron. */
3373
3467
  id: string;
3468
+ /** UUID of the container invoked by this cron. */
3374
3469
  containerId: string;
3470
+ /** UNIX cron shedule. */
3375
3471
  schedule: string;
3472
+ /** Arguments to pass with the cron. */
3376
3473
  args?: Record<string, unknown>;
3474
+ /** Status of the cron. */
3377
3475
  status: CronStatus$1;
3476
+ /** Name of the cron. */
3378
3477
  name: string;
3379
3478
  }
3380
3479
  /** Domain. */
3381
3480
  interface Domain$3 {
3481
+ /** UUID of the domain. */
3382
3482
  id: string;
3483
+ /** Domain assigned to the container. */
3383
3484
  hostname: string;
3485
+ /** UUID of the container. */
3384
3486
  containerId: string;
3487
+ /** URL (TBD). */
3385
3488
  url: string;
3489
+ /** Status of the domain. */
3386
3490
  status: DomainStatus$3;
3491
+ /** Last error message of the domain. */
3387
3492
  errorMessage?: string;
3388
3493
  }
3389
3494
  /** List containers response. */
3390
3495
  interface ListContainersResponse {
3496
+ /** Array of containers. */
3391
3497
  containers: Container[];
3498
+ /** Total number of containers. */
3392
3499
  totalCount: number;
3393
3500
  }
3394
3501
  /** List crons response. */
3395
3502
  interface ListCronsResponse$1 {
3503
+ /** Array of crons. */
3396
3504
  crons: Cron$1[];
3505
+ /** Total number of crons. */
3397
3506
  totalCount: number;
3398
3507
  }
3399
3508
  /** List domains response. */
3400
3509
  interface ListDomainsResponse$3 {
3510
+ /** Array of domains. */
3401
3511
  domains: Domain$3[];
3512
+ /** Total number of domains. */
3402
3513
  totalCount: number;
3403
3514
  }
3404
3515
  /** List logs response. */
@@ -3408,7 +3519,9 @@ interface ListLogsResponse$1 {
3408
3519
  }
3409
3520
  /** List namespaces response. */
3410
3521
  interface ListNamespacesResponse$3 {
3522
+ /** Array of the namespaces. */
3411
3523
  namespaces: Namespace$3[];
3524
+ /** Total number of namespaces. */
3412
3525
  totalCount: number;
3413
3526
  }
3414
3527
  interface ListTokensResponse$1 {
@@ -3429,17 +3542,29 @@ interface Log$1 {
3429
3542
  }
3430
3543
  /** Namespace. */
3431
3544
  interface Namespace$3 {
3545
+ /** UUID of the namespace. */
3432
3546
  id: string;
3547
+ /** Name of the namespace. */
3433
3548
  name: string;
3549
+ /** Environment variables of the namespace. */
3434
3550
  environmentVariables: Record<string, string>;
3551
+ /** UUID of the Organization the namespace belongs to. */
3435
3552
  organizationId: string;
3553
+ /** UUID of the Project the namespace belongs to. */
3436
3554
  projectId: string;
3555
+ /** Status of the namespace. */
3437
3556
  status: NamespaceStatus$2;
3557
+ /** UUID of the registry namespace. */
3438
3558
  registryNamespaceId: string;
3559
+ /** Last error message of the namesace. */
3439
3560
  errorMessage?: string;
3561
+ /** Registry endpoint of the namespace. */
3440
3562
  registryEndpoint: string;
3563
+ /** Description of the endpoint. */
3441
3564
  description?: string;
3565
+ /** Secret environment variables of the namespace. */
3442
3566
  secretEnvironmentVariables: SecretHashedValue$1[];
3567
+ /** Region in which the namespace will be created. */
3443
3568
  region: Region;
3444
3569
  }
3445
3570
  interface Secret$2 {
@@ -3452,16 +3577,29 @@ interface SecretHashedValue$1 {
3452
3577
  }
3453
3578
  /** Token. */
3454
3579
  interface Token$1 {
3580
+ /** UUID of the token. */
3455
3581
  id: string;
3582
+ /** Identifier of the token. */
3456
3583
  token: string;
3457
- /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
3584
+ /**
3585
+ * UUID of the container the token belongs to.
3586
+ *
3587
+ * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set.
3588
+ */
3458
3589
  containerId?: string;
3459
- /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
3590
+ /**
3591
+ * UUID of the namespace the token belongs to.
3592
+ *
3593
+ * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set.
3594
+ */
3460
3595
  namespaceId?: string;
3461
- /** @deprecated */
3596
+ /** @deprecated Public key of the token. */
3462
3597
  publicKey?: string;
3598
+ /** Status of the token. */
3463
3599
  status: TokenStatus$1;
3600
+ /** Description of the token. */
3464
3601
  description?: string;
3602
+ /** Expiry date of the token. */
3465
3603
  expiresAt?: Date;
3466
3604
  }
3467
3605
  type ListNamespacesRequest$3 = {
@@ -3470,11 +3608,17 @@ type ListNamespacesRequest$3 = {
3470
3608
  * config.
3471
3609
  */
3472
3610
  region?: Region;
3611
+ /** Page number. */
3473
3612
  page?: number;
3613
+ /** Number of namespaces per page. */
3474
3614
  pageSize?: number;
3615
+ /** Order of the namespaces. */
3475
3616
  orderBy?: ListNamespacesRequestOrderBy$3;
3617
+ /** Name of the namespaces. */
3476
3618
  name?: string;
3619
+ /** UUID of the Organization the namespace belongs to. */
3477
3620
  organizationId?: string;
3621
+ /** UUID of the Project the namespace belongs to. */
3478
3622
  projectId?: string;
3479
3623
  };
3480
3624
  type GetNamespaceRequest$3 = {
@@ -3483,6 +3627,7 @@ type GetNamespaceRequest$3 = {
3483
3627
  * config.
3484
3628
  */
3485
3629
  region?: Region;
3630
+ /** UUID of the namespace to get. */
3486
3631
  namespaceId: string;
3487
3632
  };
3488
3633
  type CreateNamespaceRequest$3 = {
@@ -3491,10 +3636,15 @@ type CreateNamespaceRequest$3 = {
3491
3636
  * config.
3492
3637
  */
3493
3638
  region?: Region;
3639
+ /** Name of the namespace to create. */
3494
3640
  name?: string;
3641
+ /** Environment variables of the namespace to create. */
3495
3642
  environmentVariables?: Record<string, string>;
3643
+ /** UUID of the Project in which the namespace will be created. */
3496
3644
  projectId?: string;
3645
+ /** Description of the namespace to create. */
3497
3646
  description?: string;
3647
+ /** Secret environment variables of the namespace to create. */
3498
3648
  secretEnvironmentVariables?: Secret$2[];
3499
3649
  };
3500
3650
  type UpdateNamespaceRequest$3 = {
@@ -3503,9 +3653,13 @@ type UpdateNamespaceRequest$3 = {
3503
3653
  * config.
3504
3654
  */
3505
3655
  region?: Region;
3656
+ /** UUID of the namespace to update. */
3506
3657
  namespaceId: string;
3658
+ /** Environment variables of the namespace to update. */
3507
3659
  environmentVariables?: Record<string, string>;
3660
+ /** Description of the namespace to update. */
3508
3661
  description?: string;
3662
+ /** Secret environment variables of the namespace to update. */
3509
3663
  secretEnvironmentVariables?: Secret$2[];
3510
3664
  };
3511
3665
  type DeleteNamespaceRequest$3 = {
@@ -3514,6 +3668,7 @@ type DeleteNamespaceRequest$3 = {
3514
3668
  * config.
3515
3669
  */
3516
3670
  region?: Region;
3671
+ /** UUID of the namespace to delete. */
3517
3672
  namespaceId: string;
3518
3673
  };
3519
3674
  type ListContainersRequest = {
@@ -3522,12 +3677,19 @@ type ListContainersRequest = {
3522
3677
  * config.
3523
3678
  */
3524
3679
  region?: Region;
3680
+ /** Page number. */
3525
3681
  page?: number;
3682
+ /** Number of containers per page. */
3526
3683
  pageSize?: number;
3684
+ /** Order of the containers. */
3527
3685
  orderBy?: ListContainersRequestOrderBy;
3686
+ /** UUID of the namespace the container belongs to. */
3528
3687
  namespaceId: string;
3688
+ /** Name of the container. */
3529
3689
  name?: string;
3690
+ /** UUID of the Organization the container belongs to. */
3530
3691
  organizationId?: string;
3692
+ /** UUID of the Project the container belongs to. */
3531
3693
  projectId?: string;
3532
3694
  };
3533
3695
  type GetContainerRequest = {
@@ -3536,6 +3698,7 @@ type GetContainerRequest = {
3536
3698
  * config.
3537
3699
  */
3538
3700
  region?: Region;
3701
+ /** UUID of the container to get. */
3539
3702
  containerId: string;
3540
3703
  };
3541
3704
  type CreateContainerRequest = {
@@ -3544,19 +3707,36 @@ type CreateContainerRequest = {
3544
3707
  * config.
3545
3708
  */
3546
3709
  region?: Region;
3710
+ /** UUID of the namespace the container belongs to. */
3547
3711
  namespaceId: string;
3548
- name?: string;
3712
+ /** Name of the container. */
3713
+ name: string;
3714
+ /** Environment variables of the container. */
3549
3715
  environmentVariables?: Record<string, string>;
3716
+ /** Minimum number of instances to scale the container to. */
3550
3717
  minScale?: number;
3718
+ /** Maximum number of instances to scale the container to. */
3551
3719
  maxScale?: number;
3720
+ /** Memory limit of the container in MB. */
3552
3721
  memoryLimit?: number;
3722
+ /** Processing time limit for the container. */
3553
3723
  timeout?: string;
3724
+ /** Privacy setting of the container. */
3554
3725
  privacy?: ContainerPrivacy;
3726
+ /** Description of the container. */
3555
3727
  description?: string;
3728
+ /**
3729
+ * Name of the registry image (e.g.
3730
+ * "rg.fr-par.scw.cloud/something/image:tag").
3731
+ */
3556
3732
  registryImage?: string;
3733
+ /** Number of maximum concurrent executions of the container. */
3557
3734
  maxConcurrency?: number;
3735
+ /** Protocol the container uses. */
3558
3736
  protocol?: ContainerProtocol;
3737
+ /** Port the container listens on. */
3559
3738
  port?: number;
3739
+ /** Secret environment variables of the container. */
3560
3740
  secretEnvironmentVariables?: Secret$2[];
3561
3741
  /**
3562
3742
  * Configure how HTTP and HTTPS requests are handled. Possible values:
@@ -3573,16 +3753,30 @@ type UpdateContainerRequest = {
3573
3753
  * config.
3574
3754
  */
3575
3755
  region?: Region;
3756
+ /** UUID of the container to update. */
3576
3757
  containerId: string;
3758
+ /** Environment variables of the container. */
3577
3759
  environmentVariables?: Record<string, string>;
3760
+ /** Minimum number of instances to scale the container to. */
3578
3761
  minScale?: number;
3762
+ /** Maximum number of instances to scale the container to. */
3579
3763
  maxScale?: number;
3764
+ /** Memory limit of the container in MB. */
3580
3765
  memoryLimit?: number;
3766
+ /** Processing time limit for the container. */
3581
3767
  timeout?: string;
3768
+ /** Defines whether to redeploy failed containers. */
3582
3769
  redeploy?: boolean;
3770
+ /** Privacy settings of the container. */
3583
3771
  privacy?: ContainerPrivacy;
3772
+ /** Description of the container. */
3584
3773
  description?: string;
3774
+ /**
3775
+ * Name of the registry image (e.g.
3776
+ * "rg.fr-par.scw.cloud/something/image:tag").
3777
+ */
3585
3778
  registryImage?: string;
3779
+ /** Number of maximum concurrent executions of the container. */
3586
3780
  maxConcurrency?: number;
3587
3781
  protocol?: ContainerProtocol;
3588
3782
  port?: number;
@@ -3602,6 +3796,7 @@ type DeleteContainerRequest = {
3602
3796
  * config.
3603
3797
  */
3604
3798
  region?: Region;
3799
+ /** UUID of the container to delete. */
3605
3800
  containerId: string;
3606
3801
  };
3607
3802
  type DeployContainerRequest = {
@@ -3610,6 +3805,7 @@ type DeployContainerRequest = {
3610
3805
  * config.
3611
3806
  */
3612
3807
  region?: Region;
3808
+ /** UUID of the container to deploy. */
3613
3809
  containerId: string;
3614
3810
  };
3615
3811
  type ListCronsRequest$1 = {
@@ -3618,9 +3814,13 @@ type ListCronsRequest$1 = {
3618
3814
  * config.
3619
3815
  */
3620
3816
  region?: Region;
3817
+ /** Page number. */
3621
3818
  page?: number;
3819
+ /** Number of crons per page. */
3622
3820
  pageSize?: number;
3821
+ /** Order of the crons. */
3623
3822
  orderBy?: ListCronsRequestOrderBy$1;
3823
+ /** UUID of the container invoked by the cron. */
3624
3824
  containerId: string;
3625
3825
  };
3626
3826
  type GetCronRequest$1 = {
@@ -3629,6 +3829,7 @@ type GetCronRequest$1 = {
3629
3829
  * config.
3630
3830
  */
3631
3831
  region?: Region;
3832
+ /** UUID of the cron to get. */
3632
3833
  cronId: string;
3633
3834
  };
3634
3835
  type CreateCronRequest$1 = {
@@ -3637,9 +3838,13 @@ type CreateCronRequest$1 = {
3637
3838
  * config.
3638
3839
  */
3639
3840
  region?: Region;
3841
+ /** UUID of the container to invoke by the cron. */
3640
3842
  containerId: string;
3843
+ /** UNIX cron shedule. */
3641
3844
  schedule: string;
3845
+ /** Arguments to pass with the cron. */
3642
3846
  args?: Record<string, unknown>;
3847
+ /** Name of the cron to create. */
3643
3848
  name?: string;
3644
3849
  };
3645
3850
  type UpdateCronRequest$1 = {
@@ -3648,10 +3853,15 @@ type UpdateCronRequest$1 = {
3648
3853
  * config.
3649
3854
  */
3650
3855
  region?: Region;
3856
+ /** UUID of the cron to update. */
3651
3857
  cronId: string;
3858
+ /** UUID of the container invoked by the cron. */
3652
3859
  containerId?: string;
3860
+ /** UNIX cron schedule. */
3653
3861
  schedule?: string;
3862
+ /** Arguments to pass with the cron. */
3654
3863
  args?: Record<string, unknown>;
3864
+ /** Name of the cron. */
3655
3865
  name?: string;
3656
3866
  };
3657
3867
  type DeleteCronRequest$1 = {
@@ -3660,6 +3870,7 @@ type DeleteCronRequest$1 = {
3660
3870
  * config.
3661
3871
  */
3662
3872
  region?: Region;
3873
+ /** UUID of the cron to delete. */
3663
3874
  cronId: string;
3664
3875
  };
3665
3876
  type ListLogsRequest$1 = {
@@ -3668,9 +3879,13 @@ type ListLogsRequest$1 = {
3668
3879
  * config.
3669
3880
  */
3670
3881
  region?: Region;
3882
+ /** UUID of the container. */
3671
3883
  containerId: string;
3884
+ /** Page number. */
3672
3885
  page?: number;
3886
+ /** Number of logs per page. */
3673
3887
  pageSize?: number;
3888
+ /** Order of the logs. */
3674
3889
  orderBy?: ListLogsRequestOrderBy$1;
3675
3890
  };
3676
3891
  type ListDomainsRequest$2 = {
@@ -3679,9 +3894,13 @@ type ListDomainsRequest$2 = {
3679
3894
  * config.
3680
3895
  */
3681
3896
  region?: Region;
3897
+ /** Page number. */
3682
3898
  page?: number;
3899
+ /** Number of domains per page. */
3683
3900
  pageSize?: number;
3901
+ /** Order of the domains. */
3684
3902
  orderBy?: ListDomainsRequestOrderBy$2;
3903
+ /** UUID of the container the domain belongs to. */
3685
3904
  containerId: string;
3686
3905
  };
3687
3906
  type GetDomainRequest$2 = {
@@ -3690,6 +3909,7 @@ type GetDomainRequest$2 = {
3690
3909
  * config.
3691
3910
  */
3692
3911
  region?: Region;
3912
+ /** UUID of the domain to get. */
3693
3913
  domainId: string;
3694
3914
  };
3695
3915
  type CreateDomainRequest$2 = {
@@ -3698,7 +3918,9 @@ type CreateDomainRequest$2 = {
3698
3918
  * config.
3699
3919
  */
3700
3920
  region?: Region;
3921
+ /** Domain to assign. */
3701
3922
  hostname: string;
3923
+ /** UUID of the container to assign the domain to. */
3702
3924
  containerId: string;
3703
3925
  };
3704
3926
  type DeleteDomainRequest$1 = {
@@ -3707,6 +3929,7 @@ type DeleteDomainRequest$1 = {
3707
3929
  * config.
3708
3930
  */
3709
3931
  region?: Region;
3932
+ /** UUID of the domain to delete. */
3710
3933
  domainId: string;
3711
3934
  };
3712
3935
  type IssueJWTRequest$1 = {
@@ -3727,11 +3950,21 @@ type CreateTokenRequest$1 = {
3727
3950
  * config.
3728
3951
  */
3729
3952
  region?: Region;
3730
- /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
3953
+ /**
3954
+ * UUID of the container to create the token for.
3955
+ *
3956
+ * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set.
3957
+ */
3731
3958
  containerId?: string;
3732
- /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */
3959
+ /**
3960
+ * UUID of the namespace to create the token for.
3961
+ *
3962
+ * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set.
3963
+ */
3733
3964
  namespaceId?: string;
3965
+ /** Description of the token. */
3734
3966
  description?: string;
3967
+ /** Expiry date of the token. */
3735
3968
  expiresAt?: Date;
3736
3969
  };
3737
3970
  type GetTokenRequest$1 = {
@@ -3740,6 +3973,7 @@ type GetTokenRequest$1 = {
3740
3973
  * config.
3741
3974
  */
3742
3975
  region?: Region;
3976
+ /** UUID of the token to get. */
3743
3977
  tokenId: string;
3744
3978
  };
3745
3979
  type ListTokensRequest$1 = {
@@ -3748,10 +3982,15 @@ type ListTokensRequest$1 = {
3748
3982
  * config.
3749
3983
  */
3750
3984
  region?: Region;
3985
+ /** Page number. */
3751
3986
  page?: number;
3987
+ /** Number of tokens per page. */
3752
3988
  pageSize?: number;
3989
+ /** Order of the tokens. */
3753
3990
  orderBy?: ListTokensRequestOrderBy$1;
3991
+ /** UUID of the container the token belongs to. */
3754
3992
  containerId?: string;
3993
+ /** UUID of the namespace the token belongs to. */
3755
3994
  namespaceId?: string;
3756
3995
  };
3757
3996
  type DeleteTokenRequest$1 = {
@@ -3760,6 +3999,7 @@ type DeleteTokenRequest$1 = {
3760
3999
  * config.
3761
4000
  */
3762
4001
  region?: Region;
4002
+ /** UUID of the token to delete. */
3763
4003
  tokenId: string;
3764
4004
  };
3765
4005
 
@@ -3773,7 +4013,7 @@ declare class API$k extends API$q {
3773
4013
  static readonly LOCALITIES: Region[];
3774
4014
  protected pageOfListNamespaces: (request?: Readonly<ListNamespacesRequest$3>) => Promise<ListNamespacesResponse$3>;
3775
4015
  /**
3776
- * List all your namespaces.
4016
+ * List all your namespaces. List all namespaces in a specified region.
3777
4017
  *
3778
4018
  * @param request - The request {@link ListNamespacesRequest}
3779
4019
  * @returns A Promise of ListNamespacesResponse
@@ -3783,7 +4023,7 @@ declare class API$k extends API$q {
3783
4023
  [Symbol.asyncIterator]: () => AsyncGenerator<Namespace$3[], void, void>;
3784
4024
  };
3785
4025
  /**
3786
- * Get a namespace. Get the namespace associated with the given id.
4026
+ * Get a namespace. Get the namespace associated with the specified ID.
3787
4027
  *
3788
4028
  * @param request - The request {@link GetNamespaceRequest}
3789
4029
  * @returns A Promise of Namespace
@@ -3798,15 +4038,15 @@ declare class API$k extends API$q {
3798
4038
  */
3799
4039
  waitForNamespace: (request: Readonly<GetNamespaceRequest$3>, options?: Readonly<WaitForOptions<Namespace$3>>) => Promise<Namespace$3>;
3800
4040
  /**
3801
- * Create a new namespace.
4041
+ * Create a new namespace. Create a new namespace in a specified region.
3802
4042
  *
3803
4043
  * @param request - The request {@link CreateNamespaceRequest}
3804
4044
  * @returns A Promise of Namespace
3805
4045
  */
3806
4046
  createNamespace: (request?: Readonly<CreateNamespaceRequest$3>) => Promise<Namespace$3>;
3807
4047
  /**
3808
- * Update an existing namespace. Update the space associated with the given
3809
- * id.
4048
+ * Update an existing namespace. Update the space associated with the
4049
+ * specified ID.
3810
4050
  *
3811
4051
  * @param request - The request {@link UpdateNamespaceRequest}
3812
4052
  * @returns A Promise of Namespace
@@ -3814,7 +4054,7 @@ declare class API$k extends API$q {
3814
4054
  updateNamespace: (request: Readonly<UpdateNamespaceRequest$3>) => Promise<Namespace$3>;
3815
4055
  /**
3816
4056
  * Delete an existing namespace. Delete the namespace associated with the
3817
- * given id.
4057
+ * specified ID.
3818
4058
  *
3819
4059
  * @param request - The request {@link DeleteNamespaceRequest}
3820
4060
  * @returns A Promise of Namespace
@@ -3822,7 +4062,7 @@ declare class API$k extends API$q {
3822
4062
  deleteNamespace: (request: Readonly<DeleteNamespaceRequest$3>) => Promise<Namespace$3>;
3823
4063
  protected pageOfListContainers: (request: Readonly<ListContainersRequest>) => Promise<ListContainersResponse>;
3824
4064
  /**
3825
- * List all your containers.
4065
+ * List all your containers. List all containers for a specified region.
3826
4066
  *
3827
4067
  * @param request - The request {@link ListContainersRequest}
3828
4068
  * @returns A Promise of ListContainersResponse
@@ -3832,7 +4072,7 @@ declare class API$k extends API$q {
3832
4072
  [Symbol.asyncIterator]: () => AsyncGenerator<Container[], void, void>;
3833
4073
  };
3834
4074
  /**
3835
- * Get a container. Get the container associated with the given id.
4075
+ * Get a container. Get the container associated with the specified ID.
3836
4076
  *
3837
4077
  * @param request - The request {@link GetContainerRequest}
3838
4078
  * @returns A Promise of Container
@@ -3847,7 +4087,7 @@ declare class API$k extends API$q {
3847
4087
  */
3848
4088
  waitForContainer: (request: Readonly<GetContainerRequest>, options?: Readonly<WaitForOptions<Container>>) => Promise<Container>;
3849
4089
  /**
3850
- * Create a new container.
4090
+ * Create a new container. Create a new container in the specified region.
3851
4091
  *
3852
4092
  * @param request - The request {@link CreateContainerRequest}
3853
4093
  * @returns A Promise of Container
@@ -3855,21 +4095,21 @@ declare class API$k extends API$q {
3855
4095
  createContainer: (request: Readonly<CreateContainerRequest>) => Promise<Container>;
3856
4096
  /**
3857
4097
  * Update an existing container. Update the container associated with the
3858
- * given id.
4098
+ * specified ID.
3859
4099
  *
3860
4100
  * @param request - The request {@link UpdateContainerRequest}
3861
4101
  * @returns A Promise of Container
3862
4102
  */
3863
4103
  updateContainer: (request: Readonly<UpdateContainerRequest>) => Promise<Container>;
3864
4104
  /**
3865
- * Delete a container. Delete the container associated with the given id.
4105
+ * Delete a container. Delete the container associated with the specified ID.
3866
4106
  *
3867
4107
  * @param request - The request {@link DeleteContainerRequest}
3868
4108
  * @returns A Promise of Container
3869
4109
  */
3870
4110
  deleteContainer: (request: Readonly<DeleteContainerRequest>) => Promise<Container>;
3871
4111
  /**
3872
- * Deploy a container. Deploy a container associated with the given id.
4112
+ * Deploy a container. Deploy a container associated with the specified ID.
3873
4113
  *
3874
4114
  * @param request - The request {@link DeployContainerRequest}
3875
4115
  * @returns A Promise of Container
@@ -3887,7 +4127,7 @@ declare class API$k extends API$q {
3887
4127
  [Symbol.asyncIterator]: () => AsyncGenerator<Cron$1[], void, void>;
3888
4128
  };
3889
4129
  /**
3890
- * Get a cron. Get the cron associated with the given id.
4130
+ * Get a cron. Get the cron associated with the specified ID.
3891
4131
  *
3892
4132
  * @param request - The request {@link GetCronRequest}
3893
4133
  * @returns A Promise of Cron
@@ -3909,14 +4149,14 @@ declare class API$k extends API$q {
3909
4149
  */
3910
4150
  createCron: (request: Readonly<CreateCronRequest$1>) => Promise<Cron$1>;
3911
4151
  /**
3912
- * Update an existing cron. Update the cron associated with the given id.
4152
+ * Update an existing cron. Update the cron associated with the specified ID.
3913
4153
  *
3914
4154
  * @param request - The request {@link UpdateCronRequest}
3915
4155
  * @returns A Promise of Cron
3916
4156
  */
3917
4157
  updateCron: (request: Readonly<UpdateCronRequest$1>) => Promise<Cron$1>;
3918
4158
  /**
3919
- * Delete an existing cron. Delete the cron associated with the given id.
4159
+ * Delete an existing cron. Delete the cron associated with the specified ID.
3920
4160
  *
3921
4161
  * @param request - The request {@link DeleteCronRequest}
3922
4162
  * @returns A Promise of Cron
@@ -3924,7 +4164,8 @@ declare class API$k extends API$q {
3924
4164
  deleteCron: (request: Readonly<DeleteCronRequest$1>) => Promise<Cron$1>;
3925
4165
  protected pageOfListLogs: (request: Readonly<ListLogsRequest$1>) => Promise<ListLogsResponse$1>;
3926
4166
  /**
3927
- * List your container logs.
4167
+ * List your container logs. List the logs of the container with the specified
4168
+ * ID.
3928
4169
  *
3929
4170
  * @param request - The request {@link ListLogsRequest}
3930
4171
  * @returns A Promise of ListLogsResponse
@@ -3935,7 +4176,8 @@ declare class API$k extends API$q {
3935
4176
  };
3936
4177
  protected pageOfListDomains: (request: Readonly<ListDomainsRequest$2>) => Promise<ListDomainsResponse$3>;
3937
4178
  /**
3938
- * List all domain name bindings.
4179
+ * List all domain name bindings. List all domain name bindings in a specified
4180
+ * region.
3939
4181
  *
3940
4182
  * @param request - The request {@link ListDomainsRequest}
3941
4183
  * @returns A Promise of ListDomainsResponse
@@ -3945,7 +4187,8 @@ declare class API$k extends API$q {
3945
4187
  [Symbol.asyncIterator]: () => AsyncGenerator<Domain$3[], void, void>;
3946
4188
  };
3947
4189
  /**
3948
- * Get a domain name binding.
4190
+ * Get a domain name binding. Get a domain name binding for the container with
4191
+ * the specified ID.
3949
4192
  *
3950
4193
  * @param request - The request {@link GetDomainRequest}
3951
4194
  * @returns A Promise of Domain
@@ -3960,14 +4203,16 @@ declare class API$k extends API$q {
3960
4203
  */
3961
4204
  waitForDomain: (request: Readonly<GetDomainRequest$2>, options?: Readonly<WaitForOptions<Domain$3>>) => Promise<Domain$3>;
3962
4205
  /**
3963
- * Create a domain name binding.
4206
+ * Create a domain name binding. Create a domain name binding for the
4207
+ * container with the specified ID.
3964
4208
  *
3965
4209
  * @param request - The request {@link CreateDomainRequest}
3966
4210
  * @returns A Promise of Domain
3967
4211
  */
3968
4212
  createDomain: (request: Readonly<CreateDomainRequest$2>) => Promise<Domain$3>;
3969
4213
  /**
3970
- * Delete a domain name binding.
4214
+ * Delete a domain name binding. Delete the domain name binding with the
4215
+ * specific ID.
3971
4216
  *
3972
4217
  * @param request - The request {@link DeleteDomainRequest}
3973
4218
  * @returns A Promise of Domain
@@ -3987,7 +4232,7 @@ declare class API$k extends API$q {
3987
4232
  */
3988
4233
  createToken: (request?: Readonly<CreateTokenRequest$1>) => Promise<Token$1>;
3989
4234
  /**
3990
- * Get a token.
4235
+ * Get a token. Get a token with a specified ID.
3991
4236
  *
3992
4237
  * @param request - The request {@link GetTokenRequest}
3993
4238
  * @returns A Promise of Token
@@ -4003,7 +4248,8 @@ declare class API$k extends API$q {
4003
4248
  waitForToken: (request: Readonly<GetTokenRequest$1>, options?: Readonly<WaitForOptions<Token$1>>) => Promise<Token$1>;
4004
4249
  protected pageOfListTokens: (request?: Readonly<ListTokensRequest$1>) => Promise<ListTokensResponse$1>;
4005
4250
  /**
4006
- * List all tokens.
4251
+ * List all tokens. List all tokens belonging to a specified Organization or
4252
+ * Project.
4007
4253
  *
4008
4254
  * @param request - The request {@link ListTokensRequest}
4009
4255
  * @returns A Promise of ListTokensResponse
@@ -4013,7 +4259,7 @@ declare class API$k extends API$q {
4013
4259
  [Symbol.asyncIterator]: () => AsyncGenerator<Token$1[], void, void>;
4014
4260
  };
4015
4261
  /**
4016
- * Delete a token.
4262
+ * Delete a token. Delete a token with a specified ID.
4017
4263
  *
4018
4264
  * @param request - The request {@link DeleteTokenRequest}
4019
4265
  * @returns A Promise of Token
@@ -6422,20 +6668,32 @@ interface CreateTriggerRequestSqsClientConfig {
6422
6668
  }
6423
6669
  /** Cron. */
6424
6670
  interface Cron {
6671
+ /** UUID of the cron. */
6425
6672
  id: string;
6673
+ /** UUID of the function the cron applies to. */
6426
6674
  functionId: string;
6675
+ /** Schedule of the cron. */
6427
6676
  schedule: string;
6677
+ /** Arguments to pass with the cron. */
6428
6678
  args?: Record<string, unknown>;
6679
+ /** Status of the cron. */
6429
6680
  status: CronStatus;
6681
+ /** Name of the cron. */
6430
6682
  name: string;
6431
6683
  }
6432
6684
  /** Domain. */
6433
6685
  interface Domain$1 {
6686
+ /** UUID of the domain. */
6434
6687
  id: string;
6688
+ /** Hostname associated with the function. */
6435
6689
  hostname: string;
6690
+ /** UUID of the function the domain is associated with. */
6436
6691
  functionId: string;
6692
+ /** URL of the function. */
6437
6693
  url: string;
6694
+ /** State of the doamin. */
6438
6695
  status: DomainStatus$1;
6696
+ /** Error message if the domain is in "error" state. */
6439
6697
  errorMessage?: string;
6440
6698
  }
6441
6699
  interface DownloadURL {
@@ -6444,26 +6702,46 @@ interface DownloadURL {
6444
6702
  }
6445
6703
  /** Function. */
6446
6704
  interface Function {
6705
+ /** UUID of the function. */
6447
6706
  id: string;
6707
+ /** Name of the function. */
6448
6708
  name: string;
6709
+ /** UUID of the namespace the function belongs to. */
6449
6710
  namespaceId: string;
6711
+ /** Status of the function. */
6450
6712
  status: FunctionStatus;
6713
+ /** Environment variables of the function. */
6451
6714
  environmentVariables: Record<string, string>;
6715
+ /** Minimum number of instances to scale the function to. */
6452
6716
  minScale: number;
6717
+ /** Maximum number of instances to scale the function to. */
6453
6718
  maxScale: number;
6719
+ /** Runtime of the function. */
6454
6720
  runtime: FunctionRuntime;
6721
+ /** Memory limit of the function in MB. */
6455
6722
  memoryLimit: number;
6723
+ /** CPU limit of the function. */
6456
6724
  cpuLimit: number;
6725
+ /** Request processing time limit for the function. */
6457
6726
  timeout?: string;
6727
+ /** Handler to use for the function. */
6458
6728
  handler: string;
6729
+ /** Error message if the function is in "error" state. */
6459
6730
  errorMessage?: string;
6731
+ /** Description of the current build step. */
6732
+ buildMessage?: string;
6733
+ /** Privacy setting of the function. */
6460
6734
  privacy: FunctionPrivacy;
6735
+ /** Description of the function. */
6461
6736
  description?: string;
6737
+ /** Domain name associated with the function. */
6462
6738
  domainName: string;
6739
+ /** Secret environment variables of the function. */
6463
6740
  secretEnvironmentVariables: SecretHashedValue[];
6741
+ /** Region in which the function is deployed. */
6464
6742
  region: Region;
6465
6743
  /**
6466
- * Configure how HTTP and HTTPS requests are handled. Possible values:
6744
+ * Configuration for handling of HTTP and HTTPS requests. Possible values:
6467
6745
  *
6468
6746
  * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients
6469
6747
  * to use HTTPS.
@@ -6474,32 +6752,43 @@ interface Function {
6474
6752
  }
6475
6753
  /** List crons response. */
6476
6754
  interface ListCronsResponse {
6755
+ /** Array of crons. */
6477
6756
  crons: Cron[];
6757
+ /** Total number of crons. */
6478
6758
  totalCount: number;
6479
6759
  }
6480
6760
  /** List domains response. */
6481
6761
  interface ListDomainsResponse$1 {
6762
+ /** Array of domains. */
6482
6763
  domains: Domain$1[];
6764
+ /** Total number of domains. */
6483
6765
  totalCount: number;
6484
6766
  }
6485
6767
  /** List function runtimes response. */
6486
6768
  interface ListFunctionRuntimesResponse {
6769
+ /** Array of runtimes available. */
6487
6770
  runtimes: Runtime$1[];
6771
+ /** Total number of runtimes. */
6488
6772
  totalCount: number;
6489
6773
  }
6490
6774
  /** List functions response. */
6491
6775
  interface ListFunctionsResponse {
6776
+ /** Array of functions. */
6492
6777
  functions: Function[];
6778
+ /** Total number of functions. */
6493
6779
  totalCount: number;
6494
6780
  }
6495
6781
  /** List logs response. */
6496
6782
  interface ListLogsResponse {
6783
+ /** Array of logs. */
6497
6784
  logs: Log[];
6785
+ /** Total number of logs. */
6498
6786
  totalCount: number;
6499
6787
  }
6500
6788
  /** List namespaces response. */
6501
6789
  interface ListNamespacesResponse$2 {
6502
6790
  namespaces: Namespace$2[];
6791
+ /** Total number of namespaces. */
6503
6792
  totalCount: number;
6504
6793
  }
6505
6794
  interface ListTokensResponse {
@@ -6512,10 +6801,13 @@ interface ListTriggersResponse {
6512
6801
  }
6513
6802
  /** Log. */
6514
6803
  interface Log {
6804
+ /** Message of the log. */
6515
6805
  message: string;
6806
+ /** Timestamp of the log. */
6516
6807
  timestamp?: Date;
6808
+ /** UUID of the log. */
6517
6809
  id: string;
6518
- /** Contains the severity of the log (info, debug, error, ...). */
6810
+ /** Severity of the log (info, debug, error etc.). */
6519
6811
  level: string;
6520
6812
  /** Source of the log (core runtime or user code). */
6521
6813
  source: string;
@@ -6524,17 +6816,29 @@ interface Log {
6524
6816
  }
6525
6817
  /** Namespace. */
6526
6818
  interface Namespace$2 {
6819
+ /** UUID of the namespace. */
6527
6820
  id: string;
6821
+ /** Name of the namespace. */
6528
6822
  name: string;
6823
+ /** Environment variables of the namespace. */
6529
6824
  environmentVariables: Record<string, string>;
6825
+ /** UUID of the Organization the namespace belongs to. */
6530
6826
  organizationId: string;
6827
+ /** UUID of the Project the namespace belongs to. */
6531
6828
  projectId: string;
6829
+ /** Status of the namespace. */
6532
6830
  status: NamespaceStatus$1;
6831
+ /** UUID of the registry namespace. */
6533
6832
  registryNamespaceId: string;
6833
+ /** Error message if the namespace is in "error" state. */
6534
6834
  errorMessage?: string;
6835
+ /** Registry endpoint of the namespace. */
6535
6836
  registryEndpoint: string;
6837
+ /** Description of the namespace. */
6536
6838
  description?: string;
6839
+ /** Secret environment variables of the namespace. */
6537
6840
  secretEnvironmentVariables: SecretHashedValue[];
6841
+ /** Region in which the namespace is located. */
6538
6842
  region: Region;
6539
6843
  }
6540
6844
  interface Runtime$1 {
@@ -6559,16 +6863,29 @@ interface SecretHashedValue {
6559
6863
  }
6560
6864
  /** Token. */
6561
6865
  interface Token {
6866
+ /** UUID of the token. */
6562
6867
  id: string;
6868
+ /** String of the token. */
6563
6869
  token: string;
6564
- /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
6870
+ /**
6871
+ * UUID of the function the token is associated with.
6872
+ *
6873
+ * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set.
6874
+ */
6565
6875
  functionId?: string;
6566
- /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
6876
+ /**
6877
+ * UUID of the namespace the token is assoicated with.
6878
+ *
6879
+ * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set.
6880
+ */
6567
6881
  namespaceId?: string;
6568
- /** @deprecated */
6882
+ /** @deprecated Public key of the token. */
6569
6883
  publicKey?: string;
6884
+ /** Status of the token. */
6570
6885
  status: TokenStatus;
6886
+ /** Description of the token. */
6571
6887
  description?: string;
6888
+ /** Date on which the token expires. */
6572
6889
  expiresAt?: Date;
6573
6890
  }
6574
6891
  interface Trigger {
@@ -6616,12 +6933,14 @@ interface TriggerSqsClientConfig {
6616
6933
  secretKey: string;
6617
6934
  }
6618
6935
  interface UpdateTriggerRequestSqsClientConfig {
6619
- accessKey: string;
6620
- secretKey: string;
6936
+ accessKey?: string;
6937
+ secretKey?: string;
6621
6938
  }
6622
6939
  /** Upload url. */
6623
6940
  interface UploadURL {
6941
+ /** Upload URL to upload the function to. */
6624
6942
  url: string;
6943
+ /** HTTP headers. */
6625
6944
  headers: Record<string, string[]>;
6626
6945
  }
6627
6946
  type ListNamespacesRequest$2 = {
@@ -6630,11 +6949,17 @@ type ListNamespacesRequest$2 = {
6630
6949
  * config.
6631
6950
  */
6632
6951
  region?: Region;
6952
+ /** Page number. */
6633
6953
  page?: number;
6954
+ /** Number of namespaces per page. */
6634
6955
  pageSize?: number;
6956
+ /** Order of the namespaces. */
6635
6957
  orderBy?: ListNamespacesRequestOrderBy$2;
6958
+ /** Name of the namespace. */
6636
6959
  name?: string;
6960
+ /** UUID of the Organization the namespace belongs to. */
6637
6961
  organizationId?: string;
6962
+ /** UUID of the Project the namespace belongs to. */
6638
6963
  projectId?: string;
6639
6964
  };
6640
6965
  type GetNamespaceRequest$2 = {
@@ -6643,6 +6968,7 @@ type GetNamespaceRequest$2 = {
6643
6968
  * config.
6644
6969
  */
6645
6970
  region?: Region;
6971
+ /** UUID of the namespace. */
6646
6972
  namespaceId: string;
6647
6973
  };
6648
6974
  type CreateNamespaceRequest$2 = {
@@ -6652,9 +6978,13 @@ type CreateNamespaceRequest$2 = {
6652
6978
  */
6653
6979
  region?: Region;
6654
6980
  name?: string;
6981
+ /** Environment variables of the namespace. */
6655
6982
  environmentVariables?: Record<string, string>;
6983
+ /** UUID of the project in which the namespace will be created. */
6656
6984
  projectId?: string;
6985
+ /** Description of the namespace. */
6657
6986
  description?: string;
6987
+ /** Secret environment variables of the namespace. */
6658
6988
  secretEnvironmentVariables?: Secret$1[];
6659
6989
  };
6660
6990
  type UpdateNamespaceRequest$2 = {
@@ -6663,9 +6993,13 @@ type UpdateNamespaceRequest$2 = {
6663
6993
  * config.
6664
6994
  */
6665
6995
  region?: Region;
6996
+ /** UUID of the namespapce. */
6666
6997
  namespaceId: string;
6998
+ /** Environment variables of the namespace. */
6667
6999
  environmentVariables?: Record<string, string>;
7000
+ /** Description of the namespace. */
6668
7001
  description?: string;
7002
+ /** Secret environment variables of the namespace. */
6669
7003
  secretEnvironmentVariables?: Secret$1[];
6670
7004
  };
6671
7005
  type DeleteNamespaceRequest$2 = {
@@ -6674,6 +7008,7 @@ type DeleteNamespaceRequest$2 = {
6674
7008
  * config.
6675
7009
  */
6676
7010
  region?: Region;
7011
+ /** UUID of the namespace. */
6677
7012
  namespaceId: string;
6678
7013
  };
6679
7014
  type ListFunctionsRequest = {
@@ -6682,12 +7017,19 @@ type ListFunctionsRequest = {
6682
7017
  * config.
6683
7018
  */
6684
7019
  region?: Region;
7020
+ /** Page number. */
6685
7021
  page?: number;
7022
+ /** Number of functions per page. */
6686
7023
  pageSize?: number;
7024
+ /** Order of the functions. */
6687
7025
  orderBy?: ListFunctionsRequestOrderBy;
7026
+ /** UUID of the namespace the function belongs to. */
6688
7027
  namespaceId: string;
7028
+ /** Name of the function. */
6689
7029
  name?: string;
7030
+ /** UUID of the Organziation the function belongs to. */
6690
7031
  organizationId?: string;
7032
+ /** UUID of the Project the function belongs to. */
6691
7033
  projectId?: string;
6692
7034
  };
6693
7035
  type GetFunctionRequest = {
@@ -6696,6 +7038,7 @@ type GetFunctionRequest = {
6696
7038
  * config.
6697
7039
  */
6698
7040
  region?: Region;
7041
+ /** UUID of the function. */
6699
7042
  functionId: string;
6700
7043
  };
6701
7044
  type CreateFunctionRequest = {
@@ -6704,16 +7047,27 @@ type CreateFunctionRequest = {
6704
7047
  * config.
6705
7048
  */
6706
7049
  region?: Region;
7050
+ /** Name of the function to create. */
6707
7051
  name?: string;
7052
+ /** UUID of the namespace the function will be created in. */
6708
7053
  namespaceId: string;
7054
+ /** Environment variables of the function. */
6709
7055
  environmentVariables?: Record<string, string>;
7056
+ /** Minumum number of instances to scale the function to. */
6710
7057
  minScale?: number;
7058
+ /** Maximum number of instances to scale the function to. */
6711
7059
  maxScale?: number;
7060
+ /** Runtime to use with the function. */
6712
7061
  runtime?: FunctionRuntime;
7062
+ /** Memory limit of the function in MB. */
6713
7063
  memoryLimit?: number;
7064
+ /** Request processing time limit for the function. */
6714
7065
  timeout?: string;
7066
+ /** Handler to use with the function. */
6715
7067
  handler?: string;
7068
+ /** Privacy setting of the function. */
6716
7069
  privacy?: FunctionPrivacy;
7070
+ /** Description of the function. */
6717
7071
  description?: string;
6718
7072
  secretEnvironmentVariables?: Secret$1[];
6719
7073
  /**
@@ -6731,17 +7085,29 @@ type UpdateFunctionRequest = {
6731
7085
  * config.
6732
7086
  */
6733
7087
  region?: Region;
7088
+ /** UUID of the function to update. */
6734
7089
  functionId: string;
7090
+ /** Environment variables of the function to update. */
6735
7091
  environmentVariables?: Record<string, string>;
7092
+ /** Minumum number of instances to scale the function to. */
6736
7093
  minScale?: number;
7094
+ /** Maximum number of instances to scale the function to. */
6737
7095
  maxScale?: number;
7096
+ /** Runtime to use with the function. */
6738
7097
  runtime?: FunctionRuntime;
7098
+ /** Memory limit of the function in MB. */
6739
7099
  memoryLimit?: number;
7100
+ /** Processing time limit for the function. */
6740
7101
  timeout?: string;
7102
+ /** Redeploy failed function. */
6741
7103
  redeploy?: boolean;
7104
+ /** Handler to use with the function. */
6742
7105
  handler?: string;
7106
+ /** Privacy setting of the function. */
6743
7107
  privacy?: FunctionPrivacy;
7108
+ /** Description of the function. */
6744
7109
  description?: string;
7110
+ /** Secret environment variables of the function. */
6745
7111
  secretEnvironmentVariables?: Secret$1[];
6746
7112
  /**
6747
7113
  * Configure how HTTP and HTTPS requests are handled. Possible values:
@@ -6758,6 +7124,7 @@ type DeleteFunctionRequest = {
6758
7124
  * config.
6759
7125
  */
6760
7126
  region?: Region;
7127
+ /** UUID of the function to delete. */
6761
7128
  functionId: string;
6762
7129
  };
6763
7130
  type DeployFunctionRequest = {
@@ -6766,6 +7133,7 @@ type DeployFunctionRequest = {
6766
7133
  * config.
6767
7134
  */
6768
7135
  region?: Region;
7136
+ /** UUID of the function to deploy. */
6769
7137
  functionId: string;
6770
7138
  };
6771
7139
  type ListFunctionRuntimesRequest = {
@@ -6781,6 +7149,7 @@ type GetFunctionUploadURLRequest = {
6781
7149
  * config.
6782
7150
  */
6783
7151
  region?: Region;
7152
+ /** UUID of the function to get the upload URL for. */
6784
7153
  functionId: string;
6785
7154
  contentLength: number;
6786
7155
  };
@@ -6790,6 +7159,7 @@ type GetFunctionDownloadURLRequest = {
6790
7159
  * config.
6791
7160
  */
6792
7161
  region?: Region;
7162
+ /** UUID of the function to get the the download URL for. */
6793
7163
  functionId: string;
6794
7164
  };
6795
7165
  type ListCronsRequest = {
@@ -6798,9 +7168,13 @@ type ListCronsRequest = {
6798
7168
  * config.
6799
7169
  */
6800
7170
  region?: Region;
7171
+ /** Page number. */
6801
7172
  page?: number;
7173
+ /** Number of crons per page. */
6802
7174
  pageSize?: number;
7175
+ /** Order of the crons. */
6803
7176
  orderBy?: ListCronsRequestOrderBy;
7177
+ /** UUID of the function. */
6804
7178
  functionId: string;
6805
7179
  };
6806
7180
  type GetCronRequest = {
@@ -6809,6 +7183,7 @@ type GetCronRequest = {
6809
7183
  * config.
6810
7184
  */
6811
7185
  region?: Region;
7186
+ /** UUID of the cron to get. */
6812
7187
  cronId: string;
6813
7188
  };
6814
7189
  type CreateCronRequest = {
@@ -6817,9 +7192,13 @@ type CreateCronRequest = {
6817
7192
  * config.
6818
7193
  */
6819
7194
  region?: Region;
7195
+ /** UUID of the function to use the cron with. */
6820
7196
  functionId: string;
7197
+ /** Schedule of the cron in UNIX cron format. */
6821
7198
  schedule: string;
7199
+ /** Arguments to use with the cron. */
6822
7200
  args?: Record<string, unknown>;
7201
+ /** Name of the cron. */
6823
7202
  name?: string;
6824
7203
  };
6825
7204
  type UpdateCronRequest = {
@@ -6828,10 +7207,15 @@ type UpdateCronRequest = {
6828
7207
  * config.
6829
7208
  */
6830
7209
  region?: Region;
7210
+ /** UUID of the cron to update. */
6831
7211
  cronId: string;
7212
+ /** UUID of the function to use the cron with. */
6832
7213
  functionId?: string;
7214
+ /** Schedule of the cron in UNIX cron format. */
6833
7215
  schedule?: string;
7216
+ /** Arguments to use with the cron. */
6834
7217
  args?: Record<string, unknown>;
7218
+ /** Name of the cron. */
6835
7219
  name?: string;
6836
7220
  };
6837
7221
  type DeleteCronRequest = {
@@ -6840,6 +7224,7 @@ type DeleteCronRequest = {
6840
7224
  * config.
6841
7225
  */
6842
7226
  region?: Region;
7227
+ /** UUID of the cron to delete. */
6843
7228
  cronId: string;
6844
7229
  };
6845
7230
  type ListLogsRequest = {
@@ -6848,9 +7233,13 @@ type ListLogsRequest = {
6848
7233
  * config.
6849
7234
  */
6850
7235
  region?: Region;
7236
+ /** UUID of the function to get the logs for. */
6851
7237
  functionId: string;
7238
+ /** Page number. */
6852
7239
  page?: number;
7240
+ /** Number of logs per page. */
6853
7241
  pageSize?: number;
7242
+ /** Order of the logs. */
6854
7243
  orderBy?: ListLogsRequestOrderBy;
6855
7244
  };
6856
7245
  type ListDomainsRequest$1 = {
@@ -6859,9 +7248,13 @@ type ListDomainsRequest$1 = {
6859
7248
  * config.
6860
7249
  */
6861
7250
  region?: Region;
7251
+ /** Page number. */
6862
7252
  page?: number;
7253
+ /** Number of domains per page. */
6863
7254
  pageSize?: number;
7255
+ /** Order of the domains. */
6864
7256
  orderBy?: ListDomainsRequestOrderBy;
7257
+ /** UUID of the function the domain is assoicated with. */
6865
7258
  functionId: string;
6866
7259
  };
6867
7260
  type GetDomainRequest$1 = {
@@ -6870,6 +7263,7 @@ type GetDomainRequest$1 = {
6870
7263
  * config.
6871
7264
  */
6872
7265
  region?: Region;
7266
+ /** UUID of the domain to get. */
6873
7267
  domainId: string;
6874
7268
  };
6875
7269
  type CreateDomainRequest$1 = {
@@ -6878,7 +7272,9 @@ type CreateDomainRequest$1 = {
6878
7272
  * config.
6879
7273
  */
6880
7274
  region?: Region;
7275
+ /** Hostame to create. */
6881
7276
  hostname: string;
7277
+ /** UUID of the function to associate the domain with. */
6882
7278
  functionId: string;
6883
7279
  };
6884
7280
  type DeleteDomainRequest = {
@@ -6887,6 +7283,7 @@ type DeleteDomainRequest = {
6887
7283
  * config.
6888
7284
  */
6889
7285
  region?: Region;
7286
+ /** UUID of the domain to delete. */
6890
7287
  domainId: string;
6891
7288
  };
6892
7289
  type IssueJWTRequest = {
@@ -6907,11 +7304,21 @@ type CreateTokenRequest = {
6907
7304
  * config.
6908
7305
  */
6909
7306
  region?: Region;
6910
- /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
7307
+ /**
7308
+ * UUID of the function to associate the token with.
7309
+ *
7310
+ * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set.
7311
+ */
6911
7312
  functionId?: string;
6912
- /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */
7313
+ /**
7314
+ * UUID of the namespace to associate the token with.
7315
+ *
7316
+ * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set.
7317
+ */
6913
7318
  namespaceId?: string;
7319
+ /** Description of the token. */
6914
7320
  description?: string;
7321
+ /** Date on which the token expires. */
6915
7322
  expiresAt?: Date;
6916
7323
  };
6917
7324
  type GetTokenRequest = {
@@ -6920,6 +7327,7 @@ type GetTokenRequest = {
6920
7327
  * config.
6921
7328
  */
6922
7329
  region?: Region;
7330
+ /** UUID of the token to get. */
6923
7331
  tokenId: string;
6924
7332
  };
6925
7333
  type ListTokensRequest = {
@@ -6928,10 +7336,15 @@ type ListTokensRequest = {
6928
7336
  * config.
6929
7337
  */
6930
7338
  region?: Region;
7339
+ /** Page number. */
6931
7340
  page?: number;
7341
+ /** Number of tokens per page. */
6932
7342
  pageSize?: number;
7343
+ /** Sort order for the tokens. */
6933
7344
  orderBy?: ListTokensRequestOrderBy;
7345
+ /** UUID of the function the token is assoicated with. */
6934
7346
  functionId?: string;
7347
+ /** UUID of the namespace the token is associated with. */
6935
7348
  namespaceId?: string;
6936
7349
  };
6937
7350
  type DeleteTokenRequest = {
@@ -6940,6 +7353,7 @@ type DeleteTokenRequest = {
6940
7353
  * config.
6941
7354
  */
6942
7355
  region?: Region;
7356
+ /** UUID of the token to delete. */
6943
7357
  tokenId: string;
6944
7358
  };
6945
7359
  type CreateTriggerRequest = {
@@ -6949,7 +7363,7 @@ type CreateTriggerRequest = {
6949
7363
  */
6950
7364
  region?: Region;
6951
7365
  name: string;
6952
- description: string;
7366
+ description?: string;
6953
7367
  functionId: string;
6954
7368
  /**
6955
7369
  * One-of ('config'): at most one of 'scwSqsConfig', 'sqsConfig',
@@ -7031,7 +7445,8 @@ declare class API$h extends API$q {
7031
7445
  static readonly LOCALITIES: Region[];
7032
7446
  protected pageOfListNamespaces: (request?: Readonly<ListNamespacesRequest$2>) => Promise<ListNamespacesResponse$2>;
7033
7447
  /**
7034
- * List all your namespaces.
7448
+ * List all your namespaces. List all existing namespaces in the specified
7449
+ * region.
7035
7450
  *
7036
7451
  * @param request - The request {@link ListNamespacesRequest}
7037
7452
  * @returns A Promise of ListNamespacesResponse
@@ -7041,7 +7456,7 @@ declare class API$h extends API$q {
7041
7456
  [Symbol.asyncIterator]: () => AsyncGenerator<Namespace$2[], void, void>;
7042
7457
  };
7043
7458
  /**
7044
- * Get a namespace. Get the namespace associated with the given id.
7459
+ * Get a namespace. Get the namespace associated with the specified ID.
7045
7460
  *
7046
7461
  * @param request - The request {@link GetNamespaceRequest}
7047
7462
  * @returns A Promise of Namespace
@@ -7056,15 +7471,16 @@ declare class API$h extends API$q {
7056
7471
  */
7057
7472
  waitForNamespace: (request: Readonly<GetNamespaceRequest$2>, options?: Readonly<WaitForOptions<Namespace$2>>) => Promise<Namespace$2>;
7058
7473
  /**
7059
- * Create a new namespace.
7474
+ * Create a new namespace. Create a new namespace in a specified Organization
7475
+ * or Proejct.
7060
7476
  *
7061
7477
  * @param request - The request {@link CreateNamespaceRequest}
7062
7478
  * @returns A Promise of Namespace
7063
7479
  */
7064
7480
  createNamespace: (request?: Readonly<CreateNamespaceRequest$2>) => Promise<Namespace$2>;
7065
7481
  /**
7066
- * Update an existing namespace. Update the space associated with the given
7067
- * id.
7482
+ * Update an existing namespace. Update the namespace associated with the
7483
+ * specified ID.
7068
7484
  *
7069
7485
  * @param request - The request {@link UpdateNamespaceRequest}
7070
7486
  * @returns A Promise of Namespace
@@ -7072,7 +7488,7 @@ declare class API$h extends API$q {
7072
7488
  updateNamespace: (request: Readonly<UpdateNamespaceRequest$2>) => Promise<Namespace$2>;
7073
7489
  /**
7074
7490
  * Delete an existing namespace. Delete the namespace associated with the
7075
- * given id.
7491
+ * specified ID.
7076
7492
  *
7077
7493
  * @param request - The request {@link DeleteNamespaceRequest}
7078
7494
  * @returns A Promise of Namespace
@@ -7090,7 +7506,7 @@ declare class API$h extends API$q {
7090
7506
  [Symbol.asyncIterator]: () => AsyncGenerator<Function[], void, void>;
7091
7507
  };
7092
7508
  /**
7093
- * Get a function. Get the function associated with the given id.
7509
+ * Get a function. Get the function associated with the specified ID.
7094
7510
  *
7095
7511
  * @param request - The request {@link GetFunctionRequest}
7096
7512
  * @returns A Promise of Function
@@ -7105,29 +7521,30 @@ declare class API$h extends API$q {
7105
7521
  */
7106
7522
  waitForFunction: (request: Readonly<GetFunctionRequest>, options?: Readonly<WaitForOptions<Function>>) => Promise<Function>;
7107
7523
  /**
7108
- * Create a new function.
7524
+ * Create a new function. Create a new function in the specified region for a
7525
+ * specified Organization or Project.
7109
7526
  *
7110
7527
  * @param request - The request {@link CreateFunctionRequest}
7111
7528
  * @returns A Promise of Function
7112
7529
  */
7113
7530
  createFunction: (request: Readonly<CreateFunctionRequest>) => Promise<Function>;
7114
7531
  /**
7115
- * Update an existing function. Update the function associated with the given
7116
- * id.
7532
+ * Update an existing function. Update the function associated with the
7533
+ * specified ID.
7117
7534
  *
7118
7535
  * @param request - The request {@link UpdateFunctionRequest}
7119
7536
  * @returns A Promise of Function
7120
7537
  */
7121
7538
  updateFunction: (request: Readonly<UpdateFunctionRequest>) => Promise<Function>;
7122
7539
  /**
7123
- * Delete a function. Delete the function associated with the given id.
7540
+ * Delete a function. Delete the function associated with the specified ID.
7124
7541
  *
7125
7542
  * @param request - The request {@link DeleteFunctionRequest}
7126
7543
  * @returns A Promise of Function
7127
7544
  */
7128
7545
  deleteFunction: (request: Readonly<DeleteFunctionRequest>) => Promise<Function>;
7129
7546
  /**
7130
- * Deploy a function. Deploy a function associated with the given id.
7547
+ * Deploy a function. Deploy a function associated with the specified ID.
7131
7548
  *
7132
7549
  * @param request - The request {@link DeployFunctionRequest}
7133
7550
  * @returns A Promise of Function
@@ -7142,7 +7559,7 @@ declare class API$h extends API$q {
7142
7559
  listFunctionRuntimes: (request?: Readonly<ListFunctionRuntimesRequest>) => Promise<ListFunctionRuntimesResponse>;
7143
7560
  /**
7144
7561
  * Get an upload URL of a function. Get an upload URL of a function associated
7145
- * with the given id.
7562
+ * with the specified ID.
7146
7563
  *
7147
7564
  * @param request - The request {@link GetFunctionUploadURLRequest}
7148
7565
  * @returns A Promise of UploadURL
@@ -7150,7 +7567,7 @@ declare class API$h extends API$q {
7150
7567
  getFunctionUploadURL: (request: Readonly<GetFunctionUploadURLRequest>) => Promise<UploadURL>;
7151
7568
  /**
7152
7569
  * Get a download URL of a function. Get a download URL for a function
7153
- * associated with the given id.
7570
+ * associated with the specified ID.
7154
7571
  *
7155
7572
  * @param request - The request {@link GetFunctionDownloadURLRequest}
7156
7573
  * @returns A Promise of DownloadURL
@@ -7158,7 +7575,7 @@ declare class API$h extends API$q {
7158
7575
  getFunctionDownloadURL: (request: Readonly<GetFunctionDownloadURLRequest>) => Promise<DownloadURL>;
7159
7576
  protected pageOfListCrons: (request: Readonly<ListCronsRequest>) => Promise<ListCronsResponse>;
7160
7577
  /**
7161
- * List all your crons.
7578
+ * List all crons. List all the cronjobs in a specified region.
7162
7579
  *
7163
7580
  * @param request - The request {@link ListCronsRequest}
7164
7581
  * @returns A Promise of ListCronsResponse
@@ -7168,7 +7585,7 @@ declare class API$h extends API$q {
7168
7585
  [Symbol.asyncIterator]: () => AsyncGenerator<Cron[], void, void>;
7169
7586
  };
7170
7587
  /**
7171
- * Get a cron. Get the cron associated with the given id.
7588
+ * Get a cron. Get the cron associated with the specified ID.
7172
7589
  *
7173
7590
  * @param request - The request {@link GetCronRequest}
7174
7591
  * @returns A Promise of Cron
@@ -7183,21 +7600,22 @@ declare class API$h extends API$q {
7183
7600
  */
7184
7601
  waitForCron: (request: Readonly<GetCronRequest>, options?: Readonly<WaitForOptions<Cron>>) => Promise<Cron>;
7185
7602
  /**
7186
- * Create a new cron.
7603
+ * Create a new cron. Create a new cronjob for a function with the specified
7604
+ * ID.
7187
7605
  *
7188
7606
  * @param request - The request {@link CreateCronRequest}
7189
7607
  * @returns A Promise of Cron
7190
7608
  */
7191
7609
  createCron: (request: Readonly<CreateCronRequest>) => Promise<Cron>;
7192
7610
  /**
7193
- * Update an existing cron. Update the cron associated with the given id.
7611
+ * Update an existing cron. Update the cron associated with the specified ID.
7194
7612
  *
7195
7613
  * @param request - The request {@link UpdateCronRequest}
7196
7614
  * @returns A Promise of Cron
7197
7615
  */
7198
7616
  updateCron: (request: Readonly<UpdateCronRequest>) => Promise<Cron>;
7199
7617
  /**
7200
- * Delete an existing cron. Delete the cron associated with the given id.
7618
+ * Delete an existing cron. Delete the cron associated with the specified ID.
7201
7619
  *
7202
7620
  * @param request - The request {@link DeleteCronRequest}
7203
7621
  * @returns A Promise of Cron
@@ -7205,7 +7623,8 @@ declare class API$h extends API$q {
7205
7623
  deleteCron: (request: Readonly<DeleteCronRequest>) => Promise<Cron>;
7206
7624
  protected pageOfListLogs: (request: Readonly<ListLogsRequest>) => Promise<ListLogsResponse>;
7207
7625
  /**
7208
- * List your application logs.
7626
+ * List application logs. List the application logs of the function with the
7627
+ * specified ID.
7209
7628
  *
7210
7629
  * @param request - The request {@link ListLogsRequest}
7211
7630
  * @returns A Promise of ListLogsResponse
@@ -7216,7 +7635,8 @@ declare class API$h extends API$q {
7216
7635
  };
7217
7636
  protected pageOfListDomains: (request: Readonly<ListDomainsRequest$1>) => Promise<ListDomainsResponse$1>;
7218
7637
  /**
7219
- * List all domain name bindings.
7638
+ * List all domain name bindings. List all domain name bindings in a specified
7639
+ * region.
7220
7640
  *
7221
7641
  * @param request - The request {@link ListDomainsRequest}
7222
7642
  * @returns A Promise of ListDomainsResponse
@@ -7226,7 +7646,8 @@ declare class API$h extends API$q {
7226
7646
  [Symbol.asyncIterator]: () => AsyncGenerator<Domain$1[], void, void>;
7227
7647
  };
7228
7648
  /**
7229
- * Get a domain name binding.
7649
+ * Get a domain name binding. Get a domain name binding for the function with
7650
+ * the specified ID.
7230
7651
  *
7231
7652
  * @param request - The request {@link GetDomainRequest}
7232
7653
  * @returns A Promise of Domain
@@ -7241,14 +7662,16 @@ declare class API$h extends API$q {
7241
7662
  */
7242
7663
  waitForDomain: (request: Readonly<GetDomainRequest$1>, options?: Readonly<WaitForOptions<Domain$1>>) => Promise<Domain$1>;
7243
7664
  /**
7244
- * Create a domain name binding.
7665
+ * Create a domain name binding. Create a domain name binding for the function
7666
+ * with the specified ID.
7245
7667
  *
7246
7668
  * @param request - The request {@link CreateDomainRequest}
7247
7669
  * @returns A Promise of Domain
7248
7670
  */
7249
7671
  createDomain: (request: Readonly<CreateDomainRequest$1>) => Promise<Domain$1>;
7250
7672
  /**
7251
- * Delete a domain name binding.
7673
+ * Delete a domain name binding. Delete a domain name binding for the function
7674
+ * with the specified ID.
7252
7675
  *
7253
7676
  * @param request - The request {@link DeleteDomainRequest}
7254
7677
  * @returns A Promise of Domain
@@ -7842,10 +8265,12 @@ interface User$1 {
7842
8265
  lastLoginAt?: Date;
7843
8266
  /** Type of user. */
7844
8267
  type: UserType;
7845
- /** Whether MFA is enabled. */
7846
- twoFactorEnabled: boolean;
8268
+ /** @deprecated Deprecated, use "mfa" instead. */
8269
+ twoFactorEnabled?: boolean;
7847
8270
  /** Status of user invitation. */
7848
8271
  status: UserStatus;
8272
+ /** Whether MFA is enabled. */
8273
+ mfa: boolean;
7849
8274
  }
7850
8275
  type ListSSHKeysRequest$1 = {
7851
8276
  /** Sort order of the SSH keys. */
@@ -7899,6 +8324,8 @@ type ListUsersRequest$2 = {
7899
8324
  organizationId?: string;
7900
8325
  /** Filter by list of IDs. */
7901
8326
  userIds?: string[];
8327
+ /** Filter by MFA status. */
8328
+ mfa?: boolean;
7902
8329
  };
7903
8330
  type GetUserRequest = {
7904
8331
  /** ID of the user to find. */
@@ -8338,8 +8765,7 @@ declare class API$g extends API$q {
8338
8765
  /**
8339
8766
  * Get a given user. Retrieve information about a user, specified by the
8340
8767
  * `user_id` parameter. The user's full details, including `id`, `email`,
8341
- * `organization_id`, `status` and `two_factor_enabled` are returned in the
8342
- * response.
8768
+ * `organization_id`, `status` and `mfa` are returned in the response.
8343
8769
  *
8344
8770
  * @param request - The request {@link GetUserRequest}
8345
8771
  * @returns A Promise of User
@@ -19167,7 +19593,8 @@ type GetCategoryRequest = {
19167
19593
  declare class API$a extends API$q {
19168
19594
  protected pageOfListImages: (request: Readonly<ListImagesRequest$1>) => Promise<ListImagesResponse$1>;
19169
19595
  /**
19170
- * List marketplace images.
19596
+ * List marketplace images. List all available images on the marketplace,
19597
+ * their UUID, CPU architecture and description.
19171
19598
  *
19172
19599
  * @param request - The request {@link ListImagesRequest}
19173
19600
  * @returns A Promise of ListImagesResponse
@@ -19177,21 +19604,40 @@ declare class API$a extends API$q {
19177
19604
  [Symbol.asyncIterator]: () => AsyncGenerator<Image$1[], void, void>;
19178
19605
  };
19179
19606
  /**
19180
- * Get a specific marketplace image.
19607
+ * Get a specific marketplace image. Get detailed information about a
19608
+ * marketplace image, specified by its `image_id` (UUID format).
19181
19609
  *
19182
19610
  * @param request - The request {@link GetImageRequest}
19183
19611
  * @returns A Promise of Image
19184
19612
  */
19185
19613
  getImage: (request: Readonly<GetImageRequest$1>) => Promise<Image$1>;
19186
19614
  protected pageOfListVersions: (request: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
19615
+ /**
19616
+ * List versions of an Image. Get a list of all available version of an image,
19617
+ * specified by its `image_id` (UUID format).
19618
+ *
19619
+ * @param request - The request {@link ListVersionsRequest}
19620
+ * @returns A Promise of ListVersionsResponse
19621
+ */
19187
19622
  listVersions: (request: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse> & {
19188
19623
  all: () => Promise<Version[]>;
19189
19624
  [Symbol.asyncIterator]: () => AsyncGenerator<Version[], void, void>;
19190
19625
  };
19626
+ /**
19627
+ * Get a specific image version. Get information such as the name, creation
19628
+ * date, last update and published date for an image version specified by its
19629
+ * `version_id` (UUID format).
19630
+ *
19631
+ * @param request - The request {@link GetVersionRequest}
19632
+ * @returns A Promise of Version
19633
+ */
19191
19634
  getVersion: (request: Readonly<GetVersionRequest>) => Promise<Version>;
19192
19635
  protected pageOfListLocalImages: (request?: Readonly<ListLocalImagesRequest>) => Promise<ListLocalImagesResponse>;
19193
19636
  /**
19194
- * List local images from a specific image or version.
19637
+ * List local images from a specific image or version. List information about
19638
+ * local images in a specific Availability Zone, specified by its `image_id`
19639
+ * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
19640
+ * these three parameters may be set.
19195
19641
  *
19196
19642
  * @param request - The request {@link ListLocalImagesRequest}
19197
19643
  * @returns A Promise of ListLocalImagesResponse
@@ -19200,12 +19646,35 @@ declare class API$a extends API$q {
19200
19646
  all: () => Promise<LocalImage[]>;
19201
19647
  [Symbol.asyncIterator]: () => AsyncGenerator<LocalImage[], void, void>;
19202
19648
  };
19649
+ /**
19650
+ * Get a specific local image by ID. Get detailed information about a local
19651
+ * image, including compatible commercial types, supported architecture,
19652
+ * labels and the Availability Zone of the image, specified by its
19653
+ * `local_image_id` (UUID format).
19654
+ *
19655
+ * @param request - The request {@link GetLocalImageRequest}
19656
+ * @returns A Promise of LocalImage
19657
+ */
19203
19658
  getLocalImage: (request: Readonly<GetLocalImageRequest>) => Promise<LocalImage>;
19204
19659
  protected pageOfListCategories: (request?: Readonly<ListCategoriesRequest>) => Promise<ListCategoriesResponse>;
19660
+ /**
19661
+ * List existing image categories. Get a list of all existing categories. The
19662
+ * output can be paginated.
19663
+ *
19664
+ * @param request - The request {@link ListCategoriesRequest}
19665
+ * @returns A Promise of ListCategoriesResponse
19666
+ */
19205
19667
  listCategories: (request?: Readonly<ListCategoriesRequest>) => Promise<ListCategoriesResponse> & {
19206
19668
  all: () => Promise<Category[]>;
19207
19669
  [Symbol.asyncIterator]: () => AsyncGenerator<Category[], void, void>;
19208
19670
  };
19671
+ /**
19672
+ * Get a specific category. Get information about a specific category of the
19673
+ * marketplace catalog, specified by its `category_id` (UUID format).
19674
+ *
19675
+ * @param request - The request {@link GetCategoryRequest}
19676
+ * @returns A Promise of Category
19677
+ */
19209
19678
  getCategory: (request: Readonly<GetCategoryRequest>) => Promise<Category>;
19210
19679
  }
19211
19680
 
@@ -19260,23 +19729,25 @@ type ListNamespacesRequestOrderBy$1 = 'created_at_asc' | 'created_at_desc' | 'up
19260
19729
  type NamespaceProtocol = 'unknown' | 'nats' | 'sqs_sns';
19261
19730
  /** Credential. */
19262
19731
  interface Credential {
19263
- /** Credential ID. */
19732
+ /** ID of the credentials. */
19264
19733
  id: string;
19265
- /** Credential name. */
19734
+ /** Name of the credentials. */
19266
19735
  name: string;
19267
- /** Namespace containing the Credential. */
19736
+ /** Namespace containing the credentials. */
19268
19737
  namespaceId: string;
19269
- /** Protocol associated to the Credential. */
19738
+ /** Protocol associated with the credentials. */
19270
19739
  protocol: NamespaceProtocol;
19271
19740
  /**
19272
- * Credentials file used to connect to the NATS service.
19741
+ * Object containing the credentials, if the credentials are for a NATS
19742
+ * namespace.
19273
19743
  *
19274
19744
  * One-of ('credentialType'): at most one of 'natsCredentials',
19275
19745
  * 'sqsSnsCredentials' could be set.
19276
19746
  */
19277
19747
  natsCredentials?: CredentialNATSCredsFile;
19278
19748
  /**
19279
- * Credential used to connect to the SQS/SNS service.
19749
+ * Object containing the credentials and their metadata, if the credentials
19750
+ * are for an SQS/SNS namespace.
19280
19751
  *
19281
19752
  * One-of ('credentialType'): at most one of 'natsCredentials',
19282
19753
  * 'sqsSnsCredentials' could be set.
@@ -19290,25 +19761,26 @@ interface CredentialNATSCredsFile {
19290
19761
  }
19291
19762
  /** Credential.sqssns creds. */
19292
19763
  interface CredentialSQSSNSCreds {
19293
- /** ID of the key. */
19764
+ /** Access key ID. */
19294
19765
  accessKey: string;
19295
- /** Secret value of the key. */
19766
+ /** Secret key ID. */
19296
19767
  secretKey?: string;
19297
- /** List of permissions associated to this Credential. */
19768
+ /** Permissions associated with these credentials. */
19298
19769
  permissions?: Permissions;
19299
19770
  }
19300
19771
  /** Credential summary. */
19301
19772
  interface CredentialSummary {
19302
- /** Credential ID. */
19773
+ /** ID of the credentials. */
19303
19774
  id: string;
19304
- /** Credential name. */
19775
+ /** Name of the credentials. */
19305
19776
  name: string;
19306
- /** Namespace containing the Credential. */
19777
+ /** Namespace containing the credentials. */
19307
19778
  namespaceId: string;
19308
- /** Protocol associated to the Credential. */
19779
+ /** Protocol associated with the credentials. */
19309
19780
  protocol: NamespaceProtocol;
19310
19781
  /**
19311
- * Credential used to connect to the SQS/SNS service.
19782
+ * Object containing the credentials and their metadata, if the credentials
19783
+ * are for an SQS/SNS namespace.
19312
19784
  *
19313
19785
  * One-of ('credentialType'): at most one of 'sqsSnsCredentials' could be set.
19314
19786
  */
@@ -19316,23 +19788,23 @@ interface CredentialSummary {
19316
19788
  }
19317
19789
  /** Credential summary.sqssns creds. */
19318
19790
  interface CredentialSummarySQSSNSCreds {
19319
- /** ID of the key. */
19791
+ /** Access key ID. */
19320
19792
  accessKey: string;
19321
- /** List of permissions associated to this Credential. */
19793
+ /** Permissions associated with these credentials. */
19322
19794
  permissions?: Permissions;
19323
19795
  }
19324
19796
  /** List credentials response. */
19325
19797
  interface ListCredentialsResponse {
19326
- /** Total number of existing Credentials. */
19798
+ /** Total count of existing credentials (matching any filters specified). */
19327
19799
  totalCount: number;
19328
- /** A page of Credentials. */
19800
+ /** Credentials on this page. */
19329
19801
  credentials: CredentialSummary[];
19330
19802
  }
19331
19803
  /** List namespaces response. */
19332
19804
  interface ListNamespacesResponse$1 {
19333
- /** Total number of existing Namespaces. */
19805
+ /** Total count of existing namespaces (matching any filters specified). */
19334
19806
  totalCount: number;
19335
- /** A page of Namespaces. */
19807
+ /** Namespaces on this page. */
19336
19808
  namespaces: Namespace$1[];
19337
19809
  }
19338
19810
  /** Namespace. */
@@ -19341,13 +19813,13 @@ interface Namespace$1 {
19341
19813
  id: string;
19342
19814
  /** Namespace name. */
19343
19815
  name: string;
19344
- /** Endpoint of the service matching the Namespace protocol. */
19816
+ /** Endpoint of the service matching the namespace's protocol. */
19345
19817
  endpoint: string;
19346
19818
  /** Namespace protocol. */
19347
19819
  protocol: NamespaceProtocol;
19348
- /** Project containing the Namespace. */
19820
+ /** Project ID of the Project containing the namespace. */
19349
19821
  projectId: string;
19350
- /** Region where the Namespace is deployed. */
19822
+ /** Region where the namespace is deployed. */
19351
19823
  region: Region;
19352
19824
  /** Namespace creation date. */
19353
19825
  createdAt?: Date;
@@ -19356,11 +19828,20 @@ interface Namespace$1 {
19356
19828
  }
19357
19829
  /** Permissions. */
19358
19830
  interface Permissions {
19359
- /** Defines if user can publish messages to the service. */
19831
+ /**
19832
+ * Defines whether the credentials bearer can publish messages to the service
19833
+ * (send messages to SQS queues or publish to SNS topics).
19834
+ */
19360
19835
  canPublish?: boolean;
19361
- /** Defines if user can receive messages from the service. */
19836
+ /**
19837
+ * Defines whether the credentials bearer can receive messages from the
19838
+ * service.
19839
+ */
19362
19840
  canReceive?: boolean;
19363
- /** Defines if user can manage the associated resource(s). */
19841
+ /**
19842
+ * Defines whether the credentials bearer can manage the associated resources
19843
+ * (SQS queues or SNS topics or subscriptions).
19844
+ */
19364
19845
  canManage?: boolean;
19365
19846
  }
19366
19847
  type ListNamespacesRequest$1 = {
@@ -19369,15 +19850,15 @@ type ListNamespacesRequest$1 = {
19369
19850
  * config.
19370
19851
  */
19371
19852
  region?: Region;
19372
- /** Will list only the Namespaces owned by the specified organization. */
19853
+ /** Include only namespaces in this Organization. */
19373
19854
  organizationId?: string;
19374
- /** Will list only the Namespaces contained into the specified project. */
19855
+ /** Include only namespaces in this Project. */
19375
19856
  projectId?: string;
19376
- /** Indicate the page number of results to be returned. */
19857
+ /** Page number to return. */
19377
19858
  page?: number;
19378
- /** Maximum number of results returned by page. */
19859
+ /** Maximum number of namespaces to return per page. */
19379
19860
  pageSize?: number;
19380
- /** Field used for sorting results. */
19861
+ /** Order in which to return results. */
19381
19862
  orderBy?: ListNamespacesRequestOrderBy$1;
19382
19863
  };
19383
19864
  type CreateNamespaceRequest$1 = {
@@ -19388,7 +19869,10 @@ type CreateNamespaceRequest$1 = {
19388
19869
  region?: Region;
19389
19870
  /** Namespace name. */
19390
19871
  name?: string;
19391
- /** Namespace protocol. */
19872
+ /**
19873
+ * Namespace protocol. You must specify a valid protocol (and not `unknown`)
19874
+ * to avoid an error.
19875
+ */
19392
19876
  protocol: NamespaceProtocol;
19393
19877
  /** Project containing the Namespace. */
19394
19878
  projectId?: string;
@@ -19419,7 +19903,7 @@ type DeleteNamespaceRequest$1 = {
19419
19903
  * config.
19420
19904
  */
19421
19905
  region?: Region;
19422
- /** ID of the Namespace to delete. */
19906
+ /** ID of the namespace to delete. */
19423
19907
  namespaceId: string;
19424
19908
  };
19425
19909
  type CreateCredentialRequest = {
@@ -19428,12 +19912,12 @@ type CreateCredentialRequest = {
19428
19912
  * config.
19429
19913
  */
19430
19914
  region?: Region;
19431
- /** Namespace containing the Credential. */
19915
+ /** Namespace containing the credentials. */
19432
19916
  namespaceId: string;
19433
- /** Credential name. */
19917
+ /** Name of the credentials. */
19434
19918
  name?: string;
19435
19919
  /**
19436
- * List of permissions associated to this Credential.
19920
+ * Permissions associated with these credentials.
19437
19921
  *
19438
19922
  * One-of ('optionalPermissions'): at most one of 'permissions' could be set.
19439
19923
  */
@@ -19445,7 +19929,7 @@ type DeleteCredentialRequest = {
19445
19929
  * config.
19446
19930
  */
19447
19931
  region?: Region;
19448
- /** ID of the Credential to delete. */
19932
+ /** ID of the credentials to delete. */
19449
19933
  credentialId: string;
19450
19934
  };
19451
19935
  type ListCredentialsRequest = {
@@ -19454,13 +19938,13 @@ type ListCredentialsRequest = {
19454
19938
  * config.
19455
19939
  */
19456
19940
  region?: Region;
19457
- /** Namespace containing the Credential. */
19941
+ /** Namespace containing the credentials. */
19458
19942
  namespaceId?: string;
19459
- /** Indicate the page number of results to be returned. */
19943
+ /** Page number to return. */
19460
19944
  page?: number;
19461
- /** Maximum number of results returned by page. */
19945
+ /** Maximum number of credentials to return per page. */
19462
19946
  pageSize?: number;
19463
- /** Field used for sorting results. */
19947
+ /** Order in which to return results. */
19464
19948
  orderBy?: ListCredentialsRequestOrderBy;
19465
19949
  };
19466
19950
  type UpdateCredentialRequest = {
@@ -19469,12 +19953,12 @@ type UpdateCredentialRequest = {
19469
19953
  * config.
19470
19954
  */
19471
19955
  region?: Region;
19472
- /** ID of the Credential to update. */
19956
+ /** ID of the credentials to update. */
19473
19957
  credentialId: string;
19474
- /** Credential name. */
19958
+ /** Name of the credentials. */
19475
19959
  name?: string;
19476
19960
  /**
19477
- * List of permissions associated to this Credential.
19961
+ * Permissions associated with these credentials.
19478
19962
  *
19479
19963
  * One-of ('optionalPermissions'): at most one of 'permissions' could be set.
19480
19964
  */
@@ -19486,21 +19970,25 @@ type GetCredentialRequest = {
19486
19970
  * config.
19487
19971
  */
19488
19972
  region?: Region;
19489
- /** ID of the Credential to get. */
19973
+ /** ID of the credentials to get. */
19490
19974
  credentialId: string;
19491
19975
  };
19492
19976
 
19493
19977
  /**
19494
19978
  * MnQ API (beta).
19495
19979
  *
19496
- * This API allows you to manage Messaging or Queueing brokers. MnQ API (beta).
19980
+ * This API allows you to manage Scaleway Messaging and Queueing brokers. MnQ
19981
+ * API (beta).
19497
19982
  */
19498
19983
  declare class API$9 extends API$q {
19499
19984
  /** Lists the available regions of the API. */
19500
19985
  static readonly LOCALITIES: Region[];
19501
19986
  protected pageOfListNamespaces: (request?: Readonly<ListNamespacesRequest$1>) => Promise<ListNamespacesResponse$1>;
19502
19987
  /**
19503
- * List namespaces.
19988
+ * List namespaces. List all Messaging and Queuing namespaces in the specified
19989
+ * region, for a Scaleway Organization or Project. By default, the namespaces
19990
+ * returned in the list are ordered by creation date in ascending order,
19991
+ * though this can be modified via the `order_by` field.
19504
19992
  *
19505
19993
  * @param request - The request {@link ListNamespacesRequest}
19506
19994
  * @returns A Promise of ListNamespacesResponse
@@ -19510,49 +19998,63 @@ declare class API$9 extends API$q {
19510
19998
  [Symbol.asyncIterator]: () => AsyncGenerator<Namespace$1[], void, void>;
19511
19999
  };
19512
20000
  /**
19513
- * Create a namespace.
20001
+ * Create a namespace. Create a Messaging and Queuing namespace, set to the
20002
+ * desired protocol.
19514
20003
  *
19515
20004
  * @param request - The request {@link CreateNamespaceRequest}
19516
20005
  * @returns A Promise of Namespace
19517
20006
  */
19518
20007
  createNamespace: (request: Readonly<CreateNamespaceRequest$1>) => Promise<Namespace$1>;
19519
20008
  /**
19520
- * Update the name of a namespace.
20009
+ * Update the name of a namespace. Update the name of a Messaging and Queuing
20010
+ * namespace, specified by its namespace ID.
19521
20011
  *
19522
20012
  * @param request - The request {@link UpdateNamespaceRequest}
19523
20013
  * @returns A Promise of Namespace
19524
20014
  */
19525
20015
  updateNamespace: (request: Readonly<UpdateNamespaceRequest$1>) => Promise<Namespace$1>;
19526
20016
  /**
19527
- * Get a namespace.
20017
+ * Get a namespace. Retrieve information about an existing Messaging and
20018
+ * Queuing namespace, identified by its namespace ID. Its full details,
20019
+ * including name, endpoint and protocol, are returned in the response.
19528
20020
  *
19529
20021
  * @param request - The request {@link GetNamespaceRequest}
19530
20022
  * @returns A Promise of Namespace
19531
20023
  */
19532
20024
  getNamespace: (request: Readonly<GetNamespaceRequest$1>) => Promise<Namespace$1>;
19533
20025
  /**
19534
- * Delete a namespace.
20026
+ * Delete a namespace. Delete a Messaging and Queuing namespace, specified by
20027
+ * its namespace ID. Note that deleting a namespace is irreversible, and any
20028
+ * URLs, credentials and queued messages belonging to this namespace will also
20029
+ * be deleted.
19535
20030
  *
19536
20031
  * @param request - The request {@link DeleteNamespaceRequest}
19537
20032
  */
19538
20033
  deleteNamespace: (request: Readonly<DeleteNamespaceRequest$1>) => Promise<void>;
19539
20034
  /**
19540
- * Create a set of credentials. Create a set of credentials for a specific
19541
- * namespace.
20035
+ * Create credentials. Create a set of credentials for a Messaging and Queuing
20036
+ * namespace, specified by its namespace ID. If creating credentials for a
20037
+ * NATS namespace, the `permissions` object must not be included in the
20038
+ * request. If creating credentials for an SQS/SNS namespace, the
20039
+ * `permissions` object is required, with all three of its child attributes.
19542
20040
  *
19543
20041
  * @param request - The request {@link CreateCredentialRequest}
19544
20042
  * @returns A Promise of Credential
19545
20043
  */
19546
20044
  createCredential: (request: Readonly<CreateCredentialRequest>) => Promise<Credential>;
19547
20045
  /**
19548
- * Delete credentials.
20046
+ * Delete credentials. Delete a set of credentials, specified by their
20047
+ * credential ID. Deleting credentials is irreversible and cannot be undone.
20048
+ * The credentials can no longer be used to access the namespace.
19549
20049
  *
19550
20050
  * @param request - The request {@link DeleteCredentialRequest}
19551
20051
  */
19552
20052
  deleteCredential: (request: Readonly<DeleteCredentialRequest>) => Promise<void>;
19553
20053
  protected pageOfListCredentials: (request?: Readonly<ListCredentialsRequest>) => Promise<ListCredentialsResponse>;
19554
20054
  /**
19555
- * List credentials.
20055
+ * List credentials. List existing credentials in the specified region. The
20056
+ * response contains only the metadata for the credentials, not the
20057
+ * credentials themselves (for this, use **Get Credentials**).
19556
20058
  *
19557
20059
  * @param request - The request {@link ListCredentialsRequest}
19558
20060
  * @returns A Promise of ListCredentialsResponse
@@ -19562,14 +20064,19 @@ declare class API$9 extends API$q {
19562
20064
  [Symbol.asyncIterator]: () => AsyncGenerator<CredentialSummary[], void, void>;
19563
20065
  };
19564
20066
  /**
19565
- * Update a set of credentials.
20067
+ * Update credentials. Update a set of credentials. You can update the
20068
+ * credentials' name, or (in the case of SQS/SNS credentials only) their
20069
+ * permissions. To update the name of NATS credentials, do not include the
20070
+ * `permissions` object in your request.
19566
20071
  *
19567
20072
  * @param request - The request {@link UpdateCredentialRequest}
19568
20073
  * @returns A Promise of Credential
19569
20074
  */
19570
20075
  updateCredential: (request: Readonly<UpdateCredentialRequest>) => Promise<Credential>;
19571
20076
  /**
19572
- * Get a set of credentials.
20077
+ * Get credentials. Retrieve an existing set of credentials, identified by the
20078
+ * `credential_id`. The credentials themselves, as well as their metadata
20079
+ * (protocol, namespace ID etc), are returned in the response.
19573
20080
  *
19574
20081
  * @param request - The request {@link GetCredentialRequest}
19575
20082
  * @returns A Promise of Credential
@@ -23258,20 +23765,25 @@ interface AccessSecretVersionResponse {
23258
23765
  revision: number;
23259
23766
  /** The base64-encoded secret payload of the version. */
23260
23767
  data: string;
23768
+ /**
23769
+ * The CRC32 checksum of the data as a base-10 integer. This field is present
23770
+ * only if a CRC32 was supplied during the creation of the version.
23771
+ */
23772
+ dataCrc32?: number;
23261
23773
  }
23262
23774
  /** List secret versions response. */
23263
23775
  interface ListSecretVersionsResponse {
23264
- /** Number of versions. */
23265
- totalCount: number;
23266
23776
  /** Single page of versions. */
23267
23777
  versions: SecretVersion[];
23778
+ /** Number of versions. */
23779
+ totalCount: number;
23268
23780
  }
23269
23781
  /** List secrets response. */
23270
23782
  interface ListSecretsResponse {
23271
- /** Count of all secrets matching the requested criteria. */
23272
- totalCount: number;
23273
23783
  /** Single page of secrets matching the requested criteria. */
23274
23784
  secrets: Secret[];
23785
+ /** Count of all secrets matching the requested criteria. */
23786
+ totalCount: number;
23275
23787
  }
23276
23788
  /** Password generation params. */
23277
23789
  interface PasswordGenerationParams {
@@ -23305,22 +23817,24 @@ interface Secret {
23305
23817
  updatedAt?: Date;
23306
23818
  /** List of the secret's tags. */
23307
23819
  tags: string[];
23308
- /** Region of the secret. */
23309
- region: Region;
23310
23820
  /** Number of versions for this secret. */
23311
23821
  versionCount: number;
23312
23822
  /** Updated description of the secret. */
23313
23823
  description?: string;
23824
+ /** True for secrets that are managed by another product. */
23825
+ isManaged: boolean;
23826
+ /** Region of the secret. */
23827
+ region: Region;
23314
23828
  }
23315
23829
  /** Secret version. */
23316
23830
  interface SecretVersion {
23317
- /** ID of the secret. */
23318
- secretId: string;
23319
23831
  /**
23320
23832
  * Version number. The first version of the secret is numbered 1, and all
23321
23833
  * subsequent revisions augment by 1.
23322
23834
  */
23323
23835
  revision: number;
23836
+ /** ID of the secret. */
23837
+ secretId: string;
23324
23838
  /**
23325
23839
  * Current status of the version. `unknown`: the version is in an invalid
23326
23840
  * state. `enabled`: the version is accessible. `disabled`: the version is not
@@ -23334,6 +23848,8 @@ interface SecretVersion {
23334
23848
  updatedAt?: Date;
23335
23849
  /** Description of the version. */
23336
23850
  description?: string;
23851
+ /** True if the version is the latest one. */
23852
+ isLatest: boolean;
23337
23853
  }
23338
23854
  type CreateSecretRequest = {
23339
23855
  /**
@@ -23393,13 +23909,15 @@ type ListSecretsRequest = {
23393
23909
  organizationId?: string;
23394
23910
  /** Filter by Project ID (optional). */
23395
23911
  projectId?: string;
23396
- /** Filter by secret name (optional). */
23397
- name?: string;
23398
- /** List of tags to filter on (optional). */
23399
- tags?: string[];
23400
23912
  orderBy?: ListSecretsRequestOrderBy;
23401
23913
  page?: number;
23402
23914
  pageSize?: number;
23915
+ /** List of tags to filter on (optional). */
23916
+ tags?: string[];
23917
+ /** Filter by secret name (optional). */
23918
+ name?: string;
23919
+ /** Filter by managed / not managed (optional). */
23920
+ isManaged?: boolean;
23403
23921
  };
23404
23922
  type DeleteSecretRequest = {
23405
23923
  /**
@@ -23410,6 +23928,17 @@ type DeleteSecretRequest = {
23410
23928
  /** ID of the secret. */
23411
23929
  secretId: string;
23412
23930
  };
23931
+ type AddSecretOwnerRequest = {
23932
+ /**
23933
+ * Region to target. If none is passed will use default region from the
23934
+ * config.
23935
+ */
23936
+ region?: Region;
23937
+ /** ID of the secret. */
23938
+ secretId: string;
23939
+ /** Name of the product to add. */
23940
+ productName: string;
23941
+ };
23413
23942
  type CreateSecretVersionRequest = {
23414
23943
  /**
23415
23944
  * Region to target. If none is passed will use default region from the
@@ -23423,20 +23952,28 @@ type CreateSecretVersionRequest = {
23423
23952
  /** Description of the version. */
23424
23953
  description?: string;
23425
23954
  /**
23426
- * Disable the previous secret version. If there is no previous version or if
23427
- * the previous version was already disabled, does nothing.
23955
+ * Disable the previous secret version. Optional. If there is no previous
23956
+ * version or if the previous version was already disabled, does nothing.
23428
23957
  */
23429
- disablePrevious: boolean;
23958
+ disablePrevious?: boolean;
23430
23959
  /**
23431
- * Options to generate a password. If specified, a random password will be
23432
- * generated. The data field must be empty. By default, the generator will use
23433
- * upper and lower case letters, and digits. This behavior can be tuned using
23434
- * the generation params.
23960
+ * Options to generate a password. Optional. If specified, a random password
23961
+ * will be generated. The data and data_crc32 fields must be empty. By
23962
+ * default, the generator will use upper and lower case letters, and digits.
23963
+ * This behavior can be tuned using the generation parameters.
23435
23964
  *
23436
23965
  * One-of ('PasswordGeneration'): at most one of 'passwordGeneration' could be
23437
23966
  * set.
23438
23967
  */
23439
23968
  passwordGeneration?: PasswordGenerationParams;
23969
+ /**
23970
+ * The CRC32 checksum of the data as a base-10 integer. Optional. If
23971
+ * specified, the Secret Manager will verify the integrity of the data
23972
+ * received against the given CRC32. An error is returned if the CRC32 does
23973
+ * not match. Otherwise, the CRC32 will be stored and returned along with the
23974
+ * SecretVersion on futur accesses.
23975
+ */
23976
+ dataCrc32?: number;
23440
23977
  };
23441
23978
  type GetSecretVersionRequest = {
23442
23979
  /**
@@ -23508,7 +24045,7 @@ type ListSecretVersionsByNameRequest = {
23508
24045
  /** Filter results by status. */
23509
24046
  status?: SecretVersionStatus[];
23510
24047
  };
23511
- type DestroySecretVersionRequest = {
24048
+ type EnableSecretVersionRequest = {
23512
24049
  /**
23513
24050
  * Region to target. If none is passed will use default region from the
23514
24051
  * config.
@@ -23522,7 +24059,7 @@ type DestroySecretVersionRequest = {
23522
24059
  */
23523
24060
  revision: string;
23524
24061
  };
23525
- type EnableSecretVersionRequest = {
24062
+ type DisableSecretVersionRequest = {
23526
24063
  /**
23527
24064
  * Region to target. If none is passed will use default region from the
23528
24065
  * config.
@@ -23536,7 +24073,7 @@ type EnableSecretVersionRequest = {
23536
24073
  */
23537
24074
  revision: string;
23538
24075
  };
23539
- type DisableSecretVersionRequest = {
24076
+ type AccessSecretVersionRequest = {
23540
24077
  /**
23541
24078
  * Region to target. If none is passed will use default region from the
23542
24079
  * config.
@@ -23550,28 +24087,28 @@ type DisableSecretVersionRequest = {
23550
24087
  */
23551
24088
  revision: string;
23552
24089
  };
23553
- type AccessSecretVersionRequest = {
24090
+ type AccessSecretVersionByNameRequest = {
23554
24091
  /**
23555
24092
  * Region to target. If none is passed will use default region from the
23556
24093
  * config.
23557
24094
  */
23558
24095
  region?: Region;
23559
- /** ID of the secret. */
23560
- secretId: string;
24096
+ /** Name of the secret. */
24097
+ secretName: string;
23561
24098
  /**
23562
24099
  * Version number. The first version of the secret is numbered 1, and all
23563
24100
  * subsequent revisions augment by 1. Value can be a number or "latest".
23564
24101
  */
23565
24102
  revision: string;
23566
24103
  };
23567
- type AccessSecretVersionByNameRequest = {
24104
+ type DestroySecretVersionRequest = {
23568
24105
  /**
23569
24106
  * Region to target. If none is passed will use default region from the
23570
24107
  * config.
23571
24108
  */
23572
24109
  region?: Region;
23573
- /** Name of the secret. */
23574
- secretName: string;
24110
+ /** ID of the secret. */
24111
+ secretId: string;
23575
24112
  /**
23576
24113
  * Version number. The first version of the secret is numbered 1, and all
23577
24114
  * subsequent revisions augment by 1. Value can be a number or "latest".
@@ -23640,6 +24177,12 @@ declare class API$5 extends API$q {
23640
24177
  * @param request - The request {@link DeleteSecretRequest}
23641
24178
  */
23642
24179
  deleteSecret: (request: Readonly<DeleteSecretRequest>) => Promise<void>;
24180
+ /**
24181
+ * Allow a product to use the secret.
24182
+ *
24183
+ * @param request - The request {@link AddSecretOwnerRequest}
24184
+ */
24185
+ addSecretOwner: (request: Readonly<AddSecretOwnerRequest>) => Promise<void>;
23643
24186
  /**
23644
24187
  * Create a version. Create a version of a given secret specified by the
23645
24188
  * `region` and `secret_id` parameters.
@@ -23700,14 +24243,6 @@ declare class API$5 extends API$q {
23700
24243
  all: () => Promise<SecretVersion[]>;
23701
24244
  [Symbol.asyncIterator]: () => AsyncGenerator<SecretVersion[], void, void>;
23702
24245
  };
23703
- /**
23704
- * Delete a version. Delete a secret's version and the sensitive data
23705
- * contained in it. Deleting a version is permanent and cannot be undone.
23706
- *
23707
- * @param request - The request {@link DestroySecretVersionRequest}
23708
- * @returns A Promise of SecretVersion
23709
- */
23710
- destroySecretVersion: (request: Readonly<DestroySecretVersionRequest>) => Promise<SecretVersion>;
23711
24246
  /**
23712
24247
  * Enable a version. Make a specific version accessible. You must specify the
23713
24248
  * `region`, `secret_id` and `revision` parameters.
@@ -23742,11 +24277,20 @@ declare class API$5 extends API$q {
23742
24277
  * @returns A Promise of AccessSecretVersionResponse
23743
24278
  */
23744
24279
  accessSecretVersionByName: (request: Readonly<AccessSecretVersionByNameRequest>) => Promise<AccessSecretVersionResponse>;
24280
+ /**
24281
+ * Delete a version. Delete a secret's version and the sensitive data
24282
+ * contained in it. Deleting a version is permanent and cannot be undone.
24283
+ *
24284
+ * @param request - The request {@link DestroySecretVersionRequest}
24285
+ * @returns A Promise of SecretVersion
24286
+ */
24287
+ destroySecretVersion: (request: Readonly<DestroySecretVersionRequest>) => Promise<SecretVersion>;
23745
24288
  }
23746
24289
 
23747
24290
  type index_gen$5_AccessSecretVersionByNameRequest = AccessSecretVersionByNameRequest;
23748
24291
  type index_gen$5_AccessSecretVersionRequest = AccessSecretVersionRequest;
23749
24292
  type index_gen$5_AccessSecretVersionResponse = AccessSecretVersionResponse;
24293
+ type index_gen$5_AddSecretOwnerRequest = AddSecretOwnerRequest;
23750
24294
  type index_gen$5_CreateSecretRequest = CreateSecretRequest;
23751
24295
  type index_gen$5_CreateSecretVersionRequest = CreateSecretVersionRequest;
23752
24296
  type index_gen$5_DeleteSecretRequest = DeleteSecretRequest;
@@ -23776,6 +24320,7 @@ declare namespace index_gen$5 {
23776
24320
  index_gen$5_AccessSecretVersionByNameRequest as AccessSecretVersionByNameRequest,
23777
24321
  index_gen$5_AccessSecretVersionRequest as AccessSecretVersionRequest,
23778
24322
  index_gen$5_AccessSecretVersionResponse as AccessSecretVersionResponse,
24323
+ index_gen$5_AddSecretOwnerRequest as AddSecretOwnerRequest,
23779
24324
  index_gen$5_CreateSecretRequest as CreateSecretRequest,
23780
24325
  index_gen$5_CreateSecretVersionRequest as CreateSecretVersionRequest,
23781
24326
  index_gen$5_DeleteSecretRequest as DeleteSecretRequest,
@@ -24521,81 +25066,96 @@ interface ListPrivateNetworksResponse {
24521
25066
  }
24522
25067
  /** Private network. */
24523
25068
  interface PrivateNetwork {
24524
- /** The private network ID. */
25069
+ /** Private Network ID. */
24525
25070
  id: string;
24526
- /** The private network name. */
25071
+ /** Private Network name. */
24527
25072
  name: string;
24528
- /** The private network organization. */
25073
+ /** Scaleway Organization the Private Network belongs to. */
24529
25074
  organizationId: string;
24530
- /** The private network project ID. */
25075
+ /** Scaleway Project the Private Network belongs to. */
24531
25076
  projectId: string;
24532
- /** The zone in which the private network is available. */
25077
+ /** Availability Zone in which the Private Network is available. */
24533
25078
  zone: Zone;
24534
- /** The private network tags. */
25079
+ /** Tags of the Private Network. */
24535
25080
  tags: string[];
24536
- /** The private network creation date. */
25081
+ /** Date the Private Network was created. */
24537
25082
  createdAt?: Date;
24538
- /** The last private network modification date. */
25083
+ /** Date the Private Network was last modified. */
24539
25084
  updatedAt?: Date;
24540
- /** Private network subnets CIDR. */
25085
+ /** Private Network subnets CIDR. */
24541
25086
  subnets: string[];
24542
25087
  }
24543
25088
  type ListPrivateNetworksRequest = {
24544
25089
  /** Zone to target. If none is passed will use default zone from the config. */
24545
25090
  zone?: Zone;
24546
- /** The sort order of the returned private networks. */
25091
+ /** Sort order of the returned Private Networks. */
24547
25092
  orderBy?: ListPrivateNetworksRequestOrderBy;
24548
- /** The page number for the returned private networks. */
25093
+ /** Page number to return, from the paginated results. */
24549
25094
  page?: number;
24550
- /** The maximum number of private networks per page. */
25095
+ /** Maximum number of Private Networks to return per page. */
24551
25096
  pageSize?: number;
24552
- /** Filter private networks with names containing this string. */
25097
+ /**
25098
+ * Name to filter for. Only Private Networks with names containing this string
25099
+ * will be returned.
25100
+ */
24553
25101
  name?: string;
24554
- /** Filter private networks with one or more matching tags. */
25102
+ /**
25103
+ * Tags to filter for. Only Private Networks with one or more matching tags
25104
+ * will be returned.
25105
+ */
24555
25106
  tags?: string[];
24556
- /** The organization ID on which to filter the returned private networks. */
25107
+ /**
25108
+ * Organization ID to filter for. Only Private Networks belonging to this
25109
+ * Organization will be returned.
25110
+ */
24557
25111
  organizationId?: string;
24558
- /** The project ID on which to filter the returned private networks. */
25112
+ /**
25113
+ * Project ID to filter for. Only Private Networks belonging to this Project
25114
+ * will be returned.
25115
+ */
24559
25116
  projectId?: string;
24560
- /** The PrivateNetwork IDs on which to filter the returned private networks. */
25117
+ /**
25118
+ * Private Network IDs to filter for. Only Private Networks with one of these
25119
+ * IDs will be returned.
25120
+ */
24561
25121
  privateNetworkIds?: string[];
24562
- /** Include regional Private Networks. */
25122
+ /** Defines whether to include regional Private Networks in the response. */
24563
25123
  includeRegional?: boolean;
24564
25124
  };
24565
25125
  type CreatePrivateNetworkRequest = {
24566
25126
  /** Zone to target. If none is passed will use default zone from the config. */
24567
25127
  zone?: Zone;
24568
- /** The name of the private network. */
25128
+ /** Name for the Private Network. */
24569
25129
  name?: string;
24570
- /** The project ID of the private network. */
25130
+ /** Scaleway Project in which to create the Private Network. */
24571
25131
  projectId?: string;
24572
- /** The private networks tags. */
25132
+ /** Tags for the Private Network. */
24573
25133
  tags?: string[];
24574
- /** Private network subnets CIDR. */
25134
+ /** Private Network subnets CIDR. */
24575
25135
  subnets?: string[];
24576
25136
  };
24577
25137
  type GetPrivateNetworkRequest = {
24578
25138
  /** Zone to target. If none is passed will use default zone from the config. */
24579
25139
  zone?: Zone;
24580
- /** The private network id. */
25140
+ /** Private Network ID. */
24581
25141
  privateNetworkId: string;
24582
25142
  };
24583
25143
  type UpdatePrivateNetworkRequest = {
24584
25144
  /** Zone to target. If none is passed will use default zone from the config. */
24585
25145
  zone?: Zone;
24586
- /** The private network ID. */
25146
+ /** Private Network ID. */
24587
25147
  privateNetworkId: string;
24588
- /** The name of the private network. */
25148
+ /** Name of the private network. */
24589
25149
  name?: string;
24590
- /** The private networks tags. */
25150
+ /** Tags for the Private Network. */
24591
25151
  tags?: string[];
24592
- /** @deprecated Private network subnets CIDR (deprecated). */
25152
+ /** @deprecated Private Network subnets CIDR (deprecated). */
24593
25153
  subnets?: string[];
24594
25154
  };
24595
25155
  type DeletePrivateNetworkRequest = {
24596
25156
  /** Zone to target. If none is passed will use default zone from the config. */
24597
25157
  zone?: Zone;
24598
- /** The private network ID. */
25158
+ /** Private Network ID. */
24599
25159
  privateNetworkId: string;
24600
25160
  };
24601
25161
 
@@ -24605,7 +25165,10 @@ declare class API$2 extends API$q {
24605
25165
  static readonly LOCALITIES: Zone[];
24606
25166
  protected pageOfListPrivateNetworks: (request?: Readonly<ListPrivateNetworksRequest>) => Promise<ListPrivateNetworksResponse>;
24607
25167
  /**
24608
- * List private networks.
25168
+ * List Private Networks. List existing Private Networks in a specified
25169
+ * Availability Zone. By default, the Private Networks returned in the list
25170
+ * are ordered by creation date in ascending order, though this can be
25171
+ * modified via the order_by field.
24609
25172
  *
24610
25173
  * @param request - The request {@link ListPrivateNetworksRequest}
24611
25174
  * @returns A Promise of ListPrivateNetworksResponse
@@ -24615,28 +25178,33 @@ declare class API$2 extends API$q {
24615
25178
  [Symbol.asyncIterator]: () => AsyncGenerator<PrivateNetwork[], void, void>;
24616
25179
  };
24617
25180
  /**
24618
- * Create a private network.
25181
+ * Create a Private Network. Create a new Private Network. Once created, you
25182
+ * can attach Scaleway resources in the same Availability Zone.
24619
25183
  *
24620
25184
  * @param request - The request {@link CreatePrivateNetworkRequest}
24621
25185
  * @returns A Promise of PrivateNetwork
24622
25186
  */
24623
25187
  createPrivateNetwork: (request?: Readonly<CreatePrivateNetworkRequest>) => Promise<PrivateNetwork>;
24624
25188
  /**
24625
- * Get a private network.
25189
+ * Get a Private Network. Retrieve information about an existing Private
25190
+ * Network, specified by its Private Network ID. Its full details are returned
25191
+ * in the response object.
24626
25192
  *
24627
25193
  * @param request - The request {@link GetPrivateNetworkRequest}
24628
25194
  * @returns A Promise of PrivateNetwork
24629
25195
  */
24630
25196
  getPrivateNetwork: (request: Readonly<GetPrivateNetworkRequest>) => Promise<PrivateNetwork>;
24631
25197
  /**
24632
- * Update private network.
25198
+ * Update Private Network. Update parameters (such as name or tags) of an
25199
+ * existing Private Network, specified by its Private Network ID.
24633
25200
  *
24634
25201
  * @param request - The request {@link UpdatePrivateNetworkRequest}
24635
25202
  * @returns A Promise of PrivateNetwork
24636
25203
  */
24637
25204
  updatePrivateNetwork: (request: Readonly<UpdatePrivateNetworkRequest>) => Promise<PrivateNetwork>;
24638
25205
  /**
24639
- * Delete a private network.
25206
+ * Delete a Private Network. Delete an existing Private Network. Note that you
25207
+ * must first detach all resources from the network, in order to delete it.
24640
25208
  *
24641
25209
  * @param request - The request {@link DeletePrivateNetworkRequest}
24642
25210
  */