/** * 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 { InviteMemberRequest, ListResponse, Member, MembersServiceUpdateBody, UpdateMeRequest } from '../models/index'; export interface MembersServiceAllowAccessRequest { id: string; body: object; } export interface MembersServiceDeleteRequest { id: string; } export interface MembersServiceForceSignoutRequest { id: string; body: object; } export interface MembersServiceGetRequest { id: string; } export interface MembersServiceInviteRequest { inviteMemberRequest: InviteMemberRequest; } export interface MembersServiceRevokeAccessRequest { id: string; body: object; } export interface MembersServiceUpdateRequest { id: string; membersServiceUpdateBody: MembersServiceUpdateBody; } export interface MembersServiceUpdateMyselfRequest { updateMeRequest: UpdateMeRequest; } /** * MembersApi - interface * * @export * @interface MembersApiInterface */ export interface MembersApiInterface { /** * Creates request options for membersServiceAllowAccess without sending the request * @param {string} id Member identifier (UUID) whose access should be restored * @param {object} body * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceAllowAccessRequestOpts(requestParameters: MembersServiceAllowAccessRequest): Promise; /** * Restore workspace access for a previously suspended member. * @summary Allow access for a member * @param {string} id Member identifier (UUID) whose access should be restored * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceAllowAccessRaw(requestParameters: MembersServiceAllowAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Restore workspace access for a previously suspended member. * Allow access for a member */ membersServiceAllowAccess(requestParameters: MembersServiceAllowAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceDelete without sending the request * @param {string} id Member identifier (UUID) to delete * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceDeleteRequestOpts(requestParameters: MembersServiceDeleteRequest): Promise; /** * Permanently remove a member from the workspace roster. * @summary Delete a member * @param {string} id Member identifier (UUID) to delete * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceDeleteRaw(requestParameters: MembersServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Permanently remove a member from the workspace roster. * Delete a member */ membersServiceDelete(requestParameters: MembersServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceForceSignout without sending the request * @param {string} id Member identifier (UUID) to sign out of all sessions * @param {object} body * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceForceSignoutRequestOpts(requestParameters: MembersServiceForceSignoutRequest): Promise; /** * Terminate all active sessions for the specified member. * @summary Force a member to sign out * @param {string} id Member identifier (UUID) to sign out of all sessions * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceForceSignoutRaw(requestParameters: MembersServiceForceSignoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Terminate all active sessions for the specified member. * Force a member to sign out */ membersServiceForceSignout(requestParameters: MembersServiceForceSignoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceGet without sending the request * @param {string} id Member identifier (UUID) to retrieve * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceGetRequestOpts(requestParameters: MembersServiceGetRequest): Promise; /** * Fetch a single workspace member by the provided identifier. * @summary Get a member by ID * @param {string} id Member identifier (UUID) to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceGetRaw(requestParameters: MembersServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Fetch a single workspace member by the provided identifier. * Get a member by ID */ membersServiceGet(requestParameters: MembersServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceGetMyself without sending the request * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceGetMyselfRequestOpts(): Promise; /** * Return the member information associated with the authenticated caller. * @summary Get the current member * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceGetMyselfRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return the member information associated with the authenticated caller. * Get the current member */ membersServiceGetMyself(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceInvite without sending the request * @param {InviteMemberRequest} inviteMemberRequest * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceInviteRequestOpts(requestParameters: MembersServiceInviteRequest): Promise; /** * Create a pending member and dispatch an invitation email. * @summary Invite a new member * @param {InviteMemberRequest} inviteMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceInviteRaw(requestParameters: MembersServiceInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a pending member and dispatch an invitation email. * Invite a new member */ membersServiceInvite(requestParameters: MembersServiceInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceList without sending the request * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceListRequestOpts(): Promise; /** * Retrieve a paginated list of members in the current workspace. * @summary List members * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a paginated list of members in the current workspace. * List members */ membersServiceList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceRevokeAccess without sending the request * @param {string} id Member identifier (UUID) whose access should be suspended * @param {object} body * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceRevokeAccessRequestOpts(requestParameters: MembersServiceRevokeAccessRequest): Promise; /** * Suspend a member\'s access without removing their account. * @summary Revoke access for a member * @param {string} id Member identifier (UUID) whose access should be suspended * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceRevokeAccessRaw(requestParameters: MembersServiceRevokeAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Suspend a member\'s access without removing their account. * Revoke access for a member */ membersServiceRevokeAccess(requestParameters: MembersServiceRevokeAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceUpdate without sending the request * @param {string} id Member identifier (UUID) to update * @param {MembersServiceUpdateBody} membersServiceUpdateBody * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceUpdateRequestOpts(requestParameters: MembersServiceUpdateRequest): Promise; /** * Modify profile details or role assignments for an existing member. * @summary Update a member * @param {string} id Member identifier (UUID) to update * @param {MembersServiceUpdateBody} membersServiceUpdateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceUpdateRaw(requestParameters: MembersServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify profile details or role assignments for an existing member. * Update a member */ membersServiceUpdate(requestParameters: MembersServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceUpdateMyself without sending the request * @param {UpdateMeRequest} updateMeRequest * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceUpdateMyselfRequestOpts(requestParameters: MembersServiceUpdateMyselfRequest): Promise; /** * Let the signed-in member update their own profile or credentials. * @summary Update the current member * @param {UpdateMeRequest} updateMeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApiInterface */ membersServiceUpdateMyselfRaw(requestParameters: MembersServiceUpdateMyselfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Let the signed-in member update their own profile or credentials. * Update the current member */ membersServiceUpdateMyself(requestParameters: MembersServiceUpdateMyselfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class MembersApi extends runtime.BaseAPI implements MembersApiInterface { /** * Creates request options for membersServiceAllowAccess without sending the request */ membersServiceAllowAccessRequestOpts(requestParameters: MembersServiceAllowAccessRequest): Promise; /** * Restore workspace access for a previously suspended member. * Allow access for a member */ membersServiceAllowAccessRaw(requestParameters: MembersServiceAllowAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Restore workspace access for a previously suspended member. * Allow access for a member */ membersServiceAllowAccess(requestParameters: MembersServiceAllowAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceDelete without sending the request */ membersServiceDeleteRequestOpts(requestParameters: MembersServiceDeleteRequest): Promise; /** * Permanently remove a member from the workspace roster. * Delete a member */ membersServiceDeleteRaw(requestParameters: MembersServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Permanently remove a member from the workspace roster. * Delete a member */ membersServiceDelete(requestParameters: MembersServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceForceSignout without sending the request */ membersServiceForceSignoutRequestOpts(requestParameters: MembersServiceForceSignoutRequest): Promise; /** * Terminate all active sessions for the specified member. * Force a member to sign out */ membersServiceForceSignoutRaw(requestParameters: MembersServiceForceSignoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Terminate all active sessions for the specified member. * Force a member to sign out */ membersServiceForceSignout(requestParameters: MembersServiceForceSignoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceGet without sending the request */ membersServiceGetRequestOpts(requestParameters: MembersServiceGetRequest): Promise; /** * Fetch a single workspace member by the provided identifier. * Get a member by ID */ membersServiceGetRaw(requestParameters: MembersServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Fetch a single workspace member by the provided identifier. * Get a member by ID */ membersServiceGet(requestParameters: MembersServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceGetMyself without sending the request */ membersServiceGetMyselfRequestOpts(): Promise; /** * Return the member information associated with the authenticated caller. * Get the current member */ membersServiceGetMyselfRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return the member information associated with the authenticated caller. * Get the current member */ membersServiceGetMyself(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceInvite without sending the request */ membersServiceInviteRequestOpts(requestParameters: MembersServiceInviteRequest): Promise; /** * Create a pending member and dispatch an invitation email. * Invite a new member */ membersServiceInviteRaw(requestParameters: MembersServiceInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a pending member and dispatch an invitation email. * Invite a new member */ membersServiceInvite(requestParameters: MembersServiceInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceList without sending the request */ membersServiceListRequestOpts(): Promise; /** * Retrieve a paginated list of members in the current workspace. * List members */ membersServiceListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a paginated list of members in the current workspace. * List members */ membersServiceList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceRevokeAccess without sending the request */ membersServiceRevokeAccessRequestOpts(requestParameters: MembersServiceRevokeAccessRequest): Promise; /** * Suspend a member\'s access without removing their account. * Revoke access for a member */ membersServiceRevokeAccessRaw(requestParameters: MembersServiceRevokeAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Suspend a member\'s access without removing their account. * Revoke access for a member */ membersServiceRevokeAccess(requestParameters: MembersServiceRevokeAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceUpdate without sending the request */ membersServiceUpdateRequestOpts(requestParameters: MembersServiceUpdateRequest): Promise; /** * Modify profile details or role assignments for an existing member. * Update a member */ membersServiceUpdateRaw(requestParameters: MembersServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify profile details or role assignments for an existing member. * Update a member */ membersServiceUpdate(requestParameters: MembersServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for membersServiceUpdateMyself without sending the request */ membersServiceUpdateMyselfRequestOpts(requestParameters: MembersServiceUpdateMyselfRequest): Promise; /** * Let the signed-in member update their own profile or credentials. * Update the current member */ membersServiceUpdateMyselfRaw(requestParameters: MembersServiceUpdateMyselfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Let the signed-in member update their own profile or credentials. * Update the current member */ membersServiceUpdateMyself(requestParameters: MembersServiceUpdateMyselfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }