@clear-street/clearstreet 0.103.0 → 0.104.0

package/resources/v1/locates.d.ts

@@ -7,6 +7,21 @@ import { RequestOptions } from "../../internal/request-options.js";
  * Query locate requests, granted locates, and cached locate borrow rates.
  */
 export declare class Locates extends APIResource {
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * Fetch one locate by id, matched against the locate request id, locate id, and
+     * client request id, across all days in force.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocateByID(
+     *   'id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    getLocateByID(id: string, params: LocateGetLocateByIDParams, options?: RequestOptions): APIPromise<LocateGetLocateByIDResponse>;
     /**
      * > **Beta** — this endpoint may change before general availability.
      *
@@ -38,7 +53,79 @@ export declare class Locates extends APIResource {
      * ```
      */
     getLocateRates(query: LocateGetLocateRatesParams, options?: RequestOptions): APIPromise<LocateGetLocateRatesResponse>;
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * List locates for the account on one effective date, which defaults to today's
+     * New York calendar date. Filter by comma-separated statuses and instrument ids or
+     * symbols.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocates(0);
+     * ```
+     */
+    getLocates(accountID: number, query?: LocateGetLocatesParams | null | undefined, options?: RequestOptions): APIPromise<LocateGetLocatesResponse>;
 }
+/**
+ * A locate request joined with the locate granted for it, if any.
+ */
+export interface Locate {
+    /**
+     * Account the locate is booked to.
+     */
+    account_id: number;
+    /**
+     * Caller-assigned id of the locate request.
+     */
+    client_request_id: string;
+    /**
+     * New York calendar date the locate is in force for.
+     */
+    effective_date: string;
+    /**
+     * Instrument id.
+     */
+    instrument_id: string;
+    /**
+     * Engine-assigned locate request id.
+     */
+    locate_request_id: string;
+    /**
+     * Number of shares requested.
+     */
+    requested_quantity: number;
+    /**
+     * Presented status of the locate.
+     */
+    status: LocateStatus;
+    /**
+     * Engine-assigned locate id; set once the locate is granted. When a null/undefined
+     * value is observed, it indicates it does not apply.
+     */
+    locate_id?: string | null;
+    /**
+     * Number of shares granted; set once the locate is granted. When a null/undefined
+     * value is observed, it indicates it does not apply.
+     */
+    quantity?: number | null;
+    /**
+     * Client order id the request relates to, if any. When a null/undefined value is
+     * observed, it indicates it does not apply.
+     */
+    related_order_id?: string | null;
+    /**
+     * Number of granted shares reserved. When a null/undefined value is observed, it
+     * indicates it does not apply.
+     */
+    reserved_quantity?: number | null;
+    /**
+     * Number of granted shares already used. When a null/undefined value is observed,
+     * it indicates it does not apply.
+     */
+    used_quantity?: number | null;
+}
+export type LocateList = Array<Locate>;
 /**
  * A locate borrow rate for an instrument.
  */
@@ -77,6 +164,17 @@ export interface LocateRateResult {
     rate?: LocateRate | null;
 }
 export type LocateRateResultList = Array<LocateRateResult>;
+/**
+ * The presented status of a locate: the locate-request lifecycle plus `EXPIRED`
+ * for accepted locates whose effective date has passed.
+ */
+export type LocateStatus = 'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED';
+export interface LocateGetLocateByIDResponse extends Shared.BaseResponse {
+    /**
+     * A locate request joined with the locate granted for it, if any.
+     */
+    data: Locate;
+}
 export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
     /**
      * A locate borrow rate for an instrument.
@@ -86,13 +184,37 @@ export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
 export interface LocateGetLocateRatesResponse extends Shared.BaseResponse {
     data: LocateRateResultList;
 }
+export interface LocateGetLocatesResponse extends Shared.BaseResponse {
+    data: LocateList;
+}
+export interface LocateGetLocateByIDParams {
+    /**
+     * Account identifier
+     */
+    account_id: number;
+}
 export interface LocateGetLocateRatesParams {
     /**
      * Comma-separated instrument IDs (UUID) or symbols; at least one, at most 1,000.
      */
     instrument_ids: Array<OrdersAPI.InstrumentIDOrSymbol>;
 }
+export interface LocateGetLocatesParams {
+    /**
+     * Effective date to list; defaults to today's New York calendar date. Explicit
+     * dates are used unchanged, including weekends and holidays.
+     */
+    effective_date?: string;
+    /**
+     * Comma-separated instrument IDs (UUID) or symbols.
+     */
+    instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
+    /**
+     * Comma-separated locate statuses to filter by
+     */
+    status?: Array<'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED'>;
+}
 export declare namespace Locates {
-    export { type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, };
+    export { type Locate as Locate, type LocateList as LocateList, type LocateRate as LocateRate, type LocateRateResult as LocateRateResult, type LocateRateResultList as LocateRateResultList, type LocateStatus as LocateStatus, type LocateGetLocateByIDResponse as LocateGetLocateByIDResponse, type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse, type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse, type LocateGetLocatesResponse as LocateGetLocatesResponse, type LocateGetLocateByIDParams as LocateGetLocateByIDParams, type LocateGetLocateRatesParams as LocateGetLocateRatesParams, type LocateGetLocatesParams as LocateGetLocatesParams, };
 }
 //# sourceMappingURL=locates.d.ts.map

package/resources/v1/locates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"locates.d.ts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
+{"version":3,"file":"locates.d.ts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,YAAY;IACtE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,YAAY;IACnE,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;CACnE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1/locates.js

@@ -8,6 +8,24 @@ const path_1 = require("../../internal/utils/path.js");
  * Query locate requests, granted locates, and cached locate borrow rates.
  */
 class Locates extends resource_1.APIResource {
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * Fetch one locate by id, matched against the locate request id, locate id, and
+     * client request id, across all days in force.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocateByID(
+     *   'id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    getLocateByID(id, params, options) {
+        const { account_id } = params;
+        return this._client.get((0, path_1.path) `/v1/accounts/${account_id}/locates/${id}`, options);
+    }
     /**
      * > **Beta** — this endpoint may change before general availability.
      *
@@ -43,6 +61,21 @@ class Locates extends resource_1.APIResource {
     getLocateRates(query, options) {
         return this._client.get('/v1/locates/rates', { query, ...options });
     }
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * List locates for the account on one effective date, which defaults to today's
+     * New York calendar date. Filter by comma-separated statuses and instrument ids or
+     * symbols.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocates(0);
+     * ```
+     */
+    getLocates(accountID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/accounts/${accountID}/locates`, { query, ...options });
+    }
 }
 exports.Locates = Locates;
 //# sourceMappingURL=locates.js.map

package/resources/v1/locates.js.map

@@ -1 +1 @@
-{"version":3,"file":"locates.js","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AA3CD,0BA2CC"}
+{"version":3,"file":"locates.js","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAtFD,0BAsFC"}

package/resources/v1/locates.mjs

@@ -5,6 +5,24 @@ import { path } from "../../internal/utils/path.mjs";
  * Query locate requests, granted locates, and cached locate borrow rates.
  */
 export class Locates extends APIResource {
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * Fetch one locate by id, matched against the locate request id, locate id, and
+     * client request id, across all days in force.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocateByID(
+     *   'id',
+     *   { account_id: 0 },
+     * );
+     * ```
+     */
+    getLocateByID(id, params, options) {
+        const { account_id } = params;
+        return this._client.get(path `/v1/accounts/${account_id}/locates/${id}`, options);
+    }
     /**
      * > **Beta** — this endpoint may change before general availability.
      *
@@ -40,5 +58,20 @@ export class Locates extends APIResource {
     getLocateRates(query, options) {
         return this._client.get('/v1/locates/rates', { query, ...options });
     }
+    /**
+     * > **Beta** — this endpoint may change before general availability.
+     *
+     * List locates for the account on one effective date, which defaults to today's
+     * New York calendar date. Filter by comma-separated statuses and instrument ids or
+     * symbols.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.locates.getLocates(0);
+     * ```
+     */
+    getLocates(accountID, query = {}, options) {
+        return this._client.get(path `/v1/accounts/${accountID}/locates`, { query, ...options });
+    }
 }
 //# sourceMappingURL=locates.mjs.map

package/resources/v1/locates.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"locates.mjs","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"locates.mjs","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,UAAU,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}

package/resources/v1/omni-ai/entitlements.d.mts

@@ -24,13 +24,9 @@ export declare class Entitlements extends APIResource {
     /**
      * Revoke one entitlement grant by id.
      *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.v1.omniAI.entitlements.deleteEntitlement(
-     *     'entitlement_id',
-     *   );
-     * ```
+     * Deprecated -- use `POST /omni-ai/entitlements/opt-out`.
+     *
+     * @deprecated
      */
     deleteEntitlement(entitlementID: string, options?: RequestOptions): APIPromise<EntitlementDeleteEntitlementResponse>;
     /**
@@ -44,15 +40,41 @@ export declare class Entitlements extends APIResource {
      */
     getEntitlementAgreements(options?: RequestOptions): APIPromise<EntitlementGetEntitlementAgreementsResponse>;
     /**
-     * List caller's active entitlement grants.
+     * Whether each entitlement is enabled, per account. Accounts with no recorded
+     * choice are enabled by default. Without `account_id`, covers every account the
+     * caller can access.
      *
      * @example
      * ```ts
      * const response =
-     *   await client.v1.omniAI.entitlements.getEntitlements();
+     *   await client.v1.omniAI.entitlements.getEntitlementStatus();
      * ```
      */
+    getEntitlementStatus(query?: EntitlementGetEntitlementStatusParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementGetEntitlementStatusResponse>;
+    /**
+     * List caller's active entitlement grants.
+     *
+     * Deprecated -- use `GET /omni-ai/entitlement-status`; this lists explicit grants
+     * only and omits accounts that are enabled by default.
+     *
+     * @deprecated
+     */
     getEntitlements(query?: EntitlementGetEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementGetEntitlementsResponse>;
+    /**
+     * Turn off one-or-more entitlements for the given accounts. Idempotent: accounts
+     * that are already opted out are left as they are. To turn an entitlement back on,
+     * sign the agreement with `POST /omni-ai/entitlements`.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.omniAI.entitlements.optOutEntitlements({
+     *     account_ids: [100019, 100021],
+     *     entitlement_codes: ['omni.account_data'],
+     *   });
+     * ```
+     */
+    optOutEntitlements(body: EntitlementOptOutEntitlementsParams, options?: RequestOptions): APIPromise<EntitlementOptOutEntitlementsResponse>;
 }
 export interface DeleteEntitlementResponse {
     entitlement_id: string;
@@ -82,6 +104,19 @@ export interface EntitlementResource {
     granted_at: string;
 }
 export type EntitlementResourceList = Array<EntitlementResource>;
+/**
+ * Whether an entitlement is enabled for one account. Accounts the user never chose
+ * for are enabled by default.
+ */
+export interface EntitlementStatusResource {
+    account_id: number;
+    enabled: boolean;
+    /**
+     * Stable entitlement code granted by an agreement.
+     */
+    entitlement_code: OmniAIAPI.EntitlementCode;
+}
+export type EntitlementStatusResourceList = Array<EntitlementStatusResource>;
 export interface EntitlementCreateEntitlementsResponse extends Shared.BaseResponse {
     data: EntitlementResourceList;
 }
@@ -91,18 +126,31 @@ export interface EntitlementDeleteEntitlementResponse extends Shared.BaseRespons
 export interface EntitlementGetEntitlementAgreementsResponse extends Shared.BaseResponse {
     data: EntitlementAgreementResourceList;
 }
+export interface EntitlementGetEntitlementStatusResponse extends Shared.BaseResponse {
+    data: EntitlementStatusResourceList;
+}
 export interface EntitlementGetEntitlementsResponse extends Shared.BaseResponse {
     data: EntitlementResourceList;
 }
+export interface EntitlementOptOutEntitlementsResponse extends Shared.BaseResponse {
+    data: EntitlementStatusResourceList;
+}
 export interface EntitlementCreateEntitlementsParams {
     account_ids: Array<number>;
     agreement_id: string;
     entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
 }
+export interface EntitlementGetEntitlementStatusParams {
+    account_id?: number;
+}
 export interface EntitlementGetEntitlementsParams {
     account_id?: number;
 }
+export interface EntitlementOptOutEntitlementsParams {
+    account_ids: Array<number>;
+    entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
+}
 export declare namespace Entitlements {
-    export { type DeleteEntitlementResponse as DeleteEntitlementResponse, type EntitlementAgreementResource as EntitlementAgreementResource, type EntitlementAgreementResourceList as EntitlementAgreementResourceList, type EntitlementResource as EntitlementResource, type EntitlementResourceList as EntitlementResourceList, type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse, type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse, type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse, type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse, type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams, type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams, };
+    export { type DeleteEntitlementResponse as DeleteEntitlementResponse, type EntitlementAgreementResource as EntitlementAgreementResource, type EntitlementAgreementResourceList as EntitlementAgreementResourceList, type EntitlementResource as EntitlementResource, type EntitlementResourceList as EntitlementResourceList, type EntitlementStatusResource as EntitlementStatusResource, type EntitlementStatusResourceList as EntitlementStatusResourceList, type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse, type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse, type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse, type EntitlementGetEntitlementStatusResponse as EntitlementGetEntitlementStatusResponse, type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse, type EntitlementOptOutEntitlementsResponse as EntitlementOptOutEntitlementsResponse, type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams, type EntitlementGetEntitlementStatusParams as EntitlementGetEntitlementStatusParams, type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams, type EntitlementOptOutEntitlementsParams as EntitlementOptOutEntitlementsParams, };
 }
 //# sourceMappingURL=entitlements.d.mts.map

package/resources/v1/omni-ai/entitlements.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,KAAK,SAAS,sBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAIpD;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2CAA2C,CAAC;IAI1D;;;;;;;;OAQG;IACH,eAAe,CACb,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,uBAAuB,CAAC;IAEjD,gBAAgB,EAAE,MAAM,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAC;IAExB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gCAAgC,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;IAE5C,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,2CAA4C,SAAQ,MAAM,CAAC,YAAY;IACtF,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,YAAY,EAAE,MAAM,CAAC;IAErB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
+{"version":3,"file":"entitlements.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,KAAK,SAAS,sBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAIpD;;;;;;OAMG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2CAA2C,CAAC;IAI1D;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,eAAe,CACb,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAIjD;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,uBAAuB,CAAC;IAEjD,gBAAgB,EAAE,MAAM,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAC;IAExB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gCAAgC,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;IAE5C,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;CAC7C;AAED,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAE7E,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,2CAA4C,SAAQ,MAAM,CAAC,YAAY;IACtF,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,6BAA6B,CAAC;CACrC;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,6BAA6B,CAAC;CACrC;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,YAAY,EAAE,MAAM,CAAC;IAErB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,qCAAqC;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/v1/omni-ai/entitlements.d.ts

@@ -24,13 +24,9 @@ export declare class Entitlements extends APIResource {
     /**
      * Revoke one entitlement grant by id.
      *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.v1.omniAI.entitlements.deleteEntitlement(
-     *     'entitlement_id',
-     *   );
-     * ```
+     * Deprecated -- use `POST /omni-ai/entitlements/opt-out`.
+     *
+     * @deprecated
      */
     deleteEntitlement(entitlementID: string, options?: RequestOptions): APIPromise<EntitlementDeleteEntitlementResponse>;
     /**
@@ -44,15 +40,41 @@ export declare class Entitlements extends APIResource {
      */
     getEntitlementAgreements(options?: RequestOptions): APIPromise<EntitlementGetEntitlementAgreementsResponse>;
     /**
-     * List caller's active entitlement grants.
+     * Whether each entitlement is enabled, per account. Accounts with no recorded
+     * choice are enabled by default. Without `account_id`, covers every account the
+     * caller can access.
      *
      * @example
      * ```ts
      * const response =
-     *   await client.v1.omniAI.entitlements.getEntitlements();
+     *   await client.v1.omniAI.entitlements.getEntitlementStatus();
      * ```
      */
+    getEntitlementStatus(query?: EntitlementGetEntitlementStatusParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementGetEntitlementStatusResponse>;
+    /**
+     * List caller's active entitlement grants.
+     *
+     * Deprecated -- use `GET /omni-ai/entitlement-status`; this lists explicit grants
+     * only and omits accounts that are enabled by default.
+     *
+     * @deprecated
+     */
     getEntitlements(query?: EntitlementGetEntitlementsParams | null | undefined, options?: RequestOptions): APIPromise<EntitlementGetEntitlementsResponse>;
+    /**
+     * Turn off one-or-more entitlements for the given accounts. Idempotent: accounts
+     * that are already opted out are left as they are. To turn an entitlement back on,
+     * sign the agreement with `POST /omni-ai/entitlements`.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.omniAI.entitlements.optOutEntitlements({
+     *     account_ids: [100019, 100021],
+     *     entitlement_codes: ['omni.account_data'],
+     *   });
+     * ```
+     */
+    optOutEntitlements(body: EntitlementOptOutEntitlementsParams, options?: RequestOptions): APIPromise<EntitlementOptOutEntitlementsResponse>;
 }
 export interface DeleteEntitlementResponse {
     entitlement_id: string;
@@ -82,6 +104,19 @@ export interface EntitlementResource {
     granted_at: string;
 }
 export type EntitlementResourceList = Array<EntitlementResource>;
+/**
+ * Whether an entitlement is enabled for one account. Accounts the user never chose
+ * for are enabled by default.
+ */
+export interface EntitlementStatusResource {
+    account_id: number;
+    enabled: boolean;
+    /**
+     * Stable entitlement code granted by an agreement.
+     */
+    entitlement_code: OmniAIAPI.EntitlementCode;
+}
+export type EntitlementStatusResourceList = Array<EntitlementStatusResource>;
 export interface EntitlementCreateEntitlementsResponse extends Shared.BaseResponse {
     data: EntitlementResourceList;
 }
@@ -91,18 +126,31 @@ export interface EntitlementDeleteEntitlementResponse extends Shared.BaseRespons
 export interface EntitlementGetEntitlementAgreementsResponse extends Shared.BaseResponse {
     data: EntitlementAgreementResourceList;
 }
+export interface EntitlementGetEntitlementStatusResponse extends Shared.BaseResponse {
+    data: EntitlementStatusResourceList;
+}
 export interface EntitlementGetEntitlementsResponse extends Shared.BaseResponse {
     data: EntitlementResourceList;
 }
+export interface EntitlementOptOutEntitlementsResponse extends Shared.BaseResponse {
+    data: EntitlementStatusResourceList;
+}
 export interface EntitlementCreateEntitlementsParams {
     account_ids: Array<number>;
     agreement_id: string;
     entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
 }
+export interface EntitlementGetEntitlementStatusParams {
+    account_id?: number;
+}
 export interface EntitlementGetEntitlementsParams {
     account_id?: number;
 }
+export interface EntitlementOptOutEntitlementsParams {
+    account_ids: Array<number>;
+    entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
+}
 export declare namespace Entitlements {
-    export { type DeleteEntitlementResponse as DeleteEntitlementResponse, type EntitlementAgreementResource as EntitlementAgreementResource, type EntitlementAgreementResourceList as EntitlementAgreementResourceList, type EntitlementResource as EntitlementResource, type EntitlementResourceList as EntitlementResourceList, type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse, type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse, type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse, type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse, type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams, type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams, };
+    export { type DeleteEntitlementResponse as DeleteEntitlementResponse, type EntitlementAgreementResource as EntitlementAgreementResource, type EntitlementAgreementResourceList as EntitlementAgreementResourceList, type EntitlementResource as EntitlementResource, type EntitlementResourceList as EntitlementResourceList, type EntitlementStatusResource as EntitlementStatusResource, type EntitlementStatusResourceList as EntitlementStatusResourceList, type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse, type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse, type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse, type EntitlementGetEntitlementStatusResponse as EntitlementGetEntitlementStatusResponse, type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse, type EntitlementOptOutEntitlementsResponse as EntitlementOptOutEntitlementsResponse, type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams, type EntitlementGetEntitlementStatusParams as EntitlementGetEntitlementStatusParams, type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams, type EntitlementOptOutEntitlementsParams as EntitlementOptOutEntitlementsParams, };
 }
 //# sourceMappingURL=entitlements.d.ts.map

package/resources/v1/omni-ai/entitlements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,KAAK,SAAS,qBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAIpD;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2CAA2C,CAAC;IAI1D;;;;;;;;OAQG;IACH,eAAe,CACb,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,uBAAuB,CAAC;IAEjD,gBAAgB,EAAE,MAAM,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAC;IAExB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gCAAgC,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;IAE5C,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,2CAA4C,SAAQ,MAAM,CAAC,YAAY;IACtF,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,YAAY,EAAE,MAAM,CAAC;IAErB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
+{"version":3,"file":"entitlements.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,KAAK,SAAS,qBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;IAIpD;;;;;;OAMG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2CAA2C,CAAC;IAI1D;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,eAAe,CACb,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAIjD;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,IAAI,EAAE,mCAAmC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,SAAS,CAAC,uBAAuB,CAAC;IAEjD,gBAAgB,EAAE,MAAM,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAC;IAExB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAEpD,KAAK,EAAE,MAAM,CAAC;IAEd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gCAAgC,GAAG,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;IAE5C,cAAc,EAAE,MAAM,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,eAAe,CAAC;CAC7C;AAED,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAE7E,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,yBAAyB,CAAC;CACjC;AAED,MAAM,WAAW,2CAA4C,SAAQ,MAAM,CAAC,YAAY;IACtF,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,6BAA6B,CAAC;CACrC;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,qCAAsC,SAAQ,MAAM,CAAC,YAAY;IAChF,IAAI,EAAE,6BAA6B,CAAC;CACrC;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,YAAY,EAAE,MAAM,CAAC;IAErB,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,qCAAqC;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mCAAmC;IAClD,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;CACrD;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/v1/omni-ai/entitlements.js

@@ -27,13 +27,9 @@ class Entitlements extends resource_1.APIResource {
     /**
      * Revoke one entitlement grant by id.
      *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.v1.omniAI.entitlements.deleteEntitlement(
-     *     'entitlement_id',
-     *   );
-     * ```
+     * Deprecated -- use `POST /omni-ai/entitlements/opt-out`.
+     *
+     * @deprecated
      */
     deleteEntitlement(entitlementID, options) {
         return this._client.delete((0, path_1.path) `/v1/omni-ai/entitlements/${entitlementID}`, options);
@@ -51,17 +47,47 @@ class Entitlements extends resource_1.APIResource {
         return this._client.get('/v1/omni-ai/entitlement-agreements', options);
     }
     /**
-     * List caller's active entitlement grants.
+     * Whether each entitlement is enabled, per account. Accounts with no recorded
+     * choice are enabled by default. Without `account_id`, covers every account the
+     * caller can access.
      *
      * @example
      * ```ts
      * const response =
-     *   await client.v1.omniAI.entitlements.getEntitlements();
+     *   await client.v1.omniAI.entitlements.getEntitlementStatus();
      * ```
      */
+    getEntitlementStatus(query = {}, options) {
+        return this._client.get('/v1/omni-ai/entitlement-status', { query, ...options });
+    }
+    /**
+     * List caller's active entitlement grants.
+     *
+     * Deprecated -- use `GET /omni-ai/entitlement-status`; this lists explicit grants
+     * only and omits accounts that are enabled by default.
+     *
+     * @deprecated
+     */
     getEntitlements(query = {}, options) {
         return this._client.get('/v1/omni-ai/entitlements', { query, ...options });
     }
+    /**
+     * Turn off one-or-more entitlements for the given accounts. Idempotent: accounts
+     * that are already opted out are left as they are. To turn an entitlement back on,
+     * sign the agreement with `POST /omni-ai/entitlements`.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.omniAI.entitlements.optOutEntitlements({
+     *     account_ids: [100019, 100021],
+     *     entitlement_codes: ['omni.account_data'],
+     *   });
+     * ```
+     */
+    optOutEntitlements(body, options) {
+        return this._client.post('/v1/omni-ai/entitlements/opt-out', { body, ...options });
+    }
 }
 exports.Entitlements = Entitlements;
 //# sourceMappingURL=entitlements.js.map

package/resources/v1/omni-ai/entitlements.js.map

@@ -1 +1 @@
-{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,aAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CACb,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AArED,oCAqEC"}
+{"version":3,"file":"entitlements.js","sourceRoot":"","sources":["../../../src/resources/v1/omni-ai/entitlements.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAKrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CACf,aAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,QAAkE,EAAE,EACpE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CACb,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAChB,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAvGD,oCAuGC"}