Skip to content

Conversation

@code-kendrick
Copy link

Description

This pull request introduces updates to the CurriClientService class by integrating certain functionalities from an older version of the codebase. It also includes a readme.

Changes

Check the commits to see diff. Usage of the CurriClientService is in the README: https://github.com/code-kendrick/api-examples/blob/update/example-code-nodejs/nodejs/README.md

@code-kendrick
Copy link
Author

Hi @briangonzalez & @sifxtreme, I have the same Curri package that's in this PR public on npmjs.com, but it's under my org. If this PR is approved I will request to transfer it to Curri npm org and I will request to be a contributor. Open to code reviews and suggestions too.

Package Weblink: https://www.npmjs.com/package/@christopher.kendrick/curri

CurriClientService Documentation

The CurriClientService class enables interaction with the Curri API, facilitating operations such as fetching delivery quotes, booking deliveries, managing deliveries with multiple stops, retrieving delivery information, estimating delivery times, and canceling deliveries. This README details how to install, configure, and utilize this service in your projects.

Installation

Ensure Node.js is installed on your system. Include this library in your project using npm or yarn if lib on public registry:

Using npm

npm i @christopher.kendrick/curri --save

Using yarn

yarn add @christopher.kendrick/curri 

Configuration

Obtain your user ID and API key from your Curri API account. Initialize the CurriClientService with these credentials:

const { CurriClientService } = require('./dist');
const curri = new CurriClientService({ userID: "********", apiKey: "********" });

@briangonzalez
Copy link
Member

Hey @code-kendrick — we're giving this a look and will get back soon. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants