accesspaysuite / eazycollectsdk-dotnet

EazySDK - .NET Client

Welcome to the EazySDK repository. EazySDK is an integration of the Eazy Collect API version 3 built in .NET Standard 2.0. Its core purpose is to provide a framework for developers already working with Eazy Collect to integrate Eazy Customer Manager into their platform. The framework provides functions designed to speed up the integration process between a developers Customer Relationship Manager and Eazy Collect. Getting started is as simple as providing user specific settings, and making your first call to Eazy Customer Manager should take less than a minute.

Dependencies

• Newtonsoft.Json (13.0.1>=)
• Microsoft.Extensions.Configuration (>= 2.2.0)
• Microsoft.Extensions.Configuration.Json (>= 2.2.0)

Integrating EazySDK into your application

The integration process is simple, and involves importing EazySDK into your virtual environment and configuring some settings. The most basic configuration can be seen below.

>> PM> Install-Package EazySDK
 
using EasySDK;
using Microsoft.Extentions.Configuration;

EazySDK.ClientHandler Handler = new ClientHandler();
IConfiguration Settings = Handler.Settings();

Settings.GetSection("currentEnvironment")["Environment"] = "playpen"; 
Settings.GetSection('playpenClientDetails')["ApiKey"] = "{api_key}";
Settings.GetSection('playpenClientDetails')["ClientCode"] = "{client_code}";

EazySDK.Get EazyGet = new EazySDK.Get(Settings);
string Response = EazyGet.Customers();
Console.WriteLine(Response);

Documentation

All functions in EazySDK possess their own documentation, and can be viewed by viewing the <summary> associated with the selected function. The documentation can also be found on GitHub, or in the /docs directory of the package.

Issues

If you find any issues with EazySDK, please raise an issue on GitHub detailing the issue. If this is not possible, alternatively email [email protected] with as much information as you are able to provide.

eazycollectsdk-dotnet's Issues

default json file shows customer value different than what is in documentation

https://github.com/EazyCollectServices/EazyCollectSDK-Dotnet/tree/master/EazySDK#acceptable-arguments-6 line suggests that the default is set to true
https://github.com/EazyCollectServices/EazyCollectSDK-Dotnet/blob/master/EazySDK/appsettings.json#L29 file sets it to false.

What would be the value written if the file does not exist?

Parameters null check

During contract creation, CheckScheduleNameIsAvailable is called and that ends up doing a GET request. This crashes because Parameters is null. I think a null check if required at the bottom line

https://github.com/EazyCollectServices/EazyCollectSDK-Dotnet/blob/854279338ee73788fb2b4b6fd4eeae48710a2bb4/EazySDK/Session.cs#L141

Cannot create contract using Last Day of Month

Goal

Create contract schedule based on last day of month

Steps to reproduce

Call Post.Contract with monthly schedule, start date of the last day of the month, and the PaymentDayInMonth parameter set to "99".

Expected

Contract is created

Actual

Error message is thrown: "PaymentDayInMonth must be set to 31 if the start date is 2022-07-31."

PR for fix

A pull request for the fix has been submitted: #9

Documentation

Based on documentation found here where the value is an enum of integers.

Default Config Values

When using the API, I'm getting an error which I've tracked down to the following bit of code

PaymentPostChecks.cs - Line 40

OngoingProcessingDays = int.Parse(Settings.GetSection("directDebitProcessingDays")["OngoingProcessingDays"]);

I'm not setting these values anywhere in my app. Should I be settings all these values in my app or am I missing something?

These are the ones I might need to set?

"directDebitProcessingDays": {
    "InitialProcessingDays": 10,
    "OngoingProcessingDays": 5
  },
  "contracts": {
    "AutoFixStartDate": false,
    "AutoFixTerminationTypeAdHoc": false,
    "AutoFixAtTheEndAdHoc": false,
    "AutoFixPaymentDayInMonth": false,
    "AutoFixPaymentMonthInYear": false
  },
  "payments": {
    "AutoFixPaymentDate": false,
    "IsCreditAllowed": false
  },
  "warnings": {
    "CustomerSearchWarning": true
  },
  "other": {
    "BankHolidayUpdateDays": 30,
    "ForceUpdateSchedulesOnRun": false
  }