class Plaid::Configuration
- Plaid::Configuration
- Reference
- Object
Defined in:
plaid/configuration.crConstructors
-
.new
Create a new
Configuration
. -
.new(&)
Create a new
Configuration
with block.
Class Method Summary
-
.default
The default Configuration object.
Instance Method Summary
-
#access_token : String | Nil
Defines the access token (Bearer) used with OAuth2.
-
#access_token=(access_token : String | Nil)
Defines the access token (Bearer) used with OAuth2.
-
#api_key : Hash(String, String)
Defines API keys used with API Key authentications.
-
#api_key=(api_key : Hash(String, String))
Defines API keys used with API Key authentications.
-
#api_key_prefix : Hash(String, String)
Defines API key prefixes used with API Key authentications.
-
#api_key_prefix=(api_key_prefix : Hash(String, String))
Defines API key prefixes used with API Key authentications.
-
#api_key_with_prefix(param_name)
Gets API key (with prefix if set).
-
#auth_settings
Returns Auth Settings hash for api client.
-
#base_path : String
Defines url base path
-
#base_path=(base_path : String)
Defines url base path
- #base_path=(base_path)
-
#base_url(operation : String | Nil = nil)
Returns base URL for specified operation based on server settings
-
#basic_auth_token
Gets Basic Auth token string
-
#client_side_validation=(client_side_validation : Bool)
Set this to false to skip client side validation in the operation.
-
#client_side_validation? : Bool
Set this to false to skip client side validation in the operation.
-
#configure(&)
Configure object with block.
-
#debugging=(debugging : Bool)
Set this to enable/disable debugging.
-
#debugging? : Bool
Set this to enable/disable debugging.
-
#host : String
Defines url host
-
#host=(host : String)
Defines url host
- #host=(host)
- #operation_server_settings
-
#password : String | Nil
Defines the password used with HTTP basic authentication.
-
#password=(password : String | Nil)
Defines the password used with HTTP basic authentication.
-
#scheme : String
Defines url scheme
-
#scheme=(scheme : String)
Defines url scheme
- #scheme=(scheme)
-
#server_index : Int32
Define server configuration index
-
#server_index=(server_index : Int32)
Define server configuration index
-
#server_operation_index : Hash(String, String)
Define server operation configuration index
-
#server_operation_index=(server_operation_index : Hash(String, String))
Define server operation configuration index
-
#server_operation_variables : Hash(String, String)
Default server operation variables
-
#server_operation_variables=(server_operation_variables : Hash(String, String))
Default server operation variables
-
#server_settings
Returns an array of Server setting
-
#server_url(index_string, variables = {} of String => String, servers = nil)
Returns URL based on server settings
-
#server_variables : Hash(String, String)
Default server variables
-
#server_variables=(server_variables : Hash(String, String))
Default server variables
-
#temp_folder_path : String | Nil
Defines the temporary folder to store downloaded files (for API endpoints that have file response).
-
#temp_folder_path=(temp_folder_path : String | Nil)
Defines the temporary folder to store downloaded files (for API endpoints that have file response).
-
#timeout : Int32
The time limit for HTTP request in seconds.
-
#timeout=(timeout : Int32)
The time limit for HTTP request in seconds.
-
#username : String | Nil
Defines the username used with HTTP basic authentication.
-
#username=(username : String | Nil)
Defines the username used with HTTP basic authentication.
Constructor Detail
Create a new Configuration
with block.
config = Petstore::Configuration.new do |config|
config.username = "xxx"
config.password = "xxx"
end
Class Method Detail
Instance Method Detail
Defines the access token (Bearer) used with OAuth2.
Defines API keys used with API Key authentications.
@return [Hash] "key" => parameter name, value: parameter value (API key)
@example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string) config.api_key["api_key"] = "xxx"
Defines API keys used with API Key authentications.
@return [Hash] "key" => parameter name, value: parameter value (API key)
@example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string) config.api_key["api_key"] = "xxx"
Defines API key prefixes used with API Key authentications.
@return [Hash] "key" => parameter name, value: API key prefix
@example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers) config.api_key_prefix["api_key"] = "Token"
Defines API key prefixes used with API Key authentications.
@return [Hash] "key" => parameter name, value: API key prefix
@example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers) config.api_key_prefix["api_key"] = "Token"
Gets API key (with prefix if set). @param [String] param_name the parameter name of API key auth
Returns base URL for specified operation based on server settings
Set this to false to skip client side validation in the operation. Default to true. @return [true, false]
Set this to false to skip client side validation in the operation. Default to true. @return [true, false]
Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
details will be logged with logger.debug
(see the logger
attribute).
Default to false.
@return [true, false]
Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
details will be logged with logger.debug
(see the logger
attribute).
Default to false.
@return [true, false]
Defines the password used with HTTP basic authentication.
@return [String]
Defines the password used with HTTP basic authentication.
@return [String]
Define server operation configuration index
Define server operation configuration index
Default server operation variables
Default server operation variables
Returns URL based on server settings
@param index array index of the server settings @param variables hash of variable and the corresponding value
Default server variables
Defines the temporary folder to store downloaded files
(for API endpoints that have file response).
Default to use Tempfile
.
@return [String]
Defines the temporary folder to store downloaded files
(for API endpoints that have file response).
Default to use Tempfile
.
@return [String]
The time limit for HTTP request in seconds. Default to 0 (never times out).
Defines the username used with HTTP basic authentication.
@return [String]
Defines the username used with HTTP basic authentication.
@return [String]