@relevanceai/sdk 1.40.0 → 1.41.0

package/dist-cjs/generated/DiscoveryApi.js

@@ -62,6 +62,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async CreateProject(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/projects/create',
+            options
+        });
+    }
     async UpdateProject(input, options) {
         return this.SendRequest({
             input,
@@ -814,6 +822,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async UpsertWorkflowStatus(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/workflows/{workflow_id}/status',
+            options
+        });
+    }
     async DeleteFieldChildren(input, options) {
         return this.SendRequest({
             input,
@@ -826,7 +842,7 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/field_children/{fieldchildren_id}/list',
+            path: '/datasets/{dataset_id}/field_children/list',
             options
         });
     }
@@ -850,7 +866,7 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/workflows/favourites/{favouriteworkflow_id}/list',
+            path: '/workflows/favourites/list',
             options
         });
     }

package/dist-es/generated/DiscoveryApi.js

@@ -150,6 +150,18 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
             });
         });
     };
+    DiscoveryApiClient.prototype.CreateProject = function (input, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.SendRequest({
+                        input: input,
+                        method: 'post',
+                        path: '/projects/create',
+                        options: options
+                    })];
+            });
+        });
+    };
     DiscoveryApiClient.prototype.UpdateProject = function (input, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -1278,6 +1290,18 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
             });
         });
     };
+    DiscoveryApiClient.prototype.UpsertWorkflowStatus = function (input, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.SendRequest({
+                        input: input,
+                        method: 'post',
+                        path: '/workflows/{workflow_id}/status',
+                        options: options
+                    })];
+            });
+        });
+    };
     DiscoveryApiClient.prototype.DeleteFieldChildren = function (input, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -1296,7 +1320,7 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
                 return [2 /*return*/, this.SendRequest({
                         input: input,
                         method: 'post',
-                        path: '/datasets/{dataset_id}/field_children/{fieldchildren_id}/list',
+                        path: '/datasets/{dataset_id}/field_children/list',
                         options: options
                     })];
             });
@@ -1332,7 +1356,7 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
                 return [2 /*return*/, this.SendRequest({
                         input: input,
                         method: 'post',
-                        path: '/workflows/favourites/{favouriteworkflow_id}/list',
+                        path: '/workflows/favourites/list',
                         options: options
                     })];
             });

package/dist-types/generated/DiscoveryApi.d.ts

@@ -14,6 +14,8 @@ export declare type DeleteDeployableKeyInput = operations['DeleteDeployableKey']
 export declare type DeleteDeployableKeyOutput = operations['DeleteDeployableKey']['responses']['200']['content']['application/json'];
 export declare type ListDeployablesInput = {};
 export declare type ListDeployablesOutput = operations['ListDeployables']['responses']['200']['content']['application/json'];
+export declare type CreateProjectInput = operations['CreateProject']['requestBody']['content']['application/json'];
+export declare type CreateProjectOutput = operations['CreateProject']['responses']['200']['content']['application/json'];
 export declare type UpdateProjectInput = operations['UpdateProject']['requestBody']['content']['application/json'];
 export declare type UpdateProjectOutput = operations['UpdateProject']['responses']['200']['content']['application/json'];
 export declare type TransferProjectToOrganizationInput = operations['TransferProjectToOrganization']['requestBody']['content']['application/json'];
@@ -202,6 +204,8 @@ export declare type DeleteWorkflowStatusInput = operations['DeleteWorkflowStatus
 export declare type DeleteWorkflowStatusOutput = operations['DeleteWorkflowStatus']['responses']['200']['content']['application/json'];
 export declare type UpsertWorkflowMetadataInput = operations['UpsertWorkflowMetadata']['requestBody']['content']['application/json'];
 export declare type UpsertWorkflowMetadataOutput = operations['UpsertWorkflowMetadata']['responses']['200']['content']['application/json'];
+export declare type UpsertWorkflowStatusInput = operations['UpsertWorkflowStatus']['requestBody']['content']['application/json'];
+export declare type UpsertWorkflowStatusOutput = operations['UpsertWorkflowStatus']['responses']['200']['content']['application/json'];
 export declare type DeleteFieldChildrenInput = operations['DeleteFieldChildren']['requestBody']['content']['application/json'];
 export declare type DeleteFieldChildrenOutput = operations['DeleteFieldChildren']['responses']['200']['content']['application/json'];
 export declare type ListFieldChildrensInput = operations['ListFieldChildrens']['requestBody']['content']['application/json'];
@@ -223,6 +227,7 @@ export declare class DiscoveryApiClient extends _GenericClient {
     CreateDeployableKey(input: CommandInput<CreateDeployableKeyInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateDeployableKeyOutput>>;
     DeleteDeployableKey(input: CommandInput<DeleteDeployableKeyInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteDeployableKeyOutput>>;
     ListDeployables(input: CommandInput<ListDeployablesInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListDeployablesOutput>>;
+    CreateProject(input: CommandInput<CreateProjectInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateProjectOutput>>;
     UpdateProject(input: CommandInput<UpdateProjectInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpdateProjectOutput>>;
     TransferProjectToOrganization(input: CommandInput<TransferProjectToOrganizationInput>, options?: _GenericMethodOptions): Promise<CommandOutput<TransferProjectToOrganizationOutput>>;
     ListProjects(input: CommandInput<ListProjectsInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListProjectsOutput>>;
@@ -317,6 +322,7 @@ export declare class DiscoveryApiClient extends _GenericClient {
     GetWorkflowStatus(input: CommandInput<GetWorkflowStatusInput>, options?: _GenericMethodOptions): Promise<CommandOutput<GetWorkflowStatusOutput>>;
     DeleteWorkflowStatus(input: CommandInput<DeleteWorkflowStatusInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteWorkflowStatusOutput>>;
     UpsertWorkflowMetadata(input: CommandInput<UpsertWorkflowMetadataInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpsertWorkflowMetadataOutput>>;
+    UpsertWorkflowStatus(input: CommandInput<UpsertWorkflowStatusInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpsertWorkflowStatusOutput>>;
     DeleteFieldChildren(input: CommandInput<DeleteFieldChildrenInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteFieldChildrenOutput>>;
     ListFieldChildrens(input: CommandInput<ListFieldChildrensInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListFieldChildrensOutput>>;
     UpdateFieldChildren(input: CommandInput<UpdateFieldChildrenInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpdateFieldChildrenOutput>>;

package/dist-types/generated/_DiscoveryApiSchemaTypes.d.ts

@@ -33,6 +33,10 @@ export interface paths {
         /** List all deployables. */
         get: operations["ListDeployables"];
     };
+    "/projects/create": {
+        /** Create a new Project that your user will have access to */
+        post: operations["CreateProject"];
+    };
     "/projects/update": {
         /** Update metadata of a Project */
         post: operations["UpdateProject"];
@@ -530,10 +534,14 @@ export interface paths {
         /** Update metadata for a workflow run */
         post: operations["UpsertWorkflowMetadata"];
     };
+    "/workflows/{workflow_id}/status": {
+        /** Update status for a workflow run */
+        post: operations["UpsertWorkflowStatus"];
+    };
     "/datasets/{dataset_id}/field_children/{fieldchildren_id}/delete": {
         post: operations["DeleteFieldChildren"];
     };
-    "/datasets/{dataset_id}/field_children/{fieldchildren_id}/list": {
+    "/datasets/{dataset_id}/field_children/list": {
         post: operations["ListFieldChildrens"];
     };
     "/datasets/{dataset_id}/field_children/{fieldchildren_id}/update": {
@@ -542,7 +550,7 @@ export interface paths {
     "/workflows/favourites/{favouriteworkflow_id}/delete": {
         post: operations["DeleteFavouriteWorkflow"];
     };
-    "/workflows/favourites/{favouriteworkflow_id}/list": {
+    "/workflows/favourites/list": {
         post: operations["ListFavouriteWorkflows"];
     };
     "/workflows/favourites/{favouriteworkflow_id}/update": {
@@ -632,6 +640,15 @@ export interface components {
             }[];
             count: number;
         };
+        CreateProjectInput: {
+            /** @description The name of the project */
+            name?: string;
+            /** @description The description of the project */
+            description?: string;
+        };
+        CreateProjectOutput: {
+            project_id: string;
+        };
         UpdateProjectInput: {
             /** @description The name of the project */
             name?: string;
@@ -690,6 +707,8 @@ export interface components {
             last_name?: string;
             role?: string;
             company?: string;
+            label?: string;
+            notes?: string;
             permissions?: components["schemas"]["permissions"];
             organization_permissions?: {
                 [key: string]: components["schemas"]["permissions"];
@@ -710,6 +729,29 @@ export interface components {
             page?: number;
             /** @default 20 */
             page_size?: number;
+            required_permissions?: {
+                items: {
+                    [key: string]: {
+                        resources?: {
+                            datasets?: {
+                                [key: string]: boolean;
+                            };
+                            deployables?: {
+                                [key: string]: boolean;
+                            };
+                            users?: {
+                                [key: string]: boolean;
+                            };
+                            workflows?: {
+                                [key: string]: boolean;
+                            };
+                        };
+                        actions?: {
+                            [key: string]: boolean;
+                        };
+                    };
+                };
+            };
         };
         ListUsersOutput: {
             results: {
@@ -719,6 +761,8 @@ export interface components {
                 last_name?: string;
                 role?: string;
                 company?: string;
+                label?: string;
+                notes?: string;
                 permissions: {
                     projects: {
                         [key: string]: {
@@ -847,6 +891,8 @@ export interface components {
             last_name?: string;
             role?: string;
             company?: string;
+            label?: string;
+            notes?: string;
             user_id: string;
             key_id: string;
             permissions: components["schemas"]["fullUserPermissions"];
@@ -949,6 +995,8 @@ export interface components {
             last_name?: string;
             role?: string;
             company?: string;
+            label?: string;
+            notes?: string;
             permissions: {
                 projects: {
                     [key: string]: {
@@ -1013,6 +1061,8 @@ export interface components {
             last_name?: string;
             role?: string;
             company?: string;
+            label?: string;
+            notes?: string;
             permissions?: components["schemas"]["permissions"];
             organization_permissions?: {
                 [key: string]: components["schemas"]["permissions"];
@@ -3828,6 +3878,8 @@ export interface components {
                 last_name?: string;
                 role?: string;
                 company?: string;
+                label?: string;
+                notes?: string;
             }[];
         };
         ListProjectsInOrganizationInput: unknown;
@@ -7338,17 +7390,20 @@ export interface components {
             };
             notebook_path: string;
             instance_type?: string;
+            dataset_id?: string;
         };
         TriggerWorkflowOutput: {
             job_id: string;
         };
         ListWorkflowsInput: unknown;
         ListWorkflowsOutput: {
-            results: {
+            results: ({
                 job_status: "InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped";
                 job_message: string;
                 creation_time: string;
                 notebook_path?: string;
+                dataset_id?: string;
+                status?: string;
                 params?: {
                     [key: string]: unknown;
                 };
@@ -7356,7 +7411,9 @@ export interface components {
                 metadata?: {
                     [key: string]: unknown;
                 };
-            }[];
+            } & {
+                [key: string]: unknown;
+            })[];
         };
         GetWorkflowStatusInput: unknown;
         GetWorkflowStatusOutput: {
@@ -7364,6 +7421,8 @@ export interface components {
             job_message: string;
             creation_time: string;
             notebook_path?: string;
+            dataset_id?: string;
+            status?: string;
             params?: {
                 [key: string]: unknown;
             };
@@ -7371,6 +7430,8 @@ export interface components {
             metadata?: {
                 [key: string]: unknown;
             };
+        } & {
+            [key: string]: unknown;
         };
         DeleteWorkflowStatusInput: unknown;
         DeleteWorkflowStatusOutput: unknown;
@@ -7381,6 +7442,19 @@ export interface components {
             };
         };
         UpsertWorkflowMetadataOutput: unknown;
+        UpsertWorkflowStatusInput: {
+            /** @description Metadata of the workflow. Can be an object including any information you want to store. */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /** @description Status of the workflow. Used for knowing when to send an email notification. */
+            status: "complete" | "inprogress" | "failed";
+            /** @description Workflow name that is passed into the email. */
+            workflow_name?: string;
+            /** @description Additional information of the workflow that is passed into the email. */
+            additional_information?: string;
+        };
+        UpsertWorkflowStatusOutput: unknown;
         DeleteFieldChildrenInput: unknown;
         DeleteFieldChildrenOutput: unknown;
         ListFieldChildrensInput: {
@@ -7559,6 +7633,23 @@ export interface operations {
             };
         };
     };
+    /** Create a new Project that your user will have access to */
+    CreateProject: {
+        parameters: {};
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["CreateProjectOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateProjectInput"];
+            };
+        };
+    };
     /** Update metadata of a Project */
     UpdateProject: {
         parameters: {};
@@ -9795,6 +9886,28 @@ export interface operations {
             };
         };
     };
+    /** Update status for a workflow run */
+    UpsertWorkflowStatus: {
+        parameters: {
+            path: {
+                /** ID of workflow */
+                workflow_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["UpsertWorkflowStatusOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpsertWorkflowStatusInput"];
+            };
+        };
+    };
     DeleteFieldChildren: {
         parameters: {
             path: {
@@ -9823,8 +9936,6 @@ export interface operations {
             path: {
                 /** ID of dataset */
                 dataset_id: string;
-                /** ID of fieldchildren */
-                fieldchildren_id: string;
             };
         };
         responses: {
@@ -9886,12 +9997,7 @@ export interface operations {
         };
     };
     ListFavouriteWorkflows: {
-        parameters: {
-            path: {
-                /** ID of favouriteworkflow */
-                favouriteworkflow_id: string;
-            };
-        };
+        parameters: {};
         responses: {
             /** successful operation */
             200: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relevanceai/sdk",
-  "version": "1.40.0",
+  "version": "1.41.0",
   "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",