Class: Moonbase::Resources::Meetings

Inherits:
Object
  • Object
show all
Defined in:
lib/moonbase/resources/meetings.rb

Overview

Manage your meetings, files, and notes

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Meetings

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

Parameters:



102
103
104
 
# File 'lib/moonbase/resources/meetings.rb', line 102

def initialize(client:)
  @client = client
end

Instance Method Details

#list(after: nil, before: nil, i_cal_uid: nil, limit: nil, request_options: {}) ⇒ Moonbase::Internal::CursorPage<Moonbase::Models::MeetingPointer>

Some parameter documentations has been truncated, see Models::MeetingListParams for more details.

Returns a list of meetings.

Parameters:

  • after (String) —

    When specified, returns results starting immediately after the item identified b

  • before (String) —

    When specified, returns results starting immediately before the item identified

  • i_cal_uid (Moonbase::Models::MeetingListParams::ICalUid)
  • limit (Integer) —

    Maximum number of items to return per page. Must be between 1 and 100. Defaults

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

Returns:

See Also:



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/moonbase/resources/meetings.rb', line 86

def list(params = {})
  parsed, options = Moonbase::MeetingListParams.dump_request(params)
  query = Moonbase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "meetings",
    query: query,
    page: Moonbase::Internal::CursorPage,
    model: Moonbase::MeetingPointer,
    options: options
  )
end

#retrieve(id, include: nil, request_options: {}) ⇒ Moonbase::Models::Meeting

Some parameter documentations has been truncated, see Models::MeetingRetrieveParams for more details.

Retrieves the details of an existing meeting.

Parameters:

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/moonbase/resources/meetings.rb', line 23

def retrieve(id, params = {})
  parsed, options = Moonbase::MeetingRetrieveParams.dump_request(params)
  query = Moonbase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["meetings/%1$s", id],
    query: query,
    model: Moonbase::Meeting,
    options: options
  )
end

#update(id, recording: nil, tags: nil, transcript: nil, request_options: {}) ⇒ Moonbase::Models::Meeting

Some parameter documentations has been truncated, see Models::MeetingUpdateParams for more details.

Adds a transcript, recording, or tags to an existing meeting.

Parameters:

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/moonbase/resources/meetings.rb', line 55

def update(id, params = {})
  parsed, options = Moonbase::MeetingUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["meetings/%1$s", id],
    body: parsed,
    model: Moonbase::Meeting,
    options: options
  )
end