payload-api 0.2.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package payload-api --version 0.2.2
NuGet\Install-Package payload-api -Version 0.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="payload-api" Version="0.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add payload-api --version 0.2.2
#r "nuget: payload-api, 0.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install payload-api as a Cake Addin
#addin nuget:?package=payload-api&version=0.2.2

// Install payload-api as a Cake Tool
#tool nuget:?package=payload-api&version=0.2.2

Payload C# Library

A C# library for integrating Payload.

Installation

1) Download

Download the latest version from GitHub.

2) Include in Project

Include the Payload folder in your Visual Studio project.

NuGet

nuget install payload-api

Get Started

Once you've included the Payload C# library in your project, include the Payload namespace to get started.

All Payload objects and methods are accessible using the pl static class.

API Authentication

To authenticate with the Payload API, you'll need a live or test API key. API keys are accessible from within the Payload dashboard.

using Payload;
pl.api_key = "secret_key_3bW9JMZtPVDOfFNzwRdfE";

Creating an Object

Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of creating a customer using the pl.Customer object.

// Create a Customer
var customer = pl.Customer.create(new {
    email="matt.perez@example.com",
    name="Matt Perez"
});
// Create a Payment
var payment = pl.Payment.create(new {
    amount=100.0,
    payment_method=new pl.Card(new{
        card_number="4242 4242 4242 4242"
    })
});

Accessing Object Attributes

Object attributes are accessible through both dot and bracket notation.

Console.WriteLine(customer.name);
Console.WriteLine(customer["email"]);

Updating an Object

Updating an object is a simple call to the update object method.

// Updating a customer's email
customer.update(new { email="matt.perez@newwork.com" });

Selecting Objects

Objects can be selected using any of their attributes.

// Select a customer by email
var customers = pl.Customer.filter_by(new {
    email="matt.perez@example.com"
});

Use the pl.attr attribute helper interface to write powerful queries with a little extra syntax sugar.

var payments = pl.Payment.filter_by(
    pl.attr.amount.gt(100),
    pl.attr.amount.lt(200),
    pl.attr.description.contains("Test"),
    pl.attr.created_at.gt(new DateTime(2019,2,1))
).all();

Testing the Payload C# Library

Tests are contained within the PayloadTests/ directory. To run tests enter the command in terminal

 dotnet test

Documentation

To get further information on Payload's C# library and API capabilities, visit the unabridged Payload Documentation.

Product 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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  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 tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
2.0.0 104 1/19/2024
1.0.4 254 10/12/2023
1.0.3 124 8/22/2023
1.0.2 123 8/12/2023
1.0.1 137 7/25/2023
1.0.0 136 7/5/2023
0.3.0 215 4/27/2023
0.2.5 676 6/3/2021
0.2.4 355 3/18/2021
0.2.3 307 3/17/2021
0.2.2 485 12/3/2020
0.2.1 414 9/7/2020
0.2.0 410 8/26/2020
0.1.12 649 2/27/2020
0.1.10 519 1/13/2020
0.1.9 842 12/17/2019
0.1.8 498 12/4/2019
0.1.7 460 12/4/2019
0.1.6 536 6/19/2019
0.1.5 508 6/19/2019
0.1.4 508 6/16/2019
0.1.3 503 6/16/2019