@lucidtech/las-sdk-core
Advanced tools
Comparing version 13.1.1 to 14.0.0
@@ -5,3 +5,3 @@ /// <reference types="node" /> | ||
import { Credentials } from './credentials'; | ||
import type { AppClient, AppClientList, Asset, AssetList, ContentType, CreateAppClientOptions, CreateAssetOptions, CreateDataBundleOptions, CreateDatasetOptions, CreateDocumentOptions, CreateModelOptions, CreatePaymentMethodOptions, CreatePredictionsOptions, CreateSecretOptions, CreateTrainingOption, CreateTransitionOptions, CreateUserOptions, CreateWorkflowOptions, DataBundle, DataBundleList, Dataset, DatasetList, DeleteAppClientOptions, DeleteAssetOptions, DeleteDataBundleOptions, DeleteDatasetOptions, DeleteDocumentOptions, DeleteDocumentsOptions, DeleteModelOptions, DeleteTransitionOptions, DeleteUserOptions, DeleteWorkflowExecution, DeleteWorkflowOptions, DeploymentEnvironment, DeploymentEnvironmentList, ExecuteTransitionOptions, ExecuteWorkflowOptions, FieldConfig, GetAssetOptions, GetDatasetOptions, GetDeploymentEnvironmentOptions, GetDocumentOptions, GetLogOptions, GetModelOptions, GetOrganizationOptions, GetTransitionExecutionOptions, GetTransitionOptions, GetUserOptions, GetWorkflowExecutionOptions, GetWorkflowOptions, LasDocument, LasDocumentList, LasDocumentWithoutContent, ListAppClientsOptions, ListAssetsOptions, ListDataBundleOptions, ListDatasetsOptions, ListDeploymentEnvironmentsOptions, ListDocumentsOptions, ListModelsOptions, ListPaymentMethodsOptions, ListPlansOptions, ListPredictionsOptions, ListSecretsOptions, ListTrainingsOptions, ListTransitionOptions, ListUsersOptions, ListWorkflowExecutionsOptions, ListWorkflowOptions, Log, Model, ModelList, Organization, PaymentMethod, PaymentMethodList, Plan, PlanList, PostHeartbeatOptions, PredictionList, PredictionResponse, Secret, SecretList, Training, Transition, TransitionExecution, TransitionExecutionList, TransitionExecutionListOptions, TransitionList, TransitionType, UpdateAppClientOptions, UpdateAssetOptions, UpdateDataBundleOptions, UpdateDatasetOptions, UpdateDocumentOptions, UpdateModelOptions, UpdateOrganizationOptions, UpdatePaymentMethodOptions, UpdateSecretOptions, UpdateTrainingOptions, UpdateTransitionExecution, UpdateTransitionOptions, UpdateUserOptions, UpdateWorkflowExecutionOptions, UpdateWorkflowOptions, User, UserList, Workflow, WorkflowExecution, WorkflowExecutionList, WorkflowList, WorkflowSpecification } from './types'; | ||
import type { AppClient, AppClientList, Asset, AssetList, ContentType, CreateAppClientOptions, CreateAssetOptions, CreateDataBundleOptions, CreateDatasetOptions, CreateDocumentOptions, CreateModelOptions, CreatePaymentMethodOptions, CreatePredictionsOptions, CreateSecretOptions, CreateTrainingOption, CreateTransitionOptions, CreateUserOptions, CreateWorkflowOptions, DataBundle, DataBundleList, Dataset, DatasetList, DeleteAppClientOptions, DeleteAssetOptions, DeleteDataBundleOptions, DeleteDatasetOptions, DeleteDocumentOptions, DeleteDocumentsOptions, DeleteModelOptions, DeleteTransitionOptions, DeleteUserOptions, DeleteWorkflowExecution, DeleteWorkflowOptions, DeploymentEnvironment, DeploymentEnvironmentList, ExecuteTransitionOptions, ExecuteWorkflowOptions, FieldConfig, GetAssetOptions, GetDatasetOptions, GetDeploymentEnvironmentOptions, GetDocumentOptions, GetLogOptions, GetModelOptions, GetOrganizationOptions, GetProfileOptions, GetTransitionExecutionOptions, GetTransitionOptions, GetUserOptions, GetWorkflowExecutionOptions, GetWorkflowOptions, LasDocument, LasDocumentList, LasDocumentWithoutContent, ListAppClientsOptions, ListAssetsOptions, ListDataBundleOptions, ListDatasetsOptions, ListDeploymentEnvironmentsOptions, ListDocumentsOptions, ListModelsOptions, ListPaymentMethodsOptions, ListPlansOptions, ListPredictionsOptions, ListSecretsOptions, ListTrainingsOptions, ListTransitionOptions, ListUsersOptions, ListWorkflowExecutionsOptions, ListWorkflowOptions, Log, Model, ModelList, Organization, PaymentMethod, PaymentMethodList, Plan, PlanList, PostHeartbeatOptions, PredictionList, PredictionResponse, PrivateProfile, PublicProfile, Secret, SecretList, Training, Transition, TransitionExecution, TransitionExecutionList, TransitionExecutionListOptions, TransitionList, TransitionType, UpdateAppClientOptions, UpdateAssetOptions, UpdateDataBundleOptions, UpdateDatasetOptions, UpdateDocumentOptions, UpdateModelOptions, UpdateOrganizationOptions, UpdatePaymentMethodOptions, UpdateProfileOptions, UpdateSecretOptions, UpdateTrainingOptions, UpdateTransitionExecution, UpdateTransitionOptions, UpdateUserOptions, UpdateWorkflowExecutionOptions, UpdateWorkflowOptions, User, UserList, Workflow, WorkflowExecution, WorkflowExecutionList, WorkflowList, WorkflowSpecification } from './types'; | ||
import { GetRoleOptions, ListRoleOptions, Role, RoleList } from './types/role'; | ||
@@ -649,2 +649,18 @@ /** | ||
/** | ||
* Get profile, calls the GET /profiles/{profileId} endpoint. | ||
* | ||
* @param profileId Id of the profile | ||
* @param options Request options | ||
* @returns Profile response from REST API | ||
*/ | ||
getProfile(profileId: string, options?: GetProfileOptions): Promise<PublicProfile | PrivateProfile>; | ||
/** | ||
* Updates a profile, calls the PATCH /profiles/{profileId} endpoint. | ||
* | ||
* @param profileId Id of the profile | ||
* @param options Request options | ||
* @returns Profile response from REST API | ||
*/ | ||
updateProfile(profileId: string, options?: UpdateProfileOptions): Promise<PrivateProfile>; | ||
/** | ||
* List roles, calls the GET /roles endpoint. | ||
@@ -651,0 +667,0 @@ * @param options Request options |
@@ -1047,2 +1047,26 @@ "use strict"; | ||
/** | ||
* Get profile, calls the GET /profiles/{profileId} endpoint. | ||
* | ||
* @param profileId Id of the profile | ||
* @param options Request options | ||
* @returns Profile response from REST API | ||
*/ | ||
getProfile(profileId, options) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.makeGetRequest(`/profiles/${profileId}`, options); | ||
}); | ||
} | ||
/** | ||
* Updates a profile, calls the PATCH /profiles/{profileId} endpoint. | ||
* | ||
* @param profileId Id of the profile | ||
* @param options Request options | ||
* @returns Profile response from REST API | ||
*/ | ||
updateProfile(profileId, options) { | ||
return __awaiter(this, void 0, void 0, function* () { | ||
return this.makePatchRequest(`/profiles/${profileId}`, options); | ||
}); | ||
} | ||
/** | ||
* List roles, calls the GET /roles endpoint. | ||
@@ -1049,0 +1073,0 @@ * @param options Request options |
@@ -10,5 +10,4 @@ import { JSONValue, PaginationOptions, RequestConfig } from './common'; | ||
description?: string; | ||
enum?: Array<string>; | ||
fields?: FieldConfig; | ||
enum?: Array<string>; | ||
maxLength?: number; | ||
type: 'amount' | 'date' | 'digits' | 'enum' | 'lines' | 'numeric' | 'string'; | ||
@@ -19,8 +18,6 @@ }; | ||
description?: string; | ||
metadata?: Record<string, JSONValue> | null; | ||
name?: string; | ||
width?: number; | ||
height?: number; | ||
postprocessConfig?: PostprocessConfig; | ||
preprocessConfig?: PreprocessConfig; | ||
metadata?: Record<string, JSONValue> | null; | ||
}; | ||
@@ -31,8 +28,6 @@ export type GetModelOptions = RequestConfig; | ||
fieldConfig?: FieldConfig; | ||
height?: number; | ||
metadata?: Record<string, JSONValue> | null; | ||
name?: string; | ||
postprocessConfig?: PostprocessConfig; | ||
preprocessConfig?: PreprocessConfig; | ||
width?: number; | ||
metadata?: Record<string, JSONValue> | null; | ||
trainingId?: string | null; | ||
@@ -46,3 +41,3 @@ }; | ||
fieldConfig: FieldConfig | null; | ||
height: number; | ||
metadata: Record<string, JSONValue> | null; | ||
modelId: string; | ||
@@ -59,6 +54,6 @@ name: string | null; | ||
updatedTime: string | null; | ||
width: number; | ||
metadata: Record<string, JSONValue> | null; | ||
}; | ||
export type ListModelsOptions = RequestConfig & PaginationOptions; | ||
export type ListModelsOptions = { | ||
owner?: Array<string>; | ||
} & RequestConfig & PaginationOptions; | ||
export type ModelList = { | ||
@@ -65,0 +60,0 @@ models: Array<Model>; |
@@ -47,2 +47,3 @@ import { PaginationOptions, RequestConfig } from './common'; | ||
sortBy?: 'createdTime'; | ||
modelId?: string; | ||
}; | ||
@@ -49,0 +50,0 @@ export type PredictionList = { |
@@ -0,1 +1,3 @@ | ||
import { RequestConfig } from './common'; | ||
export type GetProfileOptions = RequestConfig; | ||
export type PrivateProfile = { | ||
@@ -14,2 +16,9 @@ createdTime: string | null; | ||
}; | ||
export type UpdateProfileOptions = RequestConfig & { | ||
givenName?: string | null; | ||
familyName?: string | null; | ||
locale?: string | null; | ||
metadata?: Record<string, unknown> | null; | ||
picture?: string | null; | ||
}; | ||
export type PublicProfile = Pick<PrivateProfile, 'givenName' | 'familyName' | 'picture' | 'profileId'>; |
import { JSONValue, PaginationOptions, RequestConfig } from './common'; | ||
export type User = { | ||
avatar: string | null; | ||
createdBy: string | null; | ||
createdTime: string | null; | ||
email: string; | ||
metadata: Record<string, JSONValue> | null; | ||
name: string | null; | ||
profileId: string | null; | ||
roleIds: Array<string>; | ||
status: 'inactive' | 'active' | 'invite_pending'; | ||
updatedBy: string | null; | ||
@@ -17,11 +15,7 @@ updatedTime: string | null; | ||
appClientId?: string; | ||
avatar?: string; | ||
metadata?: Record<string, JSONValue> | null; | ||
name?: string; | ||
roleIds?: Array<string>; | ||
}; | ||
export type UpdateUserOptions = RequestConfig & { | ||
avatar?: string | null; | ||
metadata?: Record<string, JSONValue> | null; | ||
name?: string | null; | ||
roleIds?: Array<string>; | ||
@@ -28,0 +22,0 @@ }; |
@@ -1,2 +0,2 @@ | ||
import { PaginationOptions, RequestConfig } from './common'; | ||
import { JSONValue, PaginationOptions, RequestConfig } from './common'; | ||
export type WorkflowSpecification = { | ||
@@ -8,8 +8,13 @@ definition: object; | ||
export type Workflow = { | ||
completedConfig: WorkflowCompletedConfig; | ||
createdBy: null | string; | ||
createdTime: null | string; | ||
description: string | null; | ||
errorConfig: WorkflowErrorConfig; | ||
metadata: Record<string, JSONValue> | null; | ||
name: string | null; | ||
numberOfRunningExecutions: number; | ||
updatedBy: null | string; | ||
updatedTime: null | string; | ||
workflowId: string; | ||
description: string | null; | ||
numberOfRunningExecutions: number; | ||
completedConfig: WorkflowCompletedConfig; | ||
errorConfig: WorkflowErrorConfig; | ||
}; | ||
@@ -35,11 +40,14 @@ export type WorkflowCompletedConfig = { | ||
export type CreateWorkflowOptions = RequestConfig & { | ||
completedConfig?: WorkflowCompletedConfig; | ||
description?: string | null; | ||
errorConfig?: WorkflowErrorConfig; | ||
completedConfig?: WorkflowCompletedConfig; | ||
metadata?: Record<string, JSONValue>; | ||
name?: string | null; | ||
}; | ||
export type UpdateWorkflowOptions = RequestConfig & { | ||
name?: string | null; | ||
completedConfig?: WorkflowCompletedConfig; | ||
description?: string | null; | ||
errorConfig?: WorkflowErrorConfig; | ||
completedConfig?: WorkflowCompletedConfig; | ||
metadata?: Record<string, JSONValue>; | ||
name?: string | null; | ||
}; | ||
@@ -59,12 +67,12 @@ export type GetWorkflowOptions = RequestConfig; | ||
completedBy: Array<string>; | ||
completedTaskLogId: string | null; | ||
completedTaskLogId?: string | null; | ||
endTime: string | null; | ||
events: Array<Record<any, any>>; | ||
events?: Array<Record<any, any>>; | ||
executionId: string; | ||
input: Record<any, any>; | ||
logId: string | null; | ||
output: Record<any, any>; | ||
output?: Record<any, any>; | ||
startTime: string | null; | ||
status: 'succeeded' | 'failed' | 'running' | 'rejected' | 'retry' | 'error'; | ||
startTime: string | null; | ||
transitionExecutions: Record<string, Array<string>> | null; | ||
transitionExecutions?: Record<string, Array<string>> | null; | ||
workflowId: string; | ||
@@ -75,4 +83,4 @@ }; | ||
workflowId: string; | ||
status?: 'succeeded' | 'failed' | 'running' | 'rejected'; | ||
status?: Array<'succeeded' | 'failed' | 'running' | 'rejected'>; | ||
nextToken: string | null; | ||
}; |
{ | ||
"name": "@lucidtech/las-sdk-core", | ||
"version": "13.1.1", | ||
"version": "14.0.0", | ||
"author": "Lucidtech AS <hello@lucidtech.ai>", | ||
@@ -5,0 +5,0 @@ "maintainers": [ |
138392
2983