@augno/sdk 0.1.9 → 0.7.0

package/resources/operations/shipping-terms.d.mts

@@ -8,19 +8,16 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class ShippingTerms extends APIResource {
     /**
-     * Creates an account-owned shipping term.
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
      *
      * @example
      * ```ts
-     * const shippingTerm =
-     *   await client.operations.shippingTerms.create({
-     *     name: 'Prepaid',
-     *     type: 'carrier_rate_freight',
-     *     free_shipping_service_level_ids: [],
-     *   });
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
      * ```
      */
-    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
     /**
      * Returns a shipping term by ID.
      *
@@ -34,32 +31,37 @@ export declare class ShippingTerms extends APIResource {
      */
     retrieve(id: string, query?: ShippingTermRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Partially updates an account-owned shipping term. Default shipping terms cannot
-     * be updated.
+     * Creates an account-owned shipping term.
      *
      * @example
      * ```ts
      * const shippingTerm =
-     *   await client.operations.shippingTerms.update(
-     *     'shtm_014341ab4bb5bf94d5b6936f86',
-     *   );
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *   });
      * ```
      */
-    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Returns a paginated list of shipping terms for the account, including default
-     * system shipping terms.
+     * Partially updates an account-owned shipping term.
+     *
+     * System-provided default shipping terms cannot be updated.
      *
      * @example
      * ```ts
-     * const listShippingTerm =
-     *   await client.operations.shippingTerms.list();
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
      * ```
      */
-    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
+    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Deletes an account-owned shipping term. Default shipping terms cannot be
-     * deleted.
+     * Deletes an account-owned shipping term.
+     *
+     * System-provided default shipping terms cannot be deleted.
      *
      * @example
      * ```ts
@@ -76,25 +78,31 @@ export declare class ShippingTerms extends APIResource {
  */
 export interface CreateShippingTermRequest {
     /**
-     * Display name.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
     name: string;
     /**
-     * Shipping term type.
+     * Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput;
     /**
-     * Service level IDs that qualify for free shipping.
+     * IDs of service levels that ship for free under this term (typically once
+     * `minimum_order_value` is met).
      */
     free_shipping_service_level_ids?: Array<string>;
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput;
 }
@@ -116,44 +124,92 @@ export interface ListShippingTerm {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Request to partially update a shipping term. All fields are optional. Absent
- * fields are left unchanged. Send an explicit JSON null for flat_rate,
- * minimum_order_value, or free_shipping_service_level_ids to clear the existing
- * value.
+ * Request to partially update a shipping term.
+ *
+ * All fields are optional and absent fields are left unchanged. Send an explicit
+ * JSON `null` for `flat_rate`, `minimum_order_value`, or
+ * `free_shipping_service_level_ids` to clear the existing value.
  */
 export interface UpdateShippingTermRequest {
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput | null;
     /**
-     * Service level IDs that qualify for free shipping. Send null to clear.
+     * IDs of service levels that ship for free under this term (typically once
+     * `minimum_order_value` is met).
+     *
+     * Replaces the existing list. Send `null` to clear.
      */
     free_shipping_service_level_ids?: Array<string> | null;
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput | null;
     /**
-     * Display name.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
     name?: string;
     /**
-     * Shipping term type.
+     * Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
 }
 export interface ShippingTermDeleteResponse {
 }
+export interface ShippingTermListParams {
+    /**
+     * 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.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export interface ShippingTermRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
+}
 export interface ShippingTermCreateParams {
     /**
-     * Body param: Display name.
+     * Body param: Human-readable name for the shipping term, used to identify it when
+     * assigning shipping terms to customers and orders.
      */
     name: string;
     /**
-     * Body param: Shipping term type.
+     * Body param: Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
@@ -162,27 +218,19 @@ export interface ShippingTermCreateParams {
      */
     include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput;
     /**
-     * Body param: Service level IDs that qualify for free shipping.
+     * Body param: IDs of service levels that ship for free under this term (typically
+     * once `minimum_order_value` is met).
      */
     free_shipping_service_level_ids?: Array<string>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput;
 }
-export interface ShippingTermRetrieveParams {
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
-}
 export interface ShippingTermUpdateParams {
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
@@ -190,49 +238,37 @@ export interface ShippingTermUpdateParams {
      */
     include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput | null;
     /**
-     * Body param: Service level IDs that qualify for free shipping. Send null to
-     * clear.
+     * Body param: IDs of service levels that ship for free under this term (typically
+     * once `minimum_order_value` is met).
+     *
+     * Replaces the existing list. Send `null` to clear.
      */
     free_shipping_service_level_ids?: Array<string> | null;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput | null;
     /**
-     * Body param: Display name.
+     * Body param: Human-readable name for the shipping term, used to identify it when
+     * assigning shipping terms to customers and orders.
      */
     name?: string;
     /**
-     * Body param: Shipping term type.
+     * Body param: Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
 }
-export interface ShippingTermListParams {
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-}
 export declare namespace ShippingTerms {
-    export { type CreateShippingTermRequest as CreateShippingTermRequest, type ListShippingTerm as ListShippingTerm, type UpdateShippingTermRequest as UpdateShippingTermRequest, type ShippingTermDeleteResponse as ShippingTermDeleteResponse, type ShippingTermCreateParams as ShippingTermCreateParams, type ShippingTermRetrieveParams as ShippingTermRetrieveParams, type ShippingTermUpdateParams as ShippingTermUpdateParams, type ShippingTermListParams as ShippingTermListParams, };
+    export { type CreateShippingTermRequest as CreateShippingTermRequest, type ListShippingTerm as ListShippingTerm, type UpdateShippingTermRequest as UpdateShippingTermRequest, type ShippingTermDeleteResponse as ShippingTermDeleteResponse, type ShippingTermListParams as ShippingTermListParams, type ShippingTermRetrieveParams as ShippingTermRetrieveParams, type ShippingTermCreateParams as ShippingTermCreateParams, type ShippingTermUpdateParams as ShippingTermUpdateParams, };
 }
 //# sourceMappingURL=shipping-terms.d.mts.map

package/resources/operations/shipping-terms.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-terms.d.mts","sourceRoot":"","sources":["../../src/resources/operations/shipping-terms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,UAAU,sCAAkC;AACxD,OAAO,KAAK,YAAY,yCAAqC;AAC7D,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IAKzG;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IASxC;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;IAEpE;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEvC;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;CACtE;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEvC;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;CAClD;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;;OAGG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;CACtE;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"shipping-terms.d.mts","sourceRoot":"","sources":["../../src/resources/operations/shipping-terms.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,YAAY;OACjB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IAKzG;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC;IASxC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;IAEpE;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEvC;;;OAGG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAE9C;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAExD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;CACtE;AAED,MAAM,WAAW,0BAA0B;CAAG;AAE9C,MAAM,WAAW,sBAAsB;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,IAAI,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;IAEpE;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;IAEvC;;;OAGG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC;CAClD;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,OAAO,GAAG,eAAe,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,8BAA8B,CAC3G,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAE9C;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;IAExD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;CACtE;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/operations/shipping-terms.d.ts

@@ -8,19 +8,16 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class ShippingTerms extends APIResource {
     /**
-     * Creates an account-owned shipping term.
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
      *
      * @example
      * ```ts
-     * const shippingTerm =
-     *   await client.operations.shippingTerms.create({
-     *     name: 'Prepaid',
-     *     type: 'carrier_rate_freight',
-     *     free_shipping_service_level_ids: [],
-     *   });
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
      * ```
      */
-    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
     /**
      * Returns a shipping term by ID.
      *
@@ -34,32 +31,37 @@ export declare class ShippingTerms extends APIResource {
      */
     retrieve(id: string, query?: ShippingTermRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Partially updates an account-owned shipping term. Default shipping terms cannot
-     * be updated.
+     * Creates an account-owned shipping term.
      *
      * @example
      * ```ts
      * const shippingTerm =
-     *   await client.operations.shippingTerms.update(
-     *     'shtm_014341ab4bb5bf94d5b6936f86',
-     *   );
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *   });
      * ```
      */
-    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Returns a paginated list of shipping terms for the account, including default
-     * system shipping terms.
+     * Partially updates an account-owned shipping term.
+     *
+     * System-provided default shipping terms cannot be updated.
      *
      * @example
      * ```ts
-     * const listShippingTerm =
-     *   await client.operations.shippingTerms.list();
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
      * ```
      */
-    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
+    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
     /**
-     * Deletes an account-owned shipping term. Default shipping terms cannot be
-     * deleted.
+     * Deletes an account-owned shipping term.
+     *
+     * System-provided default shipping terms cannot be deleted.
      *
      * @example
      * ```ts
@@ -76,25 +78,31 @@ export declare class ShippingTerms extends APIResource {
  */
 export interface CreateShippingTermRequest {
     /**
-     * Display name.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
     name: string;
     /**
-     * Shipping term type.
+     * Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput;
     /**
-     * Service level IDs that qualify for free shipping.
+     * IDs of service levels that ship for free under this term (typically once
+     * `minimum_order_value` is met).
      */
     free_shipping_service_level_ids?: Array<string>;
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput;
 }
@@ -116,44 +124,92 @@ export interface ListShippingTerm {
     page_info: APIKeysAPI.PageInfo;
 }
 /**
- * Request to partially update a shipping term. All fields are optional. Absent
- * fields are left unchanged. Send an explicit JSON null for flat_rate,
- * minimum_order_value, or free_shipping_service_level_ids to clear the existing
- * value.
+ * Request to partially update a shipping term.
+ *
+ * All fields are optional and absent fields are left unchanged. Send an explicit
+ * JSON `null` for `flat_rate`, `minimum_order_value`, or
+ * `free_shipping_service_level_ids` to clear the existing value.
  */
 export interface UpdateShippingTermRequest {
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput | null;
     /**
-     * Service level IDs that qualify for free shipping. Send null to clear.
+     * IDs of service levels that ship for free under this term (typically once
+     * `minimum_order_value` is met).
+     *
+     * Replaces the existing list. Send `null` to clear.
      */
     free_shipping_service_level_ids?: Array<string> | null;
     /**
-     * QuantityInput represents a value with an associated unit for create/update
-     * requests.
+     * A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput | null;
     /**
-     * Display name.
+     * Human-readable name for the shipping term, used to identify it when assigning
+     * shipping terms to customers and orders.
      */
     name?: string;
     /**
-     * Shipping term type.
+     * Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
 }
 export interface ShippingTermDeleteResponse {
 }
+export interface ShippingTermListParams {
+    /**
+     * 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.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export interface ShippingTermRetrieveParams {
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
+}
 export interface ShippingTermCreateParams {
     /**
-     * Body param: Display name.
+     * Body param: Human-readable name for the shipping term, used to identify it when
+     * assigning shipping terms to customers and orders.
      */
     name: string;
     /**
-     * Body param: Shipping term type.
+     * Body param: Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
     /**
@@ -162,27 +218,19 @@ export interface ShippingTermCreateParams {
      */
     include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput;
     /**
-     * Body param: Service level IDs that qualify for free shipping.
+     * Body param: IDs of service levels that ship for free under this term (typically
+     * once `minimum_order_value` is met).
      */
     free_shipping_service_level_ids?: Array<string>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput;
 }
-export interface ShippingTermRetrieveParams {
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
-}
 export interface ShippingTermUpdateParams {
     /**
      * Query param: Sub-objects to expand in the response. When omitted, sub-objects
@@ -190,49 +238,37 @@ export interface ShippingTermUpdateParams {
      */
     include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     flat_rate?: CustomersAPI.QuantityInput | null;
     /**
-     * Body param: Service level IDs that qualify for free shipping. Send null to
-     * clear.
+     * Body param: IDs of service levels that ship for free under this term (typically
+     * once `minimum_order_value` is met).
+     *
+     * Replaces the existing list. Send `null` to clear.
      */
     free_shipping_service_level_ids?: Array<string> | null;
     /**
-     * Body param: QuantityInput represents a value with an associated unit for
-     * create/update requests.
+     * Body param: A value with an associated unit, used in create and update requests.
      */
     minimum_order_value?: CustomersAPI.QuantityInput | null;
     /**
-     * Body param: Display name.
+     * Body param: Human-readable name for the shipping term, used to identify it when
+     * assigning shipping terms to customers and orders.
      */
     name?: string;
     /**
-     * Body param: Shipping term type.
+     * Body param: Freight pricing model applied by this shipping term.
+     *
+     * - `free_freight`: no shipping cost to the buyer.
+     * - `flat_rate_freight`: a fixed shipping cost regardless of order details (see
+     *   `flat_rate`).
+     * - `carrier_rate_freight`: shipping cost is determined by the carrier's quoted
+     *   rate.
      */
     type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
 }
-export interface ShippingTermListParams {
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-     * `null`.
-     */
-    include?: Array<'owner' | 'owner.account' | 'flat_rate.unit' | 'minimum_order_value.unit' | 'free_shipping_service_levels'>;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-}
 export declare namespace ShippingTerms {
-    export { type CreateShippingTermRequest as CreateShippingTermRequest, type ListShippingTerm as ListShippingTerm, type UpdateShippingTermRequest as UpdateShippingTermRequest, type ShippingTermDeleteResponse as ShippingTermDeleteResponse, type ShippingTermCreateParams as ShippingTermCreateParams, type ShippingTermRetrieveParams as ShippingTermRetrieveParams, type ShippingTermUpdateParams as ShippingTermUpdateParams, type ShippingTermListParams as ShippingTermListParams, };
+    export { type CreateShippingTermRequest as CreateShippingTermRequest, type ListShippingTerm as ListShippingTerm, type UpdateShippingTermRequest as UpdateShippingTermRequest, type ShippingTermDeleteResponse as ShippingTermDeleteResponse, type ShippingTermListParams as ShippingTermListParams, type ShippingTermRetrieveParams as ShippingTermRetrieveParams, type ShippingTermCreateParams as ShippingTermCreateParams, type ShippingTermUpdateParams as ShippingTermUpdateParams, };
 }
 //# sourceMappingURL=shipping-terms.d.ts.map