pipedrive-openapi-client 1.0.0

data/docs/PutRole.md

@@ -0,0 +1,19 @@
+# Pipedrive::PutRole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | If the response is successful or not | [optional] 
+**data** | [**PutRoleAllOfData**](PutRoleAllOfData.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::PutRole.new(success: null,
+                                 data: null)
+```
+
+

data/docs/PutRoleAllOf.md

@@ -0,0 +1,17 @@
+# Pipedrive::PutRoleAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**PutRoleAllOfData**](PutRoleAllOfData.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::PutRoleAllOf.new(data: null)
+```
+
+

data/docs/PutRoleAllOfData.md

@@ -0,0 +1,17 @@
+# Pipedrive::PutRoleAllOfData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the updated role | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::PutRoleAllOfData.new(id: null)
+```
+
+

data/docs/RecentsApi.md

@@ -0,0 +1,73 @@
+# Pipedrive::RecentsApi
+
+All URIs are relative to *https://api.pipedrive.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**recents_get**](RecentsApi.md#recents_get) | **GET** /recents | Get recents
+
+
+
+## recents_get
+
+> recents_get(since_timestamp, opts)
+
+Get recents
+
+Returns data about all recent changes occured after given timestamp.
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Pipedrive::RecentsApi.new
+since_timestamp = 'since_timestamp_example' # String | Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
+opts = {
+  items: 'items_example', # String | Multiple selection of item types to include in query (optional)
+  start: 0, # Integer | Pagination start
+  limit: 56 # Integer | Items shown per page
+}
+
+begin
+  #Get recents
+  api_instance.recents_get(since_timestamp, opts)
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RecentsApi->recents_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **since_timestamp** | **String**| Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | 
+ **items** | **String**| Multiple selection of item types to include in query (optional) | [optional] 
+ **start** | **Integer**| Pagination start | [optional] [default to 0]
+ **limit** | **Integer**| Items shown per page | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/RoleAssignment.md

@@ -0,0 +1,27 @@
+# Pipedrive::RoleAssignment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_role_id** | **Integer** | The ID of the parent Role | [optional] 
+**name** | **String** | The name of the Role | [optional] 
+**user_id** | **Integer** | The User ID | [optional] 
+**role_id** | **Integer** | The Role ID | [optional] 
+**active_flag** | **Boolean** | Whether the Role is active or not | [optional] 
+**type** | **String** | The assignment type | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::RoleAssignment.new(parent_role_id: null,
+                                 name: null,
+                                 user_id: null,
+                                 role_id: null,
+                                 active_flag: null,
+                                 type: null)
+```
+
+

data/docs/RoleAssignmentAllOf.md

@@ -0,0 +1,23 @@
+# Pipedrive::RoleAssignmentAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | The User ID | [optional] 
+**role_id** | **Integer** | The Role ID | [optional] 
+**active_flag** | **Boolean** | Whether the Role is active or not | [optional] 
+**type** | **String** | The assignment type | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::RoleAssignmentAllOf.new(user_id: null,
+                                 role_id: null,
+                                 active_flag: null,
+                                 type: null)
+```
+
+

data/docs/RoleSettings.md

@@ -0,0 +1,31 @@
+# Pipedrive::RoleSettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deal_default_visibility** | **Float** | The default visibility level of the Deals for the Role | [optional] 
+**org_default_visibility** | **Float** | The default visibility level of the Organizations for the Role | [optional] 
+**person_default_visibility** | **Float** | The default visibility level of the People for the Role | [optional] 
+**product_default_visibility** | **Float** | The default visibility level of the Products for the Role | [optional] 
+**deal_access_level** | **Float** | The access level of the Deals for the Role (only for default Role) | [optional] 
+**org_access_level** | **Float** | The access level of the Organizations for the Role (only for default Role) | [optional] 
+**person_access_level** | **Float** | The access level of the People for the Role (only for default Role) | [optional] 
+**product_access_level** | **Float** | The access level of the Products for the Role (only for default Role) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::RoleSettings.new(deal_default_visibility: null,
+                                 org_default_visibility: null,
+                                 person_default_visibility: null,
+                                 product_default_visibility: null,
+                                 deal_access_level: null,
+                                 org_access_level: null,
+                                 person_access_level: null,
+                                 product_access_level: null)
+```
+
+

data/docs/RolesAdditionalData.md

@@ -0,0 +1,17 @@
+# Pipedrive::RolesAdditionalData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**RolesAdditionalDataPagination**](RolesAdditionalDataPagination.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::RolesAdditionalData.new(pagination: null)
+```
+
+

data/docs/RolesAdditionalDataPagination.md

@@ -0,0 +1,21 @@
+# Pipedrive::RolesAdditionalDataPagination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **Integer** | Pagination start | [optional] 
+**limit** | **Integer** | Items shown per page | [optional] 
+**more_items_in_collection** | **Boolean** | Whether there are more list items in the collection than displayed | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Pipedrive'
+
+instance = Pipedrive::RolesAdditionalDataPagination.new(start: null,
+                                 limit: null,
+                                 more_items_in_collection: null)
+```
+
+

data/docs/RolesApi.md

@@ -0,0 +1,623 @@
+# Pipedrive::RolesApi
+
+All URIs are relative to *https://api.pipedrive.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**roles_get**](RolesApi.md#roles_get) | **GET** /roles | Get all roles
+[**roles_id_assignments_delete**](RolesApi.md#roles_id_assignments_delete) | **DELETE** /roles/{id}/assignments | Delete a role assignment
+[**roles_id_assignments_get**](RolesApi.md#roles_id_assignments_get) | **GET** /roles/{id}/assignments | List role assignments
+[**roles_id_assignments_post**](RolesApi.md#roles_id_assignments_post) | **POST** /roles/{id}/assignments | Add role assignment
+[**roles_id_delete**](RolesApi.md#roles_id_delete) | **DELETE** /roles/{id} | Delete a role
+[**roles_id_get**](RolesApi.md#roles_id_get) | **GET** /roles/{id} | Get one role
+[**roles_id_put**](RolesApi.md#roles_id_put) | **PUT** /roles/{id} | Update role details
+[**roles_id_roles_get**](RolesApi.md#roles_id_roles_get) | **GET** /roles/{id}/roles | List role sub-roles
+[**roles_id_settings_get**](RolesApi.md#roles_id_settings_get) | **GET** /roles/{id}/settings | List role settings
+[**roles_id_settings_post**](RolesApi.md#roles_id_settings_post) | **POST** /roles/{id}/settings | Add or update role setting
+[**roles_post**](RolesApi.md#roles_post) | **POST** /roles | Add a role
+
+
+
+## roles_get
+
+> GetRoles roles_get(opts)
+
+Get all roles
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+opts = {
+  start: 0, # Integer | Pagination start
+  limit: 56 # Integer | Items shown per page
+}
+
+begin
+  #Get all roles
+  result = api_instance.roles_get(opts)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start** | **Integer**| Pagination start | [optional] [default to 0]
+ **limit** | **Integer**| Items shown per page | [optional] 
+
+### Return type
+
+[**GetRoles**](GetRoles.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_assignments_delete
+
+> DeleteRoleAssignment roles_id_assignments_delete(id, user_id)
+
+Delete a role assignment
+
+Delete assignment from a role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+user_id = 56 # Integer | ID of the user
+
+begin
+  #Delete a role assignment
+  result = api_instance.roles_id_assignments_delete(id, user_id)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_assignments_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **user_id** | **Integer**| ID of the user | 
+
+### Return type
+
+[**DeleteRoleAssignment**](DeleteRoleAssignment.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_assignments_get
+
+> GetRoleAssignments roles_id_assignments_get(id, opts)
+
+List role assignments
+
+List assignments for a role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+opts = {
+  start: 0, # Integer | Pagination start
+  limit: 56 # Integer | Items shown per page
+}
+
+begin
+  #List role assignments
+  result = api_instance.roles_id_assignments_get(id, opts)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_assignments_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **start** | **Integer**| Pagination start | [optional] [default to 0]
+ **limit** | **Integer**| Items shown per page | [optional] 
+
+### Return type
+
+[**GetRoleAssignments**](GetRoleAssignments.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_assignments_post
+
+> PostRoleAssignment roles_id_assignments_post(id, user_id)
+
+Add role assignment
+
+Add assignment for a role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+user_id = 56 # Integer | ID of the user
+
+begin
+  #Add role assignment
+  result = api_instance.roles_id_assignments_post(id, user_id)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_assignments_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **user_id** | **Integer**| ID of the user | 
+
+### Return type
+
+[**PostRoleAssignment**](PostRoleAssignment.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## roles_id_delete
+
+> DeleteRole roles_id_delete(id)
+
+Delete a role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+
+begin
+  #Delete a role
+  result = api_instance.roles_id_delete(id)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+
+### Return type
+
+[**DeleteRole**](DeleteRole.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_get
+
+> GetRole roles_id_get(id)
+
+Get one role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+
+begin
+  #Get one role
+  result = api_instance.roles_id_get(id)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+
+### Return type
+
+[**GetRole**](GetRole.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_put
+
+> PutRole roles_id_put(id, opts)
+
+Update role details
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+opts = {
+  parent_role_id: 56, # Integer | The ID of the parent Role
+  name: 'name_example' # String | The name of the Role
+}
+
+begin
+  #Update role details
+  result = api_instance.roles_id_put(id, opts)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_put: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **parent_role_id** | **Integer**| The ID of the parent Role | [optional] 
+ **name** | **String**| The name of the Role | [optional] 
+
+### Return type
+
+[**PutRole**](PutRole.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## roles_id_roles_get
+
+> GetRoleSubroles roles_id_roles_get(id, opts)
+
+List role sub-roles
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+opts = {
+  start: 0, # Integer | Pagination start
+  limit: 56 # Integer | Items shown per page
+}
+
+begin
+  #List role sub-roles
+  result = api_instance.roles_id_roles_get(id, opts)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_roles_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **start** | **Integer**| Pagination start | [optional] [default to 0]
+ **limit** | **Integer**| Items shown per page | [optional] 
+
+### Return type
+
+[**GetRoleSubroles**](GetRoleSubroles.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_settings_get
+
+> GetRoleSettings roles_id_settings_get(id)
+
+List role settings
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+
+begin
+  #List role settings
+  result = api_instance.roles_id_settings_get(id)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_settings_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+
+### Return type
+
+[**GetRoleSettings**](GetRoleSettings.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## roles_id_settings_post
+
+> PostRoleSettings roles_id_settings_post(id, setting_key, value)
+
+Add or update role setting
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+id = 56 # Integer | ID of the role
+setting_key = 'setting_key_example' # String | 
+value = Pipedrive::NumberBooleanDefault0.new # NumberBooleanDefault0 | Possible values for default_visibility settings: 0...1.
+
+begin
+  #Add or update role setting
+  result = api_instance.roles_id_settings_post(id, setting_key, value)
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_id_settings_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of the role | 
+ **setting_key** | **String**|  | 
+ **value** | [**NumberBooleanDefault0**](NumberBooleanDefault0.md)| Possible values for default_visibility settings: 0...1. | 
+
+### Return type
+
+[**PostRoleSettings**](PostRoleSettings.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## roles_post
+
+> PostRoles roles_post
+
+Add a role
+
+### Example
+
+```ruby
+# load the gem
+require 'pipedrive-openapi-client'
+# setup authorization
+Pipedrive.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['api_token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api_token'] = 'Bearer'
+end
+
+api_instance = Pipedrive::RolesApi.new
+
+begin
+  #Add a role
+  result = api_instance.roles_post
+  p result
+rescue Pipedrive::ApiError => e
+  puts "Exception when calling RolesApi->roles_post: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PostRoles**](PostRoles.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+