All Implemented Interfaces:

com.openai.core.Params
```
public final class InviteCreateParams
 implements Params
                    
```
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`InviteCreateParams.Builder`	A builder for InviteCreateParams.
`public final class`	`InviteCreateParams.Body`
`public final class`	`InviteCreateParams.Role`	`owner` or `reader`
`public final class`	`InviteCreateParams.Project`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`email()`	Send an email to this address
`final InviteCreateParams.Role`	`role()`	`owner` or `reader`
`final Optional<List<InviteCreateParams.Project>>`	`projects()`	An array of projects to which membership is granted at the same time the org invite is accepted.
`final JsonField<String>`	`_email()`	Returns the raw JSON value of email.
`final JsonField<InviteCreateParams.Role>`	`_role()`	Returns the raw JSON value of role.
`final JsonField<List<InviteCreateParams.Project>>`	`_projects()`	Returns the raw JSON value of projects.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final InviteCreateParams.Builder`	`toBuilder()`
`final InviteCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static InviteCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of InviteCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - email
```
 final String email()
```
    Send an email to this address
  - role
```
 final InviteCreateParams.Role role()
```
    owner or reader
  - projects
```
 final Optional<List<InviteCreateParams.Project>> projects()
```
    An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior. If empty list is passed, the user will not be invited to any projects, including the default one.
  - _email
```
 final JsonField<String> _email()
```
    Returns the raw JSON value of email.
    Unlike email, this method doesn't throw if the JSON field has an unexpected type.
  - _role
```
 final JsonField<InviteCreateParams.Role> _role()
```
    Returns the raw JSON value of role.
    Unlike role, this method doesn't throw if the JSON field has an unexpected type.
  - _projects
```
 final JsonField<List<InviteCreateParams.Project>> _projects()
```
    Returns the raw JSON value of projects.
    Unlike projects, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final InviteCreateParams.Builder toBuilder()
```
  - _body
```
 final InviteCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static InviteCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of InviteCreateParams.
    The following fields are required:
    .email() .role()

Class InviteCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

email

role

projects

_email

_role

_projects

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder