Class: OpenapiClient::ProxyApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProxyApi

Returns a new instance of ProxyApi.

[View source]

19
20
21
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_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/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#authenticate_proxy_key(opts = {}) ⇒ AuthenticationResponse

Endpoint that the Proxy can use to authenticate with the client server Endpoint that the Proxy can use to authenticate with the client server

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

[View source]

27
28
29
30
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb', line 27

def authenticate_proxy_key(opts = {})
  data, _status_code, _headers = authenticate_proxy_key_with_http_info(opts)
  data
end

#authenticate_proxy_key_with_http_info(opts = {}) ⇒ Array<(AuthenticationResponse, Integer, Hash)>

Endpoint that the Proxy can use to authenticate with the client server Endpoint that the Proxy can use to authenticate with the client server

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AuthenticationResponse data, response status code and response headers

[View source]

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
75
76
77
78
79
80
81
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb', line 37

def authenticate_proxy_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProxyApi.authenticate_proxy_key ...'
  end
  # resource path
  local_var_path = '/proxy/auth'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'inline_object'])

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

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

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

#get_proxy_config(key, opts = {}) ⇒ ProxyConfig

Gets Proxy config for multiple environments Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided

Parameters:

  • key (String) —

    Accpets a Proxy Key.

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    PageNumber

  • :page_size (Integer) —

    PageSize

  • :cluster (String) —

    Unique identifier for the cluster for the account

  • :environment (String) —

    Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key.

Returns:

[View source]

92
93
94
95
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb', line 92

def get_proxy_config(key, opts = {})
  data, _status_code, _headers = get_proxy_config_with_http_info(key, opts)
  data
end

#get_proxy_config_with_http_info(key, opts = {}) ⇒ Array<(ProxyConfig, Integer, Hash)>

Gets Proxy config for multiple environments Gets Proxy config for multiple environments if the Key query param is provided or gets config for a single environment if an environment query param is provided

Parameters:

  • key (String) —

    Accpets a Proxy Key.

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    PageNumber

  • :page_size (Integer) —

    PageSize

  • :cluster (String) —

    Unique identifier for the cluster for the account

  • :environment (String) —

    Accepts an EnvironmentID. If this is provided then the endpoint will only return config for this environment. If this is left empty then the Proxy will return config for all environments associated with the Proxy Key.

Returns:

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

    ProxyConfig data, response status code and response headers

[View source]

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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ff/ruby/server/generated/lib/openapi_client/api/proxy_api.rb', line 106

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'key'] = key
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'cluster'] = opts[:'cluster'] if !opts[:'cluster'].nil?
  query_params[:'environment'] = opts[:'environment'] if !opts[:'environment'].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[:debug_body]

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

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

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