Class: Hubspot::Crm::Pipelines::PipelineStagesApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Pipelines::PipelineStagesApi
- Defined in:
- lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_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, stage_id, opts = {}) ⇒ nil
Archive a pipeline stage Archive the pipeline stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`.
-
#archive_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a pipeline stage Archive the pipeline stage identified by `stageId` associated with the pipeline identified by `pipelineId`.
-
#create(object_type, pipeline_id, opts = {}) ⇒ PipelineStage
Create a pipeline stage Create a new stage associated with the pipeline identified by ‘pipelineId`.
-
#create_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Create a pipeline stage Create a new stage associated with the pipeline identified by `pipelineId`.
-
#get_all(object_type, pipeline_id, opts = {}) ⇒ CollectionResponsePipelineStage
Return all stages of a pipeline Return all the stages associated with the pipeline identified by ‘pipelineId`.
-
#get_all_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(CollectionResponsePipelineStage, Integer, Hash)>
Return all stages of a pipeline Return all the stages associated with the pipeline identified by `pipelineId`.
-
#get_by_id(object_type, pipeline_id, stage_id, opts = {}) ⇒ PipelineStage
Return a pipeline stage by ID Return the stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`.
-
#get_by_id_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Return a pipeline stage by ID Return the stage identified by `stageId` associated with the pipeline identified by `pipelineId`.
-
#initialize(api_client = ApiClient.default) ⇒ PipelineStagesApi
constructor
A new instance of PipelineStagesApi.
-
#replace(object_type, pipeline_id, stage_id, opts = {}) ⇒ PipelineStage
Replace a pipeline stage Replace all the properties of an existing pipeline stage with the values provided.
-
#replace_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Replace a pipeline stage Replace all the properties of an existing pipeline stage with the values provided.
-
#update(object_type, pipeline_id, stage_id, opts = {}) ⇒ PipelineStage
Update a pipeline stage Perform a partial update of the pipeline stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`.
-
#update_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Update a pipeline stage Perform a partial update of the pipeline stage identified by `stageId` associated with the pipeline identified by `pipelineId`.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PipelineStagesApi
Returns a new instance of PipelineStagesApi.
21 22 23 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_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/pipeline_stages_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#archive(object_type, pipeline_id, stage_id, opts = {}) ⇒ nil
Archive a pipeline stage Archive the pipeline stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`.
31 32 33 34 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 31 def archive(object_type, pipeline_id, stage_id, opts = {}) archive_with_http_info(object_type, pipeline_id, stage_id, opts) nil end |
#archive_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a pipeline stage Archive the pipeline stage identified by `stageId` associated with 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 94 95 96 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 43 def archive_with_http_info(object_type, pipeline_id, stage_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.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 PipelineStagesApi.archive" end # verify the required parameter 'stage_id' is set if @api_client.config.client_side_validation && stage_id.nil? fail ArgumentError, "Missing the required parameter 'stage_id' when calling PipelineStagesApi.archive" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.to_s)).sub('{' + 'stageId' + '}', CGI.escape(stage_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'] = 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: PipelineStagesApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(object_type, pipeline_id, opts = {}) ⇒ PipelineStage
Create a pipeline stage Create a new stage associated with the pipeline identified by ‘pipelineId`. The entire stage object, including its unique ID, will be returned in the response.
105 106 107 108 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 105 def create(object_type, pipeline_id, opts = {}) data, _status_code, _headers = create_with_http_info(object_type, pipeline_id, opts) data end |
#create_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Create a pipeline stage Create a new stage associated with the pipeline identified by `pipelineId`. The entire stage object, including its unique ID, will be returned in the response.
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 167 168 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 117 def create_with_http_info(object_type, pipeline_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.create" 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 PipelineStagesApi.create" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages'.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_stage_input']) # return_type return_type = opts[:return_type] || 'PipelineStage' # 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: PipelineStagesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all(object_type, pipeline_id, opts = {}) ⇒ CollectionResponsePipelineStage
Return all stages of a pipeline Return all the stages associated with the pipeline identified by ‘pipelineId`.
177 178 179 180 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 177 def get_all(object_type, pipeline_id, opts = {}) data, _status_code, _headers = get_all_with_http_info(object_type, pipeline_id, opts) data end |
#get_all_with_http_info(object_type, pipeline_id, opts = {}) ⇒ Array<(CollectionResponsePipelineStage, Integer, Hash)>
Return all stages of a pipeline Return all the stages associated with the pipeline identified by `pipelineId`.
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 239 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 189 def get_all_with_http_info(object_type, pipeline_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.get_all" 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 PipelineStagesApi.get_all" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages'.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] || 'CollectionResponsePipelineStage' # 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: PipelineStagesApi#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, stage_id, opts = {}) ⇒ PipelineStage
Return a pipeline stage by ID Return the stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`.
249 250 251 252 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 249 def get_by_id(object_type, pipeline_id, stage_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(object_type, pipeline_id, stage_id, opts) data end |
#get_by_id_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Return a pipeline stage by ID Return the stage identified by `stageId` associated with the pipeline identified by `pipelineId`.
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 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 262 def get_by_id_with_http_info(object_type, pipeline_id, stage_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.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 PipelineStagesApi.get_by_id" end # verify the required parameter 'stage_id' is set if @api_client.config.client_side_validation && stage_id.nil? fail ArgumentError, "Missing the required parameter 'stage_id' when calling PipelineStagesApi.get_by_id" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.to_s)).sub('{' + 'stageId' + '}', CGI.escape(stage_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] || 'PipelineStage' # 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: PipelineStagesApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace(object_type, pipeline_id, stage_id, opts = {}) ⇒ PipelineStage
Replace a pipeline stage Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.
326 327 328 329 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 326 def replace(object_type, pipeline_id, stage_id, opts = {}) data, _status_code, _headers = replace_with_http_info(object_type, pipeline_id, stage_id, opts) data end |
#replace_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Replace a pipeline stage Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.
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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 339 def replace_with_http_info(object_type, pipeline_id, stage_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.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 PipelineStagesApi.replace" end # verify the required parameter 'stage_id' is set if @api_client.config.client_side_validation && stage_id.nil? fail ArgumentError, "Missing the required parameter 'stage_id' when calling PipelineStagesApi.replace" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.to_s)).sub('{' + 'stageId' + '}', CGI.escape(stage_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_stage_input']) # return_type return_type = opts[:return_type] || 'PipelineStage' # 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: PipelineStagesApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(object_type, pipeline_id, stage_id, opts = {}) ⇒ PipelineStage
Update a pipeline stage Perform a partial update of the pipeline stage identified by ‘stageId` associated with the pipeline identified by `pipelineId`. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.
405 406 407 408 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 405 def update(object_type, pipeline_id, stage_id, opts = {}) data, _status_code, _headers = update_with_http_info(object_type, pipeline_id, stage_id, opts) data end |
#update_with_http_info(object_type, pipeline_id, stage_id, opts = {}) ⇒ Array<(PipelineStage, Integer, Hash)>
Update a pipeline stage Perform a partial update of the pipeline stage identified by `stageId` associated with the pipeline identified by `pipelineId`. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.
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 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stages_api.rb', line 419 def update_with_http_info(object_type, pipeline_id, stage_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PipelineStagesApi.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 PipelineStagesApi.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 PipelineStagesApi.update" end # verify the required parameter 'stage_id' is set if @api_client.config.client_side_validation && stage_id.nil? fail ArgumentError, "Missing the required parameter 'stage_id' when calling PipelineStagesApi.update" end # resource path local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'pipelineId' + '}', CGI.escape(pipeline_id.to_s)).sub('{' + 'stageId' + '}', CGI.escape(stage_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_stage_patch_input']) # return_type return_type = opts[:return_type] || 'PipelineStage' # 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: PipelineStagesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |