Class: TurnkeyClient::APIKeysApi
- Inherits:
-
Object
- Object
- TurnkeyClient::APIKeysApi
- Defined in:
- lib/turnkey_client/api/api_keys_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_api_keys(body, opts = {}) ⇒ ActivityResponse
Create API Keys Add api keys to an existing User.
-
#create_api_keys_with_http_info(body, opts = {}) ⇒ Array<(ActivityResponse, Integer, Hash)>
Create API Keys Add api keys to an existing User.
-
#delete_api_keys(body, opts = {}) ⇒ ActivityResponse
Delete API Keys Remove api keys from a User.
-
#delete_api_keys_with_http_info(body, opts = {}) ⇒ Array<(ActivityResponse, Integer, Hash)>
Delete API Keys Remove api keys from a User.
-
#get_api_key(body, opts = {}) ⇒ GetApiKeyResponse
Get API key Get details about an API key.
-
#get_api_key_with_http_info(body, opts = {}) ⇒ Array<(GetApiKeyResponse, Integer, Hash)>
Get API key Get details about an API key.
-
#get_api_keys(body, opts = {}) ⇒ GetApiKeysResponse
Get API key Get details about API keys for a user.
-
#get_api_keys_with_http_info(body, opts = {}) ⇒ Array<(GetApiKeysResponse, Integer, Hash)>
Get API key Get details about API keys for a user.
-
#initialize(api_client = ApiClient.default) ⇒ APIKeysApi
constructor
A new instance of APIKeysApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ APIKeysApi
Returns a new instance of APIKeysApi.
15 16 17 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 15 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
13 14 15 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 13 def api_client @api_client end |
Instance Method Details
#create_api_keys(body, opts = {}) ⇒ ActivityResponse
Create API Keys Add api keys to an existing User
23 24 25 26 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 23 def create_api_keys(body, opts = {}) data, _status_code, _headers = create_api_keys_with_http_info(body, opts) data end |
#create_api_keys_with_http_info(body, opts = {}) ⇒ Array<(ActivityResponse, Integer, Hash)>
Create API Keys Add api keys to an existing User
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 75 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 33 def create_api_keys_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APIKeysApi.create_api_keys ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling APIKeysApi.create_api_keys" end # resource path local_var_path = '/public/v1/submit/create_api_keys' # 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[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ActivityResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] 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 => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: APIKeysApi#create_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_api_keys(body, opts = {}) ⇒ ActivityResponse
Delete API Keys Remove api keys from a User
81 82 83 84 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 81 def delete_api_keys(body, opts = {}) data, _status_code, _headers = delete_api_keys_with_http_info(body, opts) data end |
#delete_api_keys_with_http_info(body, opts = {}) ⇒ Array<(ActivityResponse, Integer, Hash)>
Delete API Keys Remove api keys from a User
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 125 126 127 128 129 130 131 132 133 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 91 def delete_api_keys_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APIKeysApi.delete_api_keys ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling APIKeysApi.delete_api_keys" end # resource path local_var_path = '/public/v1/submit/delete_api_keys' # 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[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ActivityResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] 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 => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: APIKeysApi#delete_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_api_key(body, opts = {}) ⇒ GetApiKeyResponse
Get API key Get details about an API key
139 140 141 142 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 139 def get_api_key(body, opts = {}) data, _status_code, _headers = get_api_key_with_http_info(body, opts) data end |
#get_api_key_with_http_info(body, opts = {}) ⇒ Array<(GetApiKeyResponse, Integer, Hash)>
Get API key Get details about an API key
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 149 def get_api_key_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling APIKeysApi.get_api_key" end # resource path local_var_path = '/public/v1/query/get_api_key' # 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[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'GetApiKeyResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] 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 => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: APIKeysApi#get_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_api_keys(body, opts = {}) ⇒ GetApiKeysResponse
Get API key Get details about API keys for a user
197 198 199 200 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 197 def get_api_keys(body, opts = {}) data, _status_code, _headers = get_api_keys_with_http_info(body, opts) data end |
#get_api_keys_with_http_info(body, opts = {}) ⇒ Array<(GetApiKeysResponse, Integer, Hash)>
Get API key Get details about API keys for a user
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 246 247 248 249 |
# File 'lib/turnkey_client/api/api_keys_api.rb', line 207 def get_api_keys_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_keys ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling APIKeysApi.get_api_keys" end # resource path local_var_path = '/public/v1/query/get_api_keys' # 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[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'GetApiKeysResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] 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 => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: APIKeysApi#get_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |