Class: LaunchDarklyApi::FollowFlagsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FollowFlagsApi

Returns a new instance of FollowFlagsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_flag_followers(project_key, feature_flag_key, environment_key, member_id, opts = {}) ⇒ nil

Remove a member as a follower of a flag in a project and environment Remove a member as a follower to a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

  • member_id (String) —

    The memberId of the member to remove as a follower of the flag

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

    the optional parameters

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 30

def delete_flag_followers(project_key, feature_flag_key, environment_key, member_id, opts = {})
  delete_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts)
  nil
end

#delete_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a member as a follower of a flag in a project and environment Remove a member as a follower to a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

  • member_id (String) —

    The memberId of the member to remove as a follower of the flag

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 43

def delete_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FollowFlagsApi.delete_flag_followers ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling FollowFlagsApi.delete_flag_followers"
  end
  # verify the required parameter 'feature_flag_key' is set
  if @api_client.config.client_side_validation && feature_flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FollowFlagsApi.delete_flag_followers"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling FollowFlagsApi.delete_flag_followers"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling FollowFlagsApi.delete_flag_followers"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'memberId' + '}', CGI.escape(member_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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

#get_flag_followers(project_key, feature_flag_key, environment_key, opts = {}) ⇒ FlagFollowersGetRep

Get followers of a flag in a project and environment Get a list of members following a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:



110
111
112
113
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 110

def get_flag_followers(project_key, feature_flag_key, environment_key, opts = {})
  data, _status_code, _headers = get_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, opts)
  data
end

#get_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, opts = {}) ⇒ Array<(FlagFollowersGetRep, Integer, Hash)>

Get followers of a flag in a project and environment Get a list of members following a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:

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

    FlagFollowersGetRep data, response status code and response headers



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 122

def get_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FollowFlagsApi.get_flag_followers ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling FollowFlagsApi.get_flag_followers"
  end
  # verify the required parameter 'feature_flag_key' is set
  if @api_client.config.client_side_validation && feature_flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FollowFlagsApi.get_flag_followers"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling FollowFlagsApi.get_flag_followers"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FlagFollowersGetRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"FollowFlagsApi.get_flag_followers",
    :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: FollowFlagsApi#get_flag_followers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_followers_by_proj_env(project_key, environment_key, opts = {}) ⇒ FlagFollowersByProjEnvGetRep

Get followers of all flags in a given project and environment Get followers of all flags in a given environment and project

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 184

def get_followers_by_proj_env(project_key, environment_key, opts = {})
  data, _status_code, _headers = get_followers_by_proj_env_with_http_info(project_key, environment_key, opts)
  data
end

#get_followers_by_proj_env_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(FlagFollowersByProjEnvGetRep, Integer, Hash)>

Get followers of all flags in a given project and environment Get followers of all flags in a given environment and project

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 195

def get_followers_by_proj_env_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FollowFlagsApi.get_followers_by_proj_env ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling FollowFlagsApi.get_followers_by_proj_env"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling FollowFlagsApi.get_followers_by_proj_env"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}/followers'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FlagFollowersByProjEnvGetRep'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"FollowFlagsApi.get_followers_by_proj_env",
    :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: FollowFlagsApi#get_followers_by_proj_env\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_flag_followers(project_key, feature_flag_key, environment_key, member_id, opts = {}) ⇒ nil

Add a member as a follower of a flag in a project and environment Add a member as a follower to a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

  • member_id (String) —

    The memberId of the member to add as a follower of the flag

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

    the optional parameters

Returns:

  • (nil) 


255
256
257
258
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 255

def put_flag_followers(project_key, feature_flag_key, environment_key, member_id, opts = {})
  put_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts)
  nil
end

#put_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add a member as a follower of a flag in a project and environment Add a member as a follower to a flag in a project and environment

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

  • environment_key (String) —

    The environment key

  • member_id (String) —

    The memberId of the member to add as a follower of the flag

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/launchdarkly_api/api/follow_flags_api.rb', line 268

def put_flag_followers_with_http_info(project_key, feature_flag_key, environment_key, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FollowFlagsApi.put_flag_followers ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling FollowFlagsApi.put_flag_followers"
  end
  # verify the required parameter 'feature_flag_key' is set
  if @api_client.config.client_side_validation && feature_flag_key.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FollowFlagsApi.put_flag_followers"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling FollowFlagsApi.put_flag_followers"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling FollowFlagsApi.put_flag_followers"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'memberId' + '}', CGI.escape(member_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

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