Class: Hubspot::Crm::Contacts::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/contacts/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/contacts/api/batch_api.rb', line 21

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#archive_batch(opts = {}) ⇒ nil

Archive a batch of contacts by ID Archive a list of contacts 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:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def archive_batch(opts = {})
  archive_batch_with_http_info(opts)
  nil
end

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

Archive a batch of contacts by ID Archive a list of contacts 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:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def archive_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive_batch ...'
  end
  # resource path
  local_var_path = '/crm/v3/objects/contacts/batch/archive'

  # 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(opts[:'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_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_batch(opts = {}) ⇒ BatchResponseSimplePublicObject

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



89
90
91
92
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 89

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

#create_batch_with_http_info(opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 99

def create_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create_batch ...'
  end
  # resource path
  local_var_path = '/crm/v3/objects/contacts/batch/create'

  # 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(opts[:'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_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_batch(opts = {}) ⇒ BatchResponseSimplePublicObject

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

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

  • :batch_read_input_simple_public_object_id (BatchReadInputSimplePublicObjectId)

Returns:



150
151
152
153
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 150

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

#read_batch_with_http_info(opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 161

def read_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.read_batch ...'
  end
  # resource path
  local_var_path = '/crm/v3/objects/contacts/batch/read'

  # 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(opts[:'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_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_batch(opts = {}) ⇒ BatchResponseSimplePublicObject

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



212
213
214
215
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 212

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

#update_batch_with_http_info(opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
264
265
 
# File 'lib/hubspot/codegen/crm/contacts/api/batch_api.rb', line 222

def update_batch_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.update_batch ...'
  end
  # resource path
  local_var_path = '/crm/v3/objects/contacts/batch/update'

  # 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(opts[:'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_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end