Trait Api

pub trait Api {
    type Error;

    // Required methods
    fn create_account(
        &self,
        body: AccountRequest,
    ) -> Result<Account, Self::Error>;
    fn delete_account(&self, account_id: Uuid) -> Result<(), Self::Error>;
    fn get_account(&self, account_id: Uuid) -> Result<Account, Self::Error>;
    fn get_accounts(&self) -> Result<AccountListResponse, Self::Error>;
    fn select_account(&self, account_id: Uuid) -> Result<(), Self::Error>;
    fn update_account(
        &self,
        account_id: Uuid,
        body: AccountUpdateRequest,
    ) -> Result<Account, Self::Error>;
    fn add_application(&self, body: AppRequest) -> Result<App, Self::Error>;
    fn delete_app(&self, app_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_apps(
        &self,
        name: Option<String>,
        description: Option<String>,
        all_search: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
        sort_by: Option<String>,
    ) -> Result<GetAllAppsResponse, Self::Error>;
    fn get_app(&self, app_id: Uuid) -> Result<App, Self::Error>;
    fn get_app_certificate(
        &self,
        node_id: Uuid,
        app_id: Uuid,
    ) -> Result<Certificate, Self::Error>;
    fn get_app_node_certificate_details(
        &self,
        node_id: Uuid,
        app_id: Uuid,
    ) -> Result<CertificateDetails, Self::Error>;
    fn get_apps_unique_labels(&self) -> Result<LabelsCount, Self::Error>;
    fn update_app(
        &self,
        app_id: Uuid,
        body: AppBodyUpdateRequest,
    ) -> Result<App, Self::Error>;
    fn create_application_config(
        &self,
        body: ApplicationConfig,
    ) -> Result<ApplicationConfigResponse, Self::Error>;
    fn delete_application_config(
        &self,
        config_id: String,
    ) -> Result<(), Self::Error>;
    fn get_all_application_configs(
        &self,
        name: Option<String>,
        description: Option<String>,
        image_id: Option<Uuid>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllApplicationConfigsResponse, Self::Error>;
    fn get_application_config(
        &self,
        config_id: String,
    ) -> Result<ApplicationConfigResponse, Self::Error>;
    fn get_runtime_application_config(
        &self,
        expected_hash: &[u8; 32],
    ) -> Result<RuntimeAppConfig, Self::Error>;
    fn get_specific_runtime_application_config(
        &self,
        config_id: String,
    ) -> Result<RuntimeAppConfig, Self::Error>;
    fn update_application_config(
        &self,
        config_id: String,
        body: UpdateApplicationConfigRequest,
    ) -> Result<ApplicationConfigResponse, Self::Error>;
    fn approve_approval_request(
        &self,
        request_id: Uuid,
        body: Option<ApproveRequest>,
    ) -> Result<ApprovalRequest, Self::Error>;
    fn create_approval_request(
        &self,
        body: ApprovalRequestRequest,
    ) -> Result<ApprovalRequest, Self::Error>;
    fn delete_approval_request(
        &self,
        request_id: Uuid,
    ) -> Result<(), Self::Error>;
    fn deny_approval_request(
        &self,
        request_id: Uuid,
        body: Option<DenyRequest>,
    ) -> Result<ApprovalRequest, Self::Error>;
    fn get_all_approval_requests(
        &self,
        requester: Option<Uuid>,
        reviewer: Option<Uuid>,
        subject: Option<Uuid>,
        status: Option<String>,
        all_search: Option<String>,
        sort_by: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllApprovalRequests, Self::Error>;
    fn get_approval_request(
        &self,
        request_id: Uuid,
    ) -> Result<ApprovalRequest, Self::Error>;
    fn get_approval_request_result(
        &self,
        request_id: Uuid,
    ) -> Result<ApprovableResult, Self::Error>;
    fn authenticate_user(
        &self,
        body: Option<AuthRequest>,
    ) -> Result<AuthResponse, Self::Error>;
    fn convert_app_build(
        &self,
        body: ConvertAppBuildRequest,
    ) -> Result<Build, Self::Error>;
    fn create_build(
        &self,
        body: CreateBuildRequest,
    ) -> Result<Build, Self::Error>;
    fn delete_build(&self, build_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_builds(
        &self,
        all_search: Option<String>,
        docker_image_name: Option<String>,
        config_id: Option<String>,
        deployed_status: Option<String>,
        status: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
        sort_by: Option<String>,
    ) -> Result<GetAllBuildsResponse, Self::Error>;
    fn get_build(&self, build_id: Uuid) -> Result<Build, Self::Error>;
    fn get_build_deployments(
        &self,
        build_id: Uuid,
        status: Option<String>,
        all_search: Option<String>,
        sort_by: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllBuildDeploymentsResponse, Self::Error>;
    fn update_build(
        &self,
        build_id: Uuid,
        body: BuildUpdateRequest,
    ) -> Result<Build, Self::Error>;
    fn get_certificate(&self, cert_id: Uuid) -> Result<Certificate, Self::Error>;
    fn new_certificate(
        &self,
        body: NewCertificateRequest,
    ) -> Result<TaskResult, Self::Error>;
    fn create_dataset(
        &self,
        body: CreateDatasetRequest,
    ) -> Result<Dataset, Self::Error>;
    fn delete_dataset(&self, dataset_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_datasets(
        &self,
        name: Option<String>,
        description: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllDatasetsResponse, Self::Error>;
    fn get_dataset(&self, dataset_id: Uuid) -> Result<Dataset, Self::Error>;
    fn update_dataset(
        &self,
        dataset_id: Uuid,
        body: DatasetUpdateRequest,
    ) -> Result<Dataset, Self::Error>;
    fn deactivate_node(&self, node_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_nodes(
        &self,
        name: Option<String>,
        description: Option<String>,
        sgx_version: Option<String>,
        all_search: Option<String>,
        status: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
        sort_by: Option<String>,
    ) -> Result<GetAllNodesResponse, Self::Error>;
    fn get_node(&self, node_id: Uuid) -> Result<Node, Self::Error>;
    fn get_node_certificate(
        &self,
        node_id: Uuid,
    ) -> Result<Certificate, Self::Error>;
    fn get_node_certificate_details(
        &self,
        node_id: Uuid,
    ) -> Result<CertificateDetails, Self::Error>;
    fn get_nodes_unique_labels(&self) -> Result<LabelsCount, Self::Error>;
    fn provision_node(
        &self,
        body: NodeProvisionRequest,
    ) -> Result<TaskResult, Self::Error>;
    fn update_node(
        &self,
        node_id: Uuid,
        body: NodeUpdateRequest,
    ) -> Result<Node, Self::Error>;
    fn update_node_status(
        &self,
        body: NodeStatusRequest,
    ) -> Result<NodeStatusResponse, Self::Error>;
    fn create_registry(
        &self,
        registry_request: RegistryRequest,
    ) -> Result<Registry, Self::Error>;
    fn delete_registry(&self, registry_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_registries(&self) -> Result<Vec<Registry>, Self::Error>;
    fn get_registry(&self, registry_id: Uuid) -> Result<Registry, Self::Error>;
    fn get_registry_for_app(
        &self,
        app_id: Uuid,
    ) -> Result<AppRegistryResponse, Self::Error>;
    fn get_registry_for_image(
        &self,
        image_name: String,
    ) -> Result<ImageRegistryResponse, Self::Error>;
    fn update_registry(
        &self,
        registry_id: Uuid,
        body: UpdateRegistryRequest,
    ) -> Result<Registry, Self::Error>;
    fn get_manager_version(&self) -> Result<VersionResponse, Self::Error>;
    fn get_all_tasks(
        &self,
        task_type: Option<String>,
        status: Option<String>,
        requester: Option<String>,
        approver: Option<String>,
        all_search: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
        sort_by: Option<String>,
        base_filters: Option<String>,
    ) -> Result<GetAllTasksResponse, Self::Error>;
    fn get_task(&self, task_id: Uuid) -> Result<Task, Self::Error>;
    fn get_task_status(&self, task_id: Uuid) -> Result<TaskResult, Self::Error>;
    fn update_task(
        &self,
        task_id: Uuid,
        body: TaskUpdateRequest,
    ) -> Result<TaskResult, Self::Error>;
    fn convert_app(
        &self,
        body: ConversionRequest,
    ) -> Result<ConversionResponse, Self::Error>;
    fn accept_terms_and_conditions(&self) -> Result<(), Self::Error>;
    fn change_password(
        &self,
        body: PasswordChangeRequest,
    ) -> Result<(), Self::Error>;
    fn confirm_email(
        &self,
        body: ConfirmEmailRequest,
    ) -> Result<ConfirmEmailResponse, Self::Error>;
    fn create_user(&self, body: SignupRequest) -> Result<User, Self::Error>;
    fn delete_user_account(&self, user_id: Uuid) -> Result<(), Self::Error>;
    fn delete_user_from_account(&self, user_id: Uuid) -> Result<(), Self::Error>;
    fn forgot_password(
        &self,
        body: ForgotPasswordRequest,
    ) -> Result<(), Self::Error>;
    fn get_all_users(
        &self,
        all_search: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
        sort_by: Option<String>,
    ) -> Result<GetAllUsersResponse, Self::Error>;
    fn get_logged_in_user(&self) -> Result<User, Self::Error>;
    fn get_user(&self, user_id: Uuid) -> Result<User, Self::Error>;
    fn invite_user(&self, body: InviteUserRequest) -> Result<User, Self::Error>;
    fn process_invitations(
        &self,
        body: ProcessInviteRequest,
    ) -> Result<(), Self::Error>;
    fn resend_confirm_email(&self) -> Result<(), Self::Error>;
    fn resend_invitation(&self, user_id: Uuid) -> Result<(), Self::Error>;
    fn reset_password(
        &self,
        user_id: Uuid,
        body: PasswordResetRequest,
    ) -> Result<(), Self::Error>;
    fn update_user(
        &self,
        user_id: Uuid,
        body: UpdateUserRequest,
    ) -> Result<User, Self::Error>;
    fn validate_password_reset_token(
        &self,
        user_id: Uuid,
        body: ValidateTokenRequest,
    ) -> Result<ValidateTokenResponse, Self::Error>;
    fn create_workflow_graph(
        &self,
        body: CreateWorkflowGraph,
    ) -> Result<WorkflowGraph, Self::Error>;
    fn delete_workflow_graph(&self, graph_id: Uuid) -> Result<(), Self::Error>;
    fn get_all_workflow_graphs(
        &self,
        name: Option<String>,
        description: Option<String>,
        all_search: Option<String>,
        parent_graph_id: Option<String>,
        sort_by: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllWorkflowGraphsResponse, Self::Error>;
    fn get_workflow_graph(
        &self,
        graph_id: Uuid,
    ) -> Result<WorkflowGraph, Self::Error>;
    fn update_workflow_graph(
        &self,
        graph_id: Uuid,
        body: UpdateWorkflowGraph,
    ) -> Result<WorkflowGraph, Self::Error>;
    fn create_final_workflow_graph(
        &self,
        body: CreateFinalWorkflowGraph,
    ) -> Result<FinalWorkflow, Self::Error>;
    fn delete_final_workflow_graph(
        &self,
        graph_id: Uuid,
        version: String,
    ) -> Result<(), Self::Error>;
    fn get_all_final_workflow_graphs(
        &self,
        name: Option<String>,
        description: Option<String>,
        all_search: Option<String>,
        sort_by: Option<String>,
        limit: Option<i32>,
        offset: Option<i32>,
    ) -> Result<GetAllFinalWorkflowGraphsResponse, Self::Error>;
    fn get_final_workflow_graph(
        &self,
        graph_id: Uuid,
        version: String,
    ) -> Result<VersionInFinalWorkflow, Self::Error>;
    fn get_full_final_workflow_graph(
        &self,
        graph_id: Uuid,
    ) -> Result<FinalWorkflow, Self::Error>;
    fn update_final_workflow_graph(
        &self,
        graph_id: Uuid,
        body: CreateWorkflowVersionRequest,
    ) -> Result<VersionInFinalWorkflow, Self::Error>;
    fn get_zone(&self, zone_id: Uuid) -> Result<Zone, Self::Error>;
    fn get_zone_join_token(
        &self,
        zone_id: Uuid,
    ) -> Result<ZoneJoinToken, Self::Error>;
    fn get_zones(&self) -> Result<Vec<Zone>, Self::Error>;
}

API trait with immutable receivers i.e. fn api_call(&self, ...)

Required Associated Types

type Error

Required Methods

fn create_account(&self, body: AccountRequest) -> Result<Account, Self::Error>

Create a new account.

fn delete_account(&self, account_id: Uuid) -> Result<(), Self::Error>

Delete an account.

fn get_account(&self, account_id: Uuid) -> Result<Account, Self::Error>

Get a specific account.

fn get_accounts(&self) -> Result<AccountListResponse, Self::Error>

Get all accounts.

fn select_account(&self, account_id: Uuid) -> Result<(), Self::Error>

Select a user’s account to work on.

fn update_account( &self, account_id: Uuid, body: AccountUpdateRequest, ) -> Result<Account, Self::Error>

Update an account.

fn add_application(&self, body: AppRequest) -> Result<App, Self::Error>

Add an application.

fn delete_app(&self, app_id: Uuid) -> Result<(), Self::Error>

Delete a particular app

fn get_all_apps( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllAppsResponse, Self::Error>

Get all apps information.

fn get_app(&self, app_id: Uuid) -> Result<App, Self::Error>

Get details of a particular app.

fn get_app_certificate( &self, node_id: Uuid, app_id: Uuid, ) -> Result<Certificate, Self::Error>

Get an attested app’s certificate.

fn get_app_node_certificate_details( &self, node_id: Uuid, app_id: Uuid, ) -> Result<CertificateDetails, Self::Error>

Get an app’s certificate for a compute node.

fn get_apps_unique_labels(&self) -> Result<LabelsCount, Self::Error>

Get all the unique labels across all the applications within selected account

fn update_app( &self, app_id: Uuid, body: AppBodyUpdateRequest, ) -> Result<App, Self::Error>

Update details of a particular app.

fn create_application_config( &self, body: ApplicationConfig, ) -> Result<ApplicationConfigResponse, Self::Error>

Add an app config.

fn delete_application_config( &self, config_id: String, ) -> Result<(), Self::Error>

Delete a particular app config

fn get_all_application_configs( &self, name: Option<String>, description: Option<String>, image_id: Option<Uuid>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllApplicationConfigsResponse, Self::Error>

Get all app configs

fn get_application_config( &self, config_id: String, ) -> Result<ApplicationConfigResponse, Self::Error>

Get details of a particular app config.

fn get_runtime_application_config( &self, expected_hash: &[u8; 32], ) -> Result<RuntimeAppConfig, Self::Error>

Get app config

fn get_specific_runtime_application_config( &self, config_id: String, ) -> Result<RuntimeAppConfig, Self::Error>

Get details of a particular runtime app config.

fn update_application_config( &self, config_id: String, body: UpdateApplicationConfigRequest, ) -> Result<ApplicationConfigResponse, Self::Error>

Update details of a particular app config.

fn approve_approval_request( &self, request_id: Uuid, body: Option<ApproveRequest>, ) -> Result<ApprovalRequest, Self::Error>

Approve a request.

fn create_approval_request( &self, body: ApprovalRequestRequest, ) -> Result<ApprovalRequest, Self::Error>

Create approval request.

fn delete_approval_request(&self, request_id: Uuid) -> Result<(), Self::Error>

Delete an approval request.

fn deny_approval_request( &self, request_id: Uuid, body: Option<DenyRequest>, ) -> Result<ApprovalRequest, Self::Error>

Deny a request.

fn get_all_approval_requests( &self, requester: Option<Uuid>, reviewer: Option<Uuid>, subject: Option<Uuid>, status: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllApprovalRequests, Self::Error>

Get all approval requests

fn get_approval_request( &self, request_id: Uuid, ) -> Result<ApprovalRequest, Self::Error>

Get an approval request.

fn get_approval_request_result( &self, request_id: Uuid, ) -> Result<ApprovableResult, Self::Error>

Get the result for an approved or failed request.

fn authenticate_user( &self, body: Option<AuthRequest>, ) -> Result<AuthResponse, Self::Error>

User authentication

fn convert_app_build( &self, body: ConvertAppBuildRequest, ) -> Result<Build, Self::Error>

Convert a docker image and create a new image.

fn create_build(&self, body: CreateBuildRequest) -> Result<Build, Self::Error>

Create a new image.

fn delete_build(&self, build_id: Uuid) -> Result<(), Self::Error>

Delete a particular image.

fn get_all_builds( &self, all_search: Option<String>, docker_image_name: Option<String>, config_id: Option<String>, deployed_status: Option<String>, status: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllBuildsResponse, Self::Error>

Get all images information.

fn get_build(&self, build_id: Uuid) -> Result<Build, Self::Error>

Get details of a particular image.

fn get_build_deployments( &self, build_id: Uuid, status: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllBuildDeploymentsResponse, Self::Error>

Get all deployments of an image.

fn update_build( &self, build_id: Uuid, body: BuildUpdateRequest, ) -> Result<Build, Self::Error>

Update details of a particular image.

fn get_certificate(&self, cert_id: Uuid) -> Result<Certificate, Self::Error>

Retrieve a certificate.

fn new_certificate( &self, body: NewCertificateRequest, ) -> Result<TaskResult, Self::Error>

Request a new certificate for an Enclave application

fn create_dataset( &self, body: CreateDatasetRequest, ) -> Result<Dataset, Self::Error>

fn delete_dataset(&self, dataset_id: Uuid) -> Result<(), Self::Error>

fn get_all_datasets( &self, name: Option<String>, description: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllDatasetsResponse, Self::Error>

Get all datasets

fn get_dataset(&self, dataset_id: Uuid) -> Result<Dataset, Self::Error>

fn update_dataset( &self, dataset_id: Uuid, body: DatasetUpdateRequest, ) -> Result<Dataset, Self::Error>

fn deactivate_node(&self, node_id: Uuid) -> Result<(), Self::Error>

Deactivate a particular compute node.

fn get_all_nodes( &self, name: Option<String>, description: Option<String>, sgx_version: Option<String>, all_search: Option<String>, status: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllNodesResponse, Self::Error>

Get all compute nodes information.

fn get_node(&self, node_id: Uuid) -> Result<Node, Self::Error>

Get details of a particular compute node.

fn get_node_certificate( &self, node_id: Uuid, ) -> Result<Certificate, Self::Error>

Get an attested compute node’s certificate.

fn get_node_certificate_details( &self, node_id: Uuid, ) -> Result<CertificateDetails, Self::Error>

Get a compute node’s certificate.

fn get_nodes_unique_labels(&self) -> Result<LabelsCount, Self::Error>

Get all the unique labels across all the nodes within selected account

fn provision_node( &self, body: NodeProvisionRequest, ) -> Result<TaskResult, Self::Error>

Provision a new compute node.

fn update_node( &self, node_id: Uuid, body: NodeUpdateRequest, ) -> Result<Node, Self::Error>

Update details of a particular compute node.

fn update_node_status( &self, body: NodeStatusRequest, ) -> Result<NodeStatusResponse, Self::Error>

Called periodically by a compute node.

fn create_registry( &self, registry_request: RegistryRequest, ) -> Result<Registry, Self::Error>

Add a new registry to an account

fn delete_registry(&self, registry_id: Uuid) -> Result<(), Self::Error>

Delete registry

fn get_all_registries(&self) -> Result<Vec<Registry>, Self::Error>

Get details of all registry in the account

fn get_registry(&self, registry_id: Uuid) -> Result<Registry, Self::Error>

Get details of a particular registry

fn get_registry_for_app( &self, app_id: Uuid, ) -> Result<AppRegistryResponse, Self::Error>

Get details of the registry that will be used for the particular app images

fn get_registry_for_image( &self, image_name: String, ) -> Result<ImageRegistryResponse, Self::Error>

Get details of the registry that will be used for the particular image

fn update_registry( &self, registry_id: Uuid, body: UpdateRegistryRequest, ) -> Result<Registry, Self::Error>

Update a particular registry details

fn get_manager_version(&self) -> Result<VersionResponse, Self::Error>

Get Manager Version.

fn get_all_tasks( &self, task_type: Option<String>, status: Option<String>, requester: Option<String>, approver: Option<String>, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, base_filters: Option<String>, ) -> Result<GetAllTasksResponse, Self::Error>

Get all the tasks.

fn get_task(&self, task_id: Uuid) -> Result<Task, Self::Error>

Get details of a particular task.

fn get_task_status(&self, task_id: Uuid) -> Result<TaskResult, Self::Error>

Get status and result of a particular task.

fn update_task( &self, task_id: Uuid, body: TaskUpdateRequest, ) -> Result<TaskResult, Self::Error>

Update status of approver and task.

fn convert_app( &self, body: ConversionRequest, ) -> Result<ConversionResponse, Self::Error>

Convert an application to run in EnclaveOS.

fn accept_terms_and_conditions(&self) -> Result<(), Self::Error>

Current user accepts latest terms and conditions.

fn change_password( &self, body: PasswordChangeRequest, ) -> Result<(), Self::Error>

Change user password.

fn confirm_email( &self, body: ConfirmEmailRequest, ) -> Result<ConfirmEmailResponse, Self::Error>

Confirms user’s email address.

fn create_user(&self, body: SignupRequest) -> Result<User, Self::Error>

Create a new user.

fn delete_user_account(&self, user_id: Uuid) -> Result<(), Self::Error>

Completely delete a user profile from system

fn delete_user_from_account(&self, user_id: Uuid) -> Result<(), Self::Error>

Removed user’s association with an account.

fn forgot_password( &self, body: ForgotPasswordRequest, ) -> Result<(), Self::Error>

Initiate password reset sequence for a user.

fn get_all_users( &self, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllUsersResponse, Self::Error>

Get all user’s information.

fn get_logged_in_user(&self) -> Result<User, Self::Error>

Get details of the current logged in user.

fn get_user(&self, user_id: Uuid) -> Result<User, Self::Error>

Get details of a particular user.

fn invite_user(&self, body: InviteUserRequest) -> Result<User, Self::Error>

Invite a user.

fn process_invitations( &self, body: ProcessInviteRequest, ) -> Result<(), Self::Error>

Process a user’s pending account invitations.

fn resend_confirm_email(&self) -> Result<(), Self::Error>

Resend email with link to confirm user’s email address.

fn resend_invitation(&self, user_id: Uuid) -> Result<(), Self::Error>

Resend invite to the user to join a specific account.

fn reset_password( &self, user_id: Uuid, body: PasswordResetRequest, ) -> Result<(), Self::Error>

Reset a user’s password.

fn update_user( &self, user_id: Uuid, body: UpdateUserRequest, ) -> Result<User, Self::Error>

Update status, name, and the role of a user. User with MANAGER access role can only update another user.

fn validate_password_reset_token( &self, user_id: Uuid, body: ValidateTokenRequest, ) -> Result<ValidateTokenResponse, Self::Error>

Validates password reset token for the user.

fn create_workflow_graph( &self, body: CreateWorkflowGraph, ) -> Result<WorkflowGraph, Self::Error>

fn delete_workflow_graph(&self, graph_id: Uuid) -> Result<(), Self::Error>

Delete a particular draft workflow

fn get_all_workflow_graphs( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, parent_graph_id: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllWorkflowGraphsResponse, Self::Error>

fn get_workflow_graph( &self, graph_id: Uuid, ) -> Result<WorkflowGraph, Self::Error>

Get details of a particular draft workflow

fn update_workflow_graph( &self, graph_id: Uuid, body: UpdateWorkflowGraph, ) -> Result<WorkflowGraph, Self::Error>

fn create_final_workflow_graph( &self, body: CreateFinalWorkflowGraph, ) -> Result<FinalWorkflow, Self::Error>

fn delete_final_workflow_graph( &self, graph_id: Uuid, version: String, ) -> Result<(), Self::Error>

Delete a particular final workflow

fn get_all_final_workflow_graphs( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllFinalWorkflowGraphsResponse, Self::Error>

fn get_final_workflow_graph( &self, graph_id: Uuid, version: String, ) -> Result<VersionInFinalWorkflow, Self::Error>

Get details of a particular final workflow version

fn get_full_final_workflow_graph( &self, graph_id: Uuid, ) -> Result<FinalWorkflow, Self::Error>

Get details of a particular final workflow

fn update_final_workflow_graph( &self, graph_id: Uuid, body: CreateWorkflowVersionRequest, ) -> Result<VersionInFinalWorkflow, Self::Error>

Create a new version for a particular final workflow

fn get_zone(&self, zone_id: Uuid) -> Result<Zone, Self::Error>

Get zone details.

fn get_zone_join_token( &self, zone_id: Uuid, ) -> Result<ZoneJoinToken, Self::Error>

Get the authentication token.

fn get_zones(&self) -> Result<Vec<Zone>, Self::Error>

Get all zones.

Implementations on Foreign Types

impl<T, E> Api for RefCell<T>

where T: ApiMut<Error = E>,

type Error = E

fn create_account(&self, body: AccountRequest) -> Result<Account, Self::Error>

fn delete_account(&self, account_id: Uuid) -> Result<(), Self::Error>

fn get_account(&self, account_id: Uuid) -> Result<Account, Self::Error>

fn get_accounts(&self) -> Result<AccountListResponse, Self::Error>

fn select_account(&self, account_id: Uuid) -> Result<(), Self::Error>

fn update_account( &self, account_id: Uuid, body: AccountUpdateRequest, ) -> Result<Account, Self::Error>

fn add_application(&self, body: AppRequest) -> Result<App, Self::Error>

fn delete_app(&self, app_id: Uuid) -> Result<(), Self::Error>

fn get_all_apps( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllAppsResponse, Self::Error>

fn get_app(&self, app_id: Uuid) -> Result<App, Self::Error>

fn get_app_certificate( &self, node_id: Uuid, app_id: Uuid, ) -> Result<Certificate, Self::Error>

fn get_app_node_certificate_details( &self, node_id: Uuid, app_id: Uuid, ) -> Result<CertificateDetails, Self::Error>

fn get_apps_unique_labels(&self) -> Result<LabelsCount, Self::Error>

fn update_app( &self, app_id: Uuid, body: AppBodyUpdateRequest, ) -> Result<App, Self::Error>

fn create_application_config( &self, body: ApplicationConfig, ) -> Result<ApplicationConfigResponse, Self::Error>

fn delete_application_config( &self, config_id: String, ) -> Result<(), Self::Error>

fn get_all_application_configs( &self, name: Option<String>, description: Option<String>, image_id: Option<Uuid>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllApplicationConfigsResponse, Self::Error>

fn get_application_config( &self, config_id: String, ) -> Result<ApplicationConfigResponse, Self::Error>

fn get_runtime_application_config( &self, expected_hash: &[u8; 32], ) -> Result<RuntimeAppConfig, Self::Error>

fn get_specific_runtime_application_config( &self, config_id: String, ) -> Result<RuntimeAppConfig, Self::Error>

fn update_application_config( &self, config_id: String, body: UpdateApplicationConfigRequest, ) -> Result<ApplicationConfigResponse, Self::Error>

fn approve_approval_request( &self, request_id: Uuid, body: Option<ApproveRequest>, ) -> Result<ApprovalRequest, Self::Error>

fn create_approval_request( &self, body: ApprovalRequestRequest, ) -> Result<ApprovalRequest, Self::Error>

fn delete_approval_request(&self, request_id: Uuid) -> Result<(), Self::Error>

fn deny_approval_request( &self, request_id: Uuid, body: Option<DenyRequest>, ) -> Result<ApprovalRequest, Self::Error>

fn get_all_approval_requests( &self, requester: Option<Uuid>, reviewer: Option<Uuid>, subject: Option<Uuid>, status: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllApprovalRequests, Self::Error>

fn get_approval_request( &self, request_id: Uuid, ) -> Result<ApprovalRequest, Self::Error>

fn get_approval_request_result( &self, request_id: Uuid, ) -> Result<ApprovableResult, Self::Error>

fn authenticate_user( &self, body: Option<AuthRequest>, ) -> Result<AuthResponse, Self::Error>

fn convert_app_build( &self, body: ConvertAppBuildRequest, ) -> Result<Build, Self::Error>

fn create_build(&self, body: CreateBuildRequest) -> Result<Build, Self::Error>

fn delete_build(&self, build_id: Uuid) -> Result<(), Self::Error>

fn get_all_builds( &self, all_search: Option<String>, docker_image_name: Option<String>, config_id: Option<String>, deployed_status: Option<String>, status: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllBuildsResponse, Self::Error>

fn get_build(&self, build_id: Uuid) -> Result<Build, Self::Error>

fn get_build_deployments( &self, build_id: Uuid, status: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllBuildDeploymentsResponse, Self::Error>

fn update_build( &self, build_id: Uuid, body: BuildUpdateRequest, ) -> Result<Build, Self::Error>

fn get_certificate(&self, cert_id: Uuid) -> Result<Certificate, Self::Error>

fn new_certificate( &self, body: NewCertificateRequest, ) -> Result<TaskResult, Self::Error>

fn create_dataset( &self, body: CreateDatasetRequest, ) -> Result<Dataset, Self::Error>

fn delete_dataset(&self, dataset_id: Uuid) -> Result<(), Self::Error>

fn get_all_datasets( &self, name: Option<String>, description: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllDatasetsResponse, Self::Error>

fn get_dataset(&self, dataset_id: Uuid) -> Result<Dataset, Self::Error>

fn update_dataset( &self, dataset_id: Uuid, body: DatasetUpdateRequest, ) -> Result<Dataset, Self::Error>

fn deactivate_node(&self, node_id: Uuid) -> Result<(), Self::Error>

fn get_all_nodes( &self, name: Option<String>, description: Option<String>, sgx_version: Option<String>, all_search: Option<String>, status: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllNodesResponse, Self::Error>

fn get_node(&self, node_id: Uuid) -> Result<Node, Self::Error>

fn get_node_certificate( &self, node_id: Uuid, ) -> Result<Certificate, Self::Error>

fn get_node_certificate_details( &self, node_id: Uuid, ) -> Result<CertificateDetails, Self::Error>

fn get_nodes_unique_labels(&self) -> Result<LabelsCount, Self::Error>

fn provision_node( &self, body: NodeProvisionRequest, ) -> Result<TaskResult, Self::Error>

fn update_node( &self, node_id: Uuid, body: NodeUpdateRequest, ) -> Result<Node, Self::Error>

fn update_node_status( &self, body: NodeStatusRequest, ) -> Result<NodeStatusResponse, Self::Error>

fn create_registry( &self, registry_request: RegistryRequest, ) -> Result<Registry, Self::Error>

fn delete_registry(&self, registry_id: Uuid) -> Result<(), Self::Error>

fn get_all_registries(&self) -> Result<Vec<Registry>, Self::Error>

fn get_registry(&self, registry_id: Uuid) -> Result<Registry, Self::Error>

fn get_registry_for_app( &self, app_id: Uuid, ) -> Result<AppRegistryResponse, Self::Error>

fn get_registry_for_image( &self, image_name: String, ) -> Result<ImageRegistryResponse, Self::Error>

fn update_registry( &self, registry_id: Uuid, body: UpdateRegistryRequest, ) -> Result<Registry, Self::Error>

fn get_manager_version(&self) -> Result<VersionResponse, Self::Error>

fn get_all_tasks( &self, task_type: Option<String>, status: Option<String>, requester: Option<String>, approver: Option<String>, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, base_filters: Option<String>, ) -> Result<GetAllTasksResponse, Self::Error>

fn get_task(&self, task_id: Uuid) -> Result<Task, Self::Error>

fn get_task_status(&self, task_id: Uuid) -> Result<TaskResult, Self::Error>

fn update_task( &self, task_id: Uuid, body: TaskUpdateRequest, ) -> Result<TaskResult, Self::Error>

fn convert_app( &self, body: ConversionRequest, ) -> Result<ConversionResponse, Self::Error>

fn accept_terms_and_conditions(&self) -> Result<(), Self::Error>

fn change_password( &self, body: PasswordChangeRequest, ) -> Result<(), Self::Error>

fn confirm_email( &self, body: ConfirmEmailRequest, ) -> Result<ConfirmEmailResponse, Self::Error>

fn create_user(&self, body: SignupRequest) -> Result<User, Self::Error>

fn delete_user_account(&self, user_id: Uuid) -> Result<(), Self::Error>

fn delete_user_from_account(&self, user_id: Uuid) -> Result<(), Self::Error>

fn forgot_password( &self, body: ForgotPasswordRequest, ) -> Result<(), Self::Error>

fn get_all_users( &self, all_search: Option<String>, limit: Option<i32>, offset: Option<i32>, sort_by: Option<String>, ) -> Result<GetAllUsersResponse, Self::Error>

fn get_logged_in_user(&self) -> Result<User, Self::Error>

fn get_user(&self, user_id: Uuid) -> Result<User, Self::Error>

fn invite_user(&self, body: InviteUserRequest) -> Result<User, Self::Error>

fn process_invitations( &self, body: ProcessInviteRequest, ) -> Result<(), Self::Error>

fn resend_confirm_email(&self) -> Result<(), Self::Error>

fn resend_invitation(&self, user_id: Uuid) -> Result<(), Self::Error>

fn reset_password( &self, user_id: Uuid, body: PasswordResetRequest, ) -> Result<(), Self::Error>

fn update_user( &self, user_id: Uuid, body: UpdateUserRequest, ) -> Result<User, Self::Error>

fn validate_password_reset_token( &self, user_id: Uuid, body: ValidateTokenRequest, ) -> Result<ValidateTokenResponse, Self::Error>

fn create_workflow_graph( &self, body: CreateWorkflowGraph, ) -> Result<WorkflowGraph, Self::Error>

fn delete_workflow_graph(&self, graph_id: Uuid) -> Result<(), Self::Error>

fn get_all_workflow_graphs( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, parent_graph_id: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllWorkflowGraphsResponse, Self::Error>

fn get_workflow_graph( &self, graph_id: Uuid, ) -> Result<WorkflowGraph, Self::Error>

fn update_workflow_graph( &self, graph_id: Uuid, body: UpdateWorkflowGraph, ) -> Result<WorkflowGraph, Self::Error>

fn create_final_workflow_graph( &self, body: CreateFinalWorkflowGraph, ) -> Result<FinalWorkflow, Self::Error>

fn delete_final_workflow_graph( &self, graph_id: Uuid, version: String, ) -> Result<(), Self::Error>

fn get_all_final_workflow_graphs( &self, name: Option<String>, description: Option<String>, all_search: Option<String>, sort_by: Option<String>, limit: Option<i32>, offset: Option<i32>, ) -> Result<GetAllFinalWorkflowGraphsResponse, Self::Error>

fn get_final_workflow_graph( &self, graph_id: Uuid, version: String, ) -> Result<VersionInFinalWorkflow, Self::Error>

fn get_full_final_workflow_graph( &self, graph_id: Uuid, ) -> Result<FinalWorkflow, Self::Error>

fn update_final_workflow_graph( &self, graph_id: Uuid, body: CreateWorkflowVersionRequest, ) -> Result<VersionInFinalWorkflow, Self::Error>

fn get_zone(&self, zone_id: Uuid) -> Result<Zone, Self::Error>

fn get_zone_join_token( &self, zone_id: Uuid, ) -> Result<ZoneJoinToken, Self::Error>

fn get_zones(&self) -> Result<Vec<Zone>, Self::Error>

Implementors

impl<'a, T, E> Api for ApiCombiner<'a, T>

where T: AccountsApi<Error = E> + AppApi<Error = E> + ApplicationConfigApi<Error = E> + ApprovalRequestsApi<Error = E> + AuthApi<Error = E> + BuildApi<Error = E> + CertificateApi<Error = E> + DatasetApi<Error = E> + NodeApi<Error = E> + RegistryApi<Error = E> + SystemApi<Error = E> + TaskApi<Error = E> + ToolsApi<Error = E> + UsersApi<Error = E> + WorkflowApi<Error = E> + WorkflowFinalApi<Error = E> + ZoneApi<Error = E> + 'a,

Implements with functions of the form fn api_call(self, ...) { CategoryApi::api_call(self.0, ...) }

type Error = E

impl<T, E> Api for T

where T: ApiDecorator<Error = E>,

Implements with functions of the form fn api_call(&self, ...) { self.dispatch(|a| Api::api_call(a, ...)) }

type Error = E