Class: ZombieBattleground::Api::Requests::GetDecksRequest

Inherits:
Object
  • Object
show all
Includes:
ActiveModel::Validations, RequestHelper, ValidationHelper
Defined in:
lib/zombie_battleground/api/requests/get_decks_request.rb

Overview

Request validator for GetDecks

Constant Summary

Constants included from RequestHelper

RequestHelper::BLACKLISTED_INSTANCE_VARIABLES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RequestHelper

#params

Instance Attribute Details

#deck_id ⇒ Integer

Optionally set the Deck’s deck_id for filtered querying

Examples:

request.deck_id #=> 1

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 49

def deck_id
  @deck_id
end

#hero_id ⇒ Integer

Optionally set the Deck’s hero_id for filtered querying

Examples:

request.hero_id #=> 1

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 71

def hero_id
  @hero_id
end

#id ⇒ Integer

Optionally set the Deck’s id for filtered querying

Examples:

request.id #=> 1

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 27

def id
  @id
end

#limit ⇒ Integer

Optionally set the limit for max Matches returned

Examples:

request.limit #=> 100

Returns:

  • (Integer) 


126
127
128
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 126

def limit
  @limit
end

#name ⇒ String

Optionally set the Deck’s name for filtered querying

Examples:

request.name #=> "Buzzkill"

Returns:

  • (String) 


60
61
62
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 60

def name
  @name
end

#page ⇒ Integer

Optionally set the page number for filtered querying

Examples:

request.page #=> 1

Returns:

  • (Integer) 


115
116
117
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 115

def page
  @page
end

#primary_skill_id ⇒ Integer

Optionally set the Deck’s primary_skill_id for filtered querying

Examples:

request.primary_skill_id #=> 1

Returns:

  • (Integer) 


82
83
84
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 82

def primary_skill_id
  @primary_skill_id
end

#secondary_skill_id ⇒ Integer

Optionally set the Deck’s secondary_skill_id for filtered querying

Examples:

request.secondary_skill_id #=> 1

Returns:

  • (Integer) 


93
94
95
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 93

def secondary_skill_id
  @secondary_skill_id
end

#user_id ⇒ String

Optionally set the Deck’s user_id for filtered querying

Examples:

request.user_id #=> "ZombieSlayer_5699"

Returns:

  • (String) 


38
39
40
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 38

def user_id
  @user_id
end

#version ⇒ String

Optionally set the Deck’s version for filtered querying

Examples:

request.version #=> "v3"

Returns:

  • (String) 


104
105
106
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 104

def version
  @version
end

Instance Method Details

#uri ⇒ String

The URI for the endpoint

Examples:

request.uri # => "decks"

Returns:

  • (String) 


148
149
150
 
# File 'lib/zombie_battleground/api/requests/get_decks_request.rb', line 148

def uri
  'decks'
end