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

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

def api_client
  @api_client
end

Instance Method Details

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

Archive a batch of associations Remove the associations between all pairs of objects identified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def archive_batch(from_object_type, to_object_type, opts = {})
  archive_batch_with_http_info(from_object_type, to_object_type, opts)
  nil
end

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

Archive a batch of associations Remove the associations between all pairs of objects identified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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

def archive_batch_with_http_info(from_object_type, to_object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive_batch ...'
  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_batch"
  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_batch"
  end
  # resource path
  local_var_path = '/crm/v3/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'
  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_public_association']) 

  # 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(from_object_type, to_object_type, opts = {}) ⇒ BatchResponsePublicAssociation

Create a batch of associations Associate all pairs of objects identified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



103
104
105
106
 
# File 'lib/hubspot/codegen/crm/associations/api/batch_api.rb', line 103

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

#create_batch_with_http_info(from_object_type, to_object_type, opts = {}) ⇒ Array<(BatchResponsePublicAssociation, Integer, Hash)>

Create a batch of associations Associate all pairs of objects identified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
163
164
165
166
 
# File 'lib/hubspot/codegen/crm/associations/api/batch_api.rb', line 115

def create_batch_with_http_info(from_object_type, to_object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create_batch ...'
  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_batch"
  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_batch"
  end
  # resource path
  local_var_path = '/crm/v3/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'
  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_public_association']) 

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

  # 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(from_object_type, to_object_type, opts = {}) ⇒ BatchResponsePublicAssociationMulti

Read a batch of associations Get the IDs of all ‘toObjectType` objects associated with those specified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



175
176
177
178
 
# File 'lib/hubspot/codegen/crm/associations/api/batch_api.rb', line 175

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

#read_batch_with_http_info(from_object_type, to_object_type, opts = {}) ⇒ Array<(BatchResponsePublicAssociationMulti, Integer, Hash)>

Read a batch of associations Get the IDs of all &#x60;toObjectType&#x60; objects associated with those specified in the request body.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
236
237
238
 
# File 'lib/hubspot/codegen/crm/associations/api/batch_api.rb', line 187

def read_batch_with_http_info(from_object_type, to_object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.read_batch ...'
  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.read_batch"
  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.read_batch"
  end
  # resource path
  local_var_path = '/crm/v3/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'
  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_public_object_id']) 

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

  # 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