Skip to content

Commit

Permalink
add back Changelog, Contributing, License and README
Browse files Browse the repository at this point in the history
  • Loading branch information
dsinghvi committed Nov 27, 2023
1 parent cc92537 commit 3830ee0
Show file tree
Hide file tree
Showing 5 changed files with 1,243 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# Specify files that shouldn't be modified by Fern

README.md
LICENSE
CHANGELOG.md
CONTRIBUTING.md
321 changes: 321 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,321 @@
# Change Log

All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased][unreleased]

## [v4.1.1] - 2023-02-02

- fix audience put request

## [v4.1.0] - 2022-10-21

- adds support for invoke step via `client.automations.invokeAdHocAutomation({...})`

## [v4.0.2] - 2022-10-19

- Fix `unexpected error` in Node 18.x
- Fix baseURLs getting chopped off

## [v4.0.1] - 2022-10-13

- resolves `FetchError: invalid json response body` for API's returning no body

## [v4.0.0]

- Migrate from Axios to fetch

## [3.16.0]

- adds support for idempotency expiry to be passed in profiles and brands POST

## [3.15.0]

- adds support for audit events

## [3.14.0]

- adds support for token management

## [3.13.1] - 2022-06-03

- adds provider and channel timeout

## [3.12.0] - 2022-03-31

- adds support for message trace id (`message.metadata.trace_id`)

## [3.11.0] - 2022-03-23

- adds support for `audiences`

## [3.10.1] - 2022-03-20

- adds support for messages timeout (`message.timeout`)

## [3.10.0] - 2020-03-24

- adds support for messages brand_id (`message.brand_id`)

## [3.9.0] - 2022-03-17

- adds support for bulk messaging API v2 support

## [3.8.0] - 2022-03-14

- adds additional types for utm property (`message.metadata.utm`)

## [v3.7.0] - 2022-03-11

- adds additional types for the tags property (`message.metadata.tags`)
- adds support for searching message by tags

## [v3.6.0] - 2022-02-10

- adds additional types for the recipient property (`message.to`)

## [v3.5.0] - 2022-02-10

- adds type for unroutable status

## [v3.4.0] - 2022-01-25

- adds support for the send message object in the request body of a `/send` call

## [v3.3.0] - 2022-01-25

- adds support for bulk processing endpoints

## [v3.2.1] - 2022-01-13

- Fixes `getMessages` query params

## [v3.2.0] - 2021-11-18

- adds idempotency expiration support for send and send list endpoints

## [v3.1.0] - 2021-11-16

- Expose additional type definitions for `getMessage`

## [v3.0.0] - 2021-11-02

- fixes type definition for `getRecipientSubscriptions`

## [v2.8.0] - 2021-10-29

- adds GET /messages/{messageId}/output API

## [v2.7.0] - 2021-10-21

- adds GET /messages/{messageId}/history API

## [v2.6.0] - 2021-10-07

- Add support for DELETE /profiles/{recipient_id} (#58)
- adds GET /messages API
- adds idempotencyKey support in automations client

## [v2.4.0] - 2021-08-23

- adds notifications API
- type fix `put` method of `ICourierClientLists`

## [v2.3.0] - 2021-04-28

- adds support for update-profile step via `client.automations.invokeAdHocAutomation({...})`

## [v2.2.0] - 2021-04-07

- adds automations API

## [v2.1.0] - 2021-03-15

- adds support to add more recipients to a list subscription (#40)
- adds support to delete all the lists subscriptions for a recipient (#39)
- adds support to add recipient to multiple lists (#38)
- updates preference interface to accept new preference options (#37)

## [v2.0.0] - 2021-03-03

- supports adding subscription preferences (#35)

## [v1.7.3] - 2021-03-03

### Added

- ICourierClient exported as a type [#33](https://github.com/trycourier/courier-node/pull/33)

## [v1.7.2] - 2021-02-16

### Fixed

- Update PUT list subscription request params with appropriate type [#32](https://github.com/trycourier/courier-node/pull/32)

## [v1.7.1] - 2021-02-01

### Fixed

- Fix the notification(s) typo [#28](https://github.com/trycourier/courier-node/pull/28)

## [v1.7.0] - 2021-01-25

### Added

- Support for [Preferences API]() by @helenamerk and @aydrian
- `GET /preferences` via `client.preferences.list()`
- `GET /preferences/{recipient_id}` via `client.preferences.get(recipientId)`
- `PUT /preferences/{recipient_id}` via `client.preferences.put(recipientId, {...})`

## [v1.6.2] - 2021-01-19

### Fixed

- Bumped [axios](https://www.npmjs.com/package/axios) to version 0.21.1
- Updated types for Send to List Parameters by @rileylnapier

## [v1.6.1] - 2020-09-23

### Fixed

- Fixed return types for `PUT` methods that return 204
- Fixed param types for `client.lists.send()`
- Fixed return type for `client.lists.findByRecipientId()`
- Fixed param types for `client.lists.put()`

## [v1.6.0] - 2020-09-22

### Added

- Support for `idempotencyKey` for `POST` methods by @aydrian & @rileylnapier
- Support for [Lists API](https://docs.courier.com/reference/lists-api) by @aydrian
- `POST /send/list` via `client.lists.send(params, config)`
- `GET /profiles/{recipient_id}/lists` via `client.lists.findByRecipientId(recipientId, params)`
- `GET /lists` via `client.lists.list(params)`
- `GET /lists/{list_id}` via `client.lists.get(listId)`
- `PUT /lists/{list_id}` via `client.lists.put(listId, {...})`
- `DELETE /lists/{list_id}` via `client.lists.delete(listId)`
- `PUT /lists/{list_id}/restore` via `client.lists.restore(listId)`
- `GET /lists/{list_id}/subscriptions` via `client.lists.getSubscriptions(listId)`
- `PUT /lists/{list_id}/subscriptions` via `client.lists.putSubscriptions(listId, [recipientId], config)`
- `PUT /lists/{list_id}/subscriptions/{recipient_id}` via `client.lists.subscribe(listId, recipientId)`
- `DELETE /lists/{list_id}/subscriptions/{recipient_id}` via `client.lists.unsubscribe(listId, recipientId)`

### Changed

- Default `base_url` is now `api.courier.com`

## [v1.5.0] - 2020-07-08

### Added

- Support for [Brands API](https://docs.courier.com/reference/brands-api) by @aydrian
- `GET /brands` via `client.getBrands(params)`
- `GET /brands/:brand_id` via `client.getBrand(brandId)`
- `POST /brands` via `client.createBrand({…})`
- `PUT /brands/:brand_id` via `client.replaceBrand({…})`
- `DELETE /brands/:brand_id` via `client.deleteBrand(brandId)`
- Support for specifying notification brand during [send](https://docs.courier.com/reference/send-api#sendmessage) by @aydrian

## [v1.4.0] - 2020-06-29

### Added

- Support `GET /messages/:messageId` via `client.getMessage(messageId)` @rileylnapier

## [v1.3.0] - 2020-03-10

### Added

- Support credential storage using `COURIER_AUTH_TOKEN` environment variable by @aydrian
- Support setting base url using `COURIER_BASE_URL` environment variable by @aydrian
- Support preferences and override in send method by @aydrian
- Create GitHub Issue and Pull Request templates by @rileylnapier

### Changed

- Updated user agent string to match new standard by @aydrian

## [v1.2.1] - 2019-12-30

### Fixed

- Convert package.json import to a require by @@scarney81

## [v1.2.0] - 2019-12-20

## Added

- Custom user agent string by @aydrian

## [v1.1.6] - 2019-07-12

## [v1.1.5] - 2019-07-12

## [v1.1.4] - 2019-07-12

## [v1.1.3] - 2019-07-12

## [v1.1.2] - 2019-07-12

## [v1.1.1] - 2019-07-12

## [v1.1.0] - 2019-07-12

## [v1.0.4] - 2019-07-12

## [v1.0.3] - 2019-07-12

## [v1.0.2] - 2019-07-12

## v1.0.1 - 2019-07-12

[unreleased]: https://github.com/trycourier/courier-node/compare/v4.1.1...HEAD
[v4.1.1]: https://github.com/trycourier/courier-node/compare/v4.1.1...v4.1.0
[v4.0.2]: https://github.com/trycourier/courier-node/compare/v4.0.1...v4.0.2
[v4.0.1]: https://github.com/trycourier/courier-node/compare/v4.0.0...v4.0.1
[v4.0.0]: https://github.com/trycourier/courier-node/compare/v3.16.0...v4.0.0
[v3.11.0]: https://github.com/trycourier/courier-node/compare/v3.10.0...v3.11.0
[v3.10.0]: https://github.com/trycourier/courier-node/compare/v3.9.0...v3.10.0
[v3.9.0]: https://github.com/trycourier/courier-node/compare/v3.8.0...v3.9.0
[v3.8.0]: https://github.com/trycourier/courier-node/compare/v3.7.0...v3.8.0
[v3.7.0]: https://github.com/trycourier/courier-node/compare/v3.6.0...v3.7.0
[v3.6.0]: https://github.com/trycourier/courier-node/compare/v3.5.0...v3.6.0
[v3.5.0]: https://github.com/trycourier/courier-node/compare/v3.4.0...v3.5.0
[v3.4.0]: https://github.com/trycourier/courier-node/compare/v3.3.0...v3.4.0
[v3.3.0]: https://github.com/trycourier/courier-node/compare/v3.2.1...v3.3.0
[v3.2.1]: https://github.com/trycourier/courier-node/compare/v3.2.0...v3.2.1
[v3.2.0]: https://github.com/trycourier/courier-node/compare/v3.1.0...v3.2.0
[v3.1.0]: https://github.com/trycourier/courier-node/compare/v3.0.0...v3.1.0
[v3.0.0]: https://github.com/trycourier/courier-node/compare/v2.8.0...v3.0.0
[v2.8.0]: https://github.com/trycourier/courier-node/compare/v2.7.0...v2.8.0
[v2.7.0]: https://github.com/trycourier/courier-node/compare/v2.6.0...v2.7.0
[v2.6.0]: https://github.com/trycourier/courier-node/compare/v2.4.0...v2.6.0
[v2.4.0]: https://github.com/trycourier/courier-node/compare/v2.3.0...v2.4.0
[v2.3.0]: https://github.com/trycourier/courier-node/compare/v2.2.0...v2.3.0
[v2.2.0]: https://github.com/trycourier/courier-node/compare/v2.1.0...v2.2.0
[v2.1.0]: https://github.com/trycourier/courier-node/compare/v2.0.0...v2.1.0
[v2.0.0]: https://github.com/trycourier/courier-node/compare/v1.7.3...v2.0.0
[v1.7.3]: https://github.com/trycourier/courier-node/compare/v1.7.2...v1.7.3
[v1.7.2]: https://github.com/trycourier/courier-node/compare/v1.7.1...v1.7.2
[v1.7.1]: https://github.com/trycourier/courier-node/compare/v1.7.0...v1.7.1
[v1.7.0]: https://github.com/trycourier/courier-node/compare/v1.6.2...v1.7.0
[v1.6.2]: https://github.com/trycourier/courier-node/compare/v1.6.1...v1.6.2
[v1.6.1]: https://github.com/trycourier/courier-node/compare/v1.6.0...v1.6.1
[v1.6.0]: https://github.com/trycourier/courier-node/compare/v1.5.0...v1.6.0
[v1.5.0]: https://github.com/trycourier/courier-node/compare/v1.4.0...v1.5.0
[v1.4.0]: https://github.com/trycourier/courier-node/compare/v1.3.0...v1.4.0
[v1.3.0]: https://github.com/trycourier/courier-node/compare/v1.2.1...v1.3.0
[v1.2.1]: https://github.com/trycourier/courier-node/compare/v1.2.0...v1.2.1
[v1.2.0]: https://github.com/trycourier/courier-node/compare/v1.1.6...v1.2.0
[v1.1.6]: https://github.com/trycourier/courier-node/compare/v1.1.5...v1.1.6
[v1.1.5]: https://github.com/trycourier/courier-node/compare/v1.1.4...v1.1.5
[v1.1.4]: https://github.com/trycourier/courier-node/compare/v1.1.3...v1.1.4
[v1.1.3]: https://github.com/trycourier/courier-node/compare/v1.1.2...v1.1.3
[v1.1.2]: https://github.com/trycourier/courier-node/compare/v1.1.1...v1.1.2
[v1.1.1]: https://github.com/trycourier/courier-node/compare/v1.1.0...v1.1.1
[v1.1.0]: https://github.com/trycourier/courier-node/compare/v1.0.4...v1.1.0
[v1.0.4]: https://github.com/trycourier/courier-node/compare/v1.0.3...v1.0.4
[v1.0.3]: https://github.com/trycourier/courier-node/compare/v1.0.2...v1.0.3
[v1.0.2]: https://github.com/trycourier/courier-node/compare/v1.0.1...v1.0.2
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

PR's welcome:

https://github.com/trycourier/courier-node

# Testing

```bash
yarn lint && yarn test
```

## Code Style/Formatting

```bash
yarn format
```

## Releasing New Versions

https://www.npmjs.com/package/@trycourier/courier

Make sure you have incremented the version string in `package.json` to your new version string, hereafter referred to as `<VERSION>` and merged that commit. Then:

```bash
git tag -a v<VERSION> -m v<VERSION>
git push origin v<VERSION>
```

Note: We use NPM Automation token (https://docs.npmjs.com/creating-and-viewing-access-tokens) to publish the package. The token exists in Circle CI environment.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Courier

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.
Loading

0 comments on commit 3830ee0

Please sign in to comment.