Class: Pipedrive::TeamsApi
- Inherits:
-
Object
- Object
- Pipedrive::TeamsApi
- Defined in:
- lib/pipedrive-openapi-client/api/teams_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ TeamsApi
constructor
A new instance of TeamsApi.
-
#teams_get(opts = {}) ⇒ Teams
Get all teams Returns data about teams within the company.
-
#teams_get_with_http_info(opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get all teams Returns data about teams within the company.
-
#teams_id_get(id, opts = {}) ⇒ Teams
Get a single team Returns data about a specific team.
-
#teams_id_get_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get a single team Returns data about a specific team.
-
#teams_id_put(id, opts = {}) ⇒ Teams
Update a team Updates an existing team and returns the updated object.
-
#teams_id_put_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Update a team Updates an existing team and returns the updated object.
-
#teams_id_users_delete(id, users, opts = {}) ⇒ UserIDs
Delete users from a team Deletes users from an existing team.
-
#teams_id_users_delete_with_http_info(id, users, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Delete users from a team Deletes users from an existing team.
-
#teams_id_users_get(id, opts = {}) ⇒ UserIDs
Get all users in a team Returns list of all user IDs within a team.
-
#teams_id_users_get_with_http_info(id, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Get all users in a team Returns list of all user IDs within a team.
-
#teams_id_users_post(id, users, opts = {}) ⇒ UserIDs
Add users to a team Adds users to an existing team.
-
#teams_id_users_post_with_http_info(id, users, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Add users to a team Adds users to an existing team.
-
#teams_post(name, manager_id, opts = {}) ⇒ Teams
Add a new team Adds a new team to the company and returns the created object.
-
#teams_post_with_http_info(name, manager_id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Add a new team Adds a new team to the company and returns the created object.
-
#teams_user_id_get(id, opts = {}) ⇒ Teams
Get all teams of a user Returns data about all teams which have specified user as a member.
-
#teams_user_id_get_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get all teams of a user Returns data about all teams which have specified user as a member.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TeamsApi
Returns a new instance of TeamsApi.
19 20 21 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#teams_get(opts = {}) ⇒ Teams
Get all teams Returns data about teams within the company
28 29 30 31 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 28 def teams_get(opts = {}) data, _status_code, _headers = teams_get_with_http_info(opts) data end |
#teams_get_with_http_info(opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get all teams Returns data about teams within the company
39 40 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 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 39 def teams_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_get ...' end allowable_values = ["id", "name", "manager_id", "active_flag"] if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by']) fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}" end # resource path local_var_path = '/teams' # query parameters query_params = opts[:query_params] || {} query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'skip_users'] = opts[:'skip_users'] if !opts[:'skip_users'].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] || 'Teams' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_id_get(id, opts = {}) ⇒ Teams
Get a single team Returns data about a specific team
94 95 96 97 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 94 def teams_id_get(id, opts = {}) data, _status_code, _headers = teams_id_get_with_http_info(id, opts) data end |
#teams_id_get_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get a single team Returns data about a specific team
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 148 149 150 151 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 105 def teams_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_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 TeamsApi.teams_id_get" end # resource path local_var_path = '/teams/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'skip_users'] = opts[:'skip_users'] if !opts[:'skip_users'].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] || 'Teams' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_id_put(id, opts = {}) ⇒ Teams
Update a team Updates an existing team and returns the updated object
158 159 160 161 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 158 def teams_id_put(id, opts = {}) data, _status_code, _headers = teams_id_put_with_http_info(id, opts) data end |
#teams_id_put_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Update a team Updates an existing team and returns the updated object
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 168 def teams_id_put_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_id_put ...' 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 TeamsApi.teams_id_put" end # resource path local_var_path = '/teams/{id}'.sub('{' + 'id' + '}', CGI.escape(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/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Teams' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_id_users_delete(id, users, opts = {}) ⇒ UserIDs
Delete users from a team Deletes users from an existing team
223 224 225 226 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 223 def teams_id_users_delete(id, users, opts = {}) data, _status_code, _headers = teams_id_users_delete_with_http_info(id, users, opts) data end |
#teams_id_users_delete_with_http_info(id, users, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Delete users from a team Deletes users from an existing team
234 235 236 237 238 239 240 241 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 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 234 def teams_id_users_delete_with_http_info(id, users, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_id_users_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 TeamsApi.teams_id_users_delete" end # verify the required parameter 'users' is set if @api_client.config.client_side_validation && users.nil? fail ArgumentError, "Missing the required parameter 'users' when calling TeamsApi.teams_id_users_delete" end # resource path local_var_path = '/teams/{id}/users'.sub('{' + 'id' + '}', CGI.escape(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/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} form_params['users'] = @api_client.build_collection_param(users, :csv) # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'UserIDs' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_id_users_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_id_users_get(id, opts = {}) ⇒ UserIDs
Get all users in a team Returns list of all user IDs within a team
293 294 295 296 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 293 def teams_id_users_get(id, opts = {}) data, _status_code, _headers = teams_id_users_get_with_http_info(id, opts) data end |
#teams_id_users_get_with_http_info(id, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Get all users in a team Returns list of all user IDs within a team
303 304 305 306 307 308 309 310 311 312 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 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 303 def teams_id_users_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_id_users_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 TeamsApi.teams_id_users_get" end # resource path local_var_path = '/teams/{id}/users'.sub('{' + 'id' + '}', CGI.escape(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] || 'UserIDs' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_id_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_id_users_post(id, users, opts = {}) ⇒ UserIDs
Add users to a team Adds users to an existing team
356 357 358 359 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 356 def teams_id_users_post(id, users, opts = {}) data, _status_code, _headers = teams_id_users_post_with_http_info(id, users, opts) data end |
#teams_id_users_post_with_http_info(id, users, opts = {}) ⇒ Array<(UserIDs, Integer, Hash)>
Add users to a team Adds users to an existing team
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 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 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 367 def teams_id_users_post_with_http_info(id, users, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_id_users_post ...' 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 TeamsApi.teams_id_users_post" end # verify the required parameter 'users' is set if @api_client.config.client_side_validation && users.nil? fail ArgumentError, "Missing the required parameter 'users' when calling TeamsApi.teams_id_users_post" end # resource path local_var_path = '/teams/{id}/users'.sub('{' + 'id' + '}', CGI.escape(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/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} form_params['users'] = @api_client.build_collection_param(users, :csv) # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'UserIDs' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_id_users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_post(name, manager_id, opts = {}) ⇒ Teams
Add a new team Adds a new team to the company and returns the created object
429 430 431 432 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 429 def teams_post(name, manager_id, opts = {}) data, _status_code, _headers = teams_post_with_http_info(name, manager_id, opts) data end |
#teams_post_with_http_info(name, manager_id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Add a new team Adds a new team to the company and returns the created object
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 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 442 def teams_post_with_http_info(name, manager_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_post ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling TeamsApi.teams_post" end # verify the required parameter 'manager_id' is set if @api_client.config.client_side_validation && manager_id.nil? fail ArgumentError, "Missing the required parameter 'manager_id' when calling TeamsApi.teams_post" end # resource path local_var_path = '/teams' # 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/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} form_params['name'] = name form_params['manager_id'] = manager_id form_params['description'] = opts[:'description'] if !opts[:'description'].nil? form_params['users'] = opts[:'users'] if !opts[:'users'].nil? # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Teams' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#teams_user_id_get(id, opts = {}) ⇒ Teams
Get all teams of a user Returns data about all teams which have specified user as a member
506 507 508 509 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 506 def teams_user_id_get(id, opts = {}) data, _status_code, _headers = teams_user_id_get_with_http_info(id, opts) data end |
#teams_user_id_get_with_http_info(id, opts = {}) ⇒ Array<(Teams, Integer, Hash)>
Get all teams of a user Returns data about all teams which have specified user as a member
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/pipedrive-openapi-client/api/teams_api.rb', line 518 def teams_user_id_get_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TeamsApi.teams_user_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 TeamsApi.teams_user_id_get" end allowable_values = ["id", "name", "manager_id", "active_flag"] if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by']) fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}" end # resource path local_var_path = '/teams/user/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'skip_users'] = opts[:'skip_users'] if !opts[:'skip_users'].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] || 'Teams' # auth_names auth_names = opts[:auth_names] || ['api_key', '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: TeamsApi#teams_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |