Class: LaunchDarklyApi::CustomRolesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/custom_roles_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomRolesApi

Returns a new instance of CustomRolesApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/custom_roles_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/launchdarkly_api/api/custom_roles_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_custom_role(custom_role_key, opts = {}) ⇒ nil

Delete a custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 26

def delete_custom_role(custom_role_key, opts = {})
  delete_custom_role_with_http_info(custom_role_key, opts)
  nil
end

#delete_custom_role_with_http_info(custom_role_key, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 35

def delete_custom_role_with_http_info(custom_role_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.delete_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.delete_custom_role"
  end
  # resource path
  local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.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 = ['Token']
  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: CustomRolesApi#delete_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_role(custom_role_key, opts = {}) ⇒ CustomRole

Get one custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 77

def get_custom_role(custom_role_key, opts = {})
  data, _status_code, _headers = get_custom_role_with_http_info(custom_role_key, opts)
  data
end

#get_custom_role_with_http_info(custom_role_key, opts = {}) ⇒ Array<(CustomRole, Fixnum, Hash)>

Get one custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

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

    the optional parameters

Returns:

  • (Array<(CustomRole, Fixnum, Hash)>) —

    CustomRole data, response status code and response headers



86
87
88
89
90
91
92
93
94
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
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 86

def get_custom_role_with_http_info(custom_role_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.get_custom_role"
  end
  # resource path
  local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.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 = ['Token']
  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 => 'CustomRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_roles(opts = {}) ⇒ CustomRoles

Return a complete list of custom roles.

Parameters:

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 128

def get_custom_roles(opts = {})
  data, _status_code, _headers = get_custom_roles_with_http_info(opts)
  data
end

#get_custom_roles_with_http_info(opts = {}) ⇒ Array<(CustomRoles, Fixnum, Hash)>

Return a complete list of custom roles.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CustomRoles, Fixnum, Hash)>) —

    CustomRoles data, response status code and response headers



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
169
170
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 136

def get_custom_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_roles ...'
  end
  # resource path
  local_var_path = '/roles'

  # 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 = ['Token']
  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 => 'CustomRoles')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_custom_role(custom_role_key, patch_delta, opts = {}) ⇒ CustomRole

Modify a custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:



176
177
178
179
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 176

def patch_custom_role(custom_role_key, patch_delta, opts = {})
  data, _status_code, _headers = patch_custom_role_with_http_info(custom_role_key, patch_delta, opts)
  data
end

#patch_custom_role_with_http_info(custom_role_key, patch_delta, opts = {}) ⇒ Array<(CustomRole, Fixnum, Hash)>

Modify a custom role by key.

Parameters:

  • custom_role_key —

    The custom role key.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:

  • (Array<(CustomRole, Fixnum, Hash)>) —

    CustomRole data, response status code and response headers



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
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 186

def patch_custom_role_with_http_info(custom_role_key, patch_delta, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.patch_custom_role ...'
  end
  # verify the required parameter 'custom_role_key' is set
  if @api_client.config.client_side_validation && custom_role_key.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.patch_custom_role"
  end
  # verify the required parameter 'patch_delta' is set
  if @api_client.config.client_side_validation && patch_delta.nil?
    fail ArgumentError, "Missing the required parameter 'patch_delta' when calling CustomRolesApi.patch_custom_role"
  end
  # resource path
  local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.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(patch_delta)
  auth_names = ['Token']
  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,
    :return_type => 'CustomRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#patch_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_custom_role(custom_role_body, opts = {}) ⇒ CustomRole

Create a new custom role.

Parameters:

  • custom_role_body —

    New role or roles to create.

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 233

def post_custom_role(custom_role_body, opts = {})
  data, _status_code, _headers = post_custom_role_with_http_info(custom_role_body, opts)
  data
end

#post_custom_role_with_http_info(custom_role_body, opts = {}) ⇒ Array<(CustomRole, Fixnum, Hash)>

Create a new custom role.

Parameters:

  • custom_role_body —

    New role or roles to create.

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

    the optional parameters

Returns:

  • (Array<(CustomRole, Fixnum, Hash)>) —

    CustomRole data, response status code and response headers



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
 
# File 'lib/launchdarkly_api/api/custom_roles_api.rb', line 242

def post_custom_role_with_http_info(custom_role_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomRolesApi.post_custom_role ...'
  end
  # verify the required parameter 'custom_role_body' is set
  if @api_client.config.client_side_validation && custom_role_body.nil?
    fail ArgumentError, "Missing the required parameter 'custom_role_body' when calling CustomRolesApi.post_custom_role"
  end
  # resource path
  local_var_path = '/roles'

  # 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(custom_role_body)
  auth_names = ['Token']
  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 => 'CustomRole')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomRolesApi#post_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end