/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { PublicWorkspace, RequestWorkspaceEnrollmentRequest, UpdateWorkspaceOriginInquiryRequest, UpdateWorkspaceOriginPurposeRequest, UpdateWorkspaceRequest, Workspace } from '../models/index'; export interface WorkspacesServiceGetWorkspaceRequest { id: string; } export interface WorkspacesServicePublicGetWorkspaceRequest { slug: string; } export interface WorkspacesServiceRequestEnrollmentRequest { requestWorkspaceEnrollmentRequest: RequestWorkspaceEnrollmentRequest; } export interface WorkspacesServiceUpdateRequest { updateWorkspaceRequest: UpdateWorkspaceRequest; } export interface WorkspacesServiceUpdateOriginInquiryRequest { updateWorkspaceOriginInquiryRequest: UpdateWorkspaceOriginInquiryRequest; } export interface WorkspacesServiceUpdateOriginPurposeRequest { updateWorkspaceOriginPurposeRequest: UpdateWorkspaceOriginPurposeRequest; } /** * WorkspacesApi - interface * * @export * @interface WorkspacesApiInterface */ export interface WorkspacesApiInterface { /** * Creates request options for workspacesServiceDelete without sending the request * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceDeleteRequestOpts(): Promise; /** * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support. * @summary Delete workspace * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceDeleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support. * Delete workspace */ workspacesServiceDelete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceGetMyWorkspace without sending the request * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceGetMyWorkspaceRequestOpts(): Promise; /** * Return the workspace associated with the authenticated member\'s current session. * @summary Get my workspace * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceGetMyWorkspaceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return the workspace associated with the authenticated member\'s current session. * Get my workspace */ workspacesServiceGetMyWorkspace(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceGetWorkspace without sending the request * @param {string} id Workspace identifier (UUID) to retrieve * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceGetWorkspaceRequestOpts(requestParameters: WorkspacesServiceGetWorkspaceRequest): Promise; /** * Retrieve workspace details for the provided identifier, typically for internal tooling. * @summary Get a workspace by ID * @param {string} id Workspace identifier (UUID) to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceGetWorkspaceRaw(requestParameters: WorkspacesServiceGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve workspace details for the provided identifier, typically for internal tooling. * Get a workspace by ID */ workspacesServiceGetWorkspace(requestParameters: WorkspacesServiceGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServicePublicGetWorkspace without sending the request * @param {string} slug Workspace slug to retrieve * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServicePublicGetWorkspaceRequestOpts(requestParameters: WorkspacesServicePublicGetWorkspaceRequest): Promise; /** * Retrieve public information about a workspace that has been published. * @summary Get a public workspace by slug * @param {string} slug Workspace slug to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServicePublicGetWorkspaceRaw(requestParameters: WorkspacesServicePublicGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve public information about a workspace that has been published. * Get a public workspace by slug */ workspacesServicePublicGetWorkspace(requestParameters: WorkspacesServicePublicGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceRequestEnrollment without sending the request * @param {RequestWorkspaceEnrollmentRequest} requestWorkspaceEnrollmentRequest * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceRequestEnrollmentRequestOpts(requestParameters: WorkspacesServiceRequestEnrollmentRequest): Promise; /** * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp. * @summary Request workspace enrollment * @param {RequestWorkspaceEnrollmentRequest} requestWorkspaceEnrollmentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceRequestEnrollmentRaw(requestParameters: WorkspacesServiceRequestEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp. * Request workspace enrollment */ workspacesServiceRequestEnrollment(requestParameters: WorkspacesServiceRequestEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdate without sending the request * @param {UpdateWorkspaceRequest} updateWorkspaceRequest * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateRequestOpts(requestParameters: WorkspacesServiceUpdateRequest): Promise; /** * Modify workspace settings such as the display name and MFA enforcement policy. * @summary Update a workspace * @param {UpdateWorkspaceRequest} updateWorkspaceRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateRaw(requestParameters: WorkspacesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify workspace settings such as the display name and MFA enforcement policy. * Update a workspace */ workspacesServiceUpdate(requestParameters: WorkspacesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdateOriginInquiry without sending the request * @param {UpdateWorkspaceOriginInquiryRequest} updateWorkspaceOriginInquiryRequest * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateOriginInquiryRequestOpts(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest): Promise; /** * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs. * @summary Update workspace origin inquiry * @param {UpdateWorkspaceOriginInquiryRequest} updateWorkspaceOriginInquiryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateOriginInquiryRaw(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs. * Update workspace origin inquiry */ workspacesServiceUpdateOriginInquiry(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdateOriginPurpose without sending the request * @param {UpdateWorkspaceOriginPurposeRequest} updateWorkspaceOriginPurposeRequest * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateOriginPurposeRequestOpts(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest): Promise; /** * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs. * @summary Update workspace origin purpose * @param {UpdateWorkspaceOriginPurposeRequest} updateWorkspaceOriginPurposeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspacesApiInterface */ workspacesServiceUpdateOriginPurposeRaw(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs. * Update workspace origin purpose */ workspacesServiceUpdateOriginPurpose(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class WorkspacesApi extends runtime.BaseAPI implements WorkspacesApiInterface { /** * Creates request options for workspacesServiceDelete without sending the request */ workspacesServiceDeleteRequestOpts(): Promise; /** * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support. * Delete workspace */ workspacesServiceDeleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Soft-delete the workspace associated with the authenticated member\'s session. This operation can be reversed by contacting support. * Delete workspace */ workspacesServiceDelete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceGetMyWorkspace without sending the request */ workspacesServiceGetMyWorkspaceRequestOpts(): Promise; /** * Return the workspace associated with the authenticated member\'s current session. * Get my workspace */ workspacesServiceGetMyWorkspaceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return the workspace associated with the authenticated member\'s current session. * Get my workspace */ workspacesServiceGetMyWorkspace(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceGetWorkspace without sending the request */ workspacesServiceGetWorkspaceRequestOpts(requestParameters: WorkspacesServiceGetWorkspaceRequest): Promise; /** * Retrieve workspace details for the provided identifier, typically for internal tooling. * Get a workspace by ID */ workspacesServiceGetWorkspaceRaw(requestParameters: WorkspacesServiceGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve workspace details for the provided identifier, typically for internal tooling. * Get a workspace by ID */ workspacesServiceGetWorkspace(requestParameters: WorkspacesServiceGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServicePublicGetWorkspace without sending the request */ workspacesServicePublicGetWorkspaceRequestOpts(requestParameters: WorkspacesServicePublicGetWorkspaceRequest): Promise; /** * Retrieve public information about a workspace that has been published. * Get a public workspace by slug */ workspacesServicePublicGetWorkspaceRaw(requestParameters: WorkspacesServicePublicGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve public information about a workspace that has been published. * Get a public workspace by slug */ workspacesServicePublicGetWorkspace(requestParameters: WorkspacesServicePublicGetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceRequestEnrollment without sending the request */ workspacesServiceRequestEnrollmentRequestOpts(requestParameters: WorkspacesServiceRequestEnrollmentRequest): Promise; /** * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp. * Request workspace enrollment */ workspacesServiceRequestEnrollmentRaw(requestParameters: WorkspacesServiceRequestEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Submit a request for workspace enrollment, setting the enroll_requested_at timestamp. * Request workspace enrollment */ workspacesServiceRequestEnrollment(requestParameters: WorkspacesServiceRequestEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdate without sending the request */ workspacesServiceUpdateRequestOpts(requestParameters: WorkspacesServiceUpdateRequest): Promise; /** * Modify workspace settings such as the display name and MFA enforcement policy. * Update a workspace */ workspacesServiceUpdateRaw(requestParameters: WorkspacesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify workspace settings such as the display name and MFA enforcement policy. * Update a workspace */ workspacesServiceUpdate(requestParameters: WorkspacesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdateOriginInquiry without sending the request */ workspacesServiceUpdateOriginInquiryRequestOpts(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest): Promise; /** * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs. * Update workspace origin inquiry */ workspacesServiceUpdateOriginInquiryRaw(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Persist how a workspace discovered Linkbreakers without exposing the value to other workspace APIs. * Update workspace origin inquiry */ workspacesServiceUpdateOriginInquiry(requestParameters: WorkspacesServiceUpdateOriginInquiryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for workspacesServiceUpdateOriginPurpose without sending the request */ workspacesServiceUpdateOriginPurposeRequestOpts(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest): Promise; /** * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs. * Update workspace origin purpose */ workspacesServiceUpdateOriginPurposeRaw(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Persist what the workspace wants to build with Linkbreakers for AI assistance without exposing the value to other workspace APIs. * Update workspace origin purpose */ workspacesServiceUpdateOriginPurpose(requestParameters: WorkspacesServiceUpdateOriginPurposeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }