Module: SirvRestApi

Defined in:

lib/sirv_rest_api.rb,
lib/sirv_rest_api/client.rb,
lib/sirv_rest_api/errors.rb,
lib/sirv_rest_api/models.rb,
lib/sirv_rest_api/version.rb

Overview

Sirv REST API SDK for Ruby

Examples:

Basic usage

require 'sirv_rest_api'

client = SirvRestApi::Client.new(
  client_id: 'your-client-id',
  client_secret: 'your-client-secret'
)

client.connect
account = client.get_account_info
puts "CDN URL: #{account.cdn_url}"

Defined Under Namespace

Classes: AccountEvent, AccountInfo, AccountLimits, AccountUser, ApiError, AuthenticationError, BatchDeleteResult, BatchZipResult, BillingPlan, Client, Error, FileInfo, FileMeta, FolderContents, HttpStats, JwtResponse, NotFoundError, PlanPrice, PointOfInterest, ProductMeta, RateLimitError, RateLimitInfo, SearchResult, SpinViewStats, StorageInfo, StorageStats, TokenResponse, UserInfo, ValidationError

Constant Summary

VERSION =

"1.0.0"

Class Method Summary

• .new(**options) ⇒ Client

  Create a new client instance.

Class Method Details

.new(**options) ⇒ Client

Create a new client instance

Parameters:

• options (Hash) —

  Client options

Returns:

• (Client) —

  New client instance

# File 'lib/sirv_rest_api.rb', line 28

def new(**options)
  Client.new(**options)
end