CxReports.ApiClient 1.1.0

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package CxReports.ApiClient --version 1.1.0
                    


                    

                
NuGet\Install-Package CxReports.ApiClient -Version 1.1.0
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="CxReports.ApiClient" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CxReports.ApiClient" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CxReports.ApiClient" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CxReports.ApiClient --version 1.1.0
                    


                    

                
#r "nuget: CxReports.ApiClient, 1.1.0"
#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. 
#:package CxReports.ApiClient@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CxReports.ApiClient&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CxReports.ApiClient&version=1.1.0
                    


                            Install as a Cake Tool

.NET API Client for CxReports

This library allows you to connect to the CxReports API from your applications.

Installation

dotnet add package CxReports.ApiClient

Example Usage

First, register the ICxReportsApiClient service at stratup:

serviceCollection.AddCxReportsApiClient(configuration);

Then, resolve the ICxReportsApiClient or inject it into your class:

var cxReports = serviceProvider.GetRequiredService<ICxReportsClient>();

Now you can interact with the CxReports API:

// list all reports for the default workspace
var reports = await cxReports.GetReportsAsync();

// list all workspaces
var workspaces = await cxReports.GetWorkspacesAsync();

// download a PDF report
var pdfResponse = await cxReports.DownloadPdfAsync(new() { 
	Report = new() { TypeCode = "invoice" } 
});

using var stream = await pdfResponse.Content.ReadAsStreamAsync();
using var output = File.Create("invoice.pdf");
stream.CopyTo(output);

Playground Project

The ConsolePlay project provides the usage examples.

To set up your access variables:

  1. Copy the appSettings.json.sample file to appSettings.json.
  2. Open the file in your text editor.
  3. Replace the placeholder values with your actual values.

License

MIT License

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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
1.1.0 160 9/9/2024
1.0.1 125 7/12/2024
1.0.0 117 7/12/2024