Module ynab

ballerinax/ynab Ballerina library

1.5.1

Overview

This is a generated connector for YNAB API v1.0.0 OpenAPI specification. YNAB API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com

Prerequisites

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

Quickstart

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

Step 1: Import connector

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

Copy
import ballerinax/ynab;

Step 2: Create a new connector instance

Create a ynab:ClientConfig with the access token obtained, and initialize the connector with it.

Copy
ynab:ClientConfig clientConfig = {
    auth: {
        token: <ACCESS_TOKEN>
    }
};
ynab:Client baseClient = check new Client(clientConfig);

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 budgets list with summary information using the connector.

    List budgets

    Copy
    public function main() {
        ynab:BudgetSummaryResponse|error response = baseClient->getBudgets();
        if (response is ynab:BudgetSummaryResponse) {
            log:printInfo(response.toString());
        } else {
            log:printError(response.message());
        }
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/ynab;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

Finance/Asset Management
Cost/Paid

Contributors

Other versions

See more...