ballerinax/pushcut Ballerina library

1.5.1

Overview

This is a generated connector for Pushcut API v1 OpenAPI specification. API to send Pushcut notifications, execute Automation Server actions, and register custom webhooks as online actions.

Prerequisites

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

Quickstart

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

Step 1: Import connector

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

Copy
import ballerinax/pushcut;

Step 2: Create a new connector instance

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

Copy
pushcut:ApiKeysConfig config = {
    apiKey: "<API_KEY>"
}
pushcut: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 get a list of all active devices using the connector.

    Gets a list of all active devices

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

Import

import ballerinax/pushcut;Copy

Metadata

Released date: 10 months ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 0


Weekly downloads


Source repository


Keywords

Internet of Things/Device Management
Cost/Paid

Contributors

Other versions

See more...