Class: LaunchDarklyApi::FeatureFlagsBetaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FeatureFlagsBetaApi

Returns a new instance of FeatureFlagsBetaApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_dependent_flags(project_key, feature_flag_key, opts = {}) ⇒ MultiEnvironmentDependentFlags

List dependent feature flags List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/launchdarkly_api/api/feature_flags_beta_api.rb', line 28

def get_dependent_flags(project_key, feature_flag_key, opts = {})
  data, _status_code, _headers = get_dependent_flags_with_http_info(project_key, feature_flag_key, opts)
  data
end

#get_dependent_flags_by_env(project_key, environment_key, feature_flag_key, opts = {}) ⇒ DependentFlagsByEnvironment

List dependent feature flags by environment List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

  • feature_flag_key (String) —

    The feature flag key

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/launchdarkly_api/api/feature_flags_beta_api.rb', line 98

def get_dependent_flags_by_env(project_key, environment_key, feature_flag_key, opts = {})
  data, _status_code, _headers = get_dependent_flags_by_env_with_http_info(project_key, environment_key, feature_flag_key, opts)
  data
end

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

List dependent feature flags by environment List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

  • feature_flag_key (String) —

    The feature flag key

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

    the optional parameters

Returns:

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

    DependentFlagsByEnvironment data, response status code and response headers



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
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/launchdarkly_api/api/feature_flags_beta_api.rb', line 110

def get_dependent_flags_by_env_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsBetaApi.get_dependent_flags_by_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 FeatureFlagsBetaApi.get_dependent_flags_by_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 FeatureFlagsBetaApi.get_dependent_flags_by_env"
  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 FeatureFlagsBetaApi.get_dependent_flags_by_env"
  end
  # resource path
  local_var_path = '/api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_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] || 'DependentFlagsByEnvironment'

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

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

#get_dependent_flags_with_http_info(project_key, feature_flag_key, opts = {}) ⇒ Array<(MultiEnvironmentDependentFlags, Integer, Hash)>

List dependent feature flags List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.

Parameters:

  • project_key (String) —

    The project key

  • feature_flag_key (String) —

    The feature flag key

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

    the optional parameters

Returns:



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
87
88
89
 
# File 'lib/launchdarkly_api/api/feature_flags_beta_api.rb', line 39

def get_dependent_flags_with_http_info(project_key, feature_flag_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsBetaApi.get_dependent_flags ...'
  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 FeatureFlagsBetaApi.get_dependent_flags"
  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 FeatureFlagsBetaApi.get_dependent_flags"
  end
  # resource path
  local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_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] || 'MultiEnvironmentDependentFlags'

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

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