Module: Refsheet

Defined in:
lib/refsheet/version.rb,
lib/refsheet.rb,
lib/refsheet/api_error.rb,
lib/refsheet/api_client.rb,
lib/refsheet/api/users_api.rb,
lib/refsheet/configuration.rb,
lib/refsheet/models/inline_response_200.rb,
lib/refsheet/models/inline_response_200_data.rb,
lib/refsheet/models/inline_response_200_data_attributes.rb,
lib/refsheet/models/inline_response_200_data_attributes_roles.rb

Overview

#Refsheet.net API

#The Refsheet.net API allows another application to view and manipulate data on behalf of a user. To get started, [generate an API Key from your account settings](refsheet.net/account/settings/api). ## Authentication The API requires two values, ‘api_key_id` and `api_key_secret` to be sent either as query parameters or via headers. |Field|URL Param|Header| |—|—|—| |API Key ID|`api_key_id`|`X-ApiKeyId`| |API Key Secret|`api_key_secret`|`X-ApiKeySecret`| “` curl -H "X-ApiKeyId: YOUR_KEY_ID" \ -H "X-ApiKeySecret: YOUR_KEY_SECRET" \ refsheet.net/api/v1/users/abc123 “`

OpenAPI spec version: v1

Generated by: github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Classes: ApiClient, ApiError, Configuration, InlineResponse200, InlineResponse200Data, InlineResponse200DataAttributes, InlineResponse200DataAttributesRoles, UsersApi

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Refsheet.configure do |config|
  config.api_key_id = "xxx"
  config.api_key_secret = "xxx"
end

If no block given, return the default Configuration object.



46
47
48
49
50
51
52
 
# File 'lib/refsheet.rb', line 46

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end