Class: OpenAI::Resources::Admin::Organization::Invites

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/invites.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Invites

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Invites.

Parameters:



114
115
116
 
# File 'lib/openai/resources/admin/organization/invites.rb', line 114

def initialize(client:)
  @client = client
end

Instance Method Details

#create(email:, role:, projects: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Invite

Some parameter documentations has been truncated, see Models::Admin::Organization::InviteCreateParams for more details.

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

Parameters:

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/openai/resources/admin/organization/invites.rb', line 27

def create(params)
  parsed, options = OpenAI::Admin::Organization::InviteCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/invites",
    body: parsed,
    model: OpenAI::Admin::Organization::Invite,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#delete(invite_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::InviteDeleteResponse

Delete an invite. If the invite has already been accepted, it cannot be deleted.

Parameters:

  • invite_id (String) —

    The ID of the invite to delete.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



101
102
103
104
105
106
107
108
109
 
# File 'lib/openai/resources/admin/organization/invites.rb', line 101

def delete(invite_id, params = {})
  @client.request(
    method: :delete,
    path: ["organization/invites/%1$s", invite_id],
    model: OpenAI::Models::Admin::Organization::InviteDeleteResponse,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, limit: nil, request_options: {}) ⇒ OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::Invite>

Some parameter documentations has been truncated, see Models::Admin::Organization::InviteListParams for more details.

Returns a list of invites in the organization.

Parameters:

  • after (String) —

    A cursor for use in pagination. ‘after` is an object ID that defines your place

  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 1

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/openai/resources/admin/organization/invites.rb', line 76

def list(params = {})
  parsed, options = OpenAI::Admin::Organization::InviteListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "organization/invites",
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Admin::Organization::Invite,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(invite_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Invite

Retrieves an invite.

Parameters:

  • invite_id (String) —

    The ID of the invite to retrieve.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



50
51
52
53
54
55
56
57
58
 
# File 'lib/openai/resources/admin/organization/invites.rb', line 50

def retrieve(invite_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/invites/%1$s", invite_id],
    model: OpenAI::Admin::Organization::Invite,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end