Class: Hubspot::Crm::Pipelines::PipelinesApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Pipelines::PipelinesApi
- Defined in:
- lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(object_type, pipeline_id, opts = {}) ⇒ nil
Delete a pipeline Delete the pipeline identified by ‘pipelineId`.
-
#archive_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete a pipeline Delete the pipeline identified by `pipelineId`.
-
#create(object_type, pipeline_input, opts = {}) ⇒ Pipeline
Create a pipeline Create a new pipeline with the provided property values.
-
#create_with_http_info(object_type, pipeline_input, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>
Create a pipeline Create a new pipeline with the provided property values.
-
#get_all(object_type, opts = {}) ⇒ CollectionResponsePipelineNoPaging
Retrieve all pipelines Return all pipelines for the object type specified by ‘objectType`.
-
#get_all_with_http_info(object_type, opts = {}) ⇒ Array<(CollectionResponsePipelineNoPaging, Integer, Hash)>
Retrieve all pipelines Return all pipelines for the object type specified by `objectType`.
-
#get_by_id(object_type, pipeline_id, opts = {}) ⇒ Pipeline
Return a pipeline by ID Return a single pipeline object identified by its unique ‘pipelineId`.
-
#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 `pipelineId`.
-
#initialize(api_client = ApiClient.default) ⇒ PipelinesApi
constructor
A new instance of PipelinesApi.
-
#replace(object_type, pipeline_id, pipeline_input, opts = {}) ⇒ Pipeline
Replace a pipeline Replace all the properties of an existing pipeline with the values provided.
-
#replace_with_http_info(object_type, pipeline_id, pipeline_input, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>
Replace a pipeline Replace all the properties of an existing pipeline with the values provided.
-
#update(object_type, pipeline_id, pipeline_patch_input, opts = {}) ⇒ Pipeline
Update a pipeline Perform a partial update of the pipeline identified by ‘pipelineId`.
-
#update_with_http_info(object_type, pipeline_id, pipeline_patch_input, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>
Update a pipeline Perform a partial update of the pipeline identified by `pipelineId`.
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
Delete a pipeline Delete the pipeline identified by ‘pipelineId`.
31 32 33 34 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 31 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)>
Delete a pipeline Delete the pipeline identified by `pipelineId`.
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 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 43 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] || {} query_params[:'validateReferencesBeforeDelete'] = opts[:'validate_references_before_delete'] if !opts[:'validate_references_before_delete'].nil? # 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'] = 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, ) 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, pipeline_input, 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.
101 102 103 104 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 101 def create(object_type, pipeline_input, opts = {}) data, _status_code, _headers = create_with_http_info(object_type, pipeline_input, opts) data end |
#create_with_http_info(object_type, pipeline_input, 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.
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 163 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 112 def create_with_http_info(object_type, pipeline_input, 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 # verify the required parameter 'pipeline_input' is set if @api_client.config.client_side_validation && pipeline_input.nil? fail ArgumentError, "Missing the required parameter 'pipeline_input' 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(pipeline_input) # return_type return_type = opts[:return_type] || 'Pipeline' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) 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 = {}) ⇒ CollectionResponsePipelineNoPaging
Retrieve all pipelines Return all pipelines for the object type specified by ‘objectType`.
170 171 172 173 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 170 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<(CollectionResponsePipelineNoPaging, Integer, Hash)>
Retrieve all pipelines Return all pipelines for the object type specified by `objectType`.
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 222 223 224 225 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 180 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] || {} # 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] || 'CollectionResponsePipelineNoPaging' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) 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`.
233 234 235 236 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 233 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 `pipelineId`.
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 293 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 244 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] || {} # 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'] = 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, ) 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, pipeline_input, 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.
303 304 305 306 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 303 def replace(object_type, pipeline_id, pipeline_input, opts = {}) data, _status_code, _headers = replace_with_http_info(object_type, pipeline_id, pipeline_input, opts) data end |
#replace_with_http_info(object_type, pipeline_id, pipeline_input, 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.
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 365 366 367 368 369 370 371 372 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 316 def replace_with_http_info(object_type, pipeline_id, pipeline_input, 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 # verify the required parameter 'pipeline_input' is set if @api_client.config.client_side_validation && pipeline_input.nil? fail ArgumentError, "Missing the required parameter 'pipeline_input' 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] || {} query_params[:'validateReferencesBeforeDelete'] = opts[:'validate_references_before_delete'] if !opts[:'validate_references_before_delete'].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(pipeline_input) # return_type return_type = opts[:return_type] || 'Pipeline' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) 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, pipeline_patch_input, opts = {}) ⇒ Pipeline
Update a pipeline Perform a partial update of the pipeline identified by ‘pipelineId`. The updated pipeline will be returned in the response.
382 383 384 385 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 382 def update(object_type, pipeline_id, pipeline_patch_input, opts = {}) data, _status_code, _headers = update_with_http_info(object_type, pipeline_id, pipeline_patch_input, opts) data end |
#update_with_http_info(object_type, pipeline_id, pipeline_patch_input, opts = {}) ⇒ Array<(Pipeline, Integer, Hash)>
Update a pipeline Perform a partial update of the pipeline identified by `pipelineId`. The updated pipeline will be returned in the response.
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 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipelines_api.rb', line 395 def update_with_http_info(object_type, pipeline_id, pipeline_patch_input, 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 # verify the required parameter 'pipeline_patch_input' is set if @api_client.config.client_side_validation && pipeline_patch_input.nil? fail ArgumentError, "Missing the required parameter 'pipeline_patch_input' 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[:'validateReferencesBeforeDelete'] = opts[:'validate_references_before_delete'] if !opts[:'validate_references_before_delete'].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(pipeline_patch_input) # return_type return_type = opts[:return_type] || 'Pipeline' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) 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 |