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
96
97
98
99
100
101

# \EngagementLegacySeeDigitalInteractionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**content_shared**](EngagementLegacySeeDigitalInteractionsApi.md#content_shared) | **PUT** /v2/customer-engagement/content/shared | Report event of a content share (/v2/customer-engagement/content/shared)
[**content_viewed**](EngagementLegacySeeDigitalInteractionsApi.md#content_viewed) | **PUT** /v2/customer-engagement/content/viewed | Report event of a content view (/v2/customer-engagement/content/viewed)
[**custom_action**](EngagementLegacySeeDigitalInteractionsApi.md#custom_action) | **PUT** /v2/customer-engagement/action | Report event of a custom action (/v2/customer-engagement/action)



## content_shared

> models::RegisterGenericCrmResponse content_shared(content_shared_event)
Report event of a content share (/v2/customer-engagement/content/shared)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**content_shared_event** | [**ContentSharedEvent**](ContentSharedEvent.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

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

[[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)


## content_viewed

> models::RegisterGenericCrmResponse content_viewed(content_viewed_event)
Report event of a content view (/v2/customer-engagement/content/viewed)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**content_viewed_event** | [**ContentViewedEvent**](ContentViewedEvent.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

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

[[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)


## custom_action

> models::RegisterGenericCrmResponse custom_action(custom_action_event)
Report event of a custom action (/v2/customer-engagement/action)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**custom_action_event** | [**CustomActionEvent**](CustomActionEvent.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

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

[[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)