Module atspoke

ballerinax/atspoke Ballerina library

1.5.1

Overview

This is a generated connector for atSpoke API v0.1.0 OpenAPI specification. The atSpoke REST API provides a broad set of operations including:

  • Creation, manipulation, and deletion of requests in atSpoke
  • Management of users in atSpoke
  • Creation, manipulation, and deletion of knowledge resources in atSpoke The public API is served from https://api.askspoke.com/api/v1 – note api in the host name, not your usual organization id.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the atSpoke connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/atspoke module into the Ballerina project.

Copy
import ballerinax/atspoke;

Step 2: Create a new connector instance

Create a atspoke:ApiKeysConfig with the API key obtained, and initialize the connector with it.

Copy
atspoke:ApiKeysConfig config = {
    apiKey: "<API_KEY>"
}
atspoke:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to return a list of teams using the connector.

    Return a list of teams

    Copy
    public function main() returns error? {
        atspoke:InlineResponse2006 response = check baseClient->getTeams();
        log:printInfo(response.toString());
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/atspoke;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 0

Current verison: 0


Weekly downloads


Source repository


Keywords

Support/Customer Support

Cost/Paid


Contributors

Other versions

See more...