@trycourier/courier 7.0.0 → 7.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 7.1.0 (2025-11-18)
+
+Full Changelog: [v7.0.0...v7.1.0](https://github.com/trycourier/courier-node/compare/v7.0.0...v7.1.0)
+
+### Features
+
+* JWT scope updates ([d9fb88a](https://github.com/trycourier/courier-node/commit/d9fb88ad4c217438b599c7e9102fdaec3ae83602))
+* Test ([3353a72](https://github.com/trycourier/courier-node/commit/3353a72311650979908b120068bbcd40328753c4))
+
 ## 7.0.0 (2025-11-12)
 
 Full Changelog: [v6.7.0-alpha14...v7.0.0](https://github.com/trycourier/courier-node/compare/v6.7.0-alpha14...v7.0.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trycourier/courier",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "The official TypeScript library for the Courier API",
   "author": "Courier <support@courier.com>",
   "types": "./index.d.ts",

package/resources/auth.d.mts

@@ -4,6 +4,15 @@ import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Auth extends APIResource {
     /**
      * Returns a new access token.
+     *
+     * @example
+     * ```ts
+     * const response = await client.auth.issueToken({
+     *   expires_in: '$YOUR_NUMBER days',
+     *   scope:
+     *     'user_id:$YOUR_USER_ID write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands',
+     * });
+     * ```
      */
     issueToken(body: AuthIssueTokenParams, options?: RequestOptions): APIPromise<AuthIssueTokenResponse>;
 }
@@ -11,7 +20,37 @@ export interface AuthIssueTokenResponse {
     token: string;
 }
 export interface AuthIssueTokenParams {
+    /**
+     * Duration for token expiration. Accepts various time formats:
+     *
+     * - "2 hours" - 2 hours from now
+     * - "1d" - 1 day
+     * - "3 days" - 3 days
+     * - "10h" - 10 hours
+     * - "2.5 hrs" - 2.5 hours
+     * - "1m" - 1 minute
+     * - "5s" - 5 seconds
+     * - "1y" - 1 year
+     */
     expires_in: string;
+    /**
+     * Available scopes:
+     *
+     * - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+     *   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+     * - `read:messages` - Read messages.
+     * - `read:user-tokens` - Read user push tokens.
+     * - `write:user-tokens` - Write user push tokens.
+     * - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+     *   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+     * - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+     *   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+     * - `inbox:read:messages` - Read inbox messages.
+     * - `inbox:write:events` - Write inbox events, such as mark message as read.
+     * - `read:preferences` - Read user preferences.
+     * - `write:preferences` - Write user preferences. Example:
+     *   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+     */
     scope: string;
 }
 export declare namespace Auth {

package/resources/auth.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.mts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"auth.d.mts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/auth.d.ts

@@ -4,6 +4,15 @@ import { RequestOptions } from "../internal/request-options.js";
 export declare class Auth extends APIResource {
     /**
      * Returns a new access token.
+     *
+     * @example
+     * ```ts
+     * const response = await client.auth.issueToken({
+     *   expires_in: '$YOUR_NUMBER days',
+     *   scope:
+     *     'user_id:$YOUR_USER_ID write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands',
+     * });
+     * ```
      */
     issueToken(body: AuthIssueTokenParams, options?: RequestOptions): APIPromise<AuthIssueTokenResponse>;
 }
@@ -11,7 +20,37 @@ export interface AuthIssueTokenResponse {
     token: string;
 }
 export interface AuthIssueTokenParams {
+    /**
+     * Duration for token expiration. Accepts various time formats:
+     *
+     * - "2 hours" - 2 hours from now
+     * - "1d" - 1 day
+     * - "3 days" - 3 days
+     * - "10h" - 10 hours
+     * - "2.5 hrs" - 2.5 hours
+     * - "1m" - 1 minute
+     * - "5s" - 5 seconds
+     * - "1y" - 1 year
+     */
     expires_in: string;
+    /**
+     * Available scopes:
+     *
+     * - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+     *   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+     * - `read:messages` - Read messages.
+     * - `read:user-tokens` - Read user push tokens.
+     * - `write:user-tokens` - Write user push tokens.
+     * - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+     *   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+     * - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+     *   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+     * - `inbox:read:messages` - Read inbox messages.
+     * - `inbox:write:events` - Write inbox events, such as mark message as read.
+     * - `read:preferences` - Read user preferences.
+     * - `write:preferences` - Write user preferences. Example:
+     *   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+     */
     scope: string;
 }
 export declare namespace Auth {

package/resources/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/auth.js

@@ -6,6 +6,15 @@ const resource_1 = require("../core/resource.js");
 class Auth extends resource_1.APIResource {
     /**
      * Returns a new access token.
+     *
+     * @example
+     * ```ts
+     * const response = await client.auth.issueToken({
+     *   expires_in: '$YOUR_NUMBER days',
+     *   scope:
+     *     'user_id:$YOUR_USER_ID write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands',
+     * });
+     * ```
      */
     issueToken(body, options) {
         return this._client.post('/auth/issue-token', { body, ...options });

package/resources/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAPD,oBAOC"}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAhBD,oBAgBC"}

package/resources/auth.mjs

@@ -3,6 +3,15 @@ import { APIResource } from "../core/resource.mjs";
 export class Auth extends APIResource {
     /**
      * Returns a new access token.
+     *
+     * @example
+     * ```ts
+     * const response = await client.auth.issueToken({
+     *   expires_in: '$YOUR_NUMBER days',
+     *   scope:
+     *     'user_id:$YOUR_USER_ID write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands',
+     * });
+     * ```
      */
     issueToken(body, options) {
         return this._client.post('/auth/issue-token', { body, ...options });

package/resources/auth.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"auth.mjs","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"auth.mjs","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}

package/src/resources/auth.ts

@@ -7,6 +7,15 @@ import { RequestOptions } from '../internal/request-options';
 export class Auth extends APIResource {
   /**
    * Returns a new access token.
+   *
+   * @example
+   * ```ts
+   * const response = await client.auth.issueToken({
+   *   expires_in: '$YOUR_NUMBER days',
+   *   scope:
+   *     'user_id:$YOUR_USER_ID write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands',
+   * });
+   * ```
    */
   issueToken(body: AuthIssueTokenParams, options?: RequestOptions): APIPromise<AuthIssueTokenResponse> {
     return this._client.post('/auth/issue-token', { body, ...options });
@@ -18,8 +27,38 @@ export interface AuthIssueTokenResponse {
 }
 
 export interface AuthIssueTokenParams {
+  /**
+   * Duration for token expiration. Accepts various time formats:
+   *
+   * - "2 hours" - 2 hours from now
+   * - "1d" - 1 day
+   * - "3 days" - 3 days
+   * - "10h" - 10 hours
+   * - "2.5 hrs" - 2.5 hours
+   * - "1m" - 1 minute
+   * - "5s" - 5 seconds
+   * - "1y" - 1 year
+   */
   expires_in: string;
 
+  /**
+   * Available scopes:
+   *
+   * - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+   *   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+   * - `read:messages` - Read messages.
+   * - `read:user-tokens` - Read user push tokens.
+   * - `write:user-tokens` - Write user push tokens.
+   * - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+   *   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+   * - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+   *   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+   * - `inbox:read:messages` - Read inbox messages.
+   * - `inbox:write:events` - Write inbox events, such as mark message as read.
+   * - `read:preferences` - Read user preferences.
+   * - `write:preferences` - Write user preferences. Example:
+   *   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+   */
   scope: string;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.0.0'; // x-release-please-version
+export const VERSION = '7.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.0.0";
+export declare const VERSION = "7.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.0.0";
+export declare const VERSION = "7.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.0.0'; // x-release-please-version
+exports.VERSION = '7.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.0.0'; // x-release-please-version
+export const VERSION = '7.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map