Class: OpenAI::Resources::Admin::Organization::Projects::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/projects/users.rb,
lib/openai/resources/admin/organization/projects/users/roles.rb

Defined Under Namespace

Classes: Roles

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Users

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 Users.

Parameters:



168
169
170
171
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 168

def initialize(client:)
  @client = client
  @roles = OpenAI::Resources::Admin::Organization::Projects::Users::Roles.new(client: client)
end

Instance Attribute Details

#roles ⇒ OpenAI::Resources::Admin::Organization::Projects::Users::Roles (readonly)

Returns:



10
11
12
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 10

def roles
  @roles
end

Instance Method Details

#create(project_id, role:, email: nil, user_id: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectUser

Adds a user to the project. Users must already be members of the organization to be added to a project.

Parameters:

  • project_id (String) —

    The ID of the project.

  • role (String) —

    ‘owner` or `member`

  • email (String, nil) —

    Email of the user to add.

  • user_id (String, nil) —

    The ID of the user.

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

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 30

def create(project_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::UserCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s/users", project_id],
    body: parsed,
    model: OpenAI::Admin::Organization::Projects::ProjectUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#delete(user_id, project_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::UserDeleteResponse

Deletes a user from the project.

Returns confirmation of project user deletion, or an error if the project is archived (archived projects have no users).

Parameters:

  • user_id (String) —

    The ID of the user.

  • project_id (String) —

    The ID of the project.

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

Returns:

See Also:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 150

def delete(user_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::UserDeleteParams.dump_request(params)
  project_id =
    parsed.delete(:project_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["organization/projects/%1$s/users/%2$s", project_id, user_id],
    model: OpenAI::Models::Admin::Organization::Projects::UserDeleteResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end

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

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

Returns a list of users in the project.

Parameters:

  • project_id (String) —

    The ID of the project.

  • 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:



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 120

def list(project_id, params = {})
  parsed, options = OpenAI::Admin::Organization::Projects::UserListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["organization/projects/%1$s/users", project_id],
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Admin::Organization::Projects::ProjectUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(user_id, project_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectUser

Retrieves a user in the project.

Parameters:

  • user_id (String) —

    The ID of the user.

  • project_id (String) —

    The ID of the project.

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

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 55

def retrieve(user_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::UserRetrieveParams.dump_request(params)
  project_id =
    parsed.delete(:project_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["organization/projects/%1$s/users/%2$s", project_id, user_id],
    model: OpenAI::Admin::Organization::Projects::ProjectUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#update(user_id, project_id:, role: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::ProjectUser

Modifies a user’s role in the project.

Parameters:

  • user_id (String) —

    Path param: The ID of the user.

  • project_id (String) —

    Path param: The ID of the project.

  • role (String, nil) —

    Body param: ‘owner` or `member`

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

Returns:

See Also:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/openai/resources/admin/organization/projects/users.rb', line 85

def update(user_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::UserUpdateParams.dump_request(params)
  project_id =
    parsed.delete(:project_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s/users/%2$s", project_id, user_id],
    body: parsed,
    model: OpenAI::Admin::Organization::Projects::ProjectUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end