Class: Notisend::Resources::Recipients

Inherits:
Base
  • Object
show all
Defined in:
lib/notisend/resources/recipients.rb

Overview

List recipients: /email/lists/:list_id/recipients (+ global /email/recipients/search)

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Notisend::Resources::Base

Instance Method Details

#create(list_id:, email:, values: nil, tags: nil, unconfirmed: nil) ⇒ Object 



7
8
9
10
 
# File 'lib/notisend/resources/recipients.rb', line 7

def create(list_id:, email:, values: nil, tags: nil, unconfirmed: nil)
  payload = { email:, values:, tags:, unconfirmed: }.compact
  client.post(email_path('lists', list_id, 'recipients'), payload)
end

#delete(list_id:, id:) ⇒ Object 



25
26
27
 
# File 'lib/notisend/resources/recipients.rb', line 25

def delete(list_id:, id:)
  client.delete(email_path('lists', list_id, 'recipients', id))
end

#get(list_id:, id:) ⇒ Object 



12
13
14
 
# File 'lib/notisend/resources/recipients.rb', line 12

def get(list_id:, id:)
  client.get(email_path('lists', list_id, 'recipients', id))
end

#import(list_id:, recipients:, run_triggers: nil, tags: nil, callback_url: nil) ⇒ Object 



29
30
31
32
 
# File 'lib/notisend/resources/recipients.rb', line 29

def import(list_id:, recipients:, run_triggers: nil, tags: nil, callback_url: nil)
  payload = { recipients:, run_triggers:, tags:, callback_url: }.compact
  client.post(email_path('lists', list_id, 'recipients', 'imports'), payload)
end

#list(list_id:, page_number: nil, page_size: nil) ⇒ Object 



21
22
23
 
# File 'lib/notisend/resources/recipients.rb', line 21

def list(list_id:, page_number: nil, page_size: nil)
  paginated(email_path('lists', list_id, 'recipients'), page_params(page_number:, page_size:))
end

#search(email:, page_number: nil, page_size: nil) ⇒ Object 



34
35
36
37
 
# File 'lib/notisend/resources/recipients.rb', line 34

def search(email:, page_number: nil, page_size: nil)
  params = { email: }.merge(page_params(page_number:, page_size:))
  paginated(email_path('recipients', 'search'), params)
end

#update(list_id:, id:, email:, values: nil, tags: nil, run_triggers: nil) ⇒ Object 



16
17
18
19
 
# File 'lib/notisend/resources/recipients.rb', line 16

def update(list_id:, id:, email:, values: nil, tags: nil, run_triggers: nil)
  payload = { email:, values:, tags:, run_triggers: }.compact
  client.patch(email_path('lists', list_id, 'recipients', id), payload)
end