Skip to content

Releases: XeroAPI/Xero-NetStandard

v0.0.3

16 Oct 20:02
Compare
Choose a tag to compare
v0.0.3 Pre-release
Pre-release

Summary

This release adds functionality for user secrets for store your credentials

Changes

  • #6 Functionality to store settings/credentials in user secrets

v0.0.2

04 Oct 22:30
Compare
Choose a tag to compare
v0.0.2 Pre-release
Pre-release

Summary

This release removes the ability to set a custom UserAgent. This is so we can monitor usage of this SDK easily and allow us to identify users of this SDK that are having issues.

Changes

  • #5 Removed the ability to set a custom user agent

v0.0.1 - Initial Beta Release

01 Oct 03:24
Compare
Choose a tag to compare
Pre-release

This is the initial beta release for the .NetStandard 2.0 version of the Xero-Net SDK.

There have been a lot of changes to support .NetStandard 2.0, some of which will require changes in how existing users of the Xero-Net SDK integrate with the Xero API.

Below is an outline of some of the changes in the Xero-NetStandard repository/project compared to the Xero-Net repository/project.

  • The Xero.Api project now targets the netstandard2.0 framework. This means that applications consuming this version of the SDK will need to be running on the net461 or netcore2.0 frameworks.
  • Async support. All interactions with the Xero API are now asynchronous. All endpoints in the SDK now return Task objects which need to be awaited. All asynchronous methods have been labeled as such with method name changes.
  • Endpoints are now immutable. The reason behind this is to allow concurrent requests against the same Xero API endpoint with different query parameters, while still allowing for fluent use of the SDK.
  • There have been datacontract changes for all decimal and DateTime properties making them nullable to bring consistency across all datacontracts
  • The IAuthenticator interface has been changed to only have an Authenticate method requirement to allow for future authentication implementations. The idea is that the Authenticate method will authenticate an HttpRequestMessage by adding the OAuth signature for example.
  • The example applications and their authenticator implementations have been brought into the Xero.Api project. As the public and partner OAuth implementation requires user interaction, the authenticators are abstract, and the only method that requires implementation is to retrieve the oauth verifier code from the user authentication your request. Using the supplied application type implementations will require you to include an appsettings.json file with required details. You can find an example of this in the runnable examples.
  • There are now only two runnable examples; an MVC example and a console application example.

If there are any questions regarding these changes or problems with integrating with this new SDK, please open issues against the repository.