Struct Options 

pub struct Options { /* private fields */ }

Struct containing needed options for API clients.

Implementations

impl Options

pub fn new(api_key: String, authorization: String) -> Options

Creates new Options struct for production access.

Keep in mind that authorization must be feched from the OAuth and passed here without ‘Bearer’ included.

pub fn new_dev(api_key: String) -> Options

Creates new Options struct for sandbox access.

Authorization for this is not required as it uses one of the predefined authorization keys in https://op-developer.fi/docs

pub fn base_url(&self) -> &str

Gets base URL for requests.

This is different for production and sandbox environments.

pub fn with_base_url(self, base_url: String) -> Self

Sets base URL for all API requests.

This is useful when testing the clients and can be used together with local test or mock server.

pub fn api_key(&self) -> &str

Gets API key for requests.

This is used as HTTP header x-api-key.

pub fn with_api_key(self, api_key: String) -> Self

Sets API key for API requests using these options.

pub fn authorization(&self) -> &str

Gets Authorization for requests.

This is used together with ’Bearer ’ in the Authorization HTTP header.

pub fn with_authorization(self, authorization: String) -> Self

Sets authorization header value for API requests using these options.

The authorization should not contain ’Bearer ’ in front of the authorization key as it will be automatically preprended by the clients.

pub fn with_version(self, version: String) -> Self

Sets API version for requests.

Some APIs are on different version (AccountsV3 for example). This is information is used to construct the request URL.

pub fn version(&self) -> &str

Returns API version for requests.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.