-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π docs: add README.md and LICENSE files
π docs(README.md): provide comprehensive documentation for the Colissimo Pickup Point API Wrapper for Node.js, including features, installation, usage, API reference, contributing, license, and disclaimer π docs(LICENSE): add MIT License to the project to clarify permissions and limitations for users and contributors
- Loading branch information
Showing
2 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 bqst <[email protected]> (<https://www.bqst.fr>) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Colissimo Pickup Point API Wrapper for Node.js | ||
|
||
This package provides a convenient wrapper for the Colissimo PickupPoint Web Services, specifically for the findRDVPointRetraitAcheminement method. It is written in TypeScript, offering type safety and easy integration with TypeScript projects. | ||
|
||
## Features | ||
|
||
- Easy-to-use interface for the findRDVPointRetraitAcheminement method of Colissimo API. | ||
- Built with TypeScript for type safety. | ||
- Includes TypeScript types for request parameters and response objects. | ||
|
||
## Installation | ||
|
||
To install the package, run the following command: | ||
|
||
```bash | ||
npm install colissimo-pickup-point | ||
``` | ||
|
||
or if you use Yarn: | ||
|
||
```bash | ||
yarn add colissimo-pickup-point | ||
``` | ||
|
||
## Usage | ||
|
||
Here's a basic example of how to use the package: | ||
|
||
```typescript | ||
import ColissimoAPI from '<your-package-name>'; | ||
|
||
const api = new ColissimoAPI(); | ||
|
||
api.findRDVPointRetraitAcheminement({ | ||
accountNumber: 'YOUR_ACCOUNT_NUMBER', | ||
password: 'YOUR_PASSWORD', | ||
// ... other required parameters | ||
}).then(response => { | ||
console.log(response); | ||
}).catch(error => { | ||
console.error(error); | ||
}); | ||
``` | ||
|
||
## API Reference | ||
|
||
### `findRDVPointRetraitAcheminement(params: FindRDVPointRetraitAcheminementParams): Promise<FindRDVPointRetraitAcheminementResponse>` | ||
|
||
Fetches pickup points based on provided parameters. | ||
|
||
- `params`: An object containing all necessary parameters as per the Colissimo API documentation. | ||
|
||
Returns | ||
|
||
A Promise that resolves to the response object of the findRDVPointRetraitAcheminement method. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Please see our [contributing guidelines](CONTRIBUTING.md) for more details. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
|
||
## Disclaimer | ||
|
||
This package is not affiliated with Colissimo or La Poste in any way. It is an independent wrapper for the Colissimo PickupPoint Web Services. |