@rhoas/kafka-management-sdk - npm Package Compare versions

Comparing version 0.30.0 to 0.31.0-alpha1

dist/errors.d.ts

@@ -87,4 +87,2 @@ /**
     ERROR_113: string;
-    /** Max limit for the service account creation has reached*/
-    ERROR_115: string;
     /** Insufficient quota*/
@@ -91,0 +89,0 @@ ERROR_120: string;

dist/errors.js

@@ -90,4 +90,2 @@ "use strict";
     ERROR_113: "KAFKAS-MGMT-113",
-    /** Max limit for the service account creation has reached*/
-    ERROR_115: "KAFKAS-MGMT-115",
     /** Insufficient quota*/
@@ -94,0 +92,0 @@ ERROR_120: "KAFKAS-MGMT-120",

dist/generated/api/default-api.d.ts

@@ -23,2 +23,3 @@ /**
 import { MetricsRangeQueryList } from '../model';
+import { SupportedKafkaInstanceTypesList } from '../model';
 import { VersionMetadata } from '../model';
@@ -62,3 +63,3 @@ /**
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -79,2 +80,11 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstanceTypesByCloudProviderAndRegion: (cloudProvider: string, cloudRegion: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -171,3 +181,3 @@ * @param {string} id The ID of record
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -188,2 +198,11 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstanceTypesByCloudProviderAndRegion(cloudProvider: string, cloudRegion: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SupportedKafkaInstanceTypesList>>;
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -280,3 +299,3 @@ * @param {string} id The ID of record
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -297,2 +316,11 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstanceTypesByCloudProviderAndRegion(cloudProvider: string, cloudRegion: string, options?: any): AxiosPromise<SupportedKafkaInstanceTypesList>;
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -393,3 +421,3 @@ * @param {string} id The ID of record
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -412,2 +440,12 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getInstanceTypesByCloudProviderAndRegion(cloudProvider: string, cloudRegion: string, options?: AxiosRequestConfig): AxiosPromise<SupportedKafkaInstanceTypesList>;
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -515,3 +553,3 @@ * @param {string} id The ID of record
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -534,2 +572,12 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getInstanceTypesByCloudProviderAndRegion(cloudProvider: string, cloudRegion: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../model").SupportedKafkaInstanceTypesListAllOf, any>>;
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -536,0 +584,0 @@ * @param {string} id The ID of record

dist/generated/api/default-api.js

@@ -153,3 +153,3 @@ "use strict";
          * @param {string} [size] Number of items in each page
-         * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+         * @param {string} [instanceType] The Kafka instance type to filter the results by
          * @param {*} [options] Override http request option.
@@ -230,2 +230,38 @@ * @throws {RequiredError}
          *
+         * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+         * @param {string} cloudProvider ID of the supported cloud provider
+         * @param {string} cloudRegion Name of the supported cloud provider region
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInstanceTypesByCloudProviderAndRegion: (cloudProvider, cloudRegion, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'cloudProvider' is not null or undefined
+            (0, common_1.assertParamExists)('getInstanceTypesByCloudProviderAndRegion', 'cloudProvider', cloudProvider);
+            // verify required parameter 'cloudRegion' is not null or undefined
+            (0, common_1.assertParamExists)('getInstanceTypesByCloudProviderAndRegion', 'cloudRegion', cloudRegion);
+            const localVarPath = `/api/kafkas_mgmt/v1/instance_types/{cloud_provider}/{cloud_region}`
+                .replace(`{${"cloud_provider"}}`, encodeURIComponent(String(cloudProvider)))
+                .replace(`{${"cloud_region"}}`, encodeURIComponent(String(cloudRegion)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Bearer required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
          * @summary Returns a Kafka request by ID
@@ -508,3 +544,3 @@ * @param {string} id The ID of record
          * @param {string} [size] Number of items in each page
-         * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+         * @param {string} [instanceType] The Kafka instance type to filter the results by
          * @param {*} [options] Override http request option.
@@ -535,2 +571,16 @@ * @throws {RequiredError}
          *
+         * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+         * @param {string} cloudProvider ID of the supported cloud provider
+         * @param {string} cloudRegion Name of the supported cloud provider region
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
          * @summary Returns a Kafka request by ID
@@ -667,3 +717,3 @@ * @param {string} id The ID of record
          * @param {string} [size] Number of items in each page
-         * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+         * @param {string} [instanceType] The Kafka instance type to filter the results by
          * @param {*} [options] Override http request option.
@@ -688,2 +738,13 @@ * @throws {RequiredError}
          *
+         * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+         * @param {string} cloudProvider ID of the supported cloud provider
+         * @param {string} cloudRegion Name of the supported cloud provider region
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options) {
+            return localVarFp.getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
          * @summary Returns a Kafka request by ID
@@ -805,3 +866,3 @@ * @param {string} id The ID of record
      * @param {string} [size] Number of items in each page
-     * @param {string} [instanceType] The Kafka instance type to filter the results by  DEPRECATION NOTICE - instance_type will be deprecated
+     * @param {string} [instanceType] The Kafka instance type to filter the results by
      * @param {*} [options] Override http request option.
@@ -828,2 +889,14 @@ * @throws {RequiredError}
      *
+     * @summary Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
+     * @param {string} cloudProvider ID of the supported cloud provider
+     * @param {string} cloudRegion Name of the supported cloud provider region
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).getInstanceTypesByCloudProviderAndRegion(cloudProvider, cloudRegion, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
      * @summary Returns a Kafka request by ID
@@ -830,0 +903,0 @@ * @param {string} id The ID of record

dist/generated/model/cloud-region.d.ts

@@ -44,6 +44,5 @@ /**
     /**
-     * The Kafka instance types supported by this region.  DEPRECATION NOTICE - instance_type will be deprecated
+     * The Kafka instance types supported by this region.
      * @type {Array<string>}
      * @memberof CloudRegion
-     * @deprecated
      */
@@ -50,0 +49,0 @@ 'supported_instance_types': Array<string>;

dist/generated/model/index.d.ts

@@ -33,4 +33,9 @@ export * from './cloud-provider';
 export * from './service-account-request';
+export * from './supported-kafka-instance-type';
+export * from './supported-kafka-instance-types-list';
+export * from './supported-kafka-instance-types-list-all-of';
+export * from './supported-kafka-size';
+export * from './supported-kafka-size-bytes-value-item';
 export * from './values';
 export * from './version-metadata';
 export * from './version-metadata-all-of';

dist/generated/model/index.js

@@ -49,4 +49,9 @@ "use strict";
 __exportStar(require("./service-account-request"), exports);
+__exportStar(require("./supported-kafka-instance-type"), exports);
+__exportStar(require("./supported-kafka-instance-types-list"), exports);
+__exportStar(require("./supported-kafka-instance-types-list-all-of"), exports);
+__exportStar(require("./supported-kafka-size"), exports);
+__exportStar(require("./supported-kafka-size-bytes-value-item"), exports);
 __exportStar(require("./values"), exports);
 __exportStar(require("./version-metadata"), exports);
 __exportStar(require("./version-metadata-all-of"), exports);

dist/generated/model/kafka-request-all-of.d.ts

@@ -92,2 +92,8 @@ /**
      *
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'instance_type_name'?: string;
+    /**
+     *
      * @type {boolean}
@@ -103,2 +109,44 @@ * @memberof KafkaRequestAllOf
     'kafka_storage_size'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'size_id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'ingress_throughput_per_sec'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'egress_throughput_per_sec'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'total_max_connections'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_partitions'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_data_retention_period'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_connection_attempts_per_sec'?: number;
 }

dist/generated/model/kafka-request-payload.d.ts

@@ -48,2 +48,8 @@ /**
     'reauthentication_enabled'?: boolean | null;
+    /**
+     * kafka plan in a format of <instance_type>.<size_id>
+     * @type {string}
+     * @memberof KafkaRequestPayload
+     */
+    'plan'?: string;
 }

dist/generated/model/region-capacity-list-item.d.ts

@@ -23,3 +23,3 @@ /**
      */
-    'instance_type'?: string;
+    'instance_type': string;
     /**
@@ -29,4 +29,11 @@ * flag indicating whether the capacity for the instance type in the region is reached
      * @memberof RegionCapacityListItem
+     * @deprecated
      */
     'max_capacity_reached': boolean;
+    /**
+     * list of available Kafka instance sizes that can be created in this region when taking account current capacity and regional limits
+     * @type {Array<string>}
+     * @memberof RegionCapacityListItem
+     */
+    'available_sizes': Array<string>;
 }

package.json

 {
   "name": "@rhoas/kafka-management-sdk",
-  "version": "0.30.0",
+  "version": "0.31.0-alpha1",
   "description": "RHOAS Kafka Management SDK",
@@ -31,4 +31,4 @@ "author": "Red Hat Developers",
     "@types/node": "16.11.26",
-    "typescript": "4.6.3"
+    "typescript": "4.6.2"
   }
 }

src/errors.ts

@@ -124,5 +124,2 @@
 
-  /** Max limit for the service account creation has reached*/
-  ERROR_115 : "KAFKAS-MGMT-115", 
-
   /** Insufficient quota*/
@@ -129,0 +126,0 @@ ERROR_120 : "KAFKAS-MGMT-120",

src/generated/model/cloud-region.ts

@@ -49,6 +49,5 @@ /* tslint:disable */
     /**
-     * The Kafka instance types supported by this region.  DEPRECATION NOTICE - instance_type will be deprecated
+     * The Kafka instance types supported by this region.
      * @type {Array<string>}
      * @memberof CloudRegion
-     * @deprecated
      */
@@ -55,0 +54,0 @@ 'supported_instance_types': Array<string>;

src/generated/model/index.ts

@@ -33,4 +33,9 @@ export * from './cloud-provider';
 export * from './service-account-request';
+export * from './supported-kafka-instance-type';
+export * from './supported-kafka-instance-types-list';
+export * from './supported-kafka-instance-types-list-all-of';
+export * from './supported-kafka-size';
+export * from './supported-kafka-size-bytes-value-item';
 export * from './values';
 export * from './version-metadata';
 export * from './version-metadata-all-of';

src/generated/model/kafka-request-all-of.ts

@@ -97,2 +97,8 @@ /* tslint:disable */
      * 
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'instance_type_name'?: string;
+    /**
+     * 
      * @type {boolean}
@@ -108,3 +114,45 @@ * @memberof KafkaRequestAllOf
     'kafka_storage_size'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'size_id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'ingress_throughput_per_sec'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'egress_throughput_per_sec'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'total_max_connections'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_partitions'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_data_retention_period'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof KafkaRequestAllOf
+     */
+    'max_connection_attempts_per_sec'?: number;
 }
 

src/generated/model/kafka-request-payload.ts

@@ -53,3 +53,9 @@ /* tslint:disable */
     'reauthentication_enabled'?: boolean | null;
+    /**
+     * kafka plan in a format of <instance_type>.<size_id>
+     * @type {string}
+     * @memberof KafkaRequestPayload
+     */
+    'plan'?: string;
 }
 

src/generated/model/region-capacity-list-item.ts

@@ -28,3 +28,3 @@ /* tslint:disable */
      */
-    'instance_type'?: string;
+    'instance_type': string;
     /**
@@ -34,5 +34,12 @@ * flag indicating whether the capacity for the instance type in the region is reached
      * @memberof RegionCapacityListItem
+     * @deprecated
      */
     'max_capacity_reached': boolean;
+    /**
+     * list of available Kafka instance sizes that can be created in this region when taking account current capacity and regional limits
+     * @type {Array<string>}
+     * @memberof RegionCapacityListItem
+     */
+    'available_sizes': Array<string>;
 }
 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

373412

increased by8.25%

Number of package files

159

increased by10.42%

Lines of code

9178

increased by9.33%

No dependency changes