Skip to content

Commit

Permalink
Update code documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
richardrandak committed Jan 17, 2022
1 parent 65da40c commit fc9041e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
3 changes: 0 additions & 3 deletions FortnoxSDK/ApiConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ namespace Fortnox.SDK;

public class ApiConstants
{
// TODO: Temporary constant - remove when not needed anymore
internal const string ObsoleteSyncMethodWarning = @"Method will be removed. Use async variant. If it doesn't exist, report an issue. See https://github.com/FortnoxAB/csharp-api-sdk/issues/180";

/// <summary>
/// Base URI of Fortnox API server.
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions FortnoxSDK/Auth/IStandardAuthWorkflow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ public interface IStandardAuthWorkflow
/// <param name="refreshToken">OAuth 2 refresh token to be revoked. </param>
/// <param name="clientId">Client id given to you by Fortnox.</param>
/// <param name="clientSecret">Client secret given to you by Fortnox.</param>
/// <returns>Success of the revocation</returns>
/// <returns>"Revoked" property taken from the API response.</returns>
/// <exception cref="FortnoxApiException">If the Fortnox API returns an error.</exception>
Task<bool> RevokeRefreshTokenAsync(string refreshToken, string clientId, string clientSecret);

/// <summary>
/// Use this function to revoke a non-expirable token issued by the legacy authentication workflow.
/// </summary>
/// <param name="accessToken">GUID-formatted token to be revoked. </param>
/// <returns>Success of the revocation</returns>
/// <returns>"Revoked" property taken from the API response.</returns>
/// <exception cref="FortnoxApiException">If the Fortnox API returns an error.</exception>
Task<bool> RevokeLegacyTokenAsync(string accessToken);
}
2 changes: 1 addition & 1 deletion FortnoxSDK/Auth/IStaticTokenAuthWorkflow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Fortnox.SDK.Auth;
/// <summary>
/// Represents methods of a Fortnox legacy auth workflow.
/// </summary>
[Obsolete("2021-12-09: End-of-life for the static authorization. Use StandardAuth.")]
[Obsolete("2022-01-09: End-of-life for the static authorization. Use StandardAuth.")]
public interface IStaticTokenAuthWorkflow
{
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion FortnoxSDK/FortnoxSDK.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<LangVersion>10</LangVersion>
<PackageId>Fortnox.NET.SDK</PackageId>
<Version>4.2.9-rc</Version>
<Version>4.3.0</Version>
<Authors>Softwerk AB</Authors>
<Company>Softwerk AB</Company>
<Description>SDK package for Fortnox API. This package is developed and maintained by Softwerk AB. For more information please visit the repository on Github.</Description>
Expand Down

0 comments on commit fc9041e

Please sign in to comment.