Class: Blurb::HistoryRequest

Inherits:
RequestCollection show all
Defined in:
lib/blurb/history_request.rb

Constant Summary collapse

FROM_DATE = 
(DateTime.now - 30).strftime('%Q')
TO_DATE = 
DateTime.now.strftime('%Q')
MAX_COUNT = 
200.freeze
MIN_COUNT = 
50.freeze
FILTERS = 
[]
PARENT_CAMPAIGN_ID = 
nil

Constants inherited from BaseClass

BaseClass::CAMPAIGN_TYPE_CODES

Instance Method Summary collapse

Methods inherited from RequestCollection

#create, #create_bulk, #delete, #list, #list_extended, #retrieve_extended, #update, #update_bulk

Constructor Details

#initialize(base_url:, headers:) ⇒ HistoryRequest

Returns a new instance of HistoryRequest.



12
13
14
15
 
# File 'lib/blurb/history_request.rb', line 12

def initialize(base_url:, headers:)
  @base_url = base_url
  @headers = headers
end

Instance Method Details

#retrieve(from_date: FROM_DATE, to_date: TO_DATE, campaign_ids:, filters: FILTERS, parent_campaign_id: PARENT_CAMPAIGN_ID, count: MAX_COUNT) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/blurb/history_request.rb', line 17

def retrieve(
  from_date: FROM_DATE,
  to_date: TO_DATE,
  campaign_ids:,
  filters: FILTERS,
  parent_campaign_id: PARENT_CAMPAIGN_ID,
  count: MAX_COUNT
)

  count = MIN_COUNT if count < MIN_COUNT
  count = MAX_COUNT if count > MAX_COUNT

  payload = {
    sort: {
      key: 'DATE',
      direction: 'ASC'
    },
    fromDate: from_date.to_i,
    toDate: to_date.to_i,
    eventTypes: {
      CAMPAIGN: {
        eventTypeIds: campaign_ids
      }
    },
    count: count
  }

  payload[:eventTypes][:CAMPAIGN].merge!({ filters: filters }) if filters.present?
  payload[:eventTypes][:CAMPAIGN].merge!({ parents: [{ campaignId: parent_campaign_id }] }) if parent_campaign_id.present?

  execute_request(
    api_path: "/history",
    request_type: :post,
    payload: payload
  )
end