Class: Anthropic::Resources::Beta::Organization::Workspaces::Members

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/organization/workspaces/members.rb,
sig/anthropic/resources/beta/organization/workspaces/members.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Members

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

Parameters:



156
157
158
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 156

def initialize(client:)
  @client = client
end

Instance Method Details

#add(workspace_id, user_id:, workspace_role:, request_options: {}) ⇒ Anthropic::Models::Beta::Organization::BetaWorkspaceMember

Create Workspace Member

Parameters:

Returns:

See Also:



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 115

def add(workspace_id, params)
  parsed, options = Anthropic::Beta::Organization::Workspaces::MemberAddParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/organizations/workspaces/%1$s/members?beta=true", workspace_id],
    body: parsed,
    model: Anthropic::Beta::Organization::BetaWorkspaceMember,
    options: options
  )
end

#list(workspace_id, after_id: nil, before_id: nil, limit: nil, request_options: {}) ⇒ Anthropic::Internal::Page<Anthropic::Models::Beta::Organization::BetaWorkspaceMember>

List Workspace Members

Some parameter documentations has been truncated, see Models::Beta::Organization::Workspaces::MemberListParams for more details.

Parameters:

  • workspace_id (String) —

    ID of the Workspace.

  • after_id (String) —

    ID of the object to use as a cursor for pagination. When provided, returns the p

  • before_id (String) —

    ID of the object to use as a cursor for pagination. When provided, returns the p

  • limit (Integer) —

    Number of items to return per page.

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

Returns:

See Also:



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 87

def list(workspace_id, params = {})
  parsed, options = Anthropic::Beta::Organization::Workspaces::MemberListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/organizations/workspaces/%1$s/members?beta=true", workspace_id],
    query: query,
    page: Anthropic::Internal::Page,
    model: Anthropic::Beta::Organization::BetaWorkspaceMember,
    options: options
  )
end

#remove(user_id, workspace_id:, request_options: {}) ⇒ Anthropic::Models::Beta::Organization::Workspaces::MemberRemoveResponse

Delete Workspace Member

Parameters:

  • user_id (String) —

    ID of the User.

  • workspace_id (String) —

    ID of the Workspace.

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

Returns:

See Also:



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 139

def remove(user_id, params)
  parsed, options = Anthropic::Beta::Organization::Workspaces::MemberRemoveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/organizations/workspaces/%1$s/members/%2$s?beta=true", workspace_id, user_id],
    model: Anthropic::Models::Beta::Organization::Workspaces::MemberRemoveResponse,
    options: options
  )
end

#retrieve(user_id, workspace_id:, request_options: {}) ⇒ Anthropic::Models::Beta::Organization::BetaWorkspaceMember

Get Workspace Member

Parameters:

  • user_id (String) —

    ID of the User.

  • workspace_id (String) —

    ID of the Workspace.

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

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 22

def retrieve(user_id, params)
  parsed, options = Anthropic::Beta::Organization::Workspaces::MemberRetrieveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/organizations/workspaces/%1$s/members/%2$s?beta=true", workspace_id, user_id],
    model: Anthropic::Beta::Organization::BetaWorkspaceMember,
    options: options
  )
end

#update(user_id, workspace_id:, workspace_role:, request_options: {}) ⇒ Anthropic::Models::Beta::Organization::BetaWorkspaceMember

Update Workspace Member

Parameters:

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/anthropic/resources/beta/organization/workspaces/members.rb', line 51

def update(user_id, params)
  parsed, options = Anthropic::Beta::Organization::Workspaces::MemberUpdateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["v1/organizations/workspaces/%1$s/members/%2$s?beta=true", workspace_id, user_id],
    body: parsed,
    model: Anthropic::Beta::Organization::BetaWorkspaceMember,
    options: options
  )
end