class VivialConnect::Client

.configure(api_key, api_secret, account_id, host=“api.vivialconnect.net/api/”, api_version=“v1.0” )¶ ↑

Configures the client with your `api_key`, `api_secret`, `account_id`, `host`, and `api_version`

Required parameters:

api_key     | String | "YOURAPIKEY"
api_secret  | String | "YOURAPISECRET"
account_id  | Fixnum | 100000

Optional parameters:

host        | String | "baseapiurl" 
api_version | String | "v1.9"

NOTE: default host is "https://api.vivialconnect.net/api/" and default version is "v1.0"

Example usage:

VivialConnect::Client.configure(API_KEY, API_SECRET, ACCOUNT_ID)
=> true

NOTE: .configure does not check if your credentials are good, it merely checks that you have entered values for them

reset¶ ↑

Resets all of the configuration values to nil. This gives you a blank slate client to call .configure on.

Example usage

VivialConnect::Client.instance.reset
=> true

#reset_api_base_path(new_host, new_api_version)¶ ↑

Resets the api base path (host + api_version) on an instantiated client instance

Required paramters:

new_host        | String | "https://api.vivialconnect.net/api/"
new_api_version | String | "v1.1"

Example usage

VivialConnect::Client.instance.reset_api_base_path("https://api.vivialconnect.net/api/", "v1.1" )
=> true