Class: Access::Api

Inherits:
Object
  • Object
show all
Defined in:
lib/access/api.rb

Instance Method Summary collapse

Instance Method Details

#all_usage(options = {}) ⇒ Object

Report



323
324
325
326
327
328
 
# File 'lib/access/api.rb', line 323

def all_usage(options = {})
  # Internal Admin only Call
  request.get("/all_usage", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#autocomplete(options = {}) ⇒ Object

Autocomplete



69
70
71
72
73
 
# File 'lib/access/api.rb', line 69

def autocomplete(options = {})
  request.get("/autocomplete", "offer", options) do |response|
    AutocompleteResponse.new(response)
  end
end

#create_oauth_application(options = {}) ⇒ Object 



267
268
269
270
271
272
273
 
# File 'lib/access/api.rb', line 267

def create_oauth_application(options = {})
  # Internal Admin only Call
  request.create("/oauth_applications", 'token', options) do |response|
    OauthApplicationResponse.new(response)
  end
  # create("/oauth_applications", 'token', options)
end

#create_oauth_application_token(application_key, options = {}) ⇒ Object 



258
259
260
261
262
263
264
265
 
# File 'lib/access/api.rb', line 258

def create_oauth_application_token(application_key, options = {})
  # Internal Admin only Call
  request.create("/oauth_applications/#{application_key}/access_tokens", 'token', options) do |response|
    # TokenResponse.new(response)
    # OauthApplicationResponse.new(response)
  end
  # create("/oauth_applications/#{application_key}/access_tokens", 'token', options)
end

#delete_oauth_application(application_key, options = {}) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/access/api.rb', line 283

def delete_oauth_application(application_key, options = {})
  # Internal Admin only Call
  request.delete("/oauth_applications/#{application_key}", 'token', options) do |response|
    OauthApplication.new(response)
  end
  # delete("/oauth_applications/#{application_key}", 'token', options)
end

#favorites_create(resource_id, options = {}) ⇒ Object 



382
383
384
385
386
 
# File 'lib/access/api.rb', line 382

def favorites_create(resource_id, options = {})
  request.post("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
    FavoriteResponse.new(response)
  end
end

#favorites_delete(resource_id, options = {}) ⇒ Object 



388
389
390
391
392
 
# File 'lib/access/api.rb', line 388

def favorites_delete(resource_id, options = {})
  request.delete("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
    FavoriteResponse.new(response)
  end
end

#favorites_find(resource_id, options = {}) ⇒ Object 



376
377
378
379
380
 
# File 'lib/access/api.rb', line 376

def favorites_find(resource_id, options = {})
  request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
    FavoriteResponse.new(response)
  end
end

#favorites_search(options = {}) ⇒ Object

Favorites



370
371
372
373
374
 
# File 'lib/access/api.rb', line 370

def favorites_search(options = {})
  request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}", "mms", options) do |response|
    FavoriteResponse.new(response)
  end
end

#find_campaign(campaign_key, options = {}) ⇒ Object 



110
111
112
113
114
 
# File 'lib/access/api.rb', line 110

def find_campaign(campaign_key, options = {})
  request.get("/campaigns/#{campaign_key}", "campaign", options) do |response|
    CampaignResponse.new(response)
  end
end

#find_category(category_key, options = {}) ⇒ Object 



11
12
13
14
15
 
# File 'lib/access/api.rb', line 11

def find_category(category_key, options = {})
  request.get("/categories/#{category_key}", "offer", options) do |response|
    CategoryResponse.new(response)
  end
end

#find_channel(channel_key, options = {}) ⇒ Object 



97
98
99
100
101
 
# File 'lib/access/api.rb', line 97

def find_channel(channel_key, options = {})
  request.get("/channels/#{channel_key}", "campaign", options) do |response|
    ChannelResponse.new(response)
  end
end

#find_device(member_key, options = {}) ⇒ Object 



186
187
188
189
190
 
# File 'lib/access/api.rb', line 186

def find_device(member_key, options = {})
  request.get("/members/#{member_key}/devices/#{options.delete(:udid)}", 'mms', options) do |response|
    DeviceResponse.new(response)
  end
end

#find_filter(application_key, options = {}) ⇒ Object 



222
223
224
225
226
227
 
# File 'lib/access/api.rb', line 222

def find_filter(application_key, options = {})
  # Internal Admin only Call
  request.get("/filters/#{application_key}", "token", options) do |response|
    FilterResponse.new(response)
  end
end

#find_location(location_key, options = {}) ⇒ Object 



43
44
45
46
47
 
# File 'lib/access/api.rb', line 43

def find_location(location_key, options = {})
  request.get("/locations/#{location_key}", "offer", options) do |response|
    LocationResponse.new(response)
  end
end

#find_oauth_application(application_key, options = {}) ⇒ Object 



237
238
239
240
241
242
 
# File 'lib/access/api.rb', line 237

def find_oauth_application(application_key, options = {})
  # Internal Admin only Call
  request.get("/oauth_applications/#{application_key}", 'token', options) do |response|
    OauthApplicationResponse.new(response)
  end
end

#find_oauth_application_token(application_key, token_key, options = {}) ⇒ Object 



251
252
253
254
255
256
 
# File 'lib/access/api.rb', line 251

def find_oauth_application_token(application_key, token_key, options = {})
  # Internal Admin only Call
  request.get("/oauth_applications/#{application_key}/access_tokens/#{token_key}", 'token', options) do |response|
    TokenResponse.new(response)
  end
end

#find_offer(offer_key, options = {}) ⇒ Object 



24
25
26
27
28
 
# File 'lib/access/api.rb', line 24

def find_offer(offer_key, options = {})
  request.get("/offers/#{offer_key}", "offer", options) do |response|
    OfferResponse.new(response)
  end
end

#find_offer_redemptions_by_member(member_key, usage_redeem_key, options = {}) ⇒ Object 



206
207
208
209
210
 
# File 'lib/access/api.rb', line 206

def find_offer_redemptions_by_member(member_key, usage_redeem_key, options = {})
  request.get("/members/#{member_key}/offer_redemptions/#{usage_redeem_key}", "report", options) do |response|
    RedemptionResponse.new(response)
  end
end

#find_offer_uses_remaining(offer_key, options = {}) ⇒ Object 



30
31
32
33
34
 
# File 'lib/access/api.rb', line 30

def find_offer_uses_remaining(offer_key, options = {})
  request.get("/offers/#{offer_key}/uses_remaining", "offer", options) do |response|
    OfferResponse.new(response)
  end
end

#find_program_provisioning_method(pcid) ⇒ Object

Program



193
194
195
196
197
 
# File 'lib/access/api.rb', line 193

def find_program_provisioning_method(pcid)
  request.get("/programs/#{pcid}", "mms") do |response|
    ProgramResponse.new(response)
  end
end

#find_spot(spot_key, options = {}) ⇒ Object 



129
130
131
132
133
 
# File 'lib/access/api.rb', line 129

def find_spot(spot_key, options = {})
  request.get("/spots/#{spot_key}", "campaign", options) do |response|
    SpotResponse.new(response)
  end
end

#find_store(store_key, options = {}) ⇒ Object 



56
57
58
59
60
 
# File 'lib/access/api.rb', line 56

def find_store(store_key, options = {})
  request.get("/stores/#{store_key}", "offer", options) do |response|
    StoreResponse.new(response)
  end
end

#find_token(token, options = {}) ⇒ Object 



299
300
301
302
303
304
305
 
# File 'lib/access/api.rb', line 299

def find_token(token, options = {})
  # Internal Admin only Call
  # new verify_other
  request.get("/tokens/#{token}", "token", options) do |response|
    TokenResponse.new(response)
  end
end

#geolocation_find(options = {}) ⇒ Object 



402
403
404
405
406
 
# File 'lib/access/api.rb', line 402

def geolocation_find(options = {})
  request.get('/geolocation/find_location', 'offer', options) do |response|
    GeolocationResponse.new(response)
  end
end

#geolocation_search(options = {}) ⇒ Object

Geolocation



396
397
398
399
400
 
# File 'lib/access/api.rb', line 396

def geolocation_search(options = {})
  request.get('/geolocation', 'offer', options) do |response|
    GeolocationResponse.new(response)
  end
end

#member_location_frequent(member, options = {}) ⇒ Object 



356
357
358
359
360
 
# File 'lib/access/api.rb', line 356

def member_location_frequent(member, options = {})
  request.get("/members/#{member}/locations/frequent", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#member_location_recent(member, options = {}) ⇒ Object 



362
363
364
365
366
 
# File 'lib/access/api.rb', line 362

def member_location_recent(member, options = {})
  request.get("/members/#{member}/locations/recent", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#member_query_frequent(member, options = {}) ⇒ Object 



344
345
346
347
348
 
# File 'lib/access/api.rb', line 344

def member_query_frequent(member, options = {})
  request.get("/members/#{member}/queries/frequent", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#member_query_recent(member, options = {}) ⇒ Object 



350
351
352
353
354
 
# File 'lib/access/api.rb', line 350

def member_query_recent(member, options = {})
  request.get("/members/#{member}/queries/recent", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#member_show(member_key, options = {}) ⇒ Object

Member



167
168
169
170
171
 
# File 'lib/access/api.rb', line 167

def member_show(member_key, options = {})
  request.get("/members/#{member_key}", 'mms', options) do |response|
    MemberResponse.new(response)
  end
end

#member_update(member_key, options = {}) ⇒ Object 



173
174
175
176
177
 
# File 'lib/access/api.rb', line 173

def member_update(member_key, options = {})
  request.put("/members/#{member_key}?program_id=#{options.delete(:program_id)}", 'mms', options) do |response|
    MemberResponse.new(response)
  end
end

#national_stores(options = {}) ⇒ Object 



62
63
64
65
66
 
# File 'lib/access/api.rb', line 62

def national_stores(options={})
  request.get("/stores/national", "offer", options) do |response|
    StoreResponse.new(response)
  end
end

#redeem_offer(offer_key, redeem_type = nil, options = {}) ⇒ Object

Redeem



76
77
78
79
80
 
# File 'lib/access/api.rb', line 76

def redeem_offer(offer_key, redeem_type = nil, options = {})
  request.get("/redeem/#{offer_key}/#{redeem_type}", "redeem", options) do |response|
    RedeemResponse.new(response)
  end
end

#search_campaigns(options = {}) ⇒ Object

Campaign



104
105
106
107
108
 
# File 'lib/access/api.rb', line 104

def search_campaigns(options = {})
  request.get("/campaigns", "campaign", options) do |response|
    CampaignResponse.new(response)
  end
end

#search_categories(options = {}) ⇒ Object

Categories



5
6
7
8
9
 
# File 'lib/access/api.rb', line 5

def search_categories(options = {})
  request.get("/categories", "offer", options) do |response|
    CategoryResponse.new(response)
  end
end

#search_channels(options = {}) ⇒ Object

Channel



91
92
93
94
95
 
# File 'lib/access/api.rb', line 91

def search_channels(options = {})
  request.get("/channels", "campaign", options) do |response|
    ChannelResponse.new(response)
  end
end

#search_city_savings(options = {}) ⇒ Object

CitySavings



83
84
85
86
87
88
 
# File 'lib/access/api.rb', line 83

def search_city_savings(options = {})
  # this is broken
  request.get("/citysavings", "allcitysavings", options) do |response|
    CitySavingsResponse.new(response)
  end
end

#search_devices(member_key, options = {}) ⇒ Object

Device



180
181
182
183
184
 
# File 'lib/access/api.rb', line 180

def search_devices(member_key, options = {})
  request.get("/members/#{member_key}/devices", 'mms', options) do |response|
    DeviceResponse.new(response)
  end
end

#search_filters(options = {}) ⇒ Object

Filters



215
216
217
218
219
220
 
# File 'lib/access/api.rb', line 215

def search_filters(options = {})
  # Internal Admin only Call
  request.get("/filters", "token", options) do |response|
    FilterResponse.new(response)
  end
end

#search_locations(options = {}) ⇒ Object

Locations



37
38
39
40
41
 
# File 'lib/access/api.rb', line 37

def search_locations(options = {})
  request.get("/locations", "offer", options) do |response|
    LocationResponse.new(response)
  end
end

#search_oauth_application_tokens(application_key, options = {}) ⇒ Object 



244
245
246
247
248
249
 
# File 'lib/access/api.rb', line 244

def search_oauth_application_tokens(application_key, options = {})
  # Internal Admin only Call
  request.get("/oauth_applications/#{application_key}/access_tokens", 'token', options) do |response|
    TokenResponse.new(response)
  end
end

#search_oauth_applications(options = {}) ⇒ Object

Oauth Applications



230
231
232
233
234
235
 
# File 'lib/access/api.rb', line 230

def search_oauth_applications(options = {})
  # Internal Admin only Call
  request.get("/oauth_applications", 'token', options) do |response|
    OauthApplicationResponse.new(response)
  end
end

#search_offer_redemptions_by_member(member_key, options = {}) ⇒ Object

Offer Redemptions



200
201
202
203
204
 
# File 'lib/access/api.rb', line 200

def search_offer_redemptions_by_member(member_key, options = {})
  request.get("/members/#{member_key}/offer_redemptions", "report", options) do |response|
    RedemptionResponse.new(response)
  end
end

#search_offers(options = {}) ⇒ Object

Offers



18
19
20
21
22
 
# File 'lib/access/api.rb', line 18

def search_offers(options = {})
  request.get("/offers", "offer", options) do |response|
    OfferResponse.new(response)
  end
end

#search_spots_by_campaign(campaign_key, options = {}) ⇒ Object 



123
124
125
126
127
 
# File 'lib/access/api.rb', line 123

def search_spots_by_campaign(campaign_key, options = {})
  request.get("/spots/campaign/#{campaign_key}", "campaign", options) do |response|
    SpotResponse.new(response)
  end
end

#search_spots_by_channel(channel_key, options = {}) ⇒ Object

Spot



117
118
119
120
121
 
# File 'lib/access/api.rb', line 117

def search_spots_by_channel(channel_key, options = {})
  request.get("/spots/channel/#{channel_key}", "campaign", options) do |response|
    SpotResponse.new(response)
  end
end

#search_stores(options = {}) ⇒ Object

Stores



50
51
52
53
54
 
# File 'lib/access/api.rb', line 50

def search_stores(options = {})
  request.get("/stores", "offer", options) do |response|
    StoreResponse.new(response)
  end
end

#search_tokens(options = {}) ⇒ Object

Access Tokens



292
293
294
295
296
297
 
# File 'lib/access/api.rb', line 292

def search_tokens(options = {})
  # Internal Admin only Call
  request.get("/tokens", 'token', options) do |response|
    TokenResponse.new(response)
  end
end

#update_oauth_application(application_key, batch = {}) ⇒ Object 



275
276
277
278
279
280
281
 
# File 'lib/access/api.rb', line 275

def update_oauth_application(application_key, batch= {})
  # Internal Admin only Call
  request.put("/oauth_applications/#{application_key}", 'token', options) do |response|
    OauthApplicationResponse.new(response)
  end
  # put("/oauth_applications/#{application_key}", 'token', options)
end

#usage(options = {}) ⇒ Object 



330
331
332
333
334
335
 
# File 'lib/access/api.rb', line 330

def usage(options = {})
  # Internal Admin only Call
  request.get("/usage", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#usage_other(token, options = {}) ⇒ Object 



337
338
339
340
341
342
 
# File 'lib/access/api.rb', line 337

def usage_other(token, options = {})
  # Internal Admin only Call
  request.get("/usage/#{token}", "report", options) do |response|
    ReportResponse.new(response)
  end
end

#user_authentication(options = {}) ⇒ Object 



148
149
150
151
152
 
# File 'lib/access/api.rb', line 148

def user_authentication(options = {})
  request.post("/auth", "mms", options) do |response|
    UserResponse.new(response)
  end
end

#user_authentication_by_cvt(options = {}) ⇒ Object 



154
155
156
157
158
 
# File 'lib/access/api.rb', line 154

def user_authentication_by_cvt(options = {})
  request.get("/auth", "mms", options) do |response|
    UserResponse.new(response)
  end
end

#user_authentication_by_member_key(options = {}) ⇒ Object 



160
161
162
163
164
 
# File 'lib/access/api.rb', line 160

def user_authentication_by_member_key(options = {})
  request.get("/auth", "mms", options) do |response|
    UserResponse.new(response)
  end
end

#user_registration(options = {}) ⇒ Object

User



136
137
138
139
140
 
# File 'lib/access/api.rb', line 136

def user_registration(options = {})
  request.post("/register", "mms", options) do |response|
    UserResponse.new(response)
  end
end

#user_update(options = {}) ⇒ Object 



142
143
144
145
146
 
# File 'lib/access/api.rb', line 142

def user_update(options = {})
  request.put("/users", "mms", options) do |response|
    UserResponse.new(response)
  end
end

#verify_filter(filter, options = {}) ⇒ Object 



315
316
317
318
319
320
 
# File 'lib/access/api.rb', line 315

def verify_filter(filter, options = {})
  # Internal Admin only Call
  request.post_for_filter("/filter", 'token', filter, options) do |response|
    VerifyResponse.new(response)
  end
end

#verify_token(options = {}) ⇒ Object

Verify



308
309
310
311
312
313
 
# File 'lib/access/api.rb', line 308

def verify_token(options = {})
  # Internal Admin only Call
  request.get("/verify", 'token', options) do |response|
    VerifyResponse.new(response)
  end
end