/** * Permit.io API * Authorization as a service * * The version of the OpenAPI document: 2.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { OrgMemberCreate } from '../types'; import { OrgMemberReadWithGrants } from '../types'; import { OrgMemberRemovePermissions } from '../types'; import { OrgMemberUpdate } from '../types'; /** * MembersApi - axios parameter creator * @export */ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an organization member if needed, and grant it permissions. The member can be specified either by ID (for an existing member), or by email (for either an existing member or a new one). For a new member, an invite will be sent. * @summary Create Organization Members * @param {OrgMemberCreate} orgMemberCreate * @param {string} [inviterName] * @param {string} [inviterEmail] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganizationMembers: (orgMemberCreate: OrgMemberCreate, inviterName?: string, inviterEmail?: string, options?: AxiosRequestConfig) => Promise; /** * Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`. * @summary Delete Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationMember: (memberId: string, options?: AxiosRequestConfig) => Promise; /** * Remove permissions from a member. If the last permissions a member has are removed, the member is also deleted. * @summary Delete Organization Permissions * @param {OrgMemberRemovePermissions} orgMemberRemovePermissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationPermissions: (orgMemberRemovePermissions: OrgMemberRemovePermissions, options?: AxiosRequestConfig) => Promise; /** * Gets the authenticated account member\'s details. * @summary Get the authenticated account member * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthenticatedMember: (options?: AxiosRequestConfig) => Promise; /** * Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404. * @summary Get Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganizationMember: (memberId: string, options?: AxiosRequestConfig) => Promise; /** * Lists all the account members that current active account has access to, optionally filtering by project or environment. The active account/organization is determined by the API Key used or by the authenticated session id. * @summary List Organization Members * @param {string} [projectId] * @param {string} [envId] * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizationMembers: (projectId?: string, envId?: string, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise; /** * Updates an account member\'s settings. * @summary Update Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {OrgMemberUpdate} orgMemberUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrganizationMember: (memberId: string, orgMemberUpdate: OrgMemberUpdate, options?: AxiosRequestConfig) => Promise; }; /** * MembersApi - functional programming interface * @export */ export declare const MembersApiFp: (configuration?: Configuration) => { /** * Create an organization member if needed, and grant it permissions. The member can be specified either by ID (for an existing member), or by email (for either an existing member or a new one). For a new member, an invite will be sent. * @summary Create Organization Members * @param {OrgMemberCreate} orgMemberCreate * @param {string} [inviterName] * @param {string} [inviterEmail] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganizationMembers(orgMemberCreate: OrgMemberCreate, inviterName?: string, inviterEmail?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`. * @summary Delete Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationMember(memberId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove permissions from a member. If the last permissions a member has are removed, the member is also deleted. * @summary Delete Organization Permissions * @param {OrgMemberRemovePermissions} orgMemberRemovePermissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationPermissions(orgMemberRemovePermissions: OrgMemberRemovePermissions, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the authenticated account member\'s details. * @summary Get the authenticated account member * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthenticatedMember(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404. * @summary Get Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganizationMember(memberId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all the account members that current active account has access to, optionally filtering by project or environment. The active account/organization is determined by the API Key used or by the authenticated session id. * @summary List Organization Members * @param {string} [projectId] * @param {string} [envId] * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizationMembers(projectId?: string, envId?: string, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Updates an account member\'s settings. * @summary Update Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {OrgMemberUpdate} orgMemberUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrganizationMember(memberId: string, orgMemberUpdate: OrgMemberUpdate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MembersApi - factory interface * @export */ export declare const MembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an organization member if needed, and grant it permissions. The member can be specified either by ID (for an existing member), or by email (for either an existing member or a new one). For a new member, an invite will be sent. * @summary Create Organization Members * @param {OrgMemberCreate} orgMemberCreate * @param {string} [inviterName] * @param {string} [inviterEmail] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganizationMembers(orgMemberCreate: OrgMemberCreate, inviterName?: string, inviterEmail?: string, options?: any): AxiosPromise; /** * Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`. * @summary Delete Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationMember(memberId: string, options?: any): AxiosPromise; /** * Remove permissions from a member. If the last permissions a member has are removed, the member is also deleted. * @summary Delete Organization Permissions * @param {OrgMemberRemovePermissions} orgMemberRemovePermissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOrganizationPermissions(orgMemberRemovePermissions: OrgMemberRemovePermissions, options?: any): AxiosPromise; /** * Gets the authenticated account member\'s details. * @summary Get the authenticated account member * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthenticatedMember(options?: any): AxiosPromise; /** * Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404. * @summary Get Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganizationMember(memberId: string, options?: any): AxiosPromise; /** * Lists all the account members that current active account has access to, optionally filtering by project or environment. The active account/organization is determined by the API Key used or by the authenticated session id. * @summary List Organization Members * @param {string} [projectId] * @param {string} [envId] * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizationMembers(projectId?: string, envId?: string, page?: number, perPage?: number, options?: any): AxiosPromise>; /** * Updates an account member\'s settings. * @summary Update Organization Member * @param {string} memberId Either the unique id (UUID) of the account member, or the email address of the account member. * @param {OrgMemberUpdate} orgMemberUpdate * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOrganizationMember(memberId: string, orgMemberUpdate: OrgMemberUpdate, options?: any): AxiosPromise; }; /** * Request parameters for createOrganizationMembers operation in MembersApi. * @export * @interface MembersApiCreateOrganizationMembersRequest */ export interface MembersApiCreateOrganizationMembersRequest { /** * * @type {OrgMemberCreate} * @memberof MembersApiCreateOrganizationMembers */ readonly orgMemberCreate: OrgMemberCreate; /** * * @type {string} * @memberof MembersApiCreateOrganizationMembers */ readonly inviterName?: string; /** * * @type {string} * @memberof MembersApiCreateOrganizationMembers */ readonly inviterEmail?: string; } /** * Request parameters for deleteOrganizationMember operation in MembersApi. * @export * @interface MembersApiDeleteOrganizationMemberRequest */ export interface MembersApiDeleteOrganizationMemberRequest { /** * Either the unique id (UUID) of the account member, or the email address of the account member. * @type {string} * @memberof MembersApiDeleteOrganizationMember */ readonly memberId: string; } /** * Request parameters for deleteOrganizationPermissions operation in MembersApi. * @export * @interface MembersApiDeleteOrganizationPermissionsRequest */ export interface MembersApiDeleteOrganizationPermissionsRequest { /** * * @type {OrgMemberRemovePermissions} * @memberof MembersApiDeleteOrganizationPermissions */ readonly orgMemberRemovePermissions: OrgMemberRemovePermissions; } /** * Request parameters for getOrganizationMember operation in MembersApi. * @export * @interface MembersApiGetOrganizationMemberRequest */ export interface MembersApiGetOrganizationMemberRequest { /** * Either the unique id (UUID) of the account member, or the email address of the account member. * @type {string} * @memberof MembersApiGetOrganizationMember */ readonly memberId: string; } /** * Request parameters for listOrganizationMembers operation in MembersApi. * @export * @interface MembersApiListOrganizationMembersRequest */ export interface MembersApiListOrganizationMembersRequest { /** * * @type {string} * @memberof MembersApiListOrganizationMembers */ readonly projectId?: string; /** * * @type {string} * @memberof MembersApiListOrganizationMembers */ readonly envId?: string; /** * Page number of the results to fetch, starting at 1. * @type {number} * @memberof MembersApiListOrganizationMembers */ readonly page?: number; /** * The number of results per page (max 100). * @type {number} * @memberof MembersApiListOrganizationMembers */ readonly perPage?: number; } /** * Request parameters for updateOrganizationMember operation in MembersApi. * @export * @interface MembersApiUpdateOrganizationMemberRequest */ export interface MembersApiUpdateOrganizationMemberRequest { /** * Either the unique id (UUID) of the account member, or the email address of the account member. * @type {string} * @memberof MembersApiUpdateOrganizationMember */ readonly memberId: string; /** * * @type {OrgMemberUpdate} * @memberof MembersApiUpdateOrganizationMember */ readonly orgMemberUpdate: OrgMemberUpdate; } /** * MembersApi - object-oriented interface * @export * @class MembersApi * @extends {BaseAPI} */ export declare class MembersApi extends BaseAPI { /** * Create an organization member if needed, and grant it permissions. The member can be specified either by ID (for an existing member), or by email (for either an existing member or a new one). For a new member, an invite will be sent. * @summary Create Organization Members * @param {MembersApiCreateOrganizationMembersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ createOrganizationMembers(requestParameters: MembersApiCreateOrganizationMembersRequest, options?: AxiosRequestConfig): Promise>; /** * Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`. * @summary Delete Organization Member * @param {MembersApiDeleteOrganizationMemberRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ deleteOrganizationMember(requestParameters: MembersApiDeleteOrganizationMemberRequest, options?: AxiosRequestConfig): Promise>; /** * Remove permissions from a member. If the last permissions a member has are removed, the member is also deleted. * @summary Delete Organization Permissions * @param {MembersApiDeleteOrganizationPermissionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ deleteOrganizationPermissions(requestParameters: MembersApiDeleteOrganizationPermissionsRequest, options?: AxiosRequestConfig): Promise>; /** * Gets the authenticated account member\'s details. * @summary Get the authenticated account member * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ getAuthenticatedMember(options?: AxiosRequestConfig): Promise>; /** * Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404. * @summary Get Organization Member * @param {MembersApiGetOrganizationMemberRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ getOrganizationMember(requestParameters: MembersApiGetOrganizationMemberRequest, options?: AxiosRequestConfig): Promise>; /** * Lists all the account members that current active account has access to, optionally filtering by project or environment. The active account/organization is determined by the API Key used or by the authenticated session id. * @summary List Organization Members * @param {MembersApiListOrganizationMembersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ listOrganizationMembers(requestParameters?: MembersApiListOrganizationMembersRequest, options?: AxiosRequestConfig): Promise>; /** * Updates an account member\'s settings. * @summary Update Organization Member * @param {MembersApiUpdateOrganizationMemberRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ updateOrganizationMember(requestParameters: MembersApiUpdateOrganizationMemberRequest, options?: AxiosRequestConfig): Promise>; }