Class: OpenAI::Resources::Admin::Organization::Groups::Users

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

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:



127
128
129
 
# File 'lib/openai/resources/admin/organization/groups/users.rb', line 127

def initialize(client:)
  @client = client
end

Instance Method Details

#create(group_id, user_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Groups::UserCreateResponse

Adds a user to a group.

Parameters:

  • group_id (String) —

    The ID of the group to update.

  • user_id (String) —

    Identifier of the user to add to the group.

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

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/openai/resources/admin/organization/groups/users.rb', line 22

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

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

Removes a user from a group.

Parameters:

  • user_id (String) —

    The ID of the user to remove from the group.

  • group_id (String) —

    The ID of the group to update.

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

Returns:

See Also:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/openai/resources/admin/organization/groups/users.rb', line 109

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

#list(group_id, after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::NextCursorPage<OpenAI::Models::Admin::Organization::Groups::OrganizationGroupUser>

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

Lists the users assigned to a group.

Parameters:

  • group_id (String) —

    The ID of the group to inspect.

  • after (String) —

    A cursor for use in pagination. Provide the ID of the last user from the previou

  • limit (Integer) —

    A limit on the number of users to be returned. Limit can range between 0 and 100

  • order (Symbol, OpenAI::Models::Admin::Organization::Groups::UserListParams::Order) —

    Specifies the sort order of users in the list.

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

Returns:

See Also:



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/openai/resources/admin/organization/groups/users.rb', line 82

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

#retrieve(user_id, group_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse

Retrieves a user in a group.

Parameters:

  • user_id (String) —

    The ID of the user to retrieve from the group.

  • group_id (String) —

    The ID of the group to inspect.

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

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openai/resources/admin/organization/groups/users.rb', line 47

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