Class: SendGridWebApi::SubUserModules::Limit

Inherits:
SendGridWebApi::SubUser show all
Defined in:
lib/sub_user/limits.rb

Constant Summary collapse

LIMIT_URL = 
"apiv2/customer.limit.json"

Instance Attribute Summary

Attributes inherited from Base

#api_key

Instance Method Summary collapse

Methods inherited from SendGridWebApi::SubUser

#base_url

Methods included from SendGridWebApi::SubUserModules

#apps, #auth, #bounces, #event_notification, #iframe, #invalid_emails, #ip_management, #limits, #management, #monitor_records, #parse_email, #spam, #stats, #unsubscribes, #white_label

Methods inherited from Base

#builder_options, #initialize, #make_request_url, #query_api, #query_delete_api, #query_patch_api, #query_post_api, #query_post_json_api, #session, #to_query

Constructor Details

This class inherits a constructor from SendGridWebApi::Base

Instance Method Details

#decrement_credits(options = {}) ⇒ Object 



30
31
32
33
 
# File 'lib/sub_user/limits.rb', line 30

def decrement_credits options = {}
  options.merge!({:task => "decrement"}) unless options[:task]
  query_api(LIMIT_URL, options)    
end

#delete(options = {}) ⇒ Object 



10
11
12
13
 
# File 'lib/sub_user/limits.rb', line 10

def delete options = {}
  options.merge!({:task => "none"}) unless options[:task]
  query_api(LIMIT_URL, options)    
end

#get(options = {}) ⇒ Object 



5
6
7
8
 
# File 'lib/sub_user/limits.rb', line 5

def get options = {}
  options.merge!({:task => "retrieve"}) unless options[:task]
  query_api(LIMIT_URL, options)
end

#increment_credits(options = {}) ⇒ Object 



25
26
27
28
 
# File 'lib/sub_user/limits.rb', line 25

def increment_credits options = {}
  options.merge!({:task => "increment"}) unless options[:task]
  query_api(LIMIT_URL, options)    
end

#reset(options = {}) ⇒ Object 



15
16
17
18
 
# File 'lib/sub_user/limits.rb', line 15

def reset options = {}
  options.merge!({:task => "recurring"}) unless options[:task]
  query_api(LIMIT_URL, options)    
end

#set_credits(options = {}) ⇒ Object 



20
21
22
23
 
# File 'lib/sub_user/limits.rb', line 20

def set_credits options = {}
  options.merge!({:task => "total"}) unless options[:task]
  query_api(LIMIT_URL, options)    
end