Class: SubskribeSandboxClient::IntegrationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/integrations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationsApi

Returns a new instance of IntegrationsApi.



19
20
21
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_integration(opts = {}) ⇒ nil

Add a Anrok integration Returns the integration ID if successful

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


27
28
29
30
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 27

def add_integration(opts = {})
  add_integration_with_http_info(opts)
  nil
end

#add_integration1(opts = {}) ⇒ nil

Add a TaxJar integration Returns the integration ID if successful

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


76
77
78
79
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 76

def add_integration1(opts = {})
  add_integration1_with_http_info(opts)
  nil
end

#add_integration1_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add a TaxJar integration Returns the integration ID if successful

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



86
87
88
89
90
91
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
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 86

def add_integration1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.add_integration1 ...'
  end
  # resource path
  local_var_path = '/taxjar'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#add_integration1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_integration_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add a Anrok integration Returns the integration ID if successful

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



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
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 37

def add_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.add_integration ...'
  end
  # resource path
  local_var_path = '/anrok'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#add_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authorization_code_callback(code, state, redirect_uri, opts = {}) ⇒ nil

Handle HubSpot authorization code Endpoint to handle and process a HubSpot authorization code

Parameters:

  • code

    authorization code

  • state

    HubSpot integration id

  • redirect_uri

    uri to redirect to HubSpot

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

    the optional parameters

Returns:

  • (nil)


127
128
129
130
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 127

def authorization_code_callback(code, state, redirect_uri, opts = {})
  authorization_code_callback_with_http_info(code, state, redirect_uri, opts)
  nil
end

#authorization_code_callback1(code, state, opts = {}) ⇒ nil

Callback for the authorization code Handles the authorization code callback from Salesforce

Parameters:

  • code

    authorization code

  • state

    id of the integration

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

    the optional parameters

Options Hash (opts):

  • :redirect_uri (String)

    uri to redirect to

Returns:

  • (nil)


193
194
195
196
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 193

def authorization_code_callback1(code, state, opts = {})
  authorization_code_callback1_with_http_info(code, state, opts)
  nil
end

#authorization_code_callback1_with_http_info(code, state, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Callback for the authorization code Handles the authorization code callback from Salesforce

Parameters:

  • code

    authorization code

  • state

    id of the integration

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

    the optional parameters

Options Hash (opts):

  • :redirect_uri (String)

    uri to redirect to

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 205

def authorization_code_callback1_with_http_info(code, state, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.authorization_code_callback1 ...'
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling IntegrationsApi.authorization_code_callback1"
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling IntegrationsApi.authorization_code_callback1"
  end
  # resource path
  local_var_path = '/sfdc'

  # query parameters
  query_params = {}
  query_params[:'code'] = code
  query_params[:'state'] = state
  query_params[:'redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#authorization_code_callback1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#authorization_code_callback_with_http_info(code, state, redirect_uri, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Handle HubSpot authorization code Endpoint to handle and process a HubSpot authorization code

Parameters:

  • code

    authorization code

  • state

    HubSpot integration id

  • redirect_uri

    uri to redirect to HubSpot

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
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
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 139

def authorization_code_callback_with_http_info(code, state, redirect_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.authorization_code_callback ...'
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling IntegrationsApi.authorization_code_callback"
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling IntegrationsApi.authorization_code_callback"
  end
  # verify the required parameter 'redirect_uri' is set
  if @api_client.config.client_side_validation && redirect_uri.nil?
    fail ArgumentError, "Missing the required parameter 'redirect_uri' when calling IntegrationsApi.authorization_code_callback"
  end
  # resource path
  local_var_path = '/hubspot'

  # query parameters
  query_params = {}
  query_params[:'code'] = code
  query_params[:'state'] = state
  query_params[:'redirect_uri'] = redirect_uri

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#authorization_code_callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#complete_integration(opts = {}) ⇒ DocuSignIntegrationResponseJson

Complete Docusign integration Complete the docusign integration. This should be called after the integration has been created and an authorization code has been received from Docusign.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :code (String)

    authorization code received from Docusign

  • :state (String)

    id of the integration

Returns:



254
255
256
257
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 254

def complete_integration(opts = {})
  data, _status_code, _headers = complete_integration_with_http_info(opts)
  data
end

#complete_integration_with_http_info(opts = {}) ⇒ Array<(DocuSignIntegrationResponseJson, Fixnum, Hash)>

Complete Docusign integration Complete the docusign integration. This should be called after the integration has been created and an authorization code has been received from Docusign.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :code (String)

    authorization code received from Docusign

  • :state (String)

    id of the integration

Returns:



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 265

def complete_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.complete_integration ...'
  end
  # resource path
  local_var_path = '/docusign'

  # query parameters
  query_params = {}
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocuSignIntegrationResponseJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#complete_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integration(opts = {}) ⇒ DocuSignIntegrationResponseJson

Delete Docusign integration Removes integration with Docusign from your tenant

Parameters:

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

    the optional parameters

Returns:



306
307
308
309
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 306

def delete_integration(opts = {})
  data, _status_code, _headers = delete_integration_with_http_info(opts)
  data
end

#delete_integration1(opts = {}) ⇒ nil

Delete HubSpot Integration Deletes your integration with HubSpot.

Parameters:

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

    the optional parameters

Returns:

  • (nil)


354
355
356
357
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 354

def delete_integration1(opts = {})
  delete_integration1_with_http_info(opts)
  nil
end

#delete_integration1_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete HubSpot Integration Deletes your integration with HubSpot.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 363

def delete_integration1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.delete_integration1 ...'
  end
  # resource path
  local_var_path = '/hubspot'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#delete_integration1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integration2(opts = {}) ⇒ nil

Delete Salesforce integration Removes the Salesforce integration for the tenant.

Parameters:

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

    the optional parameters

Returns:

  • (nil)


401
402
403
404
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 401

def delete_integration2(opts = {})
  delete_integration2_with_http_info(opts)
  nil
end

#delete_integration2_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Salesforce integration Removes the Salesforce integration for the tenant.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 410

def delete_integration2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.delete_integration2 ...'
  end
  # resource path
  local_var_path = '/sfdc'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#delete_integration2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_integration_with_http_info(opts = {}) ⇒ Array<(DocuSignIntegrationResponseJson, Fixnum, Hash)>

Delete Docusign integration Removes integration with Docusign from your tenant

Parameters:

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

    the optional parameters

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 315

def delete_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.delete_integration ...'
  end
  # resource path
  local_var_path = '/docusign'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DocuSignIntegrationResponseJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#delete_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_by_id(id, opts = {}) ⇒ SalesforceAccount

Get Salesforce account Gets a Salesforce account by its id.

Parameters:

  • id

    id of the account

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

    the optional parameters

Returns:



449
450
451
452
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 449

def (id, opts = {})
  data, _status_code, _headers = (id, opts)
  data
end

#get_account_by_id_with_http_info(id, opts = {}) ⇒ Array<(SalesforceAccount, Fixnum, Hash)>

Get Salesforce account Gets a Salesforce account by its id.

Parameters:

  • id

    id of the account

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

    the optional parameters

Returns:

  • (Array<(SalesforceAccount, Fixnum, Hash)>)

    SalesforceAccount data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 459

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_account_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationsApi.get_account_by_id"
  end
  # resource path
  local_var_path = '/sfdc/account/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SalesforceAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_account_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounts_by_name(name, opts = {}) ⇒ Array<SalesforceAccount>

Get Salesforce accounts Returns Salesforce accounts matching the specified name.

Parameters:

  • name

    account name

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

    the optional parameters

Returns:



501
502
503
504
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 501

def get_accounts_by_name(name, opts = {})
  data, _status_code, _headers = get_accounts_by_name_with_http_info(name, opts)
  data
end

#get_accounts_by_name_with_http_info(name, opts = {}) ⇒ Array<(Array<SalesforceAccount>, Fixnum, Hash)>

Get Salesforce accounts Returns Salesforce accounts matching the specified name.

Parameters:

  • name

    account name

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

    the optional parameters

Returns:

  • (Array<(Array<SalesforceAccount>, Fixnum, Hash)>)

    Array<SalesforceAccount> data, response status code and response headers



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 511

def get_accounts_by_name_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_accounts_by_name ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling IntegrationsApi.get_accounts_by_name"
  end
  # resource path
  local_var_path = '/sfdc/account'

  # query parameters
  query_params = {}
  query_params[:'name'] = name

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<SalesforceAccount>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_accounts_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration(integration_id, opts = {}) ⇒ Integration

Get integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:



554
555
556
557
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 554

def get_integration(integration_id, opts = {})
  data, _status_code, _headers = get_integration_with_http_info(integration_id, opts)
  data
end

#get_integration1(integration_id, opts = {}) ⇒ AvalaraIntegration

Gets Avalara integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:



606
607
608
609
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 606

def get_integration1(integration_id, opts = {})
  data, _status_code, _headers = get_integration1_with_http_info(integration_id, opts)
  data
end

#get_integration1_with_http_info(integration_id, opts = {}) ⇒ Array<(AvalaraIntegration, Fixnum, Hash)>

Gets Avalara integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:

  • (Array<(AvalaraIntegration, Fixnum, Hash)>)

    AvalaraIntegration data, response status code and response headers



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 616

def get_integration1_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration1 ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.get_integration1"
  end
  # resource path
  local_var_path = '/avalara/{integrationId}'.sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AvalaraIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration2(integration_id, opts = {}) ⇒ TaxJarIntegration

Get integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:



658
659
660
661
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 658

def get_integration2(integration_id, opts = {})
  data, _status_code, _headers = get_integration2_with_http_info(integration_id, opts)
  data
end

#get_integration2_with_http_info(integration_id, opts = {}) ⇒ Array<(TaxJarIntegration, Fixnum, Hash)>

Get integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:

  • (Array<(TaxJarIntegration, Fixnum, Hash)>)

    TaxJarIntegration data, response status code and response headers



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 668

def get_integration2_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration2 ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.get_integration2"
  end
  # resource path
  local_var_path = '/taxjar/{integrationId}'.sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxJarIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_by_tenant(opts = {}) ⇒ AvalaraIntegration

Gets Avalara integration details Returns the details of the Avalara integration for your tenant

Parameters:

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

    the optional parameters

Returns:



709
710
711
712
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 709

def get_integration_by_tenant(opts = {})
  data, _status_code, _headers = get_integration_by_tenant_with_http_info(opts)
  data
end

#get_integration_by_tenant_with_http_info(opts = {}) ⇒ Array<(AvalaraIntegration, Fixnum, Hash)>

Gets Avalara integration details Returns the details of the Avalara integration for your tenant

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AvalaraIntegration, Fixnum, Hash)>)

    AvalaraIntegration data, response status code and response headers



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 718

def get_integration_by_tenant_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration_by_tenant ...'
  end
  # resource path
  local_var_path = '/avalara'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AvalaraIntegration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration_by_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_with_http_info(integration_id, opts = {}) ⇒ Array<(Integration, Fixnum, Hash)>

Get integration details Gets the integration details of the specified integration id

Parameters:

  • integration_id

    integration id

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

    the optional parameters

Returns:

  • (Array<(Integration, Fixnum, Hash)>)

    Integration data, response status code and response headers



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 564

def get_integration_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_integration ...'
  end
  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.get_integration"
  end
  # resource path
  local_var_path = '/anrok/{integrationId}'.sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_opportunities_by_account_id(account_id, opts = {}) ⇒ Array<Opportunity>

Get Salesforce opportunities Returns the Salesforce opportunities associated withe the specified account.

Parameters:

  • account_id

    id of the account

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

    the optional parameters

Returns:



756
757
758
759
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 756

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

#get_opportunities_by_account_id_with_http_info(account_id, opts = {}) ⇒ Array<(Array<Opportunity>, Fixnum, Hash)>

Get Salesforce opportunities Returns the Salesforce opportunities associated withe the specified account.

Parameters:

  • account_id

    id of the account

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

    the optional parameters

Returns:

  • (Array<(Array<Opportunity>, Fixnum, Hash)>)

    Array<Opportunity> data, response status code and response headers



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 766

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_opportunities_by_account_id ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling IntegrationsApi.get_opportunities_by_account_id"
  end
  # resource path
  local_var_path = '/sfdc/opportunity'

  # query parameters
  query_params = {}
  query_params[:'accountId'] = 

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Opportunity>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_opportunities_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_account(body, opts = {}) ⇒ nil

Import account from Salesforce Imports an account from Salesforce. On success a redirect uri is returned.

Parameters:

  • body

    json representation of the account

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

    the optional parameters

Returns:

  • (nil)


809
810
811
812
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 809

def (body, opts = {})
  (body, opts)
  nil
end

#import_account_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Import account from Salesforce Imports an account from Salesforce. On success a redirect uri is returned.

Parameters:

  • body

    json representation of the account

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 819

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.import_account ...'
  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 IntegrationsApi.import_account"
  end
  # resource path
  local_var_path = '/sfdc/account'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#import_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initiate_integration(opts = {}) ⇒ nil

Create Docusign integration Creates an integration with Docusign. On success a redirect URL is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


862
863
864
865
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 862

def initiate_integration(opts = {})
  initiate_integration_with_http_info(opts)
  nil
end

#initiate_integration1(opts = {}) ⇒ String

Initiate a HubSpot integration Initiates an integration with HubSpot. On success redirect URL is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :email (String)

    admin email

Returns:

  • (String)


911
912
913
914
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 911

def initiate_integration1(opts = {})
  data, _status_code, _headers = initiate_integration1_with_http_info(opts)
  data
end

#initiate_integration1_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Initiate a HubSpot integration Initiates an integration with HubSpot. On success redirect URL is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :email (String)

    admin email

Returns:

  • (Array<(String, Fixnum, Hash)>)

    String data, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 921

def initiate_integration1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.initiate_integration1 ...'
  end
  # resource path
  local_var_path = '/hubspot'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'email'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#initiate_integration1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initiate_integration2(opts = {}) ⇒ nil

Initiate integration with Salesforce Initiate a Salesforce integration. On success a redirect url is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


961
962
963
964
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 961

def initiate_integration2(opts = {})
  initiate_integration2_with_http_info(opts)
  nil
end

#initiate_integration2_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Initiate integration with Salesforce Initiate a Salesforce integration. On success a redirect url is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 971

def initiate_integration2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.initiate_integration2 ...'
  end
  # resource path
  local_var_path = '/sfdc'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#initiate_integration2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initiate_integration_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create Docusign integration Creates an integration with Docusign. On success a redirect URL is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 872

def initiate_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.initiate_integration ...'
  end
  # resource path
  local_var_path = '/docusign'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#initiate_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#integrate(opts = {}) ⇒ nil

Create an Avalara integration Creates an integration with Avalara according to the specified details. On success the id of the integration is returned

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


1010
1011
1012
1013
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1010

def integrate(opts = {})
  integrate_with_http_info(opts)
  nil
end

#integrate_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create an Avalara integration Creates an integration with Avalara according to the specified details. On success the id of the integration is returned

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1020

def integrate_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.integrate ...'
  end
  # resource path
  local_var_path = '/avalara'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#integrate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ping(opts = {}) ⇒ nil

Pings Avalara Once an integration is set up Avalara can be pinged to ensure it is working correctly. On success "PONG" is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil)


1059
1060
1061
1062
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1059

def ping(opts = {})
  ping_with_http_info(opts)
  nil
end

#ping_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Pings Avalara Once an integration is set up Avalara can be pinged to ensure it is working correctly. On success &quot;PONG&quot; is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1069

def ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.ping ...'
  end
  # resource path
  local_var_path = '/avalara/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setup_hub_spot(opts = {}) ⇒ nil

Add custom properties to HubSpot Add custom properties to HubSpot

Parameters:

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

    the optional parameters

Returns:

  • (nil)


1105
1106
1107
1108
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1105

def setup_hub_spot(opts = {})
  setup_hub_spot_with_http_info(opts)
  nil
end

#setup_hub_spot_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add custom properties to HubSpot Add custom properties to HubSpot

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1114

def setup_hub_spot_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.setup_hub_spot ...'
  end
  # resource path
  local_var_path = '/hubspot/setup'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#setup_hub_spot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_account_to_salesforce(id, opts = {}) ⇒ nil

Sync an account to Salesforce Syncs the account ARR and its orders to Salesforce.

Parameters:

  • id

    account id to sync

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

    the optional parameters

Returns:

  • (nil)


1153
1154
1155
1156
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1153

def (id, opts = {})
  (id, opts)
  nil
end

#sync_account_to_salesforce_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Sync an account to Salesforce Syncs the account ARR and its orders to Salesforce.

Parameters:

  • id

    account id to sync

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1163

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_account_to_salesforce ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationsApi.sync_account_to_salesforce"
  end
  # resource path
  local_var_path = '/sfdc/syncAccount/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_account_to_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_deleted_orders_to_salesforce(ids, opts = {}) ⇒ OrderJson

Sync orders to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • ids

    opportunityIds

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

    the optional parameters

Returns:



1206
1207
1208
1209
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1206

def sync_deleted_orders_to_salesforce(ids, opts = {})
  data, _status_code, _headers = sync_deleted_orders_to_salesforce_with_http_info(ids, opts)
  data
end

#sync_deleted_orders_to_salesforce_with_http_info(ids, opts = {}) ⇒ Array<(OrderJson, Fixnum, Hash)>

Sync orders to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • ids

    opportunityIds

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

    the optional parameters

Returns:

  • (Array<(OrderJson, Fixnum, Hash)>)

    OrderJson data, response status code and response headers



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1216

def sync_deleted_orders_to_salesforce_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_deleted_orders_to_salesforce ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling IntegrationsApi.sync_deleted_orders_to_salesforce"
  end
  # resource path
  local_var_path = '/sfdc/syncDeletedOrders'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(ids)
  auth_names = ['ApiKeyAuth']
  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 => 'OrderJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_deleted_orders_to_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_esign_details_for_order_to_hub_spot(order_id, opts = {}) ⇒ nil

Sync esign details for order id

Parameters:

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

    the optional parameters

Returns:

  • (nil)


1260
1261
1262
1263
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1260

def sync_esign_details_for_order_to_hub_spot(order_id, opts = {})
  sync_esign_details_for_order_to_hub_spot_with_http_info(order_id, opts)
  nil
end

#sync_esign_details_for_order_to_hub_spot_with_http_info(order_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Sync esign details for order id

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1270

def sync_esign_details_for_order_to_hub_spot_with_http_info(order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_esign_details_for_order_to_hub_spot ...'
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling IntegrationsApi.sync_esign_details_for_order_to_hub_spot"
  end
  # resource path
  local_var_path = '/hubspot/esign/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_esign_details_for_order_to_hub_spot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_order_to_salesforce(id, opts = {}) ⇒ OrderJson

Sync order to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • id

    order id

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

    the optional parameters

Returns:



1313
1314
1315
1316
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1313

def sync_order_to_salesforce(id, opts = {})
  data, _status_code, _headers = sync_order_to_salesforce_with_http_info(id, opts)
  data
end

#sync_order_to_salesforce_with_http_info(id, opts = {}) ⇒ Array<(OrderJson, Fixnum, Hash)>

Sync order to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • id

    order id

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

    the optional parameters

Returns:

  • (Array<(OrderJson, Fixnum, Hash)>)

    OrderJson data, response status code and response headers



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1323

def sync_order_to_salesforce_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_order_to_salesforce ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationsApi.sync_order_to_salesforce"
  end
  # resource path
  local_var_path = '/sfdc/sync/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'OrderJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_order_to_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_orders_to_salesforce(ids, opts = {}) ⇒ OrderJson

Sync orders to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • ids

    order ids

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

    the optional parameters

Returns:



1367
1368
1369
1370
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1367

def sync_orders_to_salesforce(ids, opts = {})
  data, _status_code, _headers = sync_orders_to_salesforce_with_http_info(ids, opts)
  data
end

#sync_orders_to_salesforce_with_http_info(ids, opts = {}) ⇒ Array<(OrderJson, Fixnum, Hash)>

Sync orders to Salesforce Syncs the specified order to Salesforce.

Parameters:

  • ids

    order ids

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

    the optional parameters

Returns:

  • (Array<(OrderJson, Fixnum, Hash)>)

    OrderJson data, response status code and response headers



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1377

def sync_orders_to_salesforce_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_orders_to_salesforce ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling IntegrationsApi.sync_orders_to_salesforce"
  end
  # resource path
  local_var_path = '/sfdc/syncOrders'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(ids)
  auth_names = ['ApiKeyAuth']
  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 => 'OrderJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_orders_to_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_tenant_to_salesforce(tenant_id, opts = {}) ⇒ nil

Sync whole tenant to Salesforce in a paginated fashion Syncs the specified tenant to Salesforce. Returns paginated JSON of accounts which were synced

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:

  • (nil)


1423
1424
1425
1426
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1423

def sync_tenant_to_salesforce(tenant_id, opts = {})
  sync_tenant_to_salesforce_with_http_info(tenant_id, opts)
  nil
end

#sync_tenant_to_salesforce_with_http_info(tenant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Sync whole tenant to Salesforce in a paginated fashion Syncs the specified tenant to Salesforce. Returns paginated JSON of accounts which were synced

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1435

def sync_tenant_to_salesforce_with_http_info(tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.sync_tenant_to_salesforce ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling IntegrationsApi.sync_tenant_to_salesforce"
  end
  # resource path
  local_var_path = '/sfdc/syncTenant'

  # query parameters
  query_params = {}
  query_params[:'tenantId'] = tenant_id
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#sync_tenant_to_salesforce\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_integration(opts = {}) ⇒ String

Test an integration is valid

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String)


1481
1482
1483
1484
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1481

def test_integration(opts = {})
  data, _status_code, _headers = test_integration_with_http_info(opts)
  data
end

#test_integration1(opts = {}) ⇒ String

Test an integration is valid

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String)


1531
1532
1533
1534
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1531

def test_integration1(opts = {})
  data, _status_code, _headers = test_integration1_with_http_info(opts)
  data
end

#test_integration1_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Test an integration is valid

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(String, Fixnum, Hash)>)

    String data, response status code and response headers



1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1541

def test_integration1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.test_integration1 ...'
  end
  # resource path
  local_var_path = '/taxjar/test'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#test_integration1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_integration_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Test an integration is valid

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(String, Fixnum, Hash)>)

    String data, response status code and response headers



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1491

def test_integration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.test_integration ...'
  end
  # resource path
  local_var_path = '/anrok/test'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#test_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_primary_order_id_for_opportunity(id, opts = {}) ⇒ OrderJson

Make an order primary Marks an order as the primary order for its opportunity.

Parameters:

  • id

    order id

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

    the optional parameters

Returns:



1581
1582
1583
1584
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1581

def update_primary_order_id_for_opportunity(id, opts = {})
  data, _status_code, _headers = update_primary_order_id_for_opportunity_with_http_info(id, opts)
  data
end

#update_primary_order_id_for_opportunity_with_http_info(id, opts = {}) ⇒ Array<(OrderJson, Fixnum, Hash)>

Make an order primary Marks an order as the primary order for its opportunity.

Parameters:

  • id

    order id

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

    the optional parameters

Returns:

  • (Array<(OrderJson, Fixnum, Hash)>)

    OrderJson data, response status code and response headers



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1591

def update_primary_order_id_for_opportunity_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.update_primary_order_id_for_opportunity ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IntegrationsApi.update_primary_order_id_for_opportunity"
  end
  # resource path
  local_var_path = '/sfdc/order/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  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 => 'OrderJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#update_primary_order_id_for_opportunity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_setup(opts = {}) ⇒ nil

Verify HubSpot setup Verify custom objects and properties

Parameters:

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

    the optional parameters

Returns:

  • (nil)


1634
1635
1636
1637
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1634

def verify_setup(opts = {})
  verify_setup_with_http_info(opts)
  nil
end

#verify_setup_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Verify HubSpot setup Verify custom objects and properties

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
# File 'lib/subskribe_sandbox/api/integrations_api.rb', line 1643

def verify_setup_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationsApi.verify_setup ...'
  end
  # resource path
  local_var_path = '/hubspot/setup/verify'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#verify_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end