Class: Hubspot::Crm::Associations::V4::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchApi

Returns a new instance of BatchApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_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/associations/v4/api/batch_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts = {}) ⇒ nil

Delete Batch delete associations for objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_archive (BatchInputPublicAssociationMultiArchive)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 32

def archive(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts = {})
  archive_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts)
  nil
end

#archive_labels(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {}) ⇒ nil

Delete Specific Labels Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_post (BatchInputPublicAssociationMultiPost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


112
113
114
115
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 112

def archive_labels(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
  archive_labels_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts)
  nil
end

#archive_labels_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Specific Labels Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_post (BatchInputPublicAssociationMultiPost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
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
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 124

def archive_labels_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive_labels ...'
  end
  # verify the required parameter 'from_object_type' is set
  if @api_client.config.client_side_validation && from_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.archive_labels"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive_labels"
  end
  # verify the required parameter 'batch_input_public_association_multi_post' is set
  if @api_client.config.client_side_validation && batch_input_public_association_multi_post.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_post' when calling BatchApi.archive_labels"
  end
  # resource path
  local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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(['*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.archive_labels",
    :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: BatchApi#archive_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Batch delete associations for objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_archive (BatchInputPublicAssociationMultiArchive)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 44

def archive_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
  end
  # verify the required parameter 'from_object_type' is set
  if @api_client.config.client_side_validation && from_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.archive"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive"
  end
  # verify the required parameter 'batch_input_public_association_multi_archive' is set
  if @api_client.config.client_side_validation && batch_input_public_association_multi_archive.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_archive' when calling BatchApi.archive"
  end
  # resource path
  local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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(['*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.archive",
    :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: BatchApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {}) ⇒ BatchResponseLabelsBetweenObjectPair

Create Batch create associations for objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_post (BatchInputPublicAssociationMultiPost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 192

def create(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
  data, _status_code, _headers = create_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts)
  data
end

#create_default(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {}) ⇒ BatchResponsePublicDefaultAssociation

Create Default Associations Create the default (most generic) association type between two object types

Parameters:

Returns:



272
273
274
275
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 272

def create_default(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {})
  data, _status_code, _headers = create_default_with_http_info(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts)
  data
end

#create_default_with_http_info(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {}) ⇒ Array<(BatchResponsePublicDefaultAssociation, Integer, Hash)>

Create Default Associations Create the default (most generic) association type between two object types

Parameters:

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
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
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 284

def create_default_with_http_info(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create_default ...'
  end
  # verify the required parameter 'from_object_type' is set
  if @api_client.config.client_side_validation && from_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.create_default"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create_default"
  end
  # verify the required parameter 'batch_input_public_default_association_multi_post' is set
  if @api_client.config.client_side_validation && batch_input_public_default_association_multi_post.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_public_default_association_multi_post' when calling BatchApi.create_default"
  end
  # resource path
  local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'BatchResponsePublicDefaultAssociation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.create_default",
    :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: BatchApi#create_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {}) ⇒ Array<(BatchResponseLabelsBetweenObjectPair, Integer, Hash)>

Create Batch create associations for objects

Parameters:

  • from_object_type (String)
  • to_object_type (String)
  • batch_input_public_association_multi_post (BatchInputPublicAssociationMultiPost)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



204
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 204

def create_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
  end
  # verify the required parameter 'from_object_type' is set
  if @api_client.config.client_side_validation && from_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.create"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create"
  end
  # verify the required parameter 'batch_input_public_association_multi_post' is set
  if @api_client.config.client_side_validation && batch_input_public_association_multi_post.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_post' when calling BatchApi.create"
  end
  # resource path
  local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'BatchResponseLabelsBetweenObjectPair'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.create",
    :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: BatchApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {}) ⇒ BatchResponsePublicAssociationMultiWithLabel

Read Batch read associations for objects to specific object type. The ‘after’ field in a returned paging object can be added alongside the ‘id’ to retrieve the next page of associations from that objectId. The ‘link’ field is deprecated and should be ignored.

Parameters:

Returns:



352
353
354
355
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 352

def get_page(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {})
  data, _status_code, _headers = get_page_with_http_info(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts)
  data
end

#get_page_with_http_info(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {}) ⇒ Array<(BatchResponsePublicAssociationMultiWithLabel, Integer, Hash)>

Read Batch read associations for objects to specific object type. The &#39;after&#39; field in a returned paging object can be added alongside the &#39;id&#39; to retrieve the next page of associations from that objectId. The &#39;link&#39; field is deprecated and should be ignored.

Parameters:

Returns:



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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb', line 364

def get_page_with_http_info(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.get_page ...'
  end
  # verify the required parameter 'from_object_type' is set
  if @api_client.config.client_side_validation && from_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.get_page"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.get_page"
  end
  # verify the required parameter 'batch_input_public_fetch_associations_batch_request' is set
  if @api_client.config.client_side_validation && batch_input_public_fetch_associations_batch_request.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_public_fetch_associations_batch_request' when calling BatchApi.get_page"
  end
  # resource path
  local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'BatchResponsePublicAssociationMultiWithLabel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"BatchApi.get_page",
    :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: BatchApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end