Class: BrevoRuby::DealsApi
- Inherits:
-
Object
- Object
- BrevoRuby::DealsApi
- Defined in:
- lib/brevo-ruby/api/deals_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#crm_attributes_deals_get(opts = {}) ⇒ DealAttributes
Get deal attributes.
-
#crm_attributes_deals_get_with_http_info(opts = {}) ⇒ Array<(DealAttributes, Fixnum, Hash)>
Get deal attributes.
-
#crm_deals_get(opts = {}) ⇒ DealsList
Get all deals.
-
#crm_deals_get_with_http_info(opts = {}) ⇒ Array<(DealsList, Fixnum, Hash)>
Get all deals.
-
#crm_deals_id_delete(id, opts = {}) ⇒ nil
Delete a deal.
-
#crm_deals_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a deal.
-
#crm_deals_id_get(id, opts = {}) ⇒ Deal
Get a deal.
-
#crm_deals_id_get_with_http_info(id, opts = {}) ⇒ Array<(Deal, Fixnum, Hash)>
Get a deal.
-
#crm_deals_id_patch(id, body, opts = {}) ⇒ nil
Update a deal.
-
#crm_deals_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Update a deal.
-
#crm_deals_link_unlink_id_patch(id, body, opts = {}) ⇒ nil
Link and Unlink a deal with contacts and companies.
-
#crm_deals_link_unlink_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Link and Unlink a deal with contacts and companies.
-
#crm_deals_post(body, opts = {}) ⇒ InlineResponse201
Create a deal.
-
#crm_deals_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>
Create a deal.
-
#crm_pipeline_details_get(opts = {}) ⇒ Pipeline
Get pipeline stages This endpoint is deprecated.
-
#crm_pipeline_details_get_with_http_info(opts = {}) ⇒ Array<(Pipeline, Fixnum, Hash)>
Get pipeline stages This endpoint is deprecated.
-
#crm_pipeline_details_pipeline_id_get(pipeline_id, opts = {}) ⇒ Pipelines
Get pipelines and their details.
-
#crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts = {}) ⇒ Array<(Pipelines, Fixnum, Hash)>
Get pipelines and their details.
-
#initialize(api_client = ApiClient.default) ⇒ DealsApi
constructor
A new instance of DealsApi.
-
#setUserAgent(user_agent) ⇒ Object
Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#crm_attributes_deals_get(opts = {}) ⇒ DealAttributes
Get deal attributes
35 36 37 38 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 35 def crm_attributes_deals_get(opts = {}) data, _status_code, _headers = crm_attributes_deals_get_with_http_info(opts) data end |
#crm_attributes_deals_get_with_http_info(opts = {}) ⇒ Array<(DealAttributes, Fixnum, Hash)>
Get deal attributes
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 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 43 def crm_attributes_deals_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_attributes_deals_get ...' end # resource path local_var_path = '/crm/attributes/deals' # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DealAttributes') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_attributes_deals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_get(opts = {}) ⇒ DealsList
Get all deals
88 89 90 91 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 88 def crm_deals_get(opts = {}) data, _status_code, _headers = crm_deals_get_with_http_info(opts) data end |
#crm_deals_get_with_http_info(opts = {}) ⇒ Array<(DealsList, Fixnum, Hash)>
Get all deals
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 143 144 145 146 147 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 103 def crm_deals_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_get ...' end if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort']) fail ArgumentError, 'invalid value for "sort", must be one of asc, desc' end # resource path local_var_path = '/crm/deals' # query parameters query_params = {} query_params[:'filters[attributes]'] = opts[:'filters_attributes'] if !opts[:'filters_attributes'].nil? query_params[:'filters[linkedCompaniesIds]'] = opts[:'filters_linked_companies_ids'] if !opts[:'filters_linked_companies_ids'].nil? query_params[:'filters[linkedContactsIds]'] = opts[:'filters_linked_contacts_ids'] if !opts[:'filters_linked_contacts_ids'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil? # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DealsList') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_id_delete(id, opts = {}) ⇒ nil
Delete a deal
152 153 154 155 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 152 def crm_deals_id_delete(id, opts = {}) crm_deals_id_delete_with_http_info(id, opts) nil end |
#crm_deals_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete a deal
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 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 161 def crm_deals_id_delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_id_delete ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling DealsApi.crm_deals_id_delete" end # resource path local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_id_get(id, opts = {}) ⇒ Deal
Get a deal
203 204 205 206 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 203 def crm_deals_id_get(id, opts = {}) data, _status_code, _headers = crm_deals_id_get_with_http_info(id, opts) data end |
#crm_deals_id_get_with_http_info(id, opts = {}) ⇒ Array<(Deal, Fixnum, Hash)>
Get a deal
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 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 212 def crm_deals_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_id_get ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling DealsApi.crm_deals_id_get" end # resource path local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Deal') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_id_patch(id, body, opts = {}) ⇒ nil
Update a deal
256 257 258 259 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 256 def crm_deals_id_patch(id, body, opts = {}) crm_deals_id_patch_with_http_info(id, body, opts) nil end |
#crm_deals_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Update a deal
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 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 266 def crm_deals_id_patch_with_http_info(id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_id_patch ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling DealsApi.crm_deals_id_patch" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_id_patch" end # resource path local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_link_unlink_id_patch(id, body, opts = {}) ⇒ nil
Link and Unlink a deal with contacts and companies
313 314 315 316 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 313 def crm_deals_link_unlink_id_patch(id, body, opts = {}) crm_deals_link_unlink_id_patch_with_http_info(id, body, opts) nil end |
#crm_deals_link_unlink_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Link and Unlink a deal with contacts and companies
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/brevo-ruby/api/deals_api.rb', line 323 def crm_deals_link_unlink_id_patch_with_http_info(id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_link_unlink_id_patch ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling DealsApi.crm_deals_link_unlink_id_patch" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_link_unlink_id_patch" end # resource path local_var_path = '/crm/deals/link-unlink/{id}'.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_link_unlink_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_deals_post(body, opts = {}) ⇒ InlineResponse201
Create a deal
369 370 371 372 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 369 def crm_deals_post(body, opts = {}) data, _status_code, _headers = crm_deals_post_with_http_info(body, opts) data end |
#crm_deals_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>
Create a deal
378 379 380 381 382 383 384 385 386 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 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 378 def crm_deals_post_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_post ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_post" end # resource path local_var_path = '/crm/deals' # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse201') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_deals_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_pipeline_details_get(opts = {}) ⇒ Pipeline
Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/pipelineID instead.
421 422 423 424 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 421 def crm_pipeline_details_get(opts = {}) data, _status_code, _headers = crm_pipeline_details_get_with_http_info(opts) data end |
#crm_pipeline_details_get_with_http_info(opts = {}) ⇒ Array<(Pipeline, Fixnum, Hash)>
Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/pipelineID instead.
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 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 430 def crm_pipeline_details_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_pipeline_details_get ...' end # resource path local_var_path = '/crm/pipeline/details' # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Pipeline') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_pipeline_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#crm_pipeline_details_pipeline_id_get(pipeline_id, opts = {}) ⇒ Pipelines
Get pipelines and their details
469 470 471 472 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 469 def crm_pipeline_details_pipeline_id_get(pipeline_id, opts = {}) data, _status_code, _headers = crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts) data end |
#crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts = {}) ⇒ Array<(Pipelines, Fixnum, Hash)>
Get pipelines and their details
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 478 def crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DealsApi.crm_pipeline_details_pipeline_id_get ...' 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 DealsApi.crm_pipeline_details_pipeline_id_get" end # resource path local_var_path = '/crm/pipeline/details/{pipelineID}'.sub('{' + 'pipelineID' + '}', pipeline_id.to_s) # query parameters query_params = {} # header parameters 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 = {} # http body (model) post_body = nil auth_names = ['api-key', 'partner-key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Pipelines') if @api_client.config.debugging @api_client.config.logger.debug "API called: DealsApi#crm_pipeline_details_pipeline_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#setUserAgent(user_agent) ⇒ Object
Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby
25 26 27 28 29 30 |
# File 'lib/brevo-ruby/api/deals_api.rb', line 25 def setUserAgent(user_agent) @user_agent = user_agent if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_') @api_client.default_headers['User-Agent'] = @user_agent end end |