Class: Openlayer::Resources::Workspaces::Invites

Inherits:
Object
  • Object
show all
Defined in:
lib/openlayer/resources/workspaces/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:



63
64
65
 
# File 'lib/openlayer/resources/workspaces/invites.rb', line 63

def initialize(client:)
  @client = client
end

Instance Method Details

#create(workspace_id, emails: nil, role: nil, request_options: {}) ⇒ Openlayer::Models::Workspaces::InviteCreateResponse

Invite users to a workspace.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/openlayer/resources/workspaces/invites.rb', line 22

def create(workspace_id, params = {})
  parsed, options = Openlayer::Workspaces::InviteCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["workspaces/%1$s/invites", workspace_id],
    body: parsed,
    model: Openlayer::Models::Workspaces::InviteCreateResponse,
    options: options
  )
end

#list(workspace_id, page: nil, per_page: nil, request_options: {}) ⇒ Openlayer::Models::Workspaces::InviteListResponse

Retrieve a list of invites in a workspace.

Parameters:

  • workspace_id (String) —

    The workspace id.

  • page (Integer) —

    The page to return in a paginated query.

  • per_page (Integer) —

    Maximum number of items to return per page.

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openlayer/resources/workspaces/invites.rb', line 48

def list(workspace_id, params = {})
  parsed, options = Openlayer::Workspaces::InviteListParams.dump_request(params)
  query = Openlayer::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["workspaces/%1$s/invites", workspace_id],
    query: query.transform_keys(per_page: "perPage"),
    model: Openlayer::Models::Workspaces::InviteListResponse,
    options: options
  )
end