The SalesTim API SDK provides easy to use client and server libraries for accessing The SalesTim REST API.
To learn more about the SalesTim API, see our API Documentation or try it online with our API Explorer.
This repository contains multiple SDKs for various clients and servers, each one of them located in their own folder in the
TABLE OF CONTENTS
As of today, here is the current status for each language / platform:
|Language / Platform||Directory||Description||Status|
|PowerShell||https://github.com/SalesTim/api-sdk/tree/master/src/powershell/||PowerShell module for the SalesTim API service. Cmdlets should work in any environment supported by
|Salesforce Apex||https://github.com/SalesTim/api-sdk/tree/master/src/apex/||Salesforce sample Force App for the SalesTim API service. Relies on the
|C# > .NET Core||https://github.com/SalesTim/api-sdk/tree/master/src/csharp-netcore/||C# client library for the SalesTim API service. This library supports
|Node + Express||https://github.com/SalesTim/api-sdk/tree/master/src/nodejs-express-server/||
Don’t see your favorite programming language here? Wanna see a
Just Create a New Issue!
The source code generation process () relies on two different code generators:
Why two different generators?
Autorest powershell generator if far ahead of the competition, especially:
NuGetand publish them to the PowerShell Gallery.
Azurecmdlets… and should therefore be more battle-tested and reliable.
On the other hand,
OpenAPI Generator CLI is easy to use, broadly used in production, well documented and has a large community.
To generate all SDKs in one operation, launch from the command line:
# Clone this repo git clone https://github.com/SalesTim/api-sdk.git # Download dependencies npm install # Generate ALL SDKs npm run gen-all
You can also generate SDKs individually, by using the following commands.
# Generates ps1 scripts npm run gen-powershell # Build the module npm run build-powershell # Package the module npm run pack-powershell
N.B: Source code generation for
PowerShell relies on AutoRest, that itself runs on NodeJS, which should make it quite portable. But the build and packaging scripts depends on
PowerShell Core and
.NET Core, which may be a more limiting factor.
To install these dependencies globally, you can use the following scripts:
# PowerShell Core 6.1+ npm install -g pwsh # Dotnet Core 2.1+ npm install -g dotnet-sdk-2.1
# Generates the sfdx sample project sources npm run gen-apex
# Generates aspnet core sources npm run gen-aspnetcore # Build using the dotnet command npm run build-aspnetcore
# Generates the sfdx sample project sources npm run gen-csharp-netcore
# Generates the sfdx sample project sources npm run gen-nodejs-express-server
Once generated, please refer to each
README file for further reference:
The easiest way to communicate with the team is via GitHub Issues.
Please file new issues, feature requests and suggestions, but DO search for similar open/closed pre-existing issues before creating a new issue.
This project has adopted the SalesTim Security Policy.
This project has adopted the SalesTim Open Source Code of Conduct.
This project is licenseced as described in the LICENSE file.