Class: Access::Api
- Inherits:
-
Object
- Object
- Access::Api
- Defined in:
- lib/access/api.rb
Instance Method Summary collapse
-
#all_usage(options = {}) ⇒ Object
Report.
-
#autocomplete(options = {}) ⇒ Object
Autocomplete.
- #create_oauth_application(options = {}) ⇒ Object
- #create_oauth_application_token(application_key, options = {}) ⇒ Object
- #delete_oauth_application(application_key, options = {}) ⇒ Object
- #favorites_create(resource_id, options = {}) ⇒ Object
- #favorites_delete(resource_id, options = {}) ⇒ Object
- #favorites_find(resource_id, options = {}) ⇒ Object
-
#favorites_search(options = {}) ⇒ Object
Favorites.
- #find_campaign(campaign_key, options = {}) ⇒ Object
- #find_category(category_key, options = {}) ⇒ Object
- #find_channel(channel_key, options = {}) ⇒ Object
- #find_filter(application_key, options = {}) ⇒ Object
- #find_location(location_key, options = {}) ⇒ Object
- #find_oauth_application(application_key, options = {}) ⇒ Object
- #find_oauth_application_token(application_key, token_key, options = {}) ⇒ Object
- #find_offer(offer_key, options = {}) ⇒ Object
- #find_offer_redemptions_by_member(member_key, usage_redeem_key, options = {}) ⇒ Object
- #find_spot(spot_key, options = {}) ⇒ Object
- #find_store(store_key, options = {}) ⇒ Object
- #find_token(token, options = {}) ⇒ Object
- #member_authentication(options = {}) ⇒ Object
- #member_location_frequent(member, options = {}) ⇒ Object
- #member_location_recent(member, options = {}) ⇒ Object
- #member_query_frequent(member, options = {}) ⇒ Object
- #member_query_recent(member, options = {}) ⇒ Object
-
#member_registration(options = {}) ⇒ Object
Member.
- #national_stores(options = {}) ⇒ Object
-
#redeem_offer(offer_key, redeem_type = nil, options = {}) ⇒ Object
Redeem.
-
#search_campaigns(options = {}) ⇒ Object
Campaign.
-
#search_categories(options = {}) ⇒ Object
Categories.
-
#search_channels(options = {}) ⇒ Object
Channel.
-
#search_city_savings(options = {}) ⇒ Object
CitySavings.
-
#search_filters(options = {}) ⇒ Object
Filters.
-
#search_locations(options = {}) ⇒ Object
Locations.
- #search_oauth_application_tokens(application_key, options = {}) ⇒ Object
-
#search_oauth_applications(options = {}) ⇒ Object
Oauth Applications.
-
#search_offer_redemptions_by_member(member_key, options = {}) ⇒ Object
Offer Redemptions.
-
#search_offers(options = {}) ⇒ Object
Offers.
- #search_spots_by_campaign(campaign_key, options = {}) ⇒ Object
-
#search_spots_by_channel(channel_key, options = {}) ⇒ Object
Spot.
-
#search_stores(options = {}) ⇒ Object
Stores.
-
#search_tokens(options = {}) ⇒ Object
Access Tokens.
- #update_oauth_application(application_key, batch = {}) ⇒ Object
- #usage(options = {}) ⇒ Object
- #usage_other(token, options = {}) ⇒ Object
- #verify_filter(filter, options = {}) ⇒ Object
-
#verify_token(options = {}) ⇒ Object
Verify.
Instance Method Details
#all_usage(options = {}) ⇒ Object
Report
267 268 269 270 271 272 |
# File 'lib/access/api.rb', line 267 def all_usage( = {}) # Internal Admin only Call request.get("/all_usage", "report", ) do |response| ReportResponse.new(response) end end |
#autocomplete(options = {}) ⇒ Object
Autocomplete
63 64 65 66 67 |
# File 'lib/access/api.rb', line 63 def autocomplete( = {}) request.get("/autocomplete", "offer", ) do |response| AutocompleteResponse.new(response) end end |
#create_oauth_application(options = {}) ⇒ Object
211 212 213 214 215 216 217 |
# File 'lib/access/api.rb', line 211 def create_oauth_application( = {}) # Internal Admin only Call request.create("/oauth_applications", 'token', ) do |response| OauthApplicationResponse.new(response) end # create("/oauth_applications", 'token', options) end |
#create_oauth_application_token(application_key, options = {}) ⇒ Object
202 203 204 205 206 207 208 209 |
# File 'lib/access/api.rb', line 202 def create_oauth_application_token(application_key, = {}) # Internal Admin only Call request.create("/oauth_applications/#{application_key}/access_tokens", 'token', ) 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
227 228 229 230 231 232 233 |
# File 'lib/access/api.rb', line 227 def delete_oauth_application(application_key, = {}) # Internal Admin only Call request.delete("/oauth_applications/#{application_key}", 'token', ) do |response| OauthApplication.new(response) end # delete("/oauth_applications/#{application_key}", 'token', options) end |
#favorites_create(resource_id, options = {}) ⇒ Object
326 327 328 329 330 |
# File 'lib/access/api.rb', line 326 def favorites_create(resource_id, = {}) request.post("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", ) do |response| FavoriteResponse.new(response) end end |
#favorites_delete(resource_id, options = {}) ⇒ Object
332 333 334 335 336 |
# File 'lib/access/api.rb', line 332 def favorites_delete(resource_id, = {}) request.delete("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", ) do |response| FavoriteResponse.new(response) end end |
#favorites_find(resource_id, options = {}) ⇒ Object
320 321 322 323 324 |
# File 'lib/access/api.rb', line 320 def favorites_find(resource_id, = {}) request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", ) do |response| FavoriteResponse.new(response) end end |
#favorites_search(options = {}) ⇒ Object
Favorites
314 315 316 317 318 |
# File 'lib/access/api.rb', line 314 def favorites_search( = {}) request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}", "mms", ) do |response| FavoriteResponse.new(response) end end |
#find_campaign(campaign_key, options = {}) ⇒ Object
104 105 106 107 108 |
# File 'lib/access/api.rb', line 104 def find_campaign(campaign_key, = {}) request.get("/campaigns/#{store_key}", "campaign", ) 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, = {}) request.get("/categories/#{category_key}", "offer", ) do |response| CategoryResponse.new(response) end end |
#find_channel(channel_key, options = {}) ⇒ Object
91 92 93 94 95 |
# File 'lib/access/api.rb', line 91 def find_channel(channel_key, = {}) request.get("/channels/#{channel_key}", "campaign", ) do |response| ChannelResponse.new(response) end end |
#find_filter(application_key, options = {}) ⇒ Object
166 167 168 169 170 171 |
# File 'lib/access/api.rb', line 166 def find_filter(application_key, = {}) # Internal Admin only Call request.get("/filters/#{application_key}", "token", ) do |response| FilterResponse.new(response) end end |
#find_location(location_key, options = {}) ⇒ Object
37 38 39 40 41 |
# File 'lib/access/api.rb', line 37 def find_location(location_key, = {}) request.get("/locations/#{location_key}", "offer", ) do |response| LocationResponse.new(response) end end |
#find_oauth_application(application_key, options = {}) ⇒ Object
181 182 183 184 185 186 |
# File 'lib/access/api.rb', line 181 def find_oauth_application(application_key, = {}) # Internal Admin only Call request.get("/oauth_applications/#{application_key}", 'token', ) do |response| OauthApplicationResponse.new(response) end end |
#find_oauth_application_token(application_key, token_key, options = {}) ⇒ Object
195 196 197 198 199 200 |
# File 'lib/access/api.rb', line 195 def find_oauth_application_token(application_key, token_key, = {}) # Internal Admin only Call request.get("/oauth_applications/#{application_key}/access_tokens/#{token_key}", 'token', ) 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, = {}) request.get("/offers/#{offer_key}", "offer", ) do |response| OfferResponse.new(response) end end |
#find_offer_redemptions_by_member(member_key, usage_redeem_key, options = {}) ⇒ Object
150 151 152 153 154 |
# File 'lib/access/api.rb', line 150 def find_offer_redemptions_by_member(member_key, usage_redeem_key, = {}) request.get("/members/#{member_key}/offer-redemptions/#{usage_redeem_key}", "report", ) do |response| RedemptionResponse.new(response) end end |
#find_spot(spot_key, options = {}) ⇒ Object
123 124 125 126 127 |
# File 'lib/access/api.rb', line 123 def find_spot(spot_key, = {}) request.get("/spots/#{spot_key}", "campaign", ) do |response| SpotResponse.new(response) end end |
#find_store(store_key, options = {}) ⇒ Object
50 51 52 53 54 |
# File 'lib/access/api.rb', line 50 def find_store(store_key, = {}) request.get("/stores/#{store_key}", "offer", ) do |response| StoreResponse.new(response) end end |
#find_token(token, options = {}) ⇒ Object
243 244 245 246 247 248 249 |
# File 'lib/access/api.rb', line 243 def find_token(token, = {}) # Internal Admin only Call # new verify_other request.get("/tokens/#{token}", "token", ) do |response| TokenResponse.new(response) end end |
#member_authentication(options = {}) ⇒ Object
136 137 138 139 140 |
# File 'lib/access/api.rb', line 136 def member_authentication( = {}) request.post("/auth", "mms", ) do |response| MemberResponse.new(response) end end |
#member_location_frequent(member, options = {}) ⇒ Object
300 301 302 303 304 |
# File 'lib/access/api.rb', line 300 def member_location_frequent(member, = {}) request.get("/members/#{member}/locations/frequent", "report", ) do |response| ReportResponse.new(response) end end |
#member_location_recent(member, options = {}) ⇒ Object
306 307 308 309 310 |
# File 'lib/access/api.rb', line 306 def member_location_recent(member, = {}) request.get("/members/#{member}/locations/recent", "report", ) do |response| ReportResponse.new(response) end end |
#member_query_frequent(member, options = {}) ⇒ Object
288 289 290 291 292 |
# File 'lib/access/api.rb', line 288 def member_query_frequent(member, = {}) request.get("/members/#{member}/queries/frequent", "report", ) do |response| ReportResponse.new(response) end end |
#member_query_recent(member, options = {}) ⇒ Object
294 295 296 297 298 |
# File 'lib/access/api.rb', line 294 def member_query_recent(member, = {}) request.get("/members/#{member}/queries/recent", "report", ) do |response| ReportResponse.new(response) end end |
#member_registration(options = {}) ⇒ Object
Member
130 131 132 133 134 |
# File 'lib/access/api.rb', line 130 def member_registration( = {}) request.post("/register", "mms", ) do |response| MemberResponse.new(response) end end |
#national_stores(options = {}) ⇒ Object
56 57 58 59 60 |
# File 'lib/access/api.rb', line 56 def national_stores(={}) request.get("/stores/national", "offer", ) do |response| StoreResponse.new(response) end end |
#redeem_offer(offer_key, redeem_type = nil, options = {}) ⇒ Object
Redeem
70 71 72 73 74 |
# File 'lib/access/api.rb', line 70 def redeem_offer(offer_key, redeem_type = nil, = {}) request.get("/redeem/#{offer_key}/#{redeem_type}", "redeem", ) do |response| RedeemResponse.new(response) end end |
#search_campaigns(options = {}) ⇒ Object
Campaign
98 99 100 101 102 |
# File 'lib/access/api.rb', line 98 def search_campaigns( = {}) request.get("/campaigns", "campaign", ) 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( = {}) request.get("/categories", "offer", ) do |response| CategoryResponse.new(response) end end |
#search_channels(options = {}) ⇒ Object
Channel
85 86 87 88 89 |
# File 'lib/access/api.rb', line 85 def search_channels( = {}) request.get("/channels", "campaign", ) do |response| ChannelResponse.new(response) end end |
#search_city_savings(options = {}) ⇒ Object
CitySavings
77 78 79 80 81 82 |
# File 'lib/access/api.rb', line 77 def search_city_savings( = {}) # this is broken request.get("/citysavings", "allcitysavings", ) do |response| CitySavingsResponse.new(response) end end |
#search_filters(options = {}) ⇒ Object
Filters
159 160 161 162 163 164 |
# File 'lib/access/api.rb', line 159 def search_filters( = {}) # Internal Admin only Call request.get("/filters", "token", ) do |response| FilterResponse.new(response) end end |
#search_locations(options = {}) ⇒ Object
Locations
31 32 33 34 35 |
# File 'lib/access/api.rb', line 31 def search_locations( = {}) request.get("/locations", "offer", ) do |response| LocationResponse.new(response) end end |
#search_oauth_application_tokens(application_key, options = {}) ⇒ Object
188 189 190 191 192 193 |
# File 'lib/access/api.rb', line 188 def search_oauth_application_tokens(application_key, = {}) # Internal Admin only Call request.get("/oauth_applications/#{application_key}/access_tokens", 'token', ) do |response| TokenResponse.new(response) end end |
#search_oauth_applications(options = {}) ⇒ Object
Oauth Applications
174 175 176 177 178 179 |
# File 'lib/access/api.rb', line 174 def search_oauth_applications( = {}) # Internal Admin only Call request.get("/oauth_applications", 'token', ) do |response| OauthApplicationResponse.new(response) end end |
#search_offer_redemptions_by_member(member_key, options = {}) ⇒ Object
Offer Redemptions
144 145 146 147 148 |
# File 'lib/access/api.rb', line 144 def search_offer_redemptions_by_member(member_key, = {}) request.get("/members/#{member_key}/offer-redemptions", "report", ) 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( = {}) request.get("/offers", "offer", ) do |response| OfferResponse.new(response) end end |
#search_spots_by_campaign(campaign_key, options = {}) ⇒ Object
117 118 119 120 121 |
# File 'lib/access/api.rb', line 117 def search_spots_by_campaign(campaign_key, = {}) request.get("/spots/campaign/#{campaign_key}", "campaign", ) do |response| SpotResponse.new(response) end end |
#search_spots_by_channel(channel_key, options = {}) ⇒ Object
Spot
111 112 113 114 115 |
# File 'lib/access/api.rb', line 111 def search_spots_by_channel(channel_key, = {}) request.get("/spots/channel/#{channel_key}", "campaign", ) do |response| SpotResponse.new(response) end end |
#search_stores(options = {}) ⇒ Object
Stores
44 45 46 47 48 |
# File 'lib/access/api.rb', line 44 def search_stores( = {}) request.get("/stores", "offer", ) do |response| StoreResponse.new(response) end end |
#search_tokens(options = {}) ⇒ Object
Access Tokens
236 237 238 239 240 241 |
# File 'lib/access/api.rb', line 236 def search_tokens( = {}) # Internal Admin only Call request.get("/tokens", 'token', ) do |response| TokenResponse.new(response) end end |
#update_oauth_application(application_key, batch = {}) ⇒ Object
219 220 221 222 223 224 225 |
# File 'lib/access/api.rb', line 219 def update_oauth_application(application_key, batch= {}) # Internal Admin only Call request.put("/oauth_applications/#{application_key}", 'token', ) do |response| OauthApplicationResponse.new(response) end # put("/oauth_applications/#{application_key}", 'token', options) end |
#usage(options = {}) ⇒ Object
274 275 276 277 278 279 |
# File 'lib/access/api.rb', line 274 def usage( = {}) # Internal Admin only Call request.get("/usage", "report", ) do |response| ReportResponse.new(response) end end |
#usage_other(token, options = {}) ⇒ Object
281 282 283 284 285 286 |
# File 'lib/access/api.rb', line 281 def usage_other(token, = {}) # Internal Admin only Call request.get("/usage/#{token}", "report", ) do |response| ReportResponse.new(response) end end |
#verify_filter(filter, options = {}) ⇒ Object
259 260 261 262 263 264 |
# File 'lib/access/api.rb', line 259 def verify_filter(filter, = {}) # Internal Admin only Call request.post_for_filter("/filter", 'token', filter, ) do |response| VerifyResponse.new(response) end end |
#verify_token(options = {}) ⇒ Object
Verify
252 253 254 255 256 257 |
# File 'lib/access/api.rb', line 252 def verify_token( = {}) # Internal Admin only Call request.get("/verify", 'token', ) do |response| VerifyResponse.new(response) end end |