qovery-typescript-axios 1.1.925 → 1.1.927

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -13697,6 +13697,104 @@ export interface ExternalSecretAssociatedServiceResponseList {
13697
13697
  */
13698
13698
  'results': Array<ExternalSecretAssociatedServiceResponse>;
13699
13699
  }
13700
+ /**
13701
+ * Validation constraints attached to a catalog field descriptor.
13702
+ * @export
13703
+ * @interface FieldSchemaConstraintsResponse
13704
+ */
13705
+ export interface FieldSchemaConstraintsResponse {
13706
+ /**
13707
+ *
13708
+ * @type {Array<string>}
13709
+ * @memberof FieldSchemaConstraintsResponse
13710
+ */
13711
+ 'allowedValues'?: Array<string> | null;
13712
+ /**
13713
+ *
13714
+ * @type {number}
13715
+ * @memberof FieldSchemaConstraintsResponse
13716
+ */
13717
+ 'min'?: number | null;
13718
+ /**
13719
+ *
13720
+ * @type {number}
13721
+ * @memberof FieldSchemaConstraintsResponse
13722
+ */
13723
+ 'max'?: number | null;
13724
+ /**
13725
+ *
13726
+ * @type {number}
13727
+ * @memberof FieldSchemaConstraintsResponse
13728
+ */
13729
+ 'minLength'?: number | null;
13730
+ /**
13731
+ *
13732
+ * @type {number}
13733
+ * @memberof FieldSchemaConstraintsResponse
13734
+ */
13735
+ 'maxLength'?: number | null;
13736
+ /**
13737
+ *
13738
+ * @type {string}
13739
+ * @memberof FieldSchemaConstraintsResponse
13740
+ */
13741
+ 'pattern'?: string | null;
13742
+ }
13743
+ /**
13744
+ * Canonical platform catalog field descriptor. Mirrors the q-core `FieldSchemaResponse` DTO.
13745
+ * @export
13746
+ * @interface FieldSchemaResponse
13747
+ */
13748
+ export interface FieldSchemaResponse {
13749
+ /**
13750
+ *
13751
+ * @type {string}
13752
+ * @memberof FieldSchemaResponse
13753
+ */
13754
+ 'key': string;
13755
+ /**
13756
+ * Field type understood by the Console, such as string, number, or bool
13757
+ * @type {string}
13758
+ * @memberof FieldSchemaResponse
13759
+ */
13760
+ 'type': string;
13761
+ /**
13762
+ *
13763
+ * @type {boolean}
13764
+ * @memberof FieldSchemaResponse
13765
+ */
13766
+ 'required': boolean;
13767
+ /**
13768
+ *
13769
+ * @type {string}
13770
+ * @memberof FieldSchemaResponse
13771
+ */
13772
+ 'defaultValue'?: string | null;
13773
+ /**
13774
+ *
13775
+ * @type {string}
13776
+ * @memberof FieldSchemaResponse
13777
+ */
13778
+ 'label': string;
13779
+ /**
13780
+ *
13781
+ * @type {string}
13782
+ * @memberof FieldSchemaResponse
13783
+ */
13784
+ 'description'?: string | null;
13785
+ /**
13786
+ *
13787
+ * @type {boolean}
13788
+ * @memberof FieldSchemaResponse
13789
+ */
13790
+ 'sensitive': boolean;
13791
+ /**
13792
+ *
13793
+ * @type {FieldSchemaConstraintsResponse}
13794
+ * @memberof FieldSchemaResponse
13795
+ */
13796
+ 'constraints': FieldSchemaConstraintsResponse;
13797
+ }
13700
13798
  /**
13701
13799
  * @type GcpCredentialsRequest
13702
13800
  * @export
@@ -21026,104 +21124,6 @@ export const PlatformClusterMode = {
21026
21124
  export type PlatformClusterMode = typeof PlatformClusterMode[keyof typeof PlatformClusterMode];
21027
21125
 
21028
21126
 
21029
- /**
21030
- *
21031
- * @export
21032
- * @interface PlatformComponentConfigurationConstraintsResponse
21033
- */
21034
- export interface PlatformComponentConfigurationConstraintsResponse {
21035
- /**
21036
- *
21037
- * @type {Array<string>}
21038
- * @memberof PlatformComponentConfigurationConstraintsResponse
21039
- */
21040
- 'allowedValues'?: Array<string> | null;
21041
- /**
21042
- *
21043
- * @type {number}
21044
- * @memberof PlatformComponentConfigurationConstraintsResponse
21045
- */
21046
- 'min'?: number | null;
21047
- /**
21048
- *
21049
- * @type {number}
21050
- * @memberof PlatformComponentConfigurationConstraintsResponse
21051
- */
21052
- 'max'?: number | null;
21053
- /**
21054
- *
21055
- * @type {number}
21056
- * @memberof PlatformComponentConfigurationConstraintsResponse
21057
- */
21058
- 'minLength'?: number | null;
21059
- /**
21060
- *
21061
- * @type {number}
21062
- * @memberof PlatformComponentConfigurationConstraintsResponse
21063
- */
21064
- 'maxLength'?: number | null;
21065
- /**
21066
- *
21067
- * @type {string}
21068
- * @memberof PlatformComponentConfigurationConstraintsResponse
21069
- */
21070
- 'pattern'?: string | null;
21071
- }
21072
- /**
21073
- *
21074
- * @export
21075
- * @interface PlatformComponentConfigurationFieldResponse
21076
- */
21077
- export interface PlatformComponentConfigurationFieldResponse {
21078
- /**
21079
- *
21080
- * @type {string}
21081
- * @memberof PlatformComponentConfigurationFieldResponse
21082
- */
21083
- 'key': string;
21084
- /**
21085
- * Field type understood by the Console, such as string, number, or bool
21086
- * @type {string}
21087
- * @memberof PlatformComponentConfigurationFieldResponse
21088
- */
21089
- 'type': string;
21090
- /**
21091
- *
21092
- * @type {boolean}
21093
- * @memberof PlatformComponentConfigurationFieldResponse
21094
- */
21095
- 'required': boolean;
21096
- /**
21097
- *
21098
- * @type {string}
21099
- * @memberof PlatformComponentConfigurationFieldResponse
21100
- */
21101
- 'defaultValue'?: string | null;
21102
- /**
21103
- *
21104
- * @type {string}
21105
- * @memberof PlatformComponentConfigurationFieldResponse
21106
- */
21107
- 'label': string;
21108
- /**
21109
- *
21110
- * @type {string}
21111
- * @memberof PlatformComponentConfigurationFieldResponse
21112
- */
21113
- 'description'?: string | null;
21114
- /**
21115
- *
21116
- * @type {boolean}
21117
- * @memberof PlatformComponentConfigurationFieldResponse
21118
- */
21119
- 'sensitive': boolean;
21120
- /**
21121
- *
21122
- * @type {PlatformComponentConfigurationConstraintsResponse}
21123
- * @memberof PlatformComponentConfigurationFieldResponse
21124
- */
21125
- 'constraints': PlatformComponentConfigurationConstraintsResponse;
21126
- }
21127
21127
  /**
21128
21128
  *
21129
21129
  * @export
@@ -21183,10 +21183,10 @@ export interface PlatformComponentConfigurationPreviewResponse {
21183
21183
  'componentKey': string;
21184
21184
  /**
21185
21185
  *
21186
- * @type {Array<PlatformComponentConfigurationFieldResponse>}
21186
+ * @type {Array<FieldSchemaResponse>}
21187
21187
  * @memberof PlatformComponentConfigurationPreviewResponse
21188
21188
  */
21189
- 'fields': Array<PlatformComponentConfigurationFieldResponse>;
21189
+ 'fields': Array<FieldSchemaResponse>;
21190
21190
  /**
21191
21191
  *
21192
21192
  * @type {Array<PlatformComponentInputRequirementResponse>}
@@ -21227,26 +21227,26 @@ export type PlatformComponentConfigurationRequirementStatus = typeof PlatformCom
21227
21227
  */
21228
21228
  export interface PlatformComponentConfigurationViolationResponse {
21229
21229
  /**
21230
- *
21230
+ * Stable machine-readable violation code.
21231
21231
  * @type {string}
21232
21232
  * @memberof PlatformComponentConfigurationViolationResponse
21233
21233
  */
21234
21234
  'code': string;
21235
21235
  /**
21236
- *
21236
+ * Path of the offending field. Convention: profile configuration fields use the bare field key (e.g. `storage`); cluster-provided inputs are prefixed with `clusterInputs.` (e.g. `clusterInputs.s3BucketName`). Consumers match violations to form fields using these exact paths.
21237
21237
  * @type {string}
21238
21238
  * @memberof PlatformComponentConfigurationViolationResponse
21239
21239
  */
21240
21240
  'fieldPath': string;
21241
21241
  /**
21242
- *
21242
+ * Customer-facing message describing how to fix the violation.
21243
21243
  * @type {string}
21244
21244
  * @memberof PlatformComponentConfigurationViolationResponse
21245
21245
  */
21246
21246
  'message': string;
21247
21247
  }
21248
21248
  /**
21249
- *
21249
+ * A catalog field the cluster must provide for the selected configuration: the shared field descriptor extended with its resolution scope and readiness.
21250
21250
  * @export
21251
21251
  * @interface PlatformComponentInputRequirementResponse
21252
21252
  */
@@ -21258,17 +21258,23 @@ export interface PlatformComponentInputRequirementResponse {
21258
21258
  */
21259
21259
  'key': string;
21260
21260
  /**
21261
- *
21261
+ * Field type understood by the Console, such as string, number, or bool
21262
21262
  * @type {string}
21263
21263
  * @memberof PlatformComponentInputRequirementResponse
21264
21264
  */
21265
21265
  'type': string;
21266
21266
  /**
21267
21267
  *
21268
- * @type {PlatformComponentConfigurationInputScope}
21268
+ * @type {boolean}
21269
21269
  * @memberof PlatformComponentInputRequirementResponse
21270
21270
  */
21271
- 'scope': PlatformComponentConfigurationInputScope;
21271
+ 'required': boolean;
21272
+ /**
21273
+ *
21274
+ * @type {string}
21275
+ * @memberof PlatformComponentInputRequirementResponse
21276
+ */
21277
+ 'defaultValue'?: string | null;
21272
21278
  /**
21273
21279
  *
21274
21280
  * @type {string}
@@ -21286,19 +21292,19 @@ export interface PlatformComponentInputRequirementResponse {
21286
21292
  * @type {boolean}
21287
21293
  * @memberof PlatformComponentInputRequirementResponse
21288
21294
  */
21289
- 'required': boolean;
21295
+ 'sensitive': boolean;
21290
21296
  /**
21291
21297
  *
21292
- * @type {boolean}
21298
+ * @type {FieldSchemaConstraintsResponse}
21293
21299
  * @memberof PlatformComponentInputRequirementResponse
21294
21300
  */
21295
- 'sensitive': boolean;
21301
+ 'constraints': FieldSchemaConstraintsResponse;
21296
21302
  /**
21297
21303
  *
21298
- * @type {PlatformComponentConfigurationConstraintsResponse}
21304
+ * @type {PlatformComponentConfigurationInputScope}
21299
21305
  * @memberof PlatformComponentInputRequirementResponse
21300
21306
  */
21301
- 'constraints': PlatformComponentConfigurationConstraintsResponse;
21307
+ 'scope': PlatformComponentConfigurationInputScope;
21302
21308
  /**
21303
21309
  *
21304
21310
  * @type {PlatformComponentConfigurationRequirementStatus}
@@ -21401,10 +21407,10 @@ export interface PlatformTemplateComponentResponse {
21401
21407
  'description'?: string | null;
21402
21408
  /**
21403
21409
  *
21404
- * @type {Array<PlatformComponentConfigurationFieldResponse>}
21410
+ * @type {Array<FieldSchemaResponse>}
21405
21411
  * @memberof PlatformTemplateComponentResponse
21406
21412
  */
21407
- 'fields': Array<PlatformComponentConfigurationFieldResponse>;
21413
+ 'fields': Array<FieldSchemaResponse>;
21408
21414
  }
21409
21415
 
21410
21416
 
@@ -68019,13 +68025,15 @@ export const PlatformConfigurationApiAxiosParamCreator = function (configuration
68019
68025
  };
68020
68026
  },
68021
68027
  /**
68022
- * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render.
68028
+ * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices for that cluster context.
68023
68029
  * @summary List platform templates
68024
68030
  * @param {string} organizationId Organization ID
68031
+ * @param {PlatformClusterMode} [clusterMode] Cluster management mode. Must be supplied together with cloudProvider.
68032
+ * @param {PlatformCloudVendor} [cloudProvider] Cluster cloud provider. Must be supplied together with clusterMode.
68025
68033
  * @param {*} [options] Override http request option.
68026
68034
  * @throws {RequiredError}
68027
68035
  */
68028
- listPlatformTemplates: async (organizationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
68036
+ listPlatformTemplates: async (organizationId: string, clusterMode?: PlatformClusterMode, cloudProvider?: PlatformCloudVendor, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
68029
68037
  // verify required parameter 'organizationId' is not null or undefined
68030
68038
  assertParamExists('listPlatformTemplates', 'organizationId', organizationId)
68031
68039
  const localVarPath = `/organization/{organizationId}/platformTemplate`
@@ -68048,6 +68056,14 @@ export const PlatformConfigurationApiAxiosParamCreator = function (configuration
68048
68056
  // http bearer authentication required
68049
68057
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
68050
68058
 
68059
+ if (clusterMode !== undefined) {
68060
+ localVarQueryParameter['clusterMode'] = clusterMode;
68061
+ }
68062
+
68063
+ if (cloudProvider !== undefined) {
68064
+ localVarQueryParameter['cloudProvider'] = cloudProvider;
68065
+ }
68066
+
68051
68067
 
68052
68068
 
68053
68069
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -68190,14 +68206,16 @@ export const PlatformConfigurationApiFp = function(configuration?: Configuration
68190
68206
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
68191
68207
  },
68192
68208
  /**
68193
- * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render.
68209
+ * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices for that cluster context.
68194
68210
  * @summary List platform templates
68195
68211
  * @param {string} organizationId Organization ID
68212
+ * @param {PlatformClusterMode} [clusterMode] Cluster management mode. Must be supplied together with cloudProvider.
68213
+ * @param {PlatformCloudVendor} [cloudProvider] Cluster cloud provider. Must be supplied together with clusterMode.
68196
68214
  * @param {*} [options] Override http request option.
68197
68215
  * @throws {RequiredError}
68198
68216
  */
68199
- async listPlatformTemplates(organizationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlatformTemplateCatalogResponse>> {
68200
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPlatformTemplates(organizationId, options);
68217
+ async listPlatformTemplates(organizationId: string, clusterMode?: PlatformClusterMode, cloudProvider?: PlatformCloudVendor, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlatformTemplateCatalogResponse>> {
68218
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPlatformTemplates(organizationId, clusterMode, cloudProvider, options);
68201
68219
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
68202
68220
  const localVarOperationServerBasePath = operationServerMap['PlatformConfigurationApi.listPlatformTemplates']?.[localVarOperationServerIndex]?.url;
68203
68221
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -68255,14 +68273,16 @@ export const PlatformConfigurationApiFactory = function (configuration?: Configu
68255
68273
  return localVarFp.getClusterPlatformBinding(organizationId, clusterId, options).then((request) => request(axios, basePath));
68256
68274
  },
68257
68275
  /**
68258
- * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render.
68276
+ * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices for that cluster context.
68259
68277
  * @summary List platform templates
68260
68278
  * @param {string} organizationId Organization ID
68279
+ * @param {PlatformClusterMode} [clusterMode] Cluster management mode. Must be supplied together with cloudProvider.
68280
+ * @param {PlatformCloudVendor} [cloudProvider] Cluster cloud provider. Must be supplied together with clusterMode.
68261
68281
  * @param {*} [options] Override http request option.
68262
68282
  * @throws {RequiredError}
68263
68283
  */
68264
- listPlatformTemplates(organizationId: string, options?: RawAxiosRequestConfig): AxiosPromise<PlatformTemplateCatalogResponse> {
68265
- return localVarFp.listPlatformTemplates(organizationId, options).then((request) => request(axios, basePath));
68284
+ listPlatformTemplates(organizationId: string, clusterMode?: PlatformClusterMode, cloudProvider?: PlatformCloudVendor, options?: RawAxiosRequestConfig): AxiosPromise<PlatformTemplateCatalogResponse> {
68285
+ return localVarFp.listPlatformTemplates(organizationId, clusterMode, cloudProvider, options).then((request) => request(axios, basePath));
68266
68286
  },
68267
68287
  /**
68268
68288
  * Resolves the fields and runtime requirements to display for a component using the cluster context and the values currently entered in the Console. This operation is read-only.
@@ -68313,15 +68333,17 @@ export class PlatformConfigurationApi extends BaseAPI {
68313
68333
  }
68314
68334
 
68315
68335
  /**
68316
- * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render.
68336
+ * Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices for that cluster context.
68317
68337
  * @summary List platform templates
68318
68338
  * @param {string} organizationId Organization ID
68339
+ * @param {PlatformClusterMode} [clusterMode] Cluster management mode. Must be supplied together with cloudProvider.
68340
+ * @param {PlatformCloudVendor} [cloudProvider] Cluster cloud provider. Must be supplied together with clusterMode.
68319
68341
  * @param {*} [options] Override http request option.
68320
68342
  * @throws {RequiredError}
68321
68343
  * @memberof PlatformConfigurationApi
68322
68344
  */
68323
- public listPlatformTemplates(organizationId: string, options?: RawAxiosRequestConfig) {
68324
- return PlatformConfigurationApiFp(this.configuration).listPlatformTemplates(organizationId, options).then((request) => request(this.axios, this.basePath));
68345
+ public listPlatformTemplates(organizationId: string, clusterMode?: PlatformClusterMode, cloudProvider?: PlatformCloudVendor, options?: RawAxiosRequestConfig) {
68346
+ return PlatformConfigurationApiFp(this.configuration).listPlatformTemplates(organizationId, clusterMode, cloudProvider, options).then((request) => request(this.axios, this.basePath));
68325
68347
  }
68326
68348
 
68327
68349
  /**