@augno/sdk 0.1.6

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

@@ -0,0 +1,239 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.mjs";
+import * as CustomersAPI from "../sales/customers/customers.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * List and manage shipping terms.
+ */
+export declare class ShippingTerms extends APIResource {
+    /**
+     * Creates an account-owned shipping term.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *     free_shipping_service_level_ids: [],
+     *   });
+     * ```
+     */
+    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    /**
+     * Returns a shipping term by ID.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.retrieve(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    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.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
+     * ```
+     */
+    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    /**
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
+     *
+     * @example
+     * ```ts
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
+     * ```
+     */
+    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
+    /**
+     * Deletes an account-owned shipping term. Default shipping terms cannot be
+     * deleted.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.delete(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<ShippingTermDeleteResponse>;
+}
+/**
+ * Request to create a shipping term.
+ */
+export interface CreateShippingTermRequest {
+    /**
+     * Display name.
+     */
+    name: string;
+    /**
+     * Shipping term type.
+     */
+    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Service level IDs that qualify for free shipping.
+     */
+    free_shipping_service_level_ids?: Array<string>;
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListShippingTerm {
+    /**
+     * Resources in this page.
+     */
+    data: Array<CustomersAPI.ShippingTerm>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    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.
+ */
+export interface UpdateShippingTermRequest {
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Service level IDs that qualify for free shipping. Send null to clear.
+     */
+    free_shipping_service_level_ids?: Array<string> | null;
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+    /**
+     * Display name.
+     */
+    name?: string;
+    /**
+     * Shipping term type.
+     */
+    type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+}
+export interface ShippingTermDeleteResponse {
+}
+export interface ShippingTermCreateParams {
+    /**
+     * Body param: Display name.
+     */
+    name: string;
+    /**
+     * Body param: Shipping term type.
+     */
+    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+    /**
+     * Query param: 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'>;
+    /**
+     * Body param: QuantityInput represents a value with an associated unit for
+     * create/update requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Service level IDs that qualify for free shipping.
+     */
+    free_shipping_service_level_ids?: Array<string>;
+    /**
+     * Body param: QuantityInput represents a value with an associated unit for
+     * create/update requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+}
+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
+     * are returned as `null`.
+     */
+    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.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Service level IDs that qualify for free shipping. 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.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Display name.
+     */
+    name?: string;
+    /**
+     * Body param: Shipping term type.
+     */
+    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, };
+}
+//# sourceMappingURL=shipping-terms.d.mts.map

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

@@ -0,0 +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;;;;;;;;;;;;OAYG;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,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;CACzD;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,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;CACzD;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"}

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

@@ -0,0 +1,239 @@
+import { APIResource } from "../../core/resource.js";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
+import * as CustomersAPI from "../sales/customers/customers.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * List and manage shipping terms.
+ */
+export declare class ShippingTerms extends APIResource {
+    /**
+     * Creates an account-owned shipping term.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *     free_shipping_service_level_ids: [],
+     *   });
+     * ```
+     */
+    create(params: ShippingTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    /**
+     * Returns a shipping term by ID.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.retrieve(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    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.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
+     * ```
+     */
+    update(id: string, params?: ShippingTermUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomersAPI.ShippingTerm>;
+    /**
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
+     *
+     * @example
+     * ```ts
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
+     * ```
+     */
+    list(query?: ShippingTermListParams | null | undefined, options?: RequestOptions): APIPromise<ListShippingTerm>;
+    /**
+     * Deletes an account-owned shipping term. Default shipping terms cannot be
+     * deleted.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.delete(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<ShippingTermDeleteResponse>;
+}
+/**
+ * Request to create a shipping term.
+ */
+export interface CreateShippingTermRequest {
+    /**
+     * Display name.
+     */
+    name: string;
+    /**
+     * Shipping term type.
+     */
+    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Service level IDs that qualify for free shipping.
+     */
+    free_shipping_service_level_ids?: Array<string>;
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListShippingTerm {
+    /**
+     * Resources in this page.
+     */
+    data: Array<CustomersAPI.ShippingTerm>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    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.
+ */
+export interface UpdateShippingTermRequest {
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Service level IDs that qualify for free shipping. Send null to clear.
+     */
+    free_shipping_service_level_ids?: Array<string> | null;
+    /**
+     * QuantityInput represents a value with an associated unit for create/update
+     * requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+    /**
+     * Display name.
+     */
+    name?: string;
+    /**
+     * Shipping term type.
+     */
+    type?: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+}
+export interface ShippingTermDeleteResponse {
+}
+export interface ShippingTermCreateParams {
+    /**
+     * Body param: Display name.
+     */
+    name: string;
+    /**
+     * Body param: Shipping term type.
+     */
+    type: 'free_freight' | 'flat_rate_freight' | 'carrier_rate_freight';
+    /**
+     * Query param: 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'>;
+    /**
+     * Body param: QuantityInput represents a value with an associated unit for
+     * create/update requests.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Service level IDs that qualify for free shipping.
+     */
+    free_shipping_service_level_ids?: Array<string>;
+    /**
+     * Body param: QuantityInput represents a value with an associated unit for
+     * create/update requests.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+}
+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
+     * are returned as `null`.
+     */
+    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.
+     */
+    flat_rate?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Service level IDs that qualify for free shipping. 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.
+     */
+    minimum_order_value?: CustomersAPI.QuantityInput | null;
+    /**
+     * Body param: Display name.
+     */
+    name?: string;
+    /**
+     * Body param: Shipping term type.
+     */
+    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, };
+}
+//# sourceMappingURL=shipping-terms.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-terms.d.ts","sourceRoot":"","sources":["../../src/resources/operations/shipping-terms.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,KAAK,YAAY,wCAAqC;AAC7D,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;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;;;;;;;;;;;;OAYG;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,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;CACzD;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,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,+BAA+B,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,aAAa,GAAG,IAAI,CAAC;CACzD;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"}

package/resources/operations/shipping-terms.js

@@ -0,0 +1,93 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippingTerms = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * List and manage shipping terms.
+ */
+class ShippingTerms extends resource_1.APIResource {
+    /**
+     * Creates an account-owned shipping term.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *     free_shipping_service_level_ids: [],
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/operations/shipping-terms', { query: { include }, body, ...options });
+    }
+    /**
+     * Returns a shipping term by ID.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.retrieve(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/operations/shipping-terms/${id}`, { query, ...options });
+    }
+    /**
+     * Partially updates an account-owned shipping term. Default shipping terms cannot
+     * be updated.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch((0, path_1.path) `/v1/operations/shipping-terms/${id}`, {
+            query: { include },
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
+     *
+     * @example
+     * ```ts
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/operations/shipping-terms', { query, ...options });
+    }
+    /**
+     * Deletes an account-owned shipping term. Default shipping terms cannot be
+     * deleted.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.delete(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/operations/shipping-terms/${id}`, options);
+    }
+}
+exports.ShippingTerms = ShippingTerms;
+//# sourceMappingURL=shipping-terms.js.map

package/resources/operations/shipping-terms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-terms.js","sourceRoot":"","sources":["../../src/resources/operations/shipping-terms.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE;YACnE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;CACF;AAhGD,sCAgGC"}

package/resources/operations/shipping-terms.mjs

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * List and manage shipping terms.
+ */
+export class ShippingTerms extends APIResource {
+    /**
+     * Creates an account-owned shipping term.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.create({
+     *     name: 'Prepaid',
+     *     type: 'carrier_rate_freight',
+     *     free_shipping_service_level_ids: [],
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { include, ...body } = params;
+        return this._client.post('/v1/operations/shipping-terms', { query: { include }, body, ...options });
+    }
+    /**
+     * Returns a shipping term by ID.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.retrieve(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/v1/operations/shipping-terms/${id}`, { query, ...options });
+    }
+    /**
+     * Partially updates an account-owned shipping term. Default shipping terms cannot
+     * be updated.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.update(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *     { name: 'Collect' },
+     *   );
+     * ```
+     */
+    update(id, params = {}, options) {
+        const { include, ...body } = params ?? {};
+        return this._client.patch(path `/v1/operations/shipping-terms/${id}`, {
+            query: { include },
+            body,
+            ...options,
+        });
+    }
+    /**
+     * Returns a paginated list of shipping terms for the account, including default
+     * system shipping terms.
+     *
+     * @example
+     * ```ts
+     * const listShippingTerm =
+     *   await client.operations.shippingTerms.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/operations/shipping-terms', { query, ...options });
+    }
+    /**
+     * Deletes an account-owned shipping term. Default shipping terms cannot be
+     * deleted.
+     *
+     * @example
+     * ```ts
+     * const shippingTerm =
+     *   await client.operations.shippingTerms.delete(
+     *     'shtm_014341ab4bb5bf94d5b6936f86',
+     *   );
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete(path `/v1/operations/shipping-terms/${id}`, options);
+    }
+}
+//# sourceMappingURL=shipping-terms.mjs.map

package/resources/operations/shipping-terms.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipping-terms.mjs","sourceRoot":"","sources":["../../src/resources/operations/shipping-terms.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAKlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAgC,EAAE,OAAwB;QAC/D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,SAAsD,EAAE,EACxD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE;YACnE,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iCAAiC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;CACF"}