Module: Yext::Api::Concerns::RateLimits

Included in:
AdministrativeApi, KnowledgeApi, LiveApi
Defined in:
lib/yext/api/concerns/rate_limits.rb

Overview

This module adds attributes to a module for saving and setting the rate limits returned from the Yext API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#last_meta ⇒ Object

Returns the value of attribute last_meta.



9
10
11
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 9

def last_meta
  @last_meta
end

#last_status ⇒ Object

Returns the value of attribute last_status.



9
10
11
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 9

def last_status
  @last_status
end

#rate_limit_limit ⇒ Object (readonly)

Returns the value of attribute rate_limit_limit.



9
10
11
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 9

def rate_limit_limit
  @rate_limit_limit
end

#rate_limit_remaining ⇒ Object (readonly)

Returns the value of attribute rate_limit_remaining.



9
10
11
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 9

def rate_limit_remaining
  @rate_limit_remaining
end

#rate_limit_reset_at ⇒ Object (readonly)

Returns the value of attribute rate_limit_reset_at.



9
10
11
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 9

def rate_limit_reset_at
  @rate_limit_reset_at
end

Instance Method Details

#update_rates(remaining: 1_000, limit: 1_000, reset_at: Time.now) ⇒ Object 



23
24
25
26
27
 
# File 'lib/yext/api/concerns/rate_limits.rb', line 23

def update_rates(remaining: 1_000, limit: 1_000, reset_at: Time.now)
  @rate_limit_limit     = limit
  @rate_limit_remaining = remaining
  @rate_limit_reset_at  = reset_at
end