Class: Vatsense::Resources::Usage

Inherits:

Object

• Object
• Vatsense::Resources::Usage

Defined in:

lib/vatsense/resources/usage.rb

Overview

API usage statistics

Instance Method Summary

• #initialize(client:) ⇒ Usage constructor private

  A new instance of Usage.

• #retrieve(request_options: {}) ⇒ Vatsense::Models::UsageRetrieveResponse

  Check your used and remaining API requests.

Constructor Details

#initialize(client:) ⇒ Usage

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Usage.

Parameters:

• client (Vatsense::Client)

# File 'lib/vatsense/resources/usage.rb', line 28

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Vatsense::Models::UsageRetrieveResponse

Check your used and remaining API requests.

Parameters:

• request_options (Vatsense::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Vatsense::Models::UsageRetrieveResponse)

See Also:

• Models::UsageRetrieveParams

# File 'lib/vatsense/resources/usage.rb', line 16

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "usage",
    model: Vatsense::Models::UsageRetrieveResponse,
    options: params[:request_options]
  )
end