Class: Blurb::RequestCollection

Inherits:
BaseClass show all
Defined in:
lib/blurb/request_collection.rb

Constant Summary

Constants inherited from BaseClass

BaseClass::CAMPAIGN_TYPE_CODES

Instance Method Summary collapse

Constructor Details

#initialize(headers:, base_url:, bulk_api_limit: 100) ⇒ RequestCollection

Returns a new instance of RequestCollection.



7
8
9
10
11
# File 'lib/blurb/request_collection.rb', line 7

def initialize(headers:, base_url:, bulk_api_limit: 100)
  @base_url = base_url
  @headers = headers
  @api_limit = bulk_api_limit
end

Instance Method Details

#create(**create_params) ⇒ Object



42
43
44
# File 'lib/blurb/request_collection.rb', line 42

def create(**create_params)
  create_bulk([create_params]).first
end

#create_bulk(create_array) ⇒ Object



46
47
48
49
50
51
# File 'lib/blurb/request_collection.rb', line 46

def create_bulk(create_array)
  execute_bulk_request(
    request_type: :post,
    payload: create_array,
  )
end

#delete(resource_id) ⇒ Object



64
65
66
67
68
69
# File 'lib/blurb/request_collection.rb', line 64

def delete(resource_id)
  execute_request(
    api_path: "/#{resource_id}",
    request_type: :delete
  )
end

#list(url_params = nil) ⇒ Object



13
14
15
16
17
18
# File 'lib/blurb/request_collection.rb', line 13

def list(url_params=nil)
  execute_request(
    request_type: :get,
    url_params: url_params
  )
end

#list_extended(url_params = nil) ⇒ Object



20
21
22
23
24
25
26
# File 'lib/blurb/request_collection.rb', line 20

def list_extended(url_params=nil)
  execute_request(
    api_path: "/extended",
    request_type: :get,
    url_params: url_params
  )
end

#retrieve(resource_id) ⇒ Object



28
29
30
31
32
33
# File 'lib/blurb/request_collection.rb', line 28

def retrieve(resource_id)
  execute_request(
    api_path: "/#{resource_id}",
    request_type: :get
  )
end

#retrieve_extended(resource_id) ⇒ Object



35
36
37
38
39
40
# File 'lib/blurb/request_collection.rb', line 35

def retrieve_extended(resource_id)
  execute_request(
    api_path: "/extended/#{resource_id}",
    request_type: :get
  )
end

#update(**update_params) ⇒ Object



53
54
55
# File 'lib/blurb/request_collection.rb', line 53

def update(**update_params)
  update_bulk([update_params]).first
end

#update_bulk(update_array) ⇒ Object



57
58
59
60
61
62
# File 'lib/blurb/request_collection.rb', line 57

def update_bulk(update_array)
  execute_bulk_request(
    request_type: :put,
    payload: update_array,
  )
end