Class: Hubspot::Crm::Extensions::Calling::SettingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SettingsApi

Returns a new instance of SettingsApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive(app_id, opts = {}) ⇒ nil

Delete calling settings Deletes this calling extension. This will remove your service as an option for all connected accounts.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 30

def archive(app_id, opts = {})
  archive_with_http_info(app_id, opts)
  nil
end

#archive_with_http_info(app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete calling settings Deletes this calling extension. This will remove your service as an option for all connected accounts.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 40

def archive_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.archive ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/calling/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

  # 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(['*/*'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(app_id, settings_request, opts = {}) ⇒ SettingsResponse

Configure a calling extension Used to set the menu label, target iframe URL, and dimensions for your calling extension.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • settings_request (SettingsRequest) —

    Settings state to create with.

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

    the optional parameters

Returns:



93
94
95
96
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 93

def create(app_id, settings_request, opts = {})
  data, _status_code, _headers = create_with_http_info(app_id, settings_request, opts)
  data
end

#create_with_http_info(app_id, settings_request, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>

Configure a calling extension Used to set the menu label, target iframe URL, and dimensions for your calling extension.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • settings_request (SettingsRequest) —

    Settings state to create with.

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

    the optional parameters

Returns:

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

    SettingsResponse data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 104

def create_with_http_info(app_id, settings_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.create ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.create"
  end
  # verify the required parameter 'settings_request' is set
  if @api_client.config.client_side_validation && settings_request.nil?
    fail ArgumentError, "Missing the required parameter 'settings_request' when calling SettingsApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/calling/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

  # 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(['application/json', '*/*'])
  # 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(settings_request) 

  # return_type
  return_type = opts[:return_type] || 'SettingsResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(app_id, opts = {}) ⇒ SettingsResponse

Get calling settings Returns the calling extension settings configured for your app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 162

def get_by_id(app_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(app_id, opts)
  data
end

#get_by_id_with_http_info(app_id, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>

Get calling settings Returns the calling extension settings configured for your app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    SettingsResponse data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 172

def get_by_id_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_by_id ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/calling/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

  # 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(['application/json', '*/*'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SettingsResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(app_id, settings_patch_request, opts = {}) ⇒ SettingsResponse

Update settings Updates existing calling extension settings.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • settings_patch_request (SettingsPatchRequest) —

    Updated details for the settings.

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

    the optional parameters

Returns:



225
226
227
228
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 225

def update(app_id, settings_patch_request, opts = {})
  data, _status_code, _headers = update_with_http_info(app_id, settings_patch_request, opts)
  data
end

#update_with_http_info(app_id, settings_patch_request, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>

Update settings Updates existing calling extension settings.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • settings_patch_request (SettingsPatchRequest) —

    Updated details for the settings.

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

    the optional parameters

Returns:

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

    SettingsResponse data, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/hubspot/codegen/crm/extensions/calling/api/settings_api.rb', line 236

def update_with_http_info(app_id, settings_patch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.update ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.update"
  end
  # verify the required parameter 'settings_patch_request' is set
  if @api_client.config.client_side_validation && settings_patch_request.nil?
    fail ArgumentError, "Missing the required parameter 'settings_patch_request' when calling SettingsApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/calling/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))

  # 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(['application/json', '*/*'])
  # 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(settings_patch_request) 

  # return_type
  return_type = opts[:return_type] || 'SettingsResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end