Skip to content

nowaythatworked/goflink-client

Repository files navigation

:package: ts-npm-package-boilerplate

Flink Client

Inoffical Typescript SDK for interacting with Flink API

Getting started

This is a TypeScript SDK for communicating with Flink API. The API is not offical and was reverse engineered. Currently only the endpoints for creating new users are implemented, as these are the most critical ones.

Heads up

You need a unique phone number for each account you want to create.

Installation

yarn add goflink-client

Example

import { FlinkClient } from "./FlinkClient"

(async () => {
    try {
        const flinkClient = new FlinkClient()
        const token = await flinkClient.getMeService().createAccount(
            { email: 'emailAddress', first_name: 'noway', last_name: 'thatworked', password: 'securePassword' }
        )
        if(token) {
            const status = await flinkClient.getMeService().getStatus()
            console.log('status', status)
        }
    } catch (e) {
        console.log('e', e)
    }
    
})()

Documentation

For Documentation I can only provide an OpenAPI schema. You can check it out by going to Swagger UI and putting in the link to the schema.yaml

🤝 Contributing

Contributions, issues and feature requests are welcome!
Especially extending the OpenAPI Schema.

📝 License

This project is MIT licensed.

About

Infoffical goflink SDK written in TypeScript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published