gong-rs 0.0.1

A gong.io API client for the Rust language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# \SettingsApi

All URIs are relative to *https://127.0.0.1:8443*

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_scorecards**](SettingsApi.md#list_scorecards) | **GET** /v2/settings/scorecards | Retrieve scorecards details (/v2/settings/scorecards)
[**list_trackers**](SettingsApi.md#list_trackers) | **GET** /v2/settings/trackers | Retrieve tracker details (/v2/settings/trackers)
[**list_workspaces**](SettingsApi.md#list_workspaces) | **GET** /v2/workspaces | List all company workspaces (/v2/workspaces)



## list_scorecards

> models::Scorecards list_scorecards()
Retrieve scorecards details (/v2/settings/scorecards)

Retrieve all the scorecards within the Gong system.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Scorecards**](Scorecards.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_trackers

> models::Trackers list_trackers(workspace_id)
Retrieve tracker details (/v2/settings/trackers)

Retrieves details of all keyword trackers in the system or in a given workspace.  When accessed through a Bearer token authorization method, this endpoint requires the  'api:settings:trackers:read' scope.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace_id** | Option<**String**> | The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned. |  |

### Return type

[**models::Trackers**](Trackers.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_workspaces

> models::WorkspacesMetadata list_workspaces()
List all company workspaces (/v2/workspaces)

Returns a list of all workspaces including their details.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::WorkspacesMetadata**](WorkspacesMetadata.md)

### Authorization

[BasicAuth](../README.md#BasicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)