Class: Essential::Messaging::Subscriber

Inherits:
Resource
  • Object
show all
Extended by:
Resource::Create, Resource::List
Includes:
Resource::Delete, Resource::Update
Defined in:
lib/essential/messaging/subscriber.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Resource::Create

create

Methods included from Resource::List

list, retrieve

Methods included from Resource::Delete

#delete

Methods included from Resource::Update

#update

Methods inherited from Resource

#==, #as_json, #fetch, #init_from, #initialize, #inspect, #loaded?, request, #to_json, url, #url

Methods included from Resource::AttrMethods

#filter_attrs, included

Constructor Details

This class inherits a constructor from Essential::Resource

Class Method Details

.by_carrier(params: {}, headers: @headers) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/essential/messaging/subscriber.rb', line 30

def self.by_carrier(params: {}, headers: @headers)
  # permitted:
  # :start_date, :end_date, :carrier
  resp = self.request(
    :get,
    url: '/v2/account/subscribers/analytics/by_carrier',
    params: params,
    headers: headers
  )
  JSON.parse(resp)
end

.by_transport(params: {}, headers: @headers) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/essential/messaging/subscriber.rb', line 42

def self.by_transport(params: {}, headers: @headers)
  # permitted:
  # :start_date, :end_date, :carrier
  resp = self.request(
    :get,
    url: '/v2/account/subscribers/analytics/by_transport',
    params: params,
    headers: headers
  )
  JSON.parse(resp)
end

Instance Method Details

#messages ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/essential/messaging/subscriber.rb', line 22

def messages
  Essential::Resource::PaginatorProxy.new(
    Message,
    params: {subscriber: self.sid},
    headers: @headers
  )
end