Module: Gw2::Api::Account
- Included in:
- Client
- Defined in:
- lib/gw2/modules/account.rb
Overview
achievements.rb
Instance Method Summary collapse
-
#account ⇒ Object
Returns the account information.
-
#account_achievements(params = {}) ⇒ Object
Returns the account achievements Valid Parameters - id: [String] the id of the achievement to filter - ids: [String] the ids of the achievements to filter comma seperated - page: [String] the page number to filter - page_size: [String] the page size to filter.
-
#account_bank ⇒ Object
Returns the account bank Empty slots are represented by null Slot is indicated by the index of the array.
-
#account_characters(params = {}) ⇒ Object
Returns the account characters.
-
#account_daily_crafting ⇒ Object
Returns the account daily crafting.
-
#account_dungeons ⇒ Object
Returns the daily dungeons for the account.
-
#account_dyes ⇒ Object
Returns the dye ids unlocked on the account.
-
#account_finishers ⇒ Object
Returns the finisher ids unlocked on the account.
-
#account_gliders ⇒ Object
Returns the glider IDs unlocked on the account.
-
#account_home_cats ⇒ Object
Returns the cat unlocks for the home instance on the account.
-
#account_home_nodes ⇒ Object
Returns the nodes unlocked for the home instance on the account.
-
#account_inventory ⇒ Object
Alias to account_shared_inventory.
-
#account_jadebots ⇒ Object
Returns the account jadebot skin id unlocks.
-
#account_legendary_armory ⇒ Object
Returns the account legendary armory unlocks.
-
#account_luck ⇒ Object
Returns the account luck.
-
#account_mail_carriers ⇒ Object
Returns the mail carrier ids unlocked on the account.
-
#account_masteries ⇒ Object
Returns the masteries unlocked on the account.
-
#account_mastery_points ⇒ Object
Returns the mastery points earned / spent on the account.
-
#account_materials(params = {}) ⇒ Object
Returns the account materials Array index indicates the slot Empty slots are represented by a count of 0 Valid Parameters ids: [String] the ids of the materials to filter comma seperated, can optionally use ‘all’ to get all of them.
-
#account_minis ⇒ Object
Returns the account mini ids unlocked.
-
#account_mount_skins ⇒ Object
Alias to account_mounts_skins.
-
#account_mount_types ⇒ Object
Alias to account_mounts_types.
-
#account_mounts_skins ⇒ Object
Returns the account mount skins unlocked.
-
#account_mounts_types ⇒ Object
Returns the account mount types unlocked.
-
#account_novelties ⇒ Object
Returns the account novelties unlocked.
-
#account_outfits ⇒ Object
Returns the account outfit ids unlocked.
-
#account_progression ⇒ Object
Returns the account progression.
-
#account_pvp_heroes ⇒ Object
Returns the account pvp hero ids unlocked.
-
#account_raids ⇒ Object
Returns the account weekly raid progress.
-
#account_recipes ⇒ Object
Returns the account recipe ids unlocked.
-
#account_shared_inventory ⇒ Object
Returns the shared inventory slots for the account Empty slots are represented by null Slot is indicated by the index of the array.
-
#account_skiffs ⇒ Object
Returns the account skiff skin unlocked ids.
-
#account_skins ⇒ Object
Returns the account skin ids unlocked.
-
#account_titles ⇒ Object
Returns the account title ids unlocked.
-
#account_wallet ⇒ Object
Returns the account currencies to the amount of currency the account has.
-
#account_wizardsvault_daily ⇒ Object
Returns the wizard vault daily objectives and progress.
-
#account_wizardsvault_listings ⇒ Object
Returns the astral rewards for the account.
-
#account_wizardsvault_weekly ⇒ Object
Returnst he wizard vault weekly objectives and progress.
-
#account_worldbosses ⇒ Object
Returns the daily world boss clears for the account.
-
#commerce_transactions ⇒ Object
Returns the account trading post transactions.
-
#create_subtoken(params = {}) ⇒ Object
Creates a subtoken of the current api token Valid Parameters expires: [String] An ISO-8601 datetime specifing when the generated Subtoken will expire.
-
#token_info(params = {}) ⇒ Object
Returns info about the supplied token.
Instance Method Details
#account ⇒ Object
Returns the account information
8 9 10 |
# File 'lib/gw2/modules/account.rb', line 8 def account execute_request("account") end |
#account_achievements(params = {}) ⇒ Object
Returns the account achievements Valid Parameters
-
id: [String] the id of the achievement to filter
-
ids: [String] the ids of the achievements to filter comma seperated
-
page: [String] the page number to filter
-
page_size: [String] the page size to filter
19 20 21 |
# File 'lib/gw2/modules/account.rb', line 19 def account_achievements(params = {}) execute_with_params("account/achievements", params) end |
#account_bank ⇒ Object
Returns the account bank Empty slots are represented by null Slot is indicated by the index of the array
26 27 28 29 30 |
# File 'lib/gw2/modules/account.rb', line 26 def account_bank request_string = "account/bank" execute_request(request_string) end |
#account_characters(params = {}) ⇒ Object
Returns the account characters
220 221 222 |
# File 'lib/gw2/modules/account.rb', line 220 def account_characters(params = {}) execute_with_params("characters", params) end |
#account_daily_crafting ⇒ Object
Returns the account daily crafting
33 34 35 |
# File 'lib/gw2/modules/account.rb', line 33 def account_daily_crafting execute_request("account/dailycrafting") end |
#account_dungeons ⇒ Object
Returns the daily dungeons for the account
38 39 40 |
# File 'lib/gw2/modules/account.rb', line 38 def account_dungeons execute_request("account/dungeons") end |
#account_dyes ⇒ Object
Returns the dye ids unlocked on the account
43 44 45 |
# File 'lib/gw2/modules/account.rb', line 43 def account_dyes execute_request("account/dyes") end |
#account_finishers ⇒ Object
Returns the finisher ids unlocked on the account
48 49 50 |
# File 'lib/gw2/modules/account.rb', line 48 def account_finishers execute_request("account/finishers") end |
#account_gliders ⇒ Object
Returns the glider IDs unlocked on the account
53 54 55 |
# File 'lib/gw2/modules/account.rb', line 53 def account_gliders execute_request("account/gliders") end |
#account_home_cats ⇒ Object
Returns the cat unlocks for the home instance on the account
58 59 60 |
# File 'lib/gw2/modules/account.rb', line 58 def account_home_cats execute_request("account/home/cats") end |
#account_home_nodes ⇒ Object
Returns the nodes unlocked for the home instance on the account
63 64 65 |
# File 'lib/gw2/modules/account.rb', line 63 def account_home_nodes execute_request("account/home/nodes") end |
#account_inventory ⇒ Object
Alias to account_shared_inventory
68 69 70 |
# File 'lib/gw2/modules/account.rb', line 68 def account_inventory account_shared_inventory end |
#account_jadebots ⇒ Object
Returns the account jadebot skin id unlocks
80 81 82 |
# File 'lib/gw2/modules/account.rb', line 80 def account_jadebots execute_request("account/jadebots") end |
#account_legendary_armory ⇒ Object
Returns the account legendary armory unlocks
90 91 92 |
# File 'lib/gw2/modules/account.rb', line 90 def account_legendary_armory execute_request("account/legendaryarmory") end |
#account_luck ⇒ Object
Returns the account luck
85 86 87 |
# File 'lib/gw2/modules/account.rb', line 85 def account_luck execute_request("account/luck") end |
#account_mail_carriers ⇒ Object
Returns the mail carrier ids unlocked on the account
95 96 97 |
# File 'lib/gw2/modules/account.rb', line 95 def account_mail_carriers execute_request("account/mailcarriers") end |
#account_masteries ⇒ Object
Returns the masteries unlocked on the account
100 101 102 |
# File 'lib/gw2/modules/account.rb', line 100 def account_masteries execute_request("account/masteries") end |
#account_mastery_points ⇒ Object
Returns the mastery points earned / spent on the account
105 106 107 |
# File 'lib/gw2/modules/account.rb', line 105 def account_mastery_points execute_request("account/mastery/points") end |
#account_materials(params = {}) ⇒ Object
Returns the account materials Array index indicates the slot Empty slots are represented by a count of 0 Valid Parameters ids: [String] the ids of the materials to filter comma seperated, can optionally use ‘all’ to get all of them
115 116 117 |
# File 'lib/gw2/modules/account.rb', line 115 def account_materials(params = {}) execute_with_params("account/materials", params) end |
#account_minis ⇒ Object
Returns the account mini ids unlocked
120 121 122 |
# File 'lib/gw2/modules/account.rb', line 120 def account_minis execute_request("account/minis") end |
#account_mount_skins ⇒ Object
Alias to account_mounts_skins
125 126 127 |
# File 'lib/gw2/modules/account.rb', line 125 def account_mount_skins account_mounts_skins end |
#account_mount_types ⇒ Object
Alias to account_mounts_types
135 136 137 |
# File 'lib/gw2/modules/account.rb', line 135 def account_mount_types account_mounts_types end |
#account_mounts_skins ⇒ Object
Returns the account mount skins unlocked
130 131 132 |
# File 'lib/gw2/modules/account.rb', line 130 def account_mounts_skins execute_request("account/mounts/skins") end |
#account_mounts_types ⇒ Object
Returns the account mount types unlocked
140 141 142 |
# File 'lib/gw2/modules/account.rb', line 140 def account_mounts_types execute_request("account/mounts/types") end |
#account_novelties ⇒ Object
Returns the account novelties unlocked
145 146 147 |
# File 'lib/gw2/modules/account.rb', line 145 def account_novelties execute_request("account/novelties") end |
#account_outfits ⇒ Object
Returns the account outfit ids unlocked
150 151 152 |
# File 'lib/gw2/modules/account.rb', line 150 def account_outfits execute_request("account/outfits") end |
#account_progression ⇒ Object
Returns the account progression
155 156 157 |
# File 'lib/gw2/modules/account.rb', line 155 def account_progression execute_request("account/progression") end |
#account_pvp_heroes ⇒ Object
Returns the account pvp hero ids unlocked
160 161 162 |
# File 'lib/gw2/modules/account.rb', line 160 def account_pvp_heroes execute_request("account/pvp/heroes") end |
#account_raids ⇒ Object
Returns the account weekly raid progress
165 166 167 |
# File 'lib/gw2/modules/account.rb', line 165 def account_raids execute_request("account/raids") end |
#account_recipes ⇒ Object
Returns the account recipe ids unlocked
170 171 172 |
# File 'lib/gw2/modules/account.rb', line 170 def account_recipes execute_request("account/recipes") end |
#account_shared_inventory ⇒ Object
Returns the shared inventory slots for the account Empty slots are represented by null Slot is indicated by the index of the array
75 76 77 |
# File 'lib/gw2/modules/account.rb', line 75 def account_shared_inventory execute_request("account/inventory") end |
#account_skiffs ⇒ Object
Returns the account skiff skin unlocked ids
175 176 177 |
# File 'lib/gw2/modules/account.rb', line 175 def account_skiffs execute_request("account/skiffs") end |
#account_skins ⇒ Object
Returns the account skin ids unlocked
180 181 182 |
# File 'lib/gw2/modules/account.rb', line 180 def account_skins execute_request("account/skins") end |
#account_titles ⇒ Object
Returns the account title ids unlocked
185 186 187 |
# File 'lib/gw2/modules/account.rb', line 185 def account_titles execute_request("account/titles") end |
#account_wallet ⇒ Object
Returns the account currencies to the amount of currency the account has
190 191 192 |
# File 'lib/gw2/modules/account.rb', line 190 def account_wallet execute_request("account/wallet") end |
#account_wizardsvault_daily ⇒ Object
Returns the wizard vault daily objectives and progress
195 196 197 |
# File 'lib/gw2/modules/account.rb', line 195 def account_wizardsvault_daily execute_request("account/wizardsvault/daily") end |
#account_wizardsvault_listings ⇒ Object
Returns the astral rewards for the account
200 201 202 |
# File 'lib/gw2/modules/account.rb', line 200 def account_wizardsvault_listings execute_request("account/wizardsvault/listings") end |
#account_wizardsvault_weekly ⇒ Object
Returnst he wizard vault weekly objectives and progress
205 206 207 |
# File 'lib/gw2/modules/account.rb', line 205 def account_wizardsvault_weekly execute_request("account/wizardsvault/weekly") end |
#account_worldbosses ⇒ Object
Returns the daily world boss clears for the account
210 211 212 |
# File 'lib/gw2/modules/account.rb', line 210 def account_worldbosses execute_request("account/worldbosses") end |
#commerce_transactions ⇒ Object
Returns the account trading post transactions
215 216 217 |
# File 'lib/gw2/modules/account.rb', line 215 def commerce_transactions execute_request("commerce/transactions") end |
#create_subtoken(params = {}) ⇒ Object
Creates a subtoken of the current api token Valid Parameters expires: [String] An ISO-8601 datetime specifing when the generated Subtoken will expire. The token expiry date may not exceed one year from creation. Attempting to specify a longer expiry date will result in the expiry being clamped at one year. permissions: [String] A comma separated list of permissions to grant to the Subtoken. urls: [String] A comma separated list of URLs that the Subtoken will be restricted to.
232 233 234 |
# File 'lib/gw2/modules/account.rb', line 232 def create_subtoken(params = {}) execute_with_params("createsubtoken", params) end |
#token_info(params = {}) ⇒ Object
Returns info about the supplied token
237 238 239 |
# File 'lib/gw2/modules/account.rb', line 237 def token_info(params = {}) execute_with_params("tokeninfo", params) end |