Class: GongAPI::EngagementInBetaPhaseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/api/engagement_in_beta_phase_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EngagementInBetaPhaseApi

Returns a new instance of EngagementInBetaPhaseApi.



16
17
18
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#content_shared_using_put(body, opts = {}) ⇒ BaseResponse

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:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 24

def content_shared_using_put(body, opts = {})
  data, _status_code, _headers = content_shared_using_put_with_http_info(body, opts)
  data
end

#content_shared_using_put_with_http_info(body, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

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 &#x27;api:engagement-data:write&#x27;.

Parameters:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



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
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 34

def content_shared_using_put_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EngagementInBetaPhaseApi.content_shared_using_put ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EngagementInBetaPhaseApi.content_shared_using_put"
  end
  # resource path
  local_var_path = '/v2/customer-engagement/content/shared'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'BaseResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EngagementInBetaPhaseApi#content_shared_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#content_viewed_using_put(body, opts = {}) ⇒ BaseResponse

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:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 82

def content_viewed_using_put(body, opts = {})
  data, _status_code, _headers = content_viewed_using_put_with_http_info(body, opts)
  data
end

#content_viewed_using_put_with_http_info(body, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

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 &#x27;api:engagement-data:write&#x27;.

Parameters:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 92

def content_viewed_using_put_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EngagementInBetaPhaseApi.content_viewed_using_put ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EngagementInBetaPhaseApi.content_viewed_using_put"
  end
  # resource path
  local_var_path = '/v2/customer-engagement/content/viewed'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'BaseResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EngagementInBetaPhaseApi#content_viewed_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#custom_action_using_put(body, opts = {}) ⇒ BaseResponse

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:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 140

def custom_action_using_put(body, opts = {})
  data, _status_code, _headers = custom_action_using_put_with_http_info(body, opts)
  data
end

#custom_action_using_put_with_http_info(body, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

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 &#x27;api:engagement-data:write&#x27;.

Parameters:

  • body —

    request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/gong_api/api/engagement_in_beta_phase_api.rb', line 150

def custom_action_using_put_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EngagementInBetaPhaseApi.custom_action_using_put ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling EngagementInBetaPhaseApi.custom_action_using_put"
  end
  # resource path
  local_var_path = '/v2/customer-engagement/action'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'BaseResponse' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EngagementInBetaPhaseApi#custom_action_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end