=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::organization-invites - Documentation for the /organization/invites path.
=head1 DESCRIPTION
This document describes the API endpoint at C</organization/invites>.
=head1 PATHS
=head2 C<GET /organization/invites>
Returns a list of invites in the organization.
=head3 Operation ID
C<list-invites>
$client->list-invites( ... );
=head3 Parameters
=over 4
=item * C<limit> (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Type: C<integer>
Default: C<20>
=item * C<after> (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
Type: C<string>
=back
=head3 Responses
=head4 Status Code: C<200>
Invites listed successfully.
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
{
"data" : [
"{\n \"object\": \"organization.invite\",\n \"id\": \"invite-abc\",\n \"email\": \"[email protected]\",\n \"role\": \"owner\",\n \"status\": \"accepted\",\n \"invited_at\": 1711471533,\n \"expires_at\": 1711471533,\n \"accepted_at\": 1711471533,\n \"projects\": [\n {\n \"id\": \"project-xyz\",\n \"role\": \"member\"\n }\n ]\n}\n"
]
}
=back
=head2 C<POST /organization/invites>
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
=head3 Operation ID
C<inviteUser>
$client->inviteUser( ... );
=head3 Parameters
=over 4
=back
=head3 Request Body
=head3 Content Type: C<application/json>
Example:
{
"projects" : [
null
]
}
=head3 Responses
=head4 Status Code: C<200>
User invited successfully.
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
{
"object": "organization.invite",
"id": "invite-abc",
"email": "[email protected]",
"role": "owner",
"status": "accepted",
"invited_at": 1711471533,
"expires_at": 1711471533,
"accepted_at": 1711471533,
"projects": [
{
"id": "project-xyz",
"role": "member"
}
]
}
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.
=cut