Class: OpenAI::Resources::Admin::Organization::Projects::Groups::Roles

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Roles

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

Parameters:



164
165
166
 
# File 'lib/openai/resources/admin/organization/projects/groups/roles.rb', line 164

def initialize(client:)
  @client = client
end

Instance Method Details

#create(group_id, project_id:, role_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse

Assigns a project role to a group within a project.

Parameters:

  • group_id (String) —

    Path param: The ID of the group that should receive the project role.

  • project_id (String) —

    Path param: The ID of the project to update.

  • role_id (String) —

    Body param: Identifier of the role to assign.

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

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/openai/resources/admin/organization/projects/groups/roles.rb', line 28

def create(group_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleCreateParams.dump_request(params)
  project_id = parsed.delete(:project_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  @client.request(
    method: :post,
    path: ["projects/%1$s/groups/%2$s/roles", project_id, group_id],
    body: parsed,
    model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#delete(role_id, project_id:, group_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteResponse

Unassigns a project role from a group within a project.

Parameters:

  • role_id (String) —

    The ID of the project role to remove from the group.

  • project_id (String) —

    The ID of the project to modify.

  • group_id (String) —

    The ID of the group whose project role assignment should be removed.

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

Returns:

See Also:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/openai/resources/admin/organization/projects/groups/roles.rb', line 142

def delete(role_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleDeleteParams.dump_request(params)
  project_id = parsed.delete(:project_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  group_id = parsed.delete(:group_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  @client.request(
    method: :delete,
    path: ["projects/%1$s/groups/%2$s/roles/%3$s", project_id, group_id, role_id],
    model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end

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

Lists the project roles assigned to a group within a project.

Parameters:

  • group_id (String) —

    Path param: The ID of the group to inspect.

  • project_id (String) —

    Path param: The ID of the project to inspect.

  • after (String) —

    Query param: Cursor for pagination. Provide the value from the previous response's next field to continue listing project roles.

  • limit (Integer) —

    Query param: A limit on the number of project role assignments to return.

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

    Query param: Sort order for the returned project roles.

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

Returns:

See Also:



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

def list(group_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleListParams.dump_request(params)
  project_id = parsed.delete(:project_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["projects/%1$s/groups/%2$s/roles", project_id, group_id],
    query: query,
    page: OpenAI::Internal::NextCursorPage,
    model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleListResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(role_id, project_id:, group_id:, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse

Retrieves a project role assigned to a group.

Parameters:

  • role_id (String) —

    The ID of the project role to retrieve for the group.

  • project_id (String) —

    The ID of the project to inspect.

  • group_id (String) —

    The ID of the group to inspect.

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

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openai/resources/admin/organization/projects/groups/roles.rb', line 62

def retrieve(role_id, params)
  parsed, options = OpenAI::Admin::Organization::Projects::Groups::RoleRetrieveParams.dump_request(params)
  project_id = parsed.delete(:project_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  group_id = parsed.delete(:group_id) do
    raise ArgumentError.new("missing required path argument #{_1}")
  end

  @client.request(
    method: :get,
    path: ["projects/%1$s/groups/%2$s/roles/%3$s", project_id, group_id, role_id],
    model: OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end