class ApiClient

Public Class Methods

new(api_key, api_secret, user_name = nil, password = nil) click to toggle source

Initialize the Credentials to be used by the SDK

# File lib/ApiClient.rb, line 17
def initialize(api_key, api_secret, user_name = nil, password = nil)

        @credentials = Credentials.new(
                :credential_type => (user_name.nil?) || (password.nil?) ? OAuthGrantType::CLIENT_CREDENTIALS : OAuthGrantType::PASSWORD, 
                :client_key => api_key, 
                :client_secret => api_secret,
                :user_name => user_name,
                :password => password)                               
end

Public Instance Methods

custom_request() click to toggle source

Build a custom API request

# File lib/ApiClient.rb, line 83
def custom_request()
        return CustomRequest.new(@credentials.client_key, @credentials.get_access_token)
end

download_images() click to toggle source

Download an image

# File lib/ApiClient.rb, line 73
def download_images()
        return DownloadImages.new(@credentials.client_key, @credentials.get_access_token)
end

download_videos() click to toggle source

Download a video

# File lib/ApiClient.rb, line 78
def download_videos()
        return DownloadVideos.new(@credentials.client_key, @credentials.get_access_token)
end

get_access_token() click to toggle source

Get access token to be used by the SDK

# File lib/ApiClient.rb, line 28
def get_access_token
        return @credentials.get_access_token
end

images() click to toggle source

Get metadata for images

# File lib/ApiClient.rb, line 63
def images()
        return Images.new(@credentials.client_key, @credentials.get_access_token)
end

search_images() click to toggle source

Search for both creative and editorial images

# File lib/ApiClient.rb, line 33
def search_images()
        return SearchImages.new(@credentials.client_key, @credentials.get_access_token)
end

search_images_creative() click to toggle source

Search for creative images

# File lib/ApiClient.rb, line 38
def search_images_creative()
        return SearchImagesCreative.new(@credentials.client_key, @credentials.get_access_token)
end

search_images_editorial() click to toggle source

Search for editorial images

# File lib/ApiClient.rb, line 43
def search_images_editorial()
        return SearchImagesEditorial.new(@credentials.client_key, @credentials.get_access_token)
end

search_videos() click to toggle source

Search for both creative and editorial videos

# File lib/ApiClient.rb, line 48
def search_videos()
        return SearchVideos.new(@credentials.client_key, @credentials.get_access_token)
end

search_videos_creative() click to toggle source

Search for creative videos

# File lib/ApiClient.rb, line 53
def search_videos_creative()
        return SearchVideosCreative.new(@credentials.client_key, @credentials.get_access_token)
end

search_videos_editorial() click to toggle source

Search for editorial videos

# File lib/ApiClient.rb, line 58
def search_videos_editorial()
        return SearchVideosEditorial.new(@credentials.client_key, @credentials.get_access_token)
end

videos() click to toggle source

Get metadata for videos

# File lib/ApiClient.rb, line 68
def videos()
        return Videos.new(@credentials.client_key, @credentials.get_access_token)
end