openai
Version:
The official TypeScript library for the OpenAI API
79 lines • 2.3 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { ConversationCursorPage, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export class Invites extends APIResource {
/**
* Create an invite for a user to the organization. The invite must be accepted by
* the user before they have access to the organization.
*
* @example
* ```ts
* const invite =
* await client.admin.organization.invites.create({
* email: 'email',
* role: 'reader',
* });
* ```
*/
create(body, options) {
return this._client.post('/organization/invites', {
body,
...options,
__security: { adminAPIKeyAuth: true },
});
}
/**
* Retrieves an invite.
*
* @example
* ```ts
* const invite =
* await client.admin.organization.invites.retrieve(
* 'invite_id',
* );
* ```
*/
retrieve(inviteID, options) {
return this._client.get(path `/organization/invites/${inviteID}`, {
...options,
__security: { adminAPIKeyAuth: true },
});
}
/**
* Returns a list of invites in the organization.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const invite of client.admin.organization.invites.list()) {
* // ...
* }
* ```
*/
list(query = {}, options) {
return this._client.getAPIList('/organization/invites', (ConversationCursorPage), {
query,
...options,
__security: { adminAPIKeyAuth: true },
});
}
/**
* Delete an invite. If the invite has already been accepted, it cannot be deleted.
*
* @example
* ```ts
* const invite =
* await client.admin.organization.invites.delete(
* 'invite_id',
* );
* ```
*/
delete(inviteID, options) {
return this._client.delete(path `/organization/invites/${inviteID}`, {
...options,
__security: { adminAPIKeyAuth: true },
});
}
}
//# sourceMappingURL=invites.mjs.map