Class: Pipedrive::PermissionSetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/api/permission_sets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PermissionSetsApi

Returns a new instance of PermissionSetsApi.



19
20
21
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_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/permission_sets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#permission_sets_get(opts = {}) ⇒ PermissionSets

Get all Permission Sets

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 25

def permission_sets_get(opts = {})
  data, _status_code, _headers = permission_sets_get_with_http_info(opts)
  data
end

#permission_sets_get_with_http_info(opts = {}) ⇒ Array<(PermissionSets, Integer, Hash)>

Get all Permission Sets

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PermissionSets, Integer, Hash)>) —

    PermissionSets data, response status code and response headers



33
34
35
36
37
38
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
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 33

def permission_sets_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_get ...'
  end
  # resource path
  local_var_path = '/permissionSets'

  # 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] || 'PermissionSets' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = 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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#permission_sets_id_assignments_get(id, opts = {}) ⇒ UserAssignmentsToPermissionSet

List Permission Set assignments The list of assignments for a Permission Set

Parameters:

  • id (Integer) —

    ID of the permission set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Pagination start (default to 0)

  • :limit (Integer) —

    Items shown per page

Returns:



83
84
85
86
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 83

def permission_sets_id_assignments_get(id, opts = {})
  data, _status_code, _headers = permission_sets_id_assignments_get_with_http_info(id, opts)
  data
end

#permission_sets_id_assignments_get_with_http_info(id, opts = {}) ⇒ Array<(UserAssignmentsToPermissionSet, Integer, Hash)>

List Permission Set assignments The list of assignments for a Permission Set

Parameters:

  • id (Integer) —

    ID of the permission set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Pagination start

  • :limit (Integer) —

    Items shown per page

Returns:



95
96
97
98
99
100
101
102
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
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 95

def permission_sets_id_assignments_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_id_assignments_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 PermissionSetsApi.permission_sets_id_assignments_get"
  end
  # resource path
  local_var_path = '/permissionSets/{id}/assignments'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'UserAssignmentsToPermissionSet' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = 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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_id_assignments_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#permission_sets_id_get(id, opts = {}) ⇒ SinglePermissionSetsItem

Get one Permission Set

Parameters:

  • id (Integer) —

    ID of the permission set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 148

def permission_sets_id_get(id, opts = {})
  data, _status_code, _headers = permission_sets_id_get_with_http_info(id, opts)
  data
end

#permission_sets_id_get_with_http_info(id, opts = {}) ⇒ Array<(SinglePermissionSetsItem, Integer, Hash)>

Get one Permission Set

Parameters:

  • id (Integer) —

    ID of the permission set

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SinglePermissionSetsItem, Integer, Hash)>) —

    SinglePermissionSetsItem data, response status code and response headers



157
158
159
160
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
199
200
201
202
 
# File 'lib/pipedrive-openapi-client/api/permission_sets_api.rb', line 157

def permission_sets_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PermissionSetsApi.permission_sets_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 PermissionSetsApi.permission_sets_id_get"
  end
  # resource path
  local_var_path = '/permissionSets/{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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'SinglePermissionSetsItem' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = 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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PermissionSetsApi#permission_sets_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end