Class: Hubspot::Crm::Objects::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/objects/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.



21
22
23
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 21

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



19
20
21
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#archive(object_type, batch_input_simple_public_object_id, opts = {}) ⇒ nil

Archive a batch of objects by ID Archive a list of objects given a collection of IDs. This method will return a ‘204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).

Parameters:

Returns:

  • (nil)


30
31
32
33
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 30

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

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

Archive a batch of objects by ID Archive a list of objects given a collection of IDs. This method will return a &#x60;204 No Content&#x60; response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).

Parameters:

Returns:

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

    nil, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 41

def archive_with_http_info(object_type, batch_input_simple_public_object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.archive"
  end
  # verify the required parameter 'batch_input_simple_public_object_id' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/objects/{objectType}/batch/archive'.sub('{' + 'objectType' + '}', CGI.escape(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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

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

#create(object_type, batch_input_simple_public_object_input, opts = {}) ⇒ BatchResponseSimplePublicObject

Create a batch of objects Create a batch of objects. This follows the same rules as creating an individual object.

Parameters:

Returns:



100
101
102
103
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 100

def create(object_type, batch_input_simple_public_object_input, opts = {})
  data, _status_code, _headers = create_with_http_info(object_type, batch_input_simple_public_object_input, opts)
  data
end

#create_with_http_info(object_type, batch_input_simple_public_object_input, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

Create a batch of objects Create a batch of objects. This follows the same rules as creating an individual object.

Parameters:

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 111

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

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

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

#read(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ BatchResponseSimplePublicObject

Read a batch of objects by internal ID, or unique property values Read a list of objects given a collection of IDs. Use the ‘properties` request body property to control which properties are returned.

Parameters:

Options Hash (opts):

  • :archived (Boolean)

    Whether to return only results that have been archived. (default to false)

Returns:



171
172
173
174
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 171

def read(object_type, batch_read_input_simple_public_object_id, opts = {})
  data, _status_code, _headers = read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts)
  data
end

#read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

Read a batch of objects by internal ID, or unique property values Read a list of objects given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.

Parameters:

Options Hash (opts):

  • :archived (Boolean)

    Whether to return only results that have been archived.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 183

def read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.read"
  end
  # verify the required parameter 'batch_read_input_simple_public_object_id' is set
  if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
  end
  # resource path
  local_var_path = '/crm/v3/objects/{objectType}/batch/read'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s))

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

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

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

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

#update(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ BatchResponseSimplePublicObject

Update a batch of objects Perform a partial upate on a batch of objects. This follows the same rules as performing partial updates on an individual object.

Parameters:

Returns:



243
244
245
246
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 243

def update(object_type, batch_input_simple_public_object_batch_input, opts = {})
  data, _status_code, _headers = update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts)
  data
end

#update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

Update a batch of objects Perform a partial upate on a batch of objects. This follows the same rules as performing partial updates on an individual object.

Parameters:

Returns:



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 254

def update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.update"
  end
  # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
  if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/objects/{objectType}/batch/update'.sub('{' + 'objectType' + '}', CGI.escape(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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

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

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