@augno/sdk 0.1.6 → 0.7.0

package/src/resources/operations/carriers/service-levels.ts

@@ -11,32 +11,22 @@ import { path } from '../../../internal/utils/path';
  */
 export class ServiceLevels extends APIResource {
   /**
-   * Creates a service level for a carrier.
+   * Returns a paginated list of service levels for a carrier.
    *
    * @example
    * ```ts
-   * const serviceLevel =
-   *   await client.operations.carriers.serviceLevels.create(
+   * const listServiceLevel =
+   *   await client.operations.carriers.serviceLevels.list(
    *     'cr_01784fd54c9ba197bb4e42f0e6',
-   *     {
-   *       code: 'ground',
-   *       is_default: false,
-   *       name: 'Ground Shipping',
-   *     },
    *   );
    * ```
    */
-  create(
+  list(
     carrierID: string,
-    params: ServiceLevelCreateParams,
+    query: ServiceLevelListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ServiceLevel> {
-    const { include, ...body } = params;
-    return this._client.post(path`/v1/operations/carriers/${carrierID}/service-levels`, {
-      query: { include },
-      body,
-      ...options,
-    });
+  ): APIPromise<CustomersAPI.ListServiceLevel> {
+    return this._client.get(path`/v1/operations/carriers/${carrierID}/service-levels`, { query, ...options });
   }
 
   /**
@@ -63,9 +53,40 @@ export class ServiceLevels extends APIResource {
     });
   }
 
+  /**
+   * Creates a service level for a carrier.
+   *
+   * @example
+   * ```ts
+   * const serviceLevel =
+   *   await client.operations.carriers.serviceLevels.create(
+   *     'cr_01784fd54c9ba197bb4e42f0e6',
+   *     {
+   *       code: 'ground',
+   *       is_default: false,
+   *       name: 'Ground Shipping',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    carrierID: string,
+    params: ServiceLevelCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ServiceLevel> {
+    const { include, ...body } = params;
+    return this._client.post(path`/v1/operations/carriers/${carrierID}/service-levels`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
   /**
    * Partially updates a service level.
    *
+   * System-owned service levels cannot be updated.
+   *
    * @example
    * ```ts
    * const serviceLevel =
@@ -92,27 +113,10 @@ export class ServiceLevels extends APIResource {
   }
 
   /**
-   * Returns a paginated list of service levels for a carrier.
+   * Permanently deletes a service level.
    *
-   * @example
-   * ```ts
-   * const listServiceLevel =
-   *   await client.operations.carriers.serviceLevels.list(
-   *     'cr_01784fd54c9ba197bb4e42f0e6',
-   *   );
-   * ```
-   */
-  list(
-    carrierID: string,
-    query: ServiceLevelListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ListServiceLevel> {
-    return this._client.get(path`/v1/operations/carriers/${carrierID}/service-levels`, { query, ...options });
-  }
-
-  /**
-   * Permanently deletes a service level. Fails if the service level is a default
-   * (system-synced) level.
+   * System-owned service levels and the carrier's default service level cannot be
+   * deleted; unset `is_default` first to delete a default.
    *
    * @example
    * ```ts
@@ -138,23 +142,33 @@ export class ServiceLevels extends APIResource {
  */
 export interface CreateServiceLevelRequest {
   /**
-   * Service level code.
+   * Carrier-specific code identifying this service level (e.g. `fedex_ground`).
+   *
+   * Must be unique among the carrier's service levels.
    */
   code: string;
 
   /**
-   * Default service levels are the default-selected service level for that carrier.
+   * Whether this becomes the carrier's default service level, pre-selected when the
+   * carrier is chosen.
+   *
+   * Each carrier has at most one default; setting this to `true` clears the
+   * carrier's existing default.
    */
   is_default: boolean;
 
   /**
-   * Display name.
+   * Human-readable name for the service level, shown to customers at checkout when
+   * the service level is visible.
    */
   name: string;
 
   /**
-   * Whether this service level will be available for customers to select in the
-   * customer portal.
+   * Service level visibility in the customer portal.
+   *
+   * A `visible` service level can be selected by your customers at checkout; a
+   * `hidden` one is not offered there. New service levels are visible unless set to
+   * `hidden`.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 }
@@ -164,7 +178,9 @@ export interface CreateServiceLevelRequest {
  */
 export interface UpdateServiceLevelRequest {
   /**
-   * Service level code.
+   * Carrier-specific code identifying this service level (e.g. `fedex_ground`).
+   *
+   * Must be unique among the carrier's service levels.
    */
   code?: string;
 
@@ -175,59 +191,103 @@ export interface UpdateServiceLevelRequest {
   customer_portal_visibility?: 'visible' | 'hidden';
 
   /**
-   * Default service levels are the default-selected service level for that carrier.
+   * Whether this is the carrier's default service level, pre-selected when the
+   * carrier is chosen.
+   *
+   * Each carrier has at most one default; setting this to `true` clears the
+   * carrier's existing default.
    */
   is_default?: boolean;
 
   /**
-   * Display name.
+   * Human-readable name for the service level, shown to customers at checkout when
+   * the service level is visible.
    */
   name?: string;
 }
 
 export interface ServiceLevelDeleteResponse {}
 
-export interface ServiceLevelCreateParams {
+export interface ServiceLevelListParams {
   /**
-   * Body param: Service level code.
+   * 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.
    */
-  code: string;
+  cursor?: string;
 
   /**
-   * Body param: Default service levels are the default-selected service level for
-   * that carrier.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  is_default: boolean;
+  include?: Array<'owner' | 'owner.account'>;
 
   /**
-   * Body param: Display name.
+   * Maximum number of results to return in a single page.
    */
-  name: string;
+  limit?: number;
+
+  /**
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
+   */
+  q?: string;
+}
+
+export interface ServiceLevelRetrieveParams {
+  /**
+   * Path param: Carrier ID.
+   */
+  carrier_id: string;
 
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
    */
   include?: Array<'owner' | 'owner.account'>;
+}
 
+export interface ServiceLevelCreateParams {
   /**
-   * Body param: Whether this service level will be available for customers to select
-   * in the customer portal.
+   * Body param: Carrier-specific code identifying this service level (e.g.
+   * `fedex_ground`).
+   *
+   * Must be unique among the carrier's service levels.
    */
-  customer_portal_visibility?: 'visible' | 'hidden';
-}
+  code: string;
 
-export interface ServiceLevelRetrieveParams {
   /**
-   * Path param: Carrier ID.
+   * Body param: Whether this becomes the carrier's default service level,
+   * pre-selected when the carrier is chosen.
+   *
+   * Each carrier has at most one default; setting this to `true` clears the
+   * carrier's existing default.
    */
-  carrier_id: string;
+  is_default: boolean;
+
+  /**
+   * Body param: Human-readable name for the service level, shown to customers at
+   * checkout when the service level is visible.
+   */
+  name: string;
 
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
    */
   include?: Array<'owner' | 'owner.account'>;
+
+  /**
+   * Body param: Service level visibility in the customer portal.
+   *
+   * A `visible` service level can be selected by your customers at checkout; a
+   * `hidden` one is not offered there. New service levels are visible unless set to
+   * `hidden`.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
 }
 
 export interface ServiceLevelUpdateParams {
@@ -243,7 +303,10 @@ export interface ServiceLevelUpdateParams {
   include?: Array<'owner' | 'owner.account'>;
 
   /**
-   * Body param: Service level code.
+   * Body param: Carrier-specific code identifying this service level (e.g.
+   * `fedex_ground`).
+   *
+   * Must be unique among the carrier's service levels.
    */
   code?: string;
 
@@ -254,40 +317,21 @@ export interface ServiceLevelUpdateParams {
   customer_portal_visibility?: 'visible' | 'hidden';
 
   /**
-   * Body param: Default service levels are the default-selected service level for
-   * that carrier.
+   * Body param: Whether this is the carrier's default service level, pre-selected
+   * when the carrier is chosen.
+   *
+   * Each carrier has at most one default; setting this to `true` clears the
+   * carrier's existing default.
    */
   is_default?: boolean;
 
   /**
-   * Body param: Display name.
+   * Body param: Human-readable name for the service level, shown to customers at
+   * checkout when the service level is visible.
    */
   name?: string;
 }
 
-export interface ServiceLevelListParams {
-  /**
-   * 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'>;
-
-  /**
-   * Maximum number of results per page (default: 100, max: 1000).
-   */
-  limit?: number;
-
-  /**
-   * Search query used to filter results.
-   */
-  q?: string;
-}
-
 export interface ServiceLevelDeleteParams {
   /**
    * Carrier ID.
@@ -300,10 +344,10 @@ export declare namespace ServiceLevels {
     type CreateServiceLevelRequest as CreateServiceLevelRequest,
     type UpdateServiceLevelRequest as UpdateServiceLevelRequest,
     type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse,
-    type ServiceLevelCreateParams as ServiceLevelCreateParams,
+    type ServiceLevelListParams as ServiceLevelListParams,
     type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams,
+    type ServiceLevelCreateParams as ServiceLevelCreateParams,
     type ServiceLevelUpdateParams as ServiceLevelUpdateParams,
-    type ServiceLevelListParams as ServiceLevelListParams,
     type ServiceLevelDeleteParams as ServiceLevelDeleteParams,
   };
 }

package/src/resources/operations/index.ts

@@ -6,10 +6,10 @@ export {
   type ListCarrier,
   type UpdateCarrierRequest,
   type CarrierDeleteResponse,
-  type CarrierCreateParams,
+  type CarrierListParams,
   type CarrierRetrieveParams,
+  type CarrierCreateParams,
   type CarrierUpdateParams,
-  type CarrierListParams,
 } from './carriers/index';
 export {
   LocationTypes,
@@ -22,10 +22,10 @@ export {
   type CreateLocationRequest,
   type UpdateLocationRequest,
   type LocationDeleteResponse,
-  type LocationCreateParams,
+  type LocationListParams,
   type LocationRetrieveParams,
+  type LocationCreateParams,
   type LocationUpdateParams,
-  type LocationListParams,
 } from './locations';
 export { Operations } from './operations';
 export {
@@ -33,10 +33,10 @@ export {
   type CreateScanningStationRequest,
   type UpdateScanningStationRequest,
   type ScanningStationDeleteResponse,
-  type ScanningStationCreateParams,
+  type ScanningStationListParams,
   type ScanningStationRetrieveParams,
+  type ScanningStationCreateParams,
   type ScanningStationUpdateParams,
-  type ScanningStationListParams,
 } from './scanning-stations';
 export {
   ShippingTerms,
@@ -44,8 +44,8 @@ export {
   type ListShippingTerm,
   type UpdateShippingTermRequest,
   type ShippingTermDeleteResponse,
-  type ShippingTermCreateParams,
+  type ShippingTermListParams,
   type ShippingTermRetrieveParams,
+  type ShippingTermCreateParams,
   type ShippingTermUpdateParams,
-  type ShippingTermListParams,
 } from './shipping-terms';

package/src/resources/operations/location-types.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as CustomersAPI from '../sales/customers/customers';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -10,21 +11,6 @@ import { path } from '../../internal/utils/path';
  * List and manage locations.
  */
 export class LocationTypes extends APIResource {
-  /**
-   * Returns a location type by ID or code.
-   *
-   * @example
-   * ```ts
-   * const locationType =
-   *   await client.operations.locationTypes.retrieve(
-   *     'lc_01e69cd3745a1bc0dd485986c0',
-   *   );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<LocationType> {
-    return this._client.get(path`/v1/operations/location-types/${id}`, options);
-  }
-
   /**
    * Returns a paginated list of location types.
    *
@@ -40,6 +26,21 @@ export class LocationTypes extends APIResource {
   ): APIPromise<ListLocationType> {
     return this._client.get('/v1/operations/location-types', { query, ...options });
   }
+
+  /**
+   * Returns a location type by ID or code.
+   *
+   * @example
+   * ```ts
+   * const locationType =
+   *   await client.operations.locationTypes.retrieve(
+   *     'lc_01e69cd3745a1bc0dd485986c0',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<LocationType> {
+    return this._client.get(path`/v1/operations/location-types/${id}`, options);
+  }
 }
 
 /**
@@ -63,18 +64,26 @@ export interface ListLocationType {
 }
 
 /**
- * LocationType resource.
+ * A level in the storage location hierarchy, such as a building or a bin.
  */
 export interface LocationType {
   /**
-   * Location ID.
+   * Location type ID.
    */
   id: string;
 
   /**
-   * Location type code.
+   * Location type code, identifying the level of the storage hierarchy this type
+   * represents.
+   *
+   * - `building`: a building-level location.
+   * - `section`: a section within a building.
+   * - `aisle`: an aisle within a section.
+   * - `rack`: a rack within an aisle.
+   * - `shelf`: a shelf within a rack.
+   * - `bin`: a bin within a shelf.
    */
-  code: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+  code: CustomersAPI.LocationTypeCode;
 
   /**
    * Creation timestamp.
@@ -82,7 +91,7 @@ export interface LocationType {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name of the location type.
    */
   name: string;
 
@@ -99,17 +108,23 @@ export interface LocationType {
 
 export interface LocationTypeListParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Maximum number of results to return in a single page.
    */
   limit?: number;
 
   /**
-   * Search query used to filter results.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
   q?: string;
 }