EncompassRest 0.2.0
See the version list below for details.
dotnet add package EncompassRest --version 0.2.0
NuGet\Install-Package EncompassRest -Version 0.2.0
<PackageReference Include="EncompassRest" Version="0.2.0" />
paket add EncompassRest --version 0.2.0
#r "nuget: EncompassRest, 0.2.0"
// Install EncompassRest as a Cake Addin
#addin nuget:?package=EncompassRest&version=0.2.0
// Install EncompassRest as a Cake Tool
#tool nuget:?package=EncompassRest&version=0.2.0
EncompassRest
Encompass API Client Library for .NET Framework 4.5+ and .NET Standard 1.1+.
More documentation forthcoming.
Getting Started
- Install the EncompassRest Nuget package.
- Create an async method in your consuming code.
- Create an
EncompassRestClient
object. - Use
EncompassRestClient
object to make API calls.
Create an async method
EncompassRest is a fully asynchronous library meaning all of it's Encompass API calls are made asynchronously to allow great performance for maximum throughput. To get started using the library you need to write an async
method. To avoid deadlocks with async code it is recommended you DO NOT use Task.Result
or the Task.Wait
methods and instead implement async
all the way from the top, e.g. Main
or your Controller
s actions.
Web apps:
public async Task<IActionResult> GetAsync()
{
// Your async code goes here
}
Console apps:
For C#7.1 and up you should use an async Main
method like so.
public async Task Main()
{
// Your async code goes here
}
For C#7 and below you should use Task.Run
inside of Main
to use async methods.
public void Main()
{
Task.Run(async () => {
// Your async code goes here
}).GetAwaiter().GetResult();
}
Create an EncompassRestClient
object
The EncompassRestClient
class implements IDisposable
so it is recommended to use using
statements to automatically dispose of the object.
From User Credentials
using (var client = await EncompassRestClient.CreateFromUserCredentialsAsync("apiClientId", "apiSecret", "encompassInstance", "encompassUserId", "encompassPassword"))
{
// use client
}
From Authorization Code
using (var client = await EncompassRestClient.CreateFromAuthorizationCodeAsync("apiClientId", "apiSecret", "redirectUri", "authorizationCode"))
{
// use client
}
From Access Token
using (var client = EncompassRestClient.CreateFromAccessToken("apiClientId", "apiSecret", "accessToken"))
{
// use client
}
Use EncompassRestClient
object
Use the various properties on EncompassRestClient
such as Loans
, Schema
, Webhook
, Pipeline
, and BatchUpdate
to make Encompass API calls.
If you're interested in contributing please look over the Guidelines Doc.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.1 is compatible. netstandard1.2 was computed. netstandard1.3 was computed. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Windows Phone | wpa81 was computed. |
Windows Store | netcore was computed. netcore45 was computed. netcore451 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.5
- Enums.NET (>= 2.3.1)
- Newtonsoft.Json (>= 9.0.1)
-
.NETStandard 1.1
- Enums.NET (>= 2.3.1)
- NETStandard.Library (>= 1.6.1)
- Newtonsoft.Json (>= 9.0.1)
-
.NETStandard 2.0
- Enums.NET (>= 2.3.1)
- Newtonsoft.Json (>= 9.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
1.3.4 | 4,173 | 11/14/2022 | |
1.3.2 | 38,297 | 4/15/2021 | |
1.3.1 | 16,730 | 2/5/2021 | |
1.2.2 | 20,906 | 6/1/2020 | |
1.2.1 | 2,674 | 4/23/2020 | |
1.2.0 | 6,941 | 1/22/2020 | |
1.1.0 | 7,502 | 9/25/2019 | |
1.0.0 | 5,352 | 6/3/2019 | |
0.6.0 | 3,156 | 12/7/2018 | |
0.5.0 | 4,636 | 9/12/2018 | |
0.4.0 | 3,914 | 4/27/2018 | |
0.3.0 | 1,219 | 2/15/2018 | |
0.2.1 | 1,226 | 12/22/2017 | |
0.2.0 | 1,219 | 12/18/2017 | |
0.1.0 | 1,459 | 11/30/2017 |
## New Features
* Added Custom Data Objects support.
* Added support to move a loan to a specified folder.
* Added support to create a loan in a specified folder.
* Added support to create a loan with a specified loan template.
* Added support to apply a specified loan template to an existing loan.
* Added `Loan` metadata retrieval support.
* Added `BorrowerPairs` API support.
* Added `LoanAttachment` upload support.
* Added `Loan` locking and unlocking support.
* Added `LoanTemplateSet` inspection support.
* Added `LoanApis` property to `Loan`.
* Made `Loan.Initialize` and `Contact.Initialize` public.
## Fix
* Fixed deserializing `Loan` as a property of another type.
* Fixed issue with library use in .NET Standard 1.x projects.
## Breaking Changes
* Made `CancellationToken` parameter optional and removed overloads without a `CancellationToken` parameter.
* `BorrowerContacts` and `BusinessContacts` now share a common base class `Contacts<TContact>`.
* Renamed `clientId` and `clientSecret` client creation parameters to `apiClientId` and `apiClientSecret`.
* Moved `EntityReference` from the `EncompassRest.Loans` namespace to the root `EncompassRest` namespace.
* Moved `EntityType` from the `EncompassRest.Loans.Enums` namespace to the root `EncompassRest` namespace.
* Renamed `AttachmentUrl` to `MediaUrlObject`.
* `DocumentComment.CommentId` was changed from a `Guid` to a `string`.
* Deprecated `Loans.GetLoanDocuments` and `Loans.GetLoanAttachments`. Use `Loans.GetLoanApis` instead.