Git Product home page Git Product logo

tgtg-client's Introduction


Logo

tgtg-client

An unofficial TooGoodToGo API with extensive TypeScript typings !

Explore the docs »

Report Bug . Request Feature

Downloads Contributors Issues License

Table Of Contents

About The Project

Welcome to the TooGoodToGo API Client repository!

This client library allows you to interact with the TooGoodToGo API, enabling you to access and manipulate data from the TooGoodToGo platform. With this library, you can fetch items, get your favorite businesses, and more!

Getting Started

Prerequisites

  • npm

Installation

npm install tgtg-client

Usage

import { TgtgClient } from 'tgtg-client';

// Create a new instance of the TgtgClient
const client = new TgtgClient({
  email: '[email protected]',
});

(async () => {
  try {
    // Request login using email
    const pollingId = await client.requestLoginByEmail();

    // Authenticate using polling ID
    await client.authenticate(pollingId);
    console.log('Authenticated successfully!');

    // Get your favorite businesses
    const favorites = await client.getFavorites();
    console.log('Your favorite businesses:', favorites);

    // Get items with specified filters
    const items = await client.getItems({
      favorites_only: false,
      page_size: 10,
      page: 1,
    });
    console.log('Items:', items);

    // Get your account credentials
    const credentials = client.getCredentials();
    console.log('Credentials:', credentials);

    // Set credentials (e.g., if you want to skip login process)
    client.setCredentials('new-access-token', 'new-refresh-token', 'user-id', 3600);
    console.log('Credentials updated!');
  } catch (error) {
    console.error('An error occurred:', error.message);
  }
})();

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/tgtg-client)
  3. Commit your Changes (git commit -m 'Add some features')
  4. Push to the Branch (git push origin feature/tgtg-client)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

tgtg-client's People

Contributors

bengeois avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

tgtg-client's Issues

tgtg-client fails to authenticate: 403 (Forbidden)

tgtg-client fails to authenticate. Running the provided example (with a valid email address) throws an exception:

error: There was an error during authentification request: Response code 403 (Forbidden)

I believe they might have changed something in their API.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.