@mlhub/deployments-ts-sdk 0.8.0 → 0.9.0

package/.openapi-generator/FILES

@@ -25,6 +25,7 @@ src/models/Platform.ts
 src/models/ReplicaGroup.ts
 src/models/ResourceRequirements.ts
 src/models/RestApi.ts
+src/models/Scope.ts
 src/models/ServerErrorResponse.ts
 src/models/State.ts
 src/models/Strategy.ts

package/README.md

@@ -1,4 +1,4 @@
-## @mlhub/deployments-ts-sdk@0.8.0
+## @mlhub/deployments-ts-sdk@0.9.0
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @mlhub/deployments-ts-sdk@0.8.0 --save
+npm install @mlhub/deployments-ts-sdk@0.9.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/DeploymentsApi.d.ts

@@ -14,10 +14,12 @@ import { DeployModelWithStrategyBody, ModelDeploymentResponse, Platform } from '
 export interface DeployModelWithStrategyRequest {
     platform: Platform;
     strategyName: string;
-    scope: DeployModelWithStrategyScopeEnum;
+    name: string;
+    description: string | null;
     modelName: string;
     modelAuthor: string;
     params: any;
+    scope: DeployModelWithStrategyScopeEnum;
     deployModelWithStrategyBody: DeployModelWithStrategyBody;
 }
 export interface StartModelDeploymentRequest {

package/dist/apis/DeploymentsApi.js

@@ -90,8 +90,11 @@ var DeploymentsApi = /** @class */ (function (_super) {
                         if (requestParameters.strategyName === null || requestParameters.strategyName === undefined) {
                             throw new runtime.RequiredError('strategyName', 'Required parameter requestParameters.strategyName was null or undefined when calling deployModelWithStrategy.');
                         }
-                        if (requestParameters.scope === null || requestParameters.scope === undefined) {
-                            throw new runtime.RequiredError('scope', 'Required parameter requestParameters.scope was null or undefined when calling deployModelWithStrategy.');
+                        if (requestParameters.name === null || requestParameters.name === undefined) {
+                            throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling deployModelWithStrategy.');
+                        }
+                        if (requestParameters.description === null || requestParameters.description === undefined) {
+                            throw new runtime.RequiredError('description', 'Required parameter requestParameters.description was null or undefined when calling deployModelWithStrategy.');
                         }
                         if (requestParameters.modelName === null || requestParameters.modelName === undefined) {
                             throw new runtime.RequiredError('modelName', 'Required parameter requestParameters.modelName was null or undefined when calling deployModelWithStrategy.');
@@ -102,17 +105,17 @@ var DeploymentsApi = /** @class */ (function (_super) {
                         if (requestParameters.params === null || requestParameters.params === undefined) {
                             throw new runtime.RequiredError('params', 'Required parameter requestParameters.params was null or undefined when calling deployModelWithStrategy.');
                         }
+                        if (requestParameters.scope === null || requestParameters.scope === undefined) {
+                            throw new runtime.RequiredError('scope', 'Required parameter requestParameters.scope was null or undefined when calling deployModelWithStrategy.');
+                        }
                         if (requestParameters.deployModelWithStrategyBody === null || requestParameters.deployModelWithStrategyBody === undefined) {
                             throw new runtime.RequiredError('deployModelWithStrategyBody', 'Required parameter requestParameters.deployModelWithStrategyBody was null or undefined when calling deployModelWithStrategy.');
                         }
                         queryParameters = {};
-                        if (requestParameters.scope !== undefined) {
-                            queryParameters['scope'] = requestParameters.scope;
-                        }
                         headerParameters = {};
                         headerParameters['Content-Type'] = 'application/json';
                         return [4 /*yield*/, this.request({
-                                path: "/deployments-api/platforms/{platform}/strategies/{strategy_name}".replace("{".concat("platform", "}"), encodeURIComponent(String(requestParameters.platform))).replace("{".concat("strategy_name", "}"), encodeURIComponent(String(requestParameters.strategyName))).replace("{".concat("model_name", "}"), encodeURIComponent(String(requestParameters.modelName))).replace("{".concat("model_author", "}"), encodeURIComponent(String(requestParameters.modelAuthor))).replace("{".concat("params", "}"), encodeURIComponent(String(requestParameters.params))),
+                                path: "/deployments-api/platforms/{platform}/strategies/{strategy_name}".replace("{".concat("platform", "}"), encodeURIComponent(String(requestParameters.platform))).replace("{".concat("strategy_name", "}"), encodeURIComponent(String(requestParameters.strategyName))).replace("{".concat("name", "}"), encodeURIComponent(String(requestParameters.name))).replace("{".concat("description", "}"), encodeURIComponent(String(requestParameters.description))).replace("{".concat("model_name", "}"), encodeURIComponent(String(requestParameters.modelName))).replace("{".concat("model_author", "}"), encodeURIComponent(String(requestParameters.modelAuthor))).replace("{".concat("params", "}"), encodeURIComponent(String(requestParameters.params))).replace("{".concat("scope", "}"), encodeURIComponent(String(requestParameters.scope))),
                                 method: 'POST',
                                 headers: headerParameters,
                                 query: queryParameters,

package/dist/models/DeployModelWithStrategyBody.d.ts

@@ -9,12 +9,19 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { Scope } from './';
 /**
  *
  * @export
  * @interface DeployModelWithStrategyBody
  */
 export interface DeployModelWithStrategyBody {
+    /**
+     *
+     * @type {string}
+     * @memberof DeployModelWithStrategyBody
+     */
+    description?: string | null;
     /**
      *
      * @type {string}
@@ -27,12 +34,24 @@ export interface DeployModelWithStrategyBody {
      * @memberof DeployModelWithStrategyBody
      */
     model_name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DeployModelWithStrategyBody
+     */
+    name: string;
     /**
      *
      * @type {any}
      * @memberof DeployModelWithStrategyBody
      */
     params: any | null;
+    /**
+     * Selector for global vs tenant-scoped models
+     * @type {Scope}
+     * @memberof DeployModelWithStrategyBody
+     */
+    scope?: Scope | null;
 }
 export declare function DeployModelWithStrategyBodyFromJSON(json: any): DeployModelWithStrategyBody;
 export declare function DeployModelWithStrategyBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeployModelWithStrategyBody;

package/dist/models/DeployModelWithStrategyBody.js

@@ -16,6 +16,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeployModelWithStrategyBodyFromJSON = DeployModelWithStrategyBodyFromJSON;
 exports.DeployModelWithStrategyBodyFromJSONTyped = DeployModelWithStrategyBodyFromJSONTyped;
 exports.DeployModelWithStrategyBodyToJSON = DeployModelWithStrategyBodyToJSON;
+var runtime_1 = require("../runtime");
+var _1 = require("./");
 function DeployModelWithStrategyBodyFromJSON(json) {
     return DeployModelWithStrategyBodyFromJSONTyped(json, false);
 }
@@ -24,9 +26,12 @@ function DeployModelWithStrategyBodyFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'model_author': json['model_author'],
         'model_name': json['model_name'],
+        'name': json['name'],
         'params': json['params'],
+        'scope': !(0, runtime_1.exists)(json, 'scope') ? undefined : (0, _1.ScopeFromJSON)(json['scope']),
     };
 }
 function DeployModelWithStrategyBodyToJSON(value) {
@@ -37,8 +42,11 @@ function DeployModelWithStrategyBodyToJSON(value) {
         return null;
     }
     return {
+        'description': value.description,
         'model_author': value.model_author,
         'model_name': value.model_name,
+        'name': value.name,
         'params': value.params,
+        'scope': (0, _1.ScopeToJSON)(value.scope),
     };
 }

package/dist/models/ModelDeployment.d.ts

@@ -34,6 +34,12 @@ export interface ModelDeployment {
      * @memberof ModelDeployment
      */
     deployment_strategy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ModelDeployment
+     */
+    description?: string | null;
     /**
      *
      * @type {DesiredState}
@@ -84,6 +90,12 @@ export interface ModelDeployment {
      * @memberof ModelDeployment
      */
     model: ModelReference;
+    /**
+     *
+     * @type {string}
+     * @memberof ModelDeployment
+     */
+    name: string;
     /**
      *
      * @type {string}

package/dist/models/ModelDeployment.js

@@ -29,6 +29,7 @@ function ModelDeploymentFromJSONTyped(json, ignoreDiscriminator) {
         'created_at': json['created_at'],
         'deployment_interface': !(0, runtime_1.exists)(json, 'deployment_interface') ? undefined : (0, _1.ModelDeploymentInterfaceFromJSON)(json['deployment_interface']),
         'deployment_strategy': !(0, runtime_1.exists)(json, 'deployment_strategy') ? undefined : json['deployment_strategy'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
         'desired_state': (0, _1.DesiredStateFromJSON)(json['desired_state']),
         'id': json['id'],
         'last_desired_state_change': json['last_desired_state_change'],
@@ -37,6 +38,7 @@ function ModelDeploymentFromJSONTyped(json, ignoreDiscriminator) {
         'last_state_change': json['last_state_change'],
         'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : json['metadata'],
         'model': (0, _1.ModelReferenceFromJSON)(json['model']),
+        'name': json['name'],
         'owner': json['owner'],
         'platform': (0, _1.PlatformFromJSON)(json['platform']),
         'replicas': !(0, runtime_1.exists)(json, 'replicas') ? undefined : (0, _1.ReplicaGroupFromJSON)(json['replicas']),
@@ -56,6 +58,7 @@ function ModelDeploymentToJSON(value) {
         'created_at': value.created_at,
         'deployment_interface': (0, _1.ModelDeploymentInterfaceToJSON)(value.deployment_interface),
         'deployment_strategy': value.deployment_strategy,
+        'description': value.description,
         'desired_state': (0, _1.DesiredStateToJSON)(value.desired_state),
         'id': value.id,
         'last_desired_state_change': value.last_desired_state_change,
@@ -64,6 +67,7 @@ function ModelDeploymentToJSON(value) {
         'last_state_change': value.last_state_change,
         'metadata': value.metadata,
         'model': (0, _1.ModelReferenceToJSON)(value.model),
+        'name': value.name,
         'owner': value.owner,
         'platform': (0, _1.PlatformToJSON)(value.platform),
         'replicas': (0, _1.ReplicaGroupToJSON)(value.replicas),

package/dist/models/Scope.d.ts

@@ -0,0 +1,23 @@
+/**
+ * MLHub Deployments API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum Scope {
+    Tenant = "tenant",
+    Global = "global"
+}
+export declare function ScopeFromJSON(json: any): Scope;
+export declare function ScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Scope;
+export declare function ScopeToJSON(value?: Scope | null): any;

package/dist/models/Scope.js

@@ -0,0 +1,38 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Deployments API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scope = void 0;
+exports.ScopeFromJSON = ScopeFromJSON;
+exports.ScopeFromJSONTyped = ScopeFromJSONTyped;
+exports.ScopeToJSON = ScopeToJSON;
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var Scope;
+(function (Scope) {
+    Scope["Tenant"] = "tenant";
+    Scope["Global"] = "global";
+})(Scope || (exports.Scope = Scope = {}));
+function ScopeFromJSON(json) {
+    return ScopeFromJSONTyped(json, false);
+}
+function ScopeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ScopeToJSON(value) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -16,6 +16,7 @@ export * from './Platform';
 export * from './ReplicaGroup';
 export * from './ResourceRequirements';
 export * from './RestApi';
+export * from './Scope';
 export * from './ServerErrorResponse';
 export * from './State';
 export * from './Strategy';

package/dist/models/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./Platform"), exports);
 __exportStar(require("./ReplicaGroup"), exports);
 __exportStar(require("./ResourceRequirements"), exports);
 __exportStar(require("./RestApi"), exports);
+__exportStar(require("./Scope"), exports);
 __exportStar(require("./ServerErrorResponse"), exports);
 __exportStar(require("./State"), exports);
 __exportStar(require("./Strategy"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlhub/deployments-ts-sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "OpenAPI client for @mlhub/deployments-ts-sdk",
   "author": "OpenAPI-Generator",
   "main": "./dist/index.js",

package/src/apis/DeploymentsApi.ts

@@ -38,10 +38,12 @@ import {
 export interface DeployModelWithStrategyRequest {
     platform: Platform;
     strategyName: string;
-    scope: DeployModelWithStrategyScopeEnum;
+    name: string;
+    description: string | null;
     modelName: string;
     modelAuthor: string;
     params: any;
+    scope: DeployModelWithStrategyScopeEnum;
     deployModelWithStrategyBody: DeployModelWithStrategyBody;
 }
 
@@ -74,8 +76,12 @@ export class DeploymentsApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('strategyName','Required parameter requestParameters.strategyName was null or undefined when calling deployModelWithStrategy.');
         }
 
-        if (requestParameters.scope === null || requestParameters.scope === undefined) {
-            throw new runtime.RequiredError('scope','Required parameter requestParameters.scope was null or undefined when calling deployModelWithStrategy.');
+        if (requestParameters.name === null || requestParameters.name === undefined) {
+            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling deployModelWithStrategy.');
+        }
+
+        if (requestParameters.description === null || requestParameters.description === undefined) {
+            throw new runtime.RequiredError('description','Required parameter requestParameters.description was null or undefined when calling deployModelWithStrategy.');
         }
 
         if (requestParameters.modelName === null || requestParameters.modelName === undefined) {
@@ -90,22 +96,22 @@ export class DeploymentsApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('params','Required parameter requestParameters.params was null or undefined when calling deployModelWithStrategy.');
         }
 
+        if (requestParameters.scope === null || requestParameters.scope === undefined) {
+            throw new runtime.RequiredError('scope','Required parameter requestParameters.scope was null or undefined when calling deployModelWithStrategy.');
+        }
+
         if (requestParameters.deployModelWithStrategyBody === null || requestParameters.deployModelWithStrategyBody === undefined) {
             throw new runtime.RequiredError('deployModelWithStrategyBody','Required parameter requestParameters.deployModelWithStrategyBody was null or undefined when calling deployModelWithStrategy.');
         }
 
         const queryParameters: any = {};
 
-        if (requestParameters.scope !== undefined) {
-            queryParameters['scope'] = requestParameters.scope;
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';
 
         const response = await this.request({
-            path: `/deployments-api/platforms/{platform}/strategies/{strategy_name}`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))).replace(`{${"strategy_name"}}`, encodeURIComponent(String(requestParameters.strategyName))).replace(`{${"model_name"}}`, encodeURIComponent(String(requestParameters.modelName))).replace(`{${"model_author"}}`, encodeURIComponent(String(requestParameters.modelAuthor))).replace(`{${"params"}}`, encodeURIComponent(String(requestParameters.params))),
+            path: `/deployments-api/platforms/{platform}/strategies/{strategy_name}`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))).replace(`{${"strategy_name"}}`, encodeURIComponent(String(requestParameters.strategyName))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))).replace(`{${"description"}}`, encodeURIComponent(String(requestParameters.description))).replace(`{${"model_name"}}`, encodeURIComponent(String(requestParameters.modelName))).replace(`{${"model_author"}}`, encodeURIComponent(String(requestParameters.modelAuthor))).replace(`{${"params"}}`, encodeURIComponent(String(requestParameters.params))).replace(`{${"scope"}}`, encodeURIComponent(String(requestParameters.scope))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,

package/src/models/DeployModelWithStrategyBody.ts

@@ -13,12 +13,25 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import {
+    Scope,
+    ScopeFromJSON,
+    ScopeFromJSONTyped,
+    ScopeToJSON,
+} from './';
+
 /**
  * 
  * @export
  * @interface DeployModelWithStrategyBody
  */
 export interface DeployModelWithStrategyBody {
+    /**
+     * 
+     * @type {string}
+     * @memberof DeployModelWithStrategyBody
+     */
+    description?: string | null;
     /**
      * 
      * @type {string}
@@ -31,12 +44,24 @@ export interface DeployModelWithStrategyBody {
      * @memberof DeployModelWithStrategyBody
      */
     model_name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeployModelWithStrategyBody
+     */
+    name: string;
     /**
      * 
      * @type {any}
      * @memberof DeployModelWithStrategyBody
      */
     params: any | null;
+    /**
+     * Selector for global vs tenant-scoped models
+     * @type {Scope}
+     * @memberof DeployModelWithStrategyBody
+     */
+    scope?: Scope | null;
 }
 
 export function DeployModelWithStrategyBodyFromJSON(json: any): DeployModelWithStrategyBody {
@@ -49,9 +74,12 @@ export function DeployModelWithStrategyBodyFromJSONTyped(json: any, ignoreDiscri
     }
     return {
         
+        'description': !exists(json, 'description') ? undefined : json['description'],
         'model_author': json['model_author'],
         'model_name': json['model_name'],
+        'name': json['name'],
         'params': json['params'],
+        'scope': !exists(json, 'scope') ? undefined : ScopeFromJSON(json['scope']),
     };
 }
 
@@ -64,9 +92,12 @@ export function DeployModelWithStrategyBodyToJSON(value?: DeployModelWithStrateg
     }
     return {
         
+        'description': value.description,
         'model_author': value.model_author,
         'model_name': value.model_name,
+        'name': value.name,
         'params': value.params,
+        'scope': ScopeToJSON(value.scope),
     };
 }
 

package/src/models/ModelDeployment.ts

@@ -68,6 +68,12 @@ export interface ModelDeployment {
      * @memberof ModelDeployment
      */
     deployment_strategy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelDeployment
+     */
+    description?: string | null;
     /**
      * 
      * @type {DesiredState}
@@ -116,6 +122,12 @@ export interface ModelDeployment {
      * @memberof ModelDeployment
      */
     model: ModelReference;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelDeployment
+     */
+    name: string;
     /**
      * 
      * @type {string}
@@ -167,6 +179,7 @@ export function ModelDeploymentFromJSONTyped(json: any, ignoreDiscriminator: boo
         'created_at': json['created_at'],
         'deployment_interface': !exists(json, 'deployment_interface') ? undefined : ModelDeploymentInterfaceFromJSON(json['deployment_interface']),
         'deployment_strategy': !exists(json, 'deployment_strategy') ? undefined : json['deployment_strategy'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
         'desired_state': DesiredStateFromJSON(json['desired_state']),
         'id': json['id'],
         'last_desired_state_change': json['last_desired_state_change'],
@@ -175,6 +188,7 @@ export function ModelDeploymentFromJSONTyped(json: any, ignoreDiscriminator: boo
         'last_state_change': json['last_state_change'],
         'metadata': !exists(json, 'metadata') ? undefined : json['metadata'],
         'model': ModelReferenceFromJSON(json['model']),
+        'name': json['name'],
         'owner': json['owner'],
         'platform': PlatformFromJSON(json['platform']),
         'replicas': !exists(json, 'replicas') ? undefined : ReplicaGroupFromJSON(json['replicas']),
@@ -196,6 +210,7 @@ export function ModelDeploymentToJSON(value?: ModelDeployment | null): any {
         'created_at': value.created_at,
         'deployment_interface': ModelDeploymentInterfaceToJSON(value.deployment_interface),
         'deployment_strategy': value.deployment_strategy,
+        'description': value.description,
         'desired_state': DesiredStateToJSON(value.desired_state),
         'id': value.id,
         'last_desired_state_change': value.last_desired_state_change,
@@ -204,6 +219,7 @@ export function ModelDeploymentToJSON(value?: ModelDeployment | null): any {
         'last_state_change': value.last_state_change,
         'metadata': value.metadata,
         'model': ModelReferenceToJSON(value.model),
+        'name': value.name,
         'owner': value.owner,
         'platform': PlatformToJSON(value.platform),
         'replicas': ReplicaGroupToJSON(value.replicas),

package/src/models/Scope.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Deployments API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+export enum Scope {
+    Tenant = 'tenant',
+    Global = 'global'
+}
+
+export function ScopeFromJSON(json: any): Scope {
+    return ScopeFromJSONTyped(json, false);
+}
+
+export function ScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Scope {
+    return json as Scope;
+}
+
+export function ScopeToJSON(value?: Scope | null): any {
+    return value as any;
+}
+

package/src/models/index.ts

@@ -18,6 +18,7 @@ export * from './Platform';
 export * from './ReplicaGroup';
 export * from './ResourceRequirements';
 export * from './RestApi';
+export * from './Scope';
 export * from './ServerErrorResponse';
 export * from './State';
 export * from './Strategy';