Class: Moonbase::Resources::Calls

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

Overview

View activities and capture calls

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Calls

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

Parameters:



154
155
156
 
# File 'lib/moonbase/resources/calls.rb', line 154

def initialize(client:)
  @client = client
end

Instance Method Details

#create(direction:, participants:, provider:, provider_id:, provider_status:, start_at:, answered_at: nil, end_at: nil, provider_metadata: nil, recordings: nil, tags: nil, transcript: nil, request_options: {}) ⇒ Moonbase::Models::Call

Logs a phone call.

Parameters:

Returns:

See Also:



40
41
42
43
 
# File 'lib/moonbase/resources/calls.rb', line 40

def create(params)
  parsed, options = Moonbase::CallCreateParams.dump_request(params)
  @client.request(method: :post, path: "calls", body: parsed, model: Moonbase::Call, options: options)
end

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

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

Returns a list of calls.

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

  • 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:



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/moonbase/resources/calls.rb', line 91

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

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

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

Retrieves the details of an existing call.

Parameters:

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/moonbase/resources/calls.rb', line 61

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

#upsert(direction:, participants:, provider:, provider_id:, provider_status:, start_at:, answered_at: nil, end_at: nil, provider_metadata: nil, recordings: nil, tags: nil, transcript: nil, request_options: {}) ⇒ Moonbase::Models::Call

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

Find and update an existing phone call, or create a new one.

Parameters:

Returns:

See Also:



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/moonbase/resources/calls.rb', line 140

def upsert(params)
  parsed, options = Moonbase::CallUpsertParams.dump_request(params)
  @client.request(
    method: :post,
    path: "calls/upsert",
    body: parsed,
    model: Moonbase::Call,
    options: options
  )
end