Class: Leash::Integration::GongClient

Inherits:
Object
  • Object
show all
Defined in:
lib/leash/integration/gong.rb

Instance Method Summary collapse

Constructor Details

#initialize(leash) ⇒ GongClient

Create a new Gong integration client.

Parameters:

  • leash (Leash::Client) —

    the Leash SDK client



11
12
13
 
# File 'lib/leash/integration/gong.rb', line 11

def initialize(leash)
  @leash = leash
end

Instance Method Details

#get_call(callid) ⇒ Object

Get metadata for a specific Gong call including URL, direction, scope, system, and duration. Faster than get_call_summary when you only need call metadata.

Parameters:

  • callid (String) —

    Gong call ID (numeric string up to 20 digits)

Returns:

  • (Object) 


96
97
98
99
100
101
 
# File 'lib/leash/integration/gong.rb', line 96

def get_call(callid)
  params = {
    'callId' => callid
  }.compact
  @leash.call('gong', 'get_call', params)
end

#get_call_summary(callid) ⇒ Object

Get an AI-generated summary of a single call including brief overview, key points, topics, action items, and detailed outline. This is the recommended way to understand a call - use get_call_transc…

Parameters:

  • callid (String) —

    Gong call ID (numeric string up to 20 digits)

Returns:

  • (Object) 


36
37
38
39
40
41
 
# File 'lib/leash/integration/gong.rb', line 36

def get_call_summary(callid)
  params = {
    'callId' => callid
  }.compact
  @leash.call('gong', 'get_call_summary', params)
end

#get_call_transcript(callid, maxlength: nil, offset: nil) ⇒ Object

Get the raw transcript for a single call with speaker-attributed text. Only use this when you need exact quotes - prefer get_call_summary for understanding call content. Transcripts are truncated b…

Parameters:

  • callid (String) —

    Gong call ID (numeric string up to 20 digits)

  • maxlength (Float, nil) (defaults to: nil) —

    Maximum characters to return (default: 10000, ~10KB). Longer transcripts are truncated with pagination info.

  • offset (Float, nil) (defaults to: nil) —

    Character offset to start from (default: 0). Use to paginate through long transcripts.

Returns:

  • (Object) 


49
50
51
52
53
54
55
56
 
# File 'lib/leash/integration/gong.rb', line 49

def get_call_transcript(callid, maxlength: nil, offset: nil)
  params = {
    'callId' => callid,
    'maxLength' => maxlength,
    'offset' => offset
  }.compact
  @leash.call('gong', 'get_call_transcript', params)
end

#get_library_folder_calls(folderid) ⇒ Object

Get all calls saved in a specific Gong library folder. Returns call IDs, titles, curator notes, and snippet timing. Use list_library_folders to find folder IDs. Call IDs can be passed to get_call_s…

Parameters:

  • folderid (String) —

    Library folder ID (numeric string, from list_library_folders)

Returns:

  • (Object) 


165
166
167
168
169
170
 
# File 'lib/leash/integration/gong.rb', line 165

def get_library_folder_calls(folderid)
  params = {
    'folderId' => folderid
  }.compact
  @leash.call('gong', 'get_library_folder_calls', params)
end

#get_trackers(workspaceid: nil) ⇒ Object

List all keyword tracker definitions including tracked phrases, affiliation (who speaks them), and filter queries. Explains tracker hits visible in call summaries.

Parameters:

  • workspaceid (String, nil) (defaults to: nil) —

    Filter trackers by workspace ID

Returns:

  • (Object) 


107
108
109
110
111
112
 
# File 'lib/leash/integration/gong.rb', line 107

def get_trackers(workspaceid: nil)
  params = {
    'workspaceId' => workspaceid
  }.compact
  @leash.call('gong', 'get_trackers', params)
end

#get_user(userid) ⇒ Object

Get a specific user profile including name, email, title, phone, and settings. Use to resolve user IDs returned from call data.

Parameters:

  • userid (String) —

    Gong user ID (numeric string up to 20 digits)

Returns:

  • (Object) 


118
119
120
121
122
123
 
# File 'lib/leash/integration/gong.rb', line 118

def get_user(userid)
  params = {
    'userId' => userid
  }.compact
  @leash.call('gong', 'get_user', params)
end

#list_calls(fromdatetime: nil, todatetime: nil, workspaceid: nil, cursor: nil) ⇒ Object

List Gong calls with optional date filtering. Returns minimal call metadata (ID, title, date, duration). Use get_call_summary for details or get_call_transcript for full transcript.

Parameters:

  • fromdatetime (String, nil) (defaults to: nil) —

    Start date/time filter in ISO 8601 format (e.g., 2024-01-01T00:00:00Z). Must be before toDateTime if both specified.

  • todatetime (String, nil) (defaults to: nil) —

    End date/time filter in ISO 8601 format (e.g., 2024-01-31T23:59:59Z). Must be after fromDateTime if both specified.

  • workspaceid (String, nil) (defaults to: nil) —

    Filter calls by workspace ID (numeric string up to 20 digits)

  • cursor (String, nil) (defaults to: nil) —

    Pagination cursor for fetching next page of results

Returns:

  • (Object) 


22
23
24
25
26
27
28
29
30
 
# File 'lib/leash/integration/gong.rb', line 22

def list_calls(fromdatetime: nil, todatetime: nil, workspaceid: nil, cursor: nil)
  params = {
    'fromDateTime' => fromdatetime,
    'toDateTime' => todatetime,
    'workspaceId' => workspaceid,
    'cursor' => cursor
  }.compact
  @leash.call('gong', 'list_calls', params)
end

#list_library_folders(workspaceid) ⇒ Object

List all public Gong call library folders for a workspace. Returns folder IDs and names to use with get_library_folder_calls. Use list_workspaces to find workspace IDs.

Parameters:

  • workspaceid (String) —

    Workspace ID to list folders for (use list_workspaces to find IDs)

Returns:

  • (Object) 


154
155
156
157
158
159
 
# File 'lib/leash/integration/gong.rb', line 154

def list_library_folders(workspaceid)
  params = {
    'workspaceId' => workspaceid
  }.compact
  @leash.call('gong', 'list_library_folders', params)
end

#list_users(cursor: nil, includeavatars: nil) ⇒ Object

List all Gong users in your workspace. Returns user details including name, email, and title.

Parameters:

  • cursor (String, nil) (defaults to: nil) —

    Pagination cursor for fetching next page of results

  • includeavatars (Boolean, nil) (defaults to: nil) —

    Whether to include user avatar URLs in the response

Returns:

  • (Object) 


63
64
65
66
67
68
69
 
# File 'lib/leash/integration/gong.rb', line 63

def list_users(cursor: nil, includeavatars: nil)
  params = {
    'cursor' => cursor,
    'includeAvatars' => includeavatars
  }.compact
  @leash.call('gong', 'list_users', params)
end

#list_workspaces ⇒ Object

List all Gong workspaces with their IDs and names. Use workspace IDs as filters in list_calls, search_calls, get_trackers, and other tools.

Returns:

  • (Object) 


145
146
147
148
 
# File 'lib/leash/integration/gong.rb', line 145

def list_workspaces
  params = {}
  @leash.call('gong', 'list_workspaces', params)
end

#search_calls(fromdatetime: nil, todatetime: nil, workspaceid: nil, primaryuserids: nil, callids: nil, cursor: nil) ⇒ Object

Search for Gong calls with advanced filters including date range, workspace, primary users (call hosts), and specific call IDs. More flexible than list_calls for targeted queries.

Parameters:

  • fromdatetime (String, nil) (defaults to: nil) —

    Start date/time filter in ISO 8601 format (e.g., 2024-01-01T00:00:00Z). Must be before toDateTime if both specified.

  • todatetime (String, nil) (defaults to: nil) —

    End date/time filter in ISO 8601 format (e.g., 2024-01-31T23:59:59Z). Must be after fromDateTime if both specified.

  • workspaceid (String, nil) (defaults to: nil) —

    Filter calls by workspace ID (numeric string up to 20 digits)

  • primaryuserids (Array, nil) (defaults to: nil) —

    Filter by primary user IDs (call hosts). Array of numeric strings.

  • callids (Array, nil) (defaults to: nil) —

    Filter by specific call IDs. Array of numeric strings.

  • cursor (String, nil) (defaults to: nil) —

    Pagination cursor for fetching next page of results

Returns:

  • (Object) 


80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/leash/integration/gong.rb', line 80

def search_calls(fromdatetime: nil, todatetime: nil, workspaceid: nil, primaryuserids: nil, callids: nil, cursor: nil)
  params = {
    'fromDateTime' => fromdatetime,
    'toDateTime' => todatetime,
    'workspaceId' => workspaceid,
    'primaryUserIds' => primaryuserids,
    'callIds' => callids,
    'cursor' => cursor
  }.compact
  @leash.call('gong', 'search_calls', params)
end

#search_users(userids: nil, createdfromdatetime: nil, createdtodatetime: nil, cursor: nil) ⇒ Object

Search and filter users by IDs or creation date. More flexible than list_users for resolving specific user IDs from call data.

Parameters:

  • userids (Array, nil) (defaults to: nil) —

    Specific user IDs to look up

  • createdfromdatetime (String, nil) (defaults to: nil) —

    Filter users created after this datetime (ISO 8601)

  • createdtodatetime (String, nil) (defaults to: nil) —

    Filter users created before this datetime (ISO 8601)

  • cursor (String, nil) (defaults to: nil) —

    Pagination cursor for fetching next page

Returns:

  • (Object) 


132
133
134
135
136
137
138
139
140
 
# File 'lib/leash/integration/gong.rb', line 132

def search_users(userids: nil, createdfromdatetime: nil, createdtodatetime: nil, cursor: nil)
  params = {
    'userIds' => userids,
    'createdFromDateTime' => createdfromdatetime,
    'createdToDateTime' => createdtodatetime,
    'cursor' => cursor
  }.compact
  @leash.call('gong', 'search_users', params)
end