Class: Hubspot::Crm::Pipelines::PipelinesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PipelinesApi

Returns a new instance of PipelinesApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_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/pipelines/api/pipelines_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

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

Archive a pipeline Archive the pipeline identified by ‘pipelineId`.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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

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

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

Archive a pipeline Archive the pipeline identified by &#x60;pipelineId&#x60;.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional 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
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 41

def archive_with_http_info(object_type, pipeline_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.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 PipelinesApi.archive"
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling PipelinesApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.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(['*/*'])

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

  # http body (model)
  post_body = opts[:body] 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelinesApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(object_type, opts = {}) ⇒ Pipeline

Create a pipeline Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



98
99
100
101
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 98

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

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

Create a pipeline Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Pipeline data, response status code and response headers



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 109

def create_with_http_info(object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.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 PipelinesApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}'.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(opts[:'pipeline_input']) 

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

  # 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: PipelinesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all(object_type, opts = {}) ⇒ CollectionResponsePipeline

Retrieve all pipelines Return all pipelines for the object type specified by ‘objectType`.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

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

Returns:



164
165
166
167
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 164

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

#get_all_with_http_info(object_type, opts = {}) ⇒ Array<(CollectionResponsePipeline, Integer, Hash)>

Retrieve all pipelines Return all pipelines for the object type specified by &#x60;objectType&#x60;.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    CollectionResponsePipeline data, response status code and response headers



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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 175

def get_all_with_http_info(object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.get_all ...'
  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 PipelinesApi.get_all"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}'.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', '*/*'])

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelinesApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(object_type, pipeline_id, opts = {}) ⇒ Pipeline

Return a pipeline by ID Return a single pipeline object identified by its unique ‘pipelineId`.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

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

Returns:



230
231
232
233
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 230

def get_by_id(object_type, pipeline_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(object_type, pipeline_id, opts)
  data
end

#get_by_id_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>

Return a pipeline by ID Return a single pipeline object identified by its unique &#x60;pipelineId&#x60;.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    Pipeline data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
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
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 242

def get_by_id_with_http_info(object_type, pipeline_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.get_by_id ...'
  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 PipelinesApi.get_by_id"
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling PipelinesApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.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', '*/*'])

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

  # http body (model)
  post_body = opts[:body] 

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

  # 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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelinesApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace(object_type, pipeline_id, opts = {}) ⇒ Pipeline

Replace a pipeline Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



301
302
303
304
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 301

def replace(object_type, pipeline_id, opts = {})
  data, _status_code, _headers = replace_with_http_info(object_type, pipeline_id, opts)
  data
end

#replace_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>

Replace a pipeline Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

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

    Pipeline data, response status code and response headers



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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 313

def replace_with_http_info(object_type, pipeline_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.replace ...'
  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 PipelinesApi.replace"
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling PipelinesApi.replace"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.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[:'pipeline_input']) 

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

  # 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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelinesApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(object_type, pipeline_id, opts = {}) ⇒ Pipeline

Update a pipeline Perform a partial update of the pipeline identified by ‘pipelineId`. The updated pipeline will be returned in the response.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

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

  • :pipeline_patch_input (PipelinePatchInput)

Returns:



374
375
376
377
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 374

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

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

Update a pipeline Perform a partial update of the pipeline identified by &#x60;pipelineId&#x60;. The updated pipeline will be returned in the response.

Parameters:

  • object_type (String)
  • pipeline_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

  • :pipeline_patch_input (PipelinePatchInput)

Returns:

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

    Pipeline data, response status code and response headers



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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 387

def update_with_http_info(object_type, pipeline_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelinesApi.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 PipelinesApi.update"
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling PipelinesApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.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(opts[:'pipeline_patch_input']) 

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

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PipelinesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end