All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
v4.1.1 - 2023-02-02
- fix audience put request
- 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
- Migrate from Axios to fetch
- adds support for idempotency expiry to be passed in profiles and brands POST
- adds support for audit events
- adds support for token management
- adds provider and channel timeout
- adds support for message trace id (
message.metadata.trace_id
)
- adds support for
audiences
- adds support for messages timeout (
message.timeout
)
- adds support for messages brand_id (
message.brand_id
)
- adds support for bulk messaging API v2 support
- 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 ofICourierClientLists
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
- ICourierClient exported as a type #33
v1.7.2 - 2021-02-16
- Update PUT list subscription request params with appropriate type #32
v1.7.1 - 2021-02-01
- Fix the notification(s) typo #28
v1.7.0 - 2021-01-25
- Support for Preferences API by @helenamerk and @aydrian
GET /preferences
viaclient.preferences.list()
GET /preferences/{recipient_id}
viaclient.preferences.get(recipientId)
PUT /preferences/{recipient_id}
viaclient.preferences.put(recipientId, {...})
v1.6.2 - 2021-01-19
- Bumped axios to version 0.21.1
- Updated types for Send to List Parameters by @rileylnapier
v1.6.1 - 2020-09-23
- 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
- Support for
idempotencyKey
forPOST
methods by @aydrian & @rileylnapier - Support for Lists API by @aydrian
POST /send/list
viaclient.lists.send(params, config)
GET /profiles/{recipient_id}/lists
viaclient.lists.findByRecipientId(recipientId, params)
GET /lists
viaclient.lists.list(params)
GET /lists/{list_id}
viaclient.lists.get(listId)
PUT /lists/{list_id}
viaclient.lists.put(listId, {...})
DELETE /lists/{list_id}
viaclient.lists.delete(listId)
PUT /lists/{list_id}/restore
viaclient.lists.restore(listId)
GET /lists/{list_id}/subscriptions
viaclient.lists.getSubscriptions(listId)
PUT /lists/{list_id}/subscriptions
viaclient.lists.putSubscriptions(listId, [recipientId], config)
PUT /lists/{list_id}/subscriptions/{recipient_id}
viaclient.lists.subscribe(listId, recipientId)
DELETE /lists/{list_id}/subscriptions/{recipient_id}
viaclient.lists.unsubscribe(listId, recipientId)
- Default
base_url
is nowapi.courier.com
v1.5.0 - 2020-07-08
- Support for Brands API by @aydrian
GET /brands
viaclient.getBrands(params)
GET /brands/:brand_id
viaclient.getBrand(brandId)
POST /brands
viaclient.createBrand({…})
PUT /brands/:brand_id
viaclient.replaceBrand({…})
DELETE /brands/:brand_id
viaclient.deleteBrand(brandId)
- Support for specifying notification brand during send by @aydrian
v1.4.0 - 2020-06-29
- Support
GET /messages/:messageId
viaclient.getMessage(messageId)
@rileylnapier
v1.3.0 - 2020-03-10
- 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
- Updated user agent string to match new standard by @aydrian
v1.2.1 - 2019-12-30
- Convert package.json import to a require by @@scarney81
v1.2.0 - 2019-12-20
- Custom user agent string by @aydrian