Skip to content

Commit 32a0f41

Browse files
ArchomedaArchomeda
authored
Merge pull request #103 from Archomeda/feature/account-progression
Add /v2/account/progression and deprecate /v2/account/luck
2 parents 4d7385f + 2cb7dc1 commit 32a0f41

File tree

13 files changed

+132
-4
lines changed

13 files changed

+132
-4
lines changed

‎CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Gw2Sharp History
22

3+
## 1.4.0 (28 September 2021)
4+
This release focuses on the new account progression addition, introduced on 28 September 2021.
5+
6+
### Endpoints
7+
- Add `/v2/account/progression` ([#101](https://github.com/Archomeda/Gw2Sharp/issues/101), [#103](https://github.com/Archomeda/Gw2Sharp/pull/103))
8+
- Mark `/v2/account/luck` as deprecated (progression is the replacement) ([#102](https://github.com/Archomeda/Gw2Sharp/issues/102), [#103](https://github.com/Archomeda/Gw2Sharp/pull/103))
9+
10+
*Note: All deprecations in version 1.x will be removed in version 2.0. Make sure that you update the references.*
11+
12+
---
13+
314
## 1.3.0 (4 September 2021)
415
This release includes a single addition to the WvW match endpoints, which is the ability to request a match by world id for the following endpoints:
516
- `/v2/wvw/matches`

‎Gw2Sharp.Tests/TestFiles/Account/AccountProgression.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[
2+
{
3+
"id": "fractal_agony_impedance",
4+
"value": 2
5+
},
6+
{
7+
"id": "fractal_empowerment",
8+
"value": 1
9+
},
10+
{
11+
"id": "fractal_karmic_retribution",
12+
"value": 3
13+
},
14+
{
15+
"id": "luck",
16+
"value": 1234000
17+
}
18+
]

‎Gw2Sharp.Tests/WebApi/V2/Clients/Account/AccountLuckClientTests.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
using System;
12
using System.Threading.Tasks;
23
using Gw2Sharp.WebApi.V2.Clients;
34
using Xunit;
45

56
namespace Gw2Sharp.Tests.WebApi.V2.Clients
67
{
8+
[Obsolete("Deprecated since 2021-09-28. This will be removed from Gw2Sharp starting from version 2.0.")]
79
public class AccountLuckClientTests : BaseEndpointClientTests<IAccountLuckClient>
810
{
911
protected override bool IsAuthenticated => true;

‎Gw2Sharp.Tests/WebApi/V2/Clients/Account/AccountProgressionClientTests.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
using System.Threading.Tasks;
2+
using Gw2Sharp.WebApi.V2.Clients;
3+
using Xunit;
4+
5+
namespace Gw2Sharp.Tests.WebApi.V2.Clients
6+
{
7+
public class AccountProgressionClientTests : BaseEndpointClientTests<IAccountProgressionClient>
8+
{
9+
protected override bool IsAuthenticated => true;
10+
11+
protected override IAccountProgressionClient CreateClient(IGw2Client gw2Client) =>
12+
gw2Client.WebApi.V2.Account.Progression;
13+
14+
[Theory]
15+
[InlineData("TestFiles.Account.AccountProgression.json")]
16+
public Task BlobTest(string file) => this.AssertBlobDataAsync(this.Client, file);
17+
}
18+
}

‎Gw2Sharp/WebApi/V2/Clients/Account/AccountClient.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ public class AccountClient : BaseEndpointClient, IAccountClient
2424
private readonly IAccountHomeClient home;
2525
private readonly IAccountInventoryClient inventory;
2626
private readonly IAccountLegendaryArmoryClient legendaryArmory;
27+
#pragma warning disable CS0618 // Type or member is obsolete
2728
private readonly IAccountLuckClient luck;
29+
#pragma warning restore CS0618 // Type or member is obsolete
2830
private readonly IAccountMailCarriersClient mailCarriers;
2931
private readonly IAccountMapChestsClient mapChests;
3032
private readonly IAccountMasteriesClient masteries;
@@ -34,6 +36,7 @@ public class AccountClient : BaseEndpointClient, IAccountClient
3436
private readonly IAccountMountsClient mounts;
3537
private readonly IAccountNoveltiesClient novelties;
3638
private readonly IAccountOutfitsClient outfits;
39+
private readonly IAccountProgressionClient progression;
3740
private readonly IAccountPvpClient pvp;
3841
private readonly IAccountRaidsClient raids;
3942
private readonly IAccountRecipesClient recipes;
@@ -63,7 +66,9 @@ protected internal AccountClient(IConnection connection, IGw2Client gw2Client) :
6366
this.home = new AccountHomeClient(connection, gw2Client);
6467
this.inventory = new AccountInventoryClient(connection, gw2Client);
6568
this.legendaryArmory = new AccountLegendaryArmoryClient(connection, gw2Client);
69+
#pragma warning disable CS0618 // Type or member is obsolete
6670
this.luck = new AccountLuckClient(connection, gw2Client);
71+
#pragma warning restore CS0618 // Type or member is obsolete
6772
this.mailCarriers = new AccountMailCarriersClient(connection, gw2Client);
6873
this.mapChests = new AccountMapChestsClient(connection, gw2Client);
6974
this.masteries = new AccountMasteriesClient(connection, gw2Client);
@@ -73,6 +78,7 @@ protected internal AccountClient(IConnection connection, IGw2Client gw2Client) :
7378
this.mounts = new AccountMountsClient(connection, gw2Client);
7479
this.novelties = new AccountNoveltiesClient(connection, gw2Client);
7580
this.outfits = new AccountOutfitsClient(connection, gw2Client);
81+
this.progression = new AccountProgressionClient(connection, gw2Client);
7682
this.pvp = new AccountPvpClient(connection, gw2Client);
7783
this.raids = new AccountRaidsClient(connection, gw2Client);
7884
this.recipes = new AccountRecipesClient(connection, gw2Client);
@@ -119,6 +125,7 @@ protected internal AccountClient(IConnection connection, IGw2Client gw2Client) :
119125
public virtual IAccountLegendaryArmoryClient LegendaryArmory => this.legendaryArmory;
120126

121127
/// <inheritdoc />
128+
[Obsolete("Deprecated since 2021-09-28. Use Account.Progression instead. This will be removed from Gw2Sharp starting from version 2.0.")]
122129
public virtual IAccountLuckClient Luck => this.luck;
123130

124131
/// <inheritdoc />
@@ -151,6 +158,9 @@ protected internal AccountClient(IConnection connection, IGw2Client gw2Client) :
151158
/// <inheritdoc />
152159
public virtual IAccountPvpClient Pvp => this.pvp;
153160

161+
/// <inheritdoc />
162+
public virtual IAccountProgressionClient Progression => this.progression;
163+
154164
/// <inheritdoc />
155165
public virtual IAccountRaidsClient Raids => this.raids;
156166

‎Gw2Sharp/WebApi/V2/Clients/Account/AccountLuckClient.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace Gw2Sharp.WebApi.V2.Clients
88
/// </summary>
99
[EndpointPath("account/luck")]
1010
[EndpointSchemaVersion("2019-02-21T00:00:00.000Z")]
11+
[Obsolete("Deprecated since 2021-09-28. Use Account.Progression instead. This will be removed from Gw2Sharp starting from version 2.0.")]
1112
public class AccountLuckClient : BaseEndpointBlobClient<IApiV2ObjectList<AccountLuck>>, IAccountLuckClient
1213
{
1314
/// <summary>

‎Gw2Sharp/WebApi/V2/Clients/Account/AccountProgressionClient.cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using System;
2+
using Gw2Sharp.WebApi.V2.Models;
3+
4+
namespace Gw2Sharp.WebApi.V2.Clients
5+
{
6+
/// <summary>
7+
/// A client of the Guild Wars 2 API v2 account progression endpoint.
8+
/// </summary>
9+
[EndpointPath("account/progression")]
10+
[EndpointSchemaVersion("2021-09-28T00:00:00.000Z")]
11+
public class AccountProgressionClient : BaseEndpointBlobClient<IApiV2ObjectList<AccountProgression>>, IAccountProgressionClient
12+
{
13+
/// <summary>
14+
/// Creates a new <see cref="AccountProgressionClient"/> that is used for the API v2 account progression endpoint.
15+
/// </summary>
16+
/// <param name="connection">The connection used to make requests, see <see cref="IConnection"/>.</param>
17+
/// <param name="gw2Client">The Guild Wars 2 client.</param>
18+
/// <exception cref="ArgumentNullException"><paramref name="connection"/> or <paramref name="gw2Client"/> is <c>null</c>.</exception>
19+
protected internal AccountProgressionClient(IConnection connection, IGw2Client gw2Client) :
20+
base(connection, gw2Client)
21+
{ }
22+
}
23+
}

‎Gw2Sharp/WebApi/V2/Clients/Account/IAccountClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System;
12
using Gw2Sharp.WebApi.V2.Models;
23

34
namespace Gw2Sharp.WebApi.V2.Clients
@@ -89,6 +90,7 @@ public interface IAccountClient :
8990
/// Gets the luck progression.
9091
/// Requires scores: account, progression, unlocks.
9192
/// </summary>
93+
[Obsolete("Deprecated since 2021-09-28. Use Account.Progression instead. This will be removed from Gw2Sharp starting from version 2.0.")]
9294
IAccountLuckClient Luck { get; }
9395

9496
/// <summary>
@@ -148,6 +150,12 @@ public interface IAccountClient :
148150
/// </summary>
149151
IAccountOutfitsClient Outfits { get; }
150152

153+
/// <summary>
154+
/// Gets the progression.
155+
/// Requires scopes: account, progression.
156+
/// </summary>
157+
IAccountProgressionClient Progression { get; }
158+
151159
/// <summary>
152160
/// Gets the PvP.
153161
/// </summary>

‎Gw2Sharp/WebApi/V2/Clients/Account/IAccountLuckClient.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1+
using System;
12
using Gw2Sharp.WebApi.V2.Models;
23

34
namespace Gw2Sharp.WebApi.V2.Clients
45
{
56
/// <summary>
67
/// A client of the Guild Wars 2 API v2 account luck endpoint.
78
/// </summary>
9+
[Obsolete("Deprecated since 2021-09-28. Use Account.Progression instead. This will be removed from Gw2Sharp starting from version 2.0.")]
810
public interface IAccountLuckClient :
911
IAuthenticatedClient,
1012
IBlobClient<IApiV2ObjectList<AccountLuck>>

‎Gw2Sharp/WebApi/V2/Clients/Account/IAccountProgressionClient.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using Gw2Sharp.WebApi.V2.Models;
2+
3+
namespace Gw2Sharp.WebApi.V2.Clients
4+
{
5+
/// <summary>
6+
/// A client of the Guild Wars 2 API v2 account progression endpoint.
7+
/// </summary>
8+
public interface IAccountProgressionClient :
9+
IAuthenticatedClient,
10+
IBlobClient<IApiV2ObjectList<AccountProgression>>
11+
{
12+
}
13+
}

‎Gw2Sharp/WebApi/V2/Models/Account/AccountLuck.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
using System;
2+
13
namespace Gw2Sharp.WebApi.V2.Models
24
{
35
/// <summary>
46
/// Represents an account luck.
57
/// </summary>
8+
[Obsolete("Deprecated since 2021-09-28. Use Account.Progression instead. This will be removed from Gw2Sharp starting from version 2.0.")]
69
public class AccountLuck
710
{
811
/// <summary>

‎Gw2Sharp/WebApi/V2/Models/Account/AccountProgression.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
namespace Gw2Sharp.WebApi.V2.Models
2+
{
3+
/// <summary>
4+
/// Represents an account progression.
5+
/// </summary>
6+
public class AccountProgression
7+
{
8+
/// <summary>
9+
/// The progression id.
10+
/// </summary>
11+
public string Id { get; set; } = string.Empty;
12+
13+
/// <summary>
14+
/// The progression value.
15+
/// </summary>
16+
public int Value { get; set; }
17+
}
18+
}

‎docs/guides/endpoints.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For your convenience, the following list gives an overview of the web API endpoi
3636
/v2/account/home/nodes | 🔑 | [`Gw2Client.WebApi.V2.Account.Home.Nodes`](../api/Gw2Sharp.WebApi.V2.Clients.AccountHomeNodesClient.html)
3737
/v2/account/inventory | 🔑📆 | [`Gw2Client.WebApi.V2.Account.Inventory`](../api/Gw2Sharp.WebApi.V2.Clients.AccountInventoryClient.html)
3838
/v2/account/legendaryarmory | 🔑 | [`Gw2Client.WebApi.V2.Account.LegendaryArmory`](../api/Gw2Sharp.WebApi.V2.Clients.AccountLegendaryArmoryClient.html)
39-
/v2/account/luck | 🔑 | [`Gw2Client.WebApi.V2.Account.Luck`](../api/Gw2Sharp.WebApi.V2.Clients.AccountLuckClient.html)
39+
/v2/account/luck<br>➡️ /v2/account/progression | 🔑⚠️ | [`Gw2Client.WebApi.V2.Account.Luck`](../api/Gw2Sharp.WebApi.V2.Clients.AccountLuckClient.html)
4040
~~/v2/account/mail~~ | ✖️ |
4141
/v2/account/mailcarriers | 🔑 | [`Gw2Client.WebApi.V2.Account.MailCarriers`](../api/Gw2Sharp.WebApi.V2.Clients.AccountMailCarriersClient.html)
4242
/v2/account/mapchests | 🔑 | [`Gw2Client.WebApi.V2.Account.MapChests`](../api/Gw2Sharp.WebApi.V2.Clients.AccountMapChestsClient.html)
@@ -49,6 +49,7 @@ For your convenience, the following list gives an overview of the web API endpoi
4949
/v2/account/mounts/types | 🔑 | [`Gw2Client.WebApi.V2.Account.Mounts.Types`](../api/Gw2Sharp.WebApi.V2.Clients.AccountMountsTypesClient.html)
5050
/v2/account/novelties | 🔑 | [`Gw2Client.WebApi.V2.Account.Novelties.Types`](../api/Gw2Sharp.WebApi.V2.Clients.AccountNoveltiesClient.html)
5151
/v2/account/outfits | 🔑📆 | [`Gw2Client.WebApi.V2.Account.Outfits`](../api/Gw2Sharp.WebApi.V2.Clients.AccountOutfitsClient.html)
52+
/v2/account/progression | 🔑 | [`Gw2Client.WebApi.V2.Account.Progression`](../api/Gw2Sharp.WebApi.V2.Clients.AccountProgressionClient.html)
5253
/v2/account/pvp/heroes | 🔑 | [`Gw2Client.WebApi.V2.Account.Pvp.Heroes`](../api/Gw2Sharp.WebApi.V2.Clients.AccountPvpHeroesClient.html)
5354
/v2/account/raids | 🔑 | [`Gw2Client.WebApi.V2.Account.Raids`](../api/Gw2Sharp.WebApi.V2.Clients.AccountRaidsClient.html)
5455
/v2/account/recipes | 🔑📆 | [`Gw2Client.WebApi.V2.Account.Recipes`](../api/Gw2Sharp.WebApi.V2.Clients.AccountRecipesClient.html)
@@ -185,9 +186,9 @@ For your convenience, the following list gives an overview of the web API endpoi
185186
/v2/wvw/matches/overview | 📄📚📦 | [`Gw2Client.WebApi.V2.Wvw.Matches.Overview`](../api/Gw2Sharp.WebApi.V2.Clients.WvwMatchesOverviewClient.html)
186187
/v2/wvw/matches/scores | 📄📚📦 | [`Gw2Client.WebApi.V2.Wvw.Matches.Scores`](../api/Gw2Sharp.WebApi.V2.Clients.WvwMatchesScoresClient.html)
187188
/v2/wvw/matches/stats | 📄📚📦 | [`Gw2Client.WebApi.V2.Wvw.Matches.Stats`](../api/Gw2Sharp.WebApi.V2.Clients.WvwMatchesStatsClient.html)
188-
~~/v2/wvw/matches/stats/`:id`/guilds/`:guild_id`~~ | ✖️ | *Broken on the API as of 2012-12-22*
189-
~~/v2/wvw/matches/stats/`:id`/teams/`:team`/top/kdr~~ | ✖️ | *Broken on the API as of 2012-12-22*
190-
~~/v2/wvw/matches/stats/`:id`/teams/`:team`/top/kills~~ | ✖️ | *Broken on the API as of 2012-12-22*
189+
~~/v2/wvw/matches/stats/`:id`/guilds/`:guild_id`~~ | ✖️ | *Broken on the API as of 2020-12-22*
190+
~~/v2/wvw/matches/stats/`:id`/teams/`:team`/top/kdr~~ | ✖️ | *Broken on the API as of 2020-12-22*
191+
~~/v2/wvw/matches/stats/`:id`/teams/`:team`/top/kills~~ | ✖️ | *Broken on the API as of 2020-12-22*
191192
/v2/wvw/objectives | 🌐📄📚📦 | [`Gw2Client.WebApi.V2.Wvw.Objectives`](../api/Gw2Sharp.WebApi.V2.Clients.WvwObjectivesClient.html)
192193
/v2/wvw/ranks | 🌐📄📚📦 | [`Gw2Client.WebApi.V2.Wvw.Ranks`](../api/Gw2Sharp.WebApi.V2.Clients.WvwRanksClient.html)
193194
~~/v2/wvw/rewardtracks~~ | ✖️ |

0 commit comments

Comments
 (0)