https://github.com/nowaythatworked/goflink-client

Infoffical goflink SDK written in TypeScript
https://github.com/nowaythatworked/goflink-client

Last synced: about 2 months ago
JSON representation

Infoffical goflink SDK written in TypeScript

• Host: GitHub
• URL: https://github.com/nowaythatworked/goflink-client
• Owner: nowaythatworked
• License: mit
• Created: 2022-05-25T23:46:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-26T17:33:15.000Z (over 2 years ago)
• Last Synced: 2024-04-24T15:27:16.725Z (9 months ago)
• Language: TypeScript
• Size: 125 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


 

 
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

```ts

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](https://petstore.swagger.io/) and putting in the link to the [schema.yaml](https://raw.githubusercontent.com/nowaythatworked/goflink-client/main/src/schema.yaml)

## 🤝 Contributing

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

## 📝 License

This project is [MIT](LICENSE) licensed.