Talegen.EveryOrg.Client

Every.org API Client Wrapper for .NET Projects

This repository (Talegen.EveryOrg.Client is where we (Talegen) develop and maintain the Every.org API Client library. The source code here is available to everyone under the standard Apache 2.0 license.

The purpose of this library is to provide a common/useful wrapper around the Every.org API endpoints assisting .NET developers to create a seamless experience when interacting with the API.

Documentation

Documentation is generated from XML comments utilizing the XmlDocMd CLI.

You can download this tool using the following command from PowerShell:

dotnet tool install --global xmldocmd --version 2.9.0

Use

Installing Package

dotnet add package Talegen.EveryOrg.Client --version 1.0.0

Register the Service

    // Register IEveryOrgClient scoped service here
    services.AddEveryOrgClient(config =>
    {
        config.PrivateKey = privateKey;
        config.PublicKey = publicKey;
    });

Consume the IEveryOrgClient client

Using Dependency Injection, you can consume an instance of IEveryOrgClient by simply including it in a DI created class. It is recommended you do not invoke via GetService.

    // via DI
    public class MyService
    {
        private readonly IEveryOrgClient client;

        public MyService(IEveryOrgClient everyOrgclient)
        {
            this.client = everyOrgClient;
        }
        
        public async Task<DetailsResult> GetNonprofitAsync(string orgId, CancellationToken token)
        {
            return await this.client.GetDetailsAsync(orgId, token);
        }
    }

Contributing

There are many ways in which you can participate in the project, for example:

• Submit bugs and feature requests, and help us verify as they are checked in.
• Review source code changes.
• Review the documentation and make pull requests for anything from typos to new content.

If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute, which covers the following:

• How to build and run from source
• The development workflow, including debugging and running tests.
• Coding and style guidelines
• Submitting code changes (pull requests)
• Contributing to translations

Feedback

• Ask a question on Stack Overflow
• Request a new feature.
• Up vote popular feature requests.
• File an issue.
• Follow @TalegenInc and let us know what you think!

Code of Conduct

This project has adopted the Talegen Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact us with additional questions or comments.

License

Copyright © Talegen, LLC. All rights reserved.