@augno/sdk 0.1.9 → 0.7.1

package/resources/catalog/products.mjs

@@ -6,24 +6,25 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class Products extends APIResource {
     /**
-     * Creates a product.
+     * Returns a paginated list of products for the target account.
+     *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.create({
-     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
-     *   sku: 'ALM-2024-1001',
-     *   type: 'sale',
-     * });
+     * const listProduct = await client.catalog.products.list();
      * ```
      */
-    create(params, options) {
-        const { include, ...body } = params;
-        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/catalog/products', { query, ...options });
     }
     /**
      * Returns a product by ID.
      *
+     * This endpoint requires the permissions: `items:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.retrieve(
@@ -35,33 +36,49 @@ export class Products extends APIResource {
         return this._client.get(path `/v1/catalog/products/${id}`, { query, ...options });
     }
     /**
-     * Partially updates a product.
+     * Creates a product and its backing inventory item.
+     *
+     * The new item starts with zero on-hand inventory, and its pricing defaults to
+     * zero rates in the category's base unit unless `unit_price` or `unit_cost` is
+     * provided.
+     *
+     * This endpoint requires the permission: `items:create`.
      *
      * @example
      * ```ts
-     * const product = await client.catalog.products.update(
-     *   'pd_013c29ab3f1518d0004094c316',
-     * );
+     * const product = await client.catalog.products.create({
+     *   category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
+     *   sku: 'ALM-2024-1001',
+     *   type: 'sale',
+     * });
      * ```
      */
-    update(id, params = {}, options) {
-        const { include, ...body } = params ?? {};
-        return this._client.patch(path `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/catalog/products', { query: { include }, body, ...options });
     }
     /**
-     * Returns a paginated list of products for the target account.
+     * Partially updates a product.
+     *
+     * This endpoint requires the permission: `items:update`.
      *
      * @example
      * ```ts
-     * const listProduct = await client.catalog.products.list();
+     * const product = await client.catalog.products.update(
+     *   'pd_013c29ab3f1518d0004094c316',
+     *   { sku: 'SKU-002' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/catalog/products', { query, ...options });
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/catalog/products/${id}`, { query: { include }, body, ...options });
     }
     /**
      * Soft-deletes a product and returns the deleted product.
      *
+     * This endpoint requires the permission: `items:delete`.
+     *
      * @example
      * ```ts
      * const product = await client.catalog.products.delete(
@@ -76,6 +93,8 @@ export class Products extends APIResource {
     /**
      * Changes the product line assignment for a product.
      *
+     * This endpoint requires the permission: `items:update`.
+     *
      * @example
      * ```ts
      * const product =

package/resources/catalog/products.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAOlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../src/resources/catalog/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAOf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,EAAU,EACV,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAU,EACV,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,wBAAwB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAqB,EACrB,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,EAAE,iBAAiB,aAAa,EAAE,EAAE;YACtF,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/catalog/properties/attributes.d.mts

@@ -7,21 +7,24 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
  */
 export declare class Attributes extends APIResource {
     /**
-     * Creates an attribute under a property.
+     * Returns a paginated list of attributes for a property.
+     *
+     * This endpoint requires the permission: `properties:read`.
      *
      * @example
      * ```ts
-     * const attribute =
-     *   await client.catalog.properties.attributes.create(
+     * const listAttribute =
+     *   await client.catalog.properties.attributes.list(
      *     'pp_01e21344878064372f69e67093',
-     *     { value: 'Red' },
      *   );
      * ```
      */
-    create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
+    list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
     /**
      * Returns an attribute by ID within a property.
      *
+     * This endpoint requires the permission: `properties:read`.
+     *
      * @example
      * ```ts
      * const attribute =
@@ -33,33 +36,50 @@ export declare class Attributes extends APIResource {
      */
     retrieve(id: string, params: AttributeRetrieveParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
-     * Partially updates an attribute.
+     * Creates an attribute under a property.
+     *
+     * This endpoint requires the permission: `properties:create`.
      *
      * @example
      * ```ts
      * const attribute =
-     *   await client.catalog.properties.attributes.update(
-     *     'at_01c9493ec0c46bb0ed12708ae4',
-     *     { property_id: 'pp_01e21344878064372f69e67093' },
+     *   await client.catalog.properties.attributes.create(
+     *     'pp_01e21344878064372f69e67093',
+     *     {
+     *       value: 'Red',
+     *       color: 'red',
+     *       sort_order: 1,
+     *     },
      *   );
      * ```
      */
-    update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
+    create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
-     * Returns a paginated list of attributes for a property.
+     * Partially updates an attribute.
+     *
+     * This endpoint requires the permission: `properties:update`.
      *
      * @example
      * ```ts
-     * const listAttribute =
-     *   await client.catalog.properties.attributes.list(
-     *     'pp_01e21344878064372f69e67093',
+     * const attribute =
+     *   await client.catalog.properties.attributes.update(
+     *     'at_01c9493ec0c46bb0ed12708ae4',
+     *     {
+     *       property_id: 'pp_01e21344878064372f69e67093',
+     *       value: 'Blue',
+     *     },
      *   );
      * ```
      */
-    list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
+    update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
      * Deletes an attribute from a property.
      *
+     * Remaining attributes in the property are shifted so their sort orders stay
+     * contiguous.
+     *
+     * This endpoint requires the permission: `properties:delete`.
+     *
      * @example
      * ```ts
      * const attribute =
@@ -76,15 +96,26 @@ export declare class Attributes extends APIResource {
  */
 export interface CreateAttributeRequest {
     /**
-     * Attribute value.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be unique across all attributes in the account, not just within the
+     * property. Leading and trailing whitespace is trimmed.
      */
     value: string;
     /**
-     * Color code. Randomly assigned if not provided.
+     * Swatch color used to display this attribute in the UI.
+     *
+     * When omitted, one of the nine named colors (everything except `default`) is
+     * assigned at random.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Display order. Defaults to last position if not provided.
+     * Position of the new attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count plus one; siblings at or
+     * after this position are shifted one position later. Defaults to the last
+     * position if not provided.
      */
     sort_order?: number;
 }
@@ -93,33 +124,46 @@ export interface CreateAttributeRequest {
  */
 export interface UpdateAttributeRequest {
     /**
-     * Color code.
+     * Swatch color used to display this attribute in the UI.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Display order. Must be a positive integer.
+     * New position of this attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count; the attributes between
+     * the old and new positions shift to make room.
      */
     sort_order?: number;
     /**
-     * Attribute value.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be non-blank and unique across all attributes in the account, not just
+     * within the property.
      */
     value?: string;
 }
 export interface AttributeDeleteResponse {
 }
-export interface AttributeCreateParams {
+export interface AttributeListParams {
     /**
-     * Attribute value.
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
      */
-    value: string;
+    cursor?: string;
     /**
-     * Color code. Randomly assigned if not provided.
+     * Maximum number of results to return in a single page.
      */
-    color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+    limit?: number;
     /**
-     * Display order. Defaults to last position if not provided.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
-    sort_order?: number;
+    q?: string;
 }
 export interface AttributeRetrieveParams {
     /**
@@ -127,37 +171,55 @@ export interface AttributeRetrieveParams {
      */
     property_id: string;
 }
-export interface AttributeUpdateParams {
+export interface AttributeCreateParams {
     /**
-     * Path param: Property ID.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be unique across all attributes in the account, not just within the
+     * property. Leading and trailing whitespace is trimmed.
      */
-    property_id: string;
+    value: string;
     /**
-     * Body param: Color code.
+     * Swatch color used to display this attribute in the UI.
+     *
+     * When omitted, one of the nine named colors (everything except `default`) is
+     * assigned at random.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Body param: Display order. Must be a positive integer.
+     * Position of the new attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count plus one; siblings at or
+     * after this position are shifted one position later. Defaults to the last
+     * position if not provided.
      */
     sort_order?: number;
+}
+export interface AttributeUpdateParams {
     /**
-     * Body param: Attribute value.
+     * Path param: Property ID.
      */
-    value?: string;
-}
-export interface AttributeListParams {
+    property_id: string;
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Body param: Swatch color used to display this attribute in the UI.
      */
-    cursor?: string;
+    color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: New position of this attribute relative to its siblings within the
+     * property, starting at `1`.
+     *
+     * Must be at most the property's current attribute count; the attributes between
+     * the old and new positions shift to make room.
      */
-    limit?: number;
+    sort_order?: number;
     /**
-     * Search query used to filter results.
+     * Body param: The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be non-blank and unique across all attributes in the account, not just
+     * within the property.
      */
-    q?: string;
+    value?: string;
 }
 export interface AttributeDeleteParams {
     /**
@@ -166,6 +228,6 @@ export interface AttributeDeleteParams {
     property_id: string;
 }
 export declare namespace Attributes {
-    export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeCreateParams as AttributeCreateParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeListParams as AttributeListParams, type AttributeDeleteParams as AttributeDeleteParams, };
+    export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeListParams as AttributeListParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeCreateParams as AttributeCreateParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
 }
 //# sourceMappingURL=attributes.d.mts.map

package/resources/catalog/properties/attributes.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;OAUG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"attributes.d.mts","sourceRoot":"","sources":["../../../src/resources/catalog/properties/attributes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC;IAI1C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAKtC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAItC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAIvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;CAAG;AAE3C,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE1G;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/catalog/properties/attributes.d.ts

@@ -7,21 +7,24 @@ import { RequestOptions } from "../../../internal/request-options.js";
  */
 export declare class Attributes extends APIResource {
     /**
-     * Creates an attribute under a property.
+     * Returns a paginated list of attributes for a property.
+     *
+     * This endpoint requires the permission: `properties:read`.
      *
      * @example
      * ```ts
-     * const attribute =
-     *   await client.catalog.properties.attributes.create(
+     * const listAttribute =
+     *   await client.catalog.properties.attributes.list(
      *     'pp_01e21344878064372f69e67093',
-     *     { value: 'Red' },
      *   );
      * ```
      */
-    create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
+    list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
     /**
      * Returns an attribute by ID within a property.
      *
+     * This endpoint requires the permission: `properties:read`.
+     *
      * @example
      * ```ts
      * const attribute =
@@ -33,33 +36,50 @@ export declare class Attributes extends APIResource {
      */
     retrieve(id: string, params: AttributeRetrieveParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
-     * Partially updates an attribute.
+     * Creates an attribute under a property.
+     *
+     * This endpoint requires the permission: `properties:create`.
      *
      * @example
      * ```ts
      * const attribute =
-     *   await client.catalog.properties.attributes.update(
-     *     'at_01c9493ec0c46bb0ed12708ae4',
-     *     { property_id: 'pp_01e21344878064372f69e67093' },
+     *   await client.catalog.properties.attributes.create(
+     *     'pp_01e21344878064372f69e67093',
+     *     {
+     *       value: 'Red',
+     *       color: 'red',
+     *       sort_order: 1,
+     *     },
      *   );
      * ```
      */
-    update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
+    create(propertyID: string, body: AttributeCreateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
-     * Returns a paginated list of attributes for a property.
+     * Partially updates an attribute.
+     *
+     * This endpoint requires the permission: `properties:update`.
      *
      * @example
      * ```ts
-     * const listAttribute =
-     *   await client.catalog.properties.attributes.list(
-     *     'pp_01e21344878064372f69e67093',
+     * const attribute =
+     *   await client.catalog.properties.attributes.update(
+     *     'at_01c9493ec0c46bb0ed12708ae4',
+     *     {
+     *       property_id: 'pp_01e21344878064372f69e67093',
+     *       value: 'Blue',
+     *     },
      *   );
      * ```
      */
-    list(propertyID: string, query?: AttributeListParams | null | undefined, options?: RequestOptions): APIPromise<PropertiesAPI.ListAttribute>;
+    update(id: string, params: AttributeUpdateParams, options?: RequestOptions): APIPromise<PropertiesAPI.Attribute>;
     /**
      * Deletes an attribute from a property.
      *
+     * Remaining attributes in the property are shifted so their sort orders stay
+     * contiguous.
+     *
+     * This endpoint requires the permission: `properties:delete`.
+     *
      * @example
      * ```ts
      * const attribute =
@@ -76,15 +96,26 @@ export declare class Attributes extends APIResource {
  */
 export interface CreateAttributeRequest {
     /**
-     * Attribute value.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be unique across all attributes in the account, not just within the
+     * property. Leading and trailing whitespace is trimmed.
      */
     value: string;
     /**
-     * Color code. Randomly assigned if not provided.
+     * Swatch color used to display this attribute in the UI.
+     *
+     * When omitted, one of the nine named colors (everything except `default`) is
+     * assigned at random.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Display order. Defaults to last position if not provided.
+     * Position of the new attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count plus one; siblings at or
+     * after this position are shifted one position later. Defaults to the last
+     * position if not provided.
      */
     sort_order?: number;
 }
@@ -93,33 +124,46 @@ export interface CreateAttributeRequest {
  */
 export interface UpdateAttributeRequest {
     /**
-     * Color code.
+     * Swatch color used to display this attribute in the UI.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Display order. Must be a positive integer.
+     * New position of this attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count; the attributes between
+     * the old and new positions shift to make room.
      */
     sort_order?: number;
     /**
-     * Attribute value.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be non-blank and unique across all attributes in the account, not just
+     * within the property.
      */
     value?: string;
 }
 export interface AttributeDeleteResponse {
 }
-export interface AttributeCreateParams {
+export interface AttributeListParams {
     /**
-     * Attribute value.
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
      */
-    value: string;
+    cursor?: string;
     /**
-     * Color code. Randomly assigned if not provided.
+     * Maximum number of results to return in a single page.
      */
-    color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+    limit?: number;
     /**
-     * Display order. Defaults to last position if not provided.
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
      */
-    sort_order?: number;
+    q?: string;
 }
 export interface AttributeRetrieveParams {
     /**
@@ -127,37 +171,55 @@ export interface AttributeRetrieveParams {
      */
     property_id: string;
 }
-export interface AttributeUpdateParams {
+export interface AttributeCreateParams {
     /**
-     * Path param: Property ID.
+     * The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be unique across all attributes in the account, not just within the
+     * property. Leading and trailing whitespace is trimmed.
      */
-    property_id: string;
+    value: string;
     /**
-     * Body param: Color code.
+     * Swatch color used to display this attribute in the UI.
+     *
+     * When omitted, one of the nine named colors (everything except `default`) is
+     * assigned at random.
      */
     color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Body param: Display order. Must be a positive integer.
+     * Position of the new attribute relative to its siblings within the property,
+     * starting at `1`.
+     *
+     * Must be at most the property's current attribute count plus one; siblings at or
+     * after this position are shifted one position later. Defaults to the last
+     * position if not provided.
      */
     sort_order?: number;
+}
+export interface AttributeUpdateParams {
     /**
-     * Body param: Attribute value.
+     * Path param: Property ID.
      */
-    value?: string;
-}
-export interface AttributeListParams {
+    property_id: string;
     /**
-     * Cursor token used to retrieve the next or previous page of results.
+     * Body param: Swatch color used to display this attribute in the UI.
      */
-    cursor?: string;
+    color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
     /**
-     * Maximum number of results per page (default: 100, max: 1000).
+     * Body param: New position of this attribute relative to its siblings within the
+     * property, starting at `1`.
+     *
+     * Must be at most the property's current attribute count; the attributes between
+     * the old and new positions shift to make room.
      */
-    limit?: number;
+    sort_order?: number;
     /**
-     * Search query used to filter results.
+     * Body param: The selectable value this attribute represents, such as `Red`.
+     *
+     * Must be non-blank and unique across all attributes in the account, not just
+     * within the property.
      */
-    q?: string;
+    value?: string;
 }
 export interface AttributeDeleteParams {
     /**
@@ -166,6 +228,6 @@ export interface AttributeDeleteParams {
     property_id: string;
 }
 export declare namespace Attributes {
-    export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeCreateParams as AttributeCreateParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeListParams as AttributeListParams, type AttributeDeleteParams as AttributeDeleteParams, };
+    export { type CreateAttributeRequest as CreateAttributeRequest, type UpdateAttributeRequest as UpdateAttributeRequest, type AttributeDeleteResponse as AttributeDeleteResponse, type AttributeListParams as AttributeListParams, type AttributeRetrieveParams as AttributeRetrieveParams, type AttributeCreateParams as AttributeCreateParams, type AttributeUpdateParams as AttributeUpdateParams, type AttributeDeleteParams as AttributeDeleteParams, };
 }
 //# sourceMappingURL=attributes.d.ts.map