Class: Pushcrew::Segment

Inherits:
Object
  • Object
show all
Extended by:
Pushcrew
Defined in:
lib/pushcrew.rb

Constant Summary

Constants included from Pushcrew

VERSION

Class Method Summary collapse

Methods included from Pushcrew

deleteRequest, getRequest, handle_error_response, patchRequest, postRequest, putRequest

Class Method Details

.add_segment(segment) ⇒ JSON

Add A Segment

Parameters:

Parameters:

  • segment (Hash)

Returns:

  • (JSON) 


166
167
168
 
# File 'lib/pushcrew.rb', line 166

def self.add_segment(segment)
  postRequest(segment, "segments")
end

.add_subscribers_to_segment(subscribers_id, segment_id) ⇒ JSON

Add Subscribers to a Segment

Parameters:

Parameters:

  • subscribers_id (Hash)
  • segment_id (String)

Returns:

  • (JSON) 


183
184
185
 
# File 'lib/pushcrew.rb', line 183

def self.add_subscribers_to_segment(subscribers_id, segment_id)
  postRequest(subscribers_id ,"segments/#{segment_id}/subscribers")
end

.delete_segment(segment_id) ⇒ JSON

Delete A Segment

Parameters:

Parameters:

  • segment_id (String)

Returns:

  • (JSON) 


222
223
224
 
# File 'lib/pushcrew.rb', line 222

def self.delete_segment(segment_id)
  deleteRequest ("segments/#{segment_id}")
end

.get_list_segments ⇒ JSON

Get List of Segments

Returns:

  • (JSON) 


173
174
175
 
# File 'lib/pushcrew.rb', line 173

def self.get_list_segments()
  getRequest("segments")
end

.get_segments_for_a_subscriber(segment_id) ⇒ JSON

Get Segments for a Subscriber

Parameters:

Parameters:

  • segment_id (String)

Returns:

  • (JSON) 


203
204
205
 
# File 'lib/pushcrew.rb', line 203

def self.get_segments_for_a_subscriber(segment_id)
  getRequest("subscribers/#{segment_id}/segments")
end

.get_subscribers_segment(segment_id, page_number = 1, items_per_page = 2) ⇒ JSON

Get Subscribers in a Segment

Parameters:

Parameters:

  • segment_id (String)
  • page_number (Interger) (defaults to: 1)
  • items_per_page (Interger) (defaults to: 2)

Returns:

  • (JSON) 


194
195
196
 
# File 'lib/pushcrew.rb', line 194

def self.get_subscribers_segment(segment_id, page_number=1, items_per_page=2)
  getRequest("segments/#{segment_id}/subscribers?page=#{page_number}&per_page=#{items_per_page}")
end

.remove_subscribers_from_a_segment(subscribers_id, segment_id) ⇒ JSON

Remove Subscribers from a Segment

Parameters:

Parameters:

  • subscribers_id (Hash)
  • segment_id (String)

Returns:

  • (JSON) 


213
214
215
 
# File 'lib/pushcrew.rb', line 213

def self.remove_subscribers_from_a_segment(subscribers_id, segment_id)
  putRequest(subscribers_id, "segments/#{segment_id}/subscribers")
end