@augno/sdk 0.1.6

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

@@ -0,0 +1,309 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+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';
+
+/**
+ * List and manage service levels (shipping service levels).
+ */
+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,
+    });
+  }
+
+  /**
+   * Returns a service level by ID.
+   *
+   * @example
+   * ```ts
+   * const serviceLevel =
+   *   await client.operations.carriers.serviceLevels.retrieve(
+   *     'crop_01cfaf03f104e90ef9680e2a30',
+   *     { carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6' },
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: ServiceLevelRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ServiceLevel> {
+    const { carrier_id, ...query } = params;
+    return this._client.get(path`/v1/operations/carriers/${carrier_id}/service-levels/${id}`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Partially updates a service level.
+   *
+   * @example
+   * ```ts
+   * const serviceLevel =
+   *   await client.operations.carriers.serviceLevels.update(
+   *     'crop_01cfaf03f104e90ef9680e2a30',
+   *     {
+   *       carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
+   *       name: 'Express Shipping',
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: ServiceLevelUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.ServiceLevel> {
+    const { carrier_id, include, ...body } = params;
+    return this._client.patch(path`/v1/operations/carriers/${carrier_id}/service-levels/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of service levels for a carrier.
+   *
+   * @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.
+   *
+   * @example
+   * ```ts
+   * const serviceLevel =
+   *   await client.operations.carriers.serviceLevels.delete(
+   *     'crop_01cfaf03f104e90ef9680e2a30',
+   *     { carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6' },
+   *   );
+   * ```
+   */
+  delete(
+    id: string,
+    params: ServiceLevelDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ServiceLevelDeleteResponse> {
+    const { carrier_id } = params;
+    return this._client.delete(path`/v1/operations/carriers/${carrier_id}/service-levels/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a service level.
+ */
+export interface CreateServiceLevelRequest {
+  /**
+   * Service level code.
+   */
+  code: string;
+
+  /**
+   * Default service levels are the default-selected service level for that carrier.
+   */
+  is_default: boolean;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Whether this service level will be available for customers to select in the
+   * customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+}
+
+/**
+ * Request to update a service level.
+ */
+export interface UpdateServiceLevelRequest {
+  /**
+   * Service level code.
+   */
+  code?: string;
+
+  /**
+   * Whether this service level will be available for customers to select in the
+   * customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Default service levels are the default-selected service level for that carrier.
+   */
+  is_default?: boolean;
+
+  /**
+   * Display name.
+   */
+  name?: string;
+}
+
+export interface ServiceLevelDeleteResponse {}
+
+export interface ServiceLevelCreateParams {
+  /**
+   * Body param: Service level code.
+   */
+  code: string;
+
+  /**
+   * Body param: Default service levels are the default-selected service level for
+   * that carrier.
+   */
+  is_default: boolean;
+
+  /**
+   * Body param: Display name.
+   */
+  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: Whether this service level will be available for customers to select
+   * in the customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+}
+
+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 ServiceLevelUpdateParams {
+  /**
+   * 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'>;
+
+  /**
+   * Body param: Service level code.
+   */
+  code?: string;
+
+  /**
+   * Body param: Whether this service level will be available for customers to select
+   * in the customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Body param: Default service levels are the default-selected service level for
+   * that carrier.
+   */
+  is_default?: boolean;
+
+  /**
+   * Body param: Display name.
+   */
+  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.
+   */
+  carrier_id: string;
+}
+
+export declare namespace ServiceLevels {
+  export {
+    type CreateServiceLevelRequest as CreateServiceLevelRequest,
+    type UpdateServiceLevelRequest as UpdateServiceLevelRequest,
+    type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse,
+    type ServiceLevelCreateParams as ServiceLevelCreateParams,
+    type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams,
+    type ServiceLevelUpdateParams as ServiceLevelUpdateParams,
+    type ServiceLevelListParams as ServiceLevelListParams,
+    type ServiceLevelDeleteParams as ServiceLevelDeleteParams,
+  };
+}

package/src/resources/operations/carriers.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './carriers/index';

package/src/resources/operations/index.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Carriers,
+  type CreateCarrierRequest,
+  type ListCarrier,
+  type UpdateCarrierRequest,
+  type CarrierDeleteResponse,
+  type CarrierCreateParams,
+  type CarrierRetrieveParams,
+  type CarrierUpdateParams,
+  type CarrierListParams,
+} from './carriers/index';
+export {
+  LocationTypes,
+  type ListLocationType,
+  type LocationType,
+  type LocationTypeListParams,
+} from './location-types';
+export {
+  Locations,
+  type CreateLocationRequest,
+  type UpdateLocationRequest,
+  type LocationDeleteResponse,
+  type LocationCreateParams,
+  type LocationRetrieveParams,
+  type LocationUpdateParams,
+  type LocationListParams,
+} from './locations';
+export { Operations } from './operations';
+export {
+  ScanningStations,
+  type CreateScanningStationRequest,
+  type UpdateScanningStationRequest,
+  type ScanningStationDeleteResponse,
+  type ScanningStationCreateParams,
+  type ScanningStationRetrieveParams,
+  type ScanningStationUpdateParams,
+  type ScanningStationListParams,
+} from './scanning-stations';
+export {
+  ShippingTerms,
+  type CreateShippingTermRequest,
+  type ListShippingTerm,
+  type UpdateShippingTermRequest,
+  type ShippingTermDeleteResponse,
+  type ShippingTermCreateParams,
+  type ShippingTermRetrieveParams,
+  type ShippingTermUpdateParams,
+  type ShippingTermListParams,
+} from './shipping-terms';

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

@@ -0,0 +1,123 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+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.
+   *
+   * @example
+   * ```ts
+   * const listLocationType =
+   *   await client.operations.locationTypes.list();
+   * ```
+   */
+  list(
+    query: LocationTypeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListLocationType> {
+    return this._client.get('/v1/operations/location-types', { query, ...options });
+  }
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListLocationType {
+  /**
+   * Resources in this page.
+   */
+  data: Array<LocationType>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * LocationType resource.
+ */
+export interface LocationType {
+  /**
+   * Location ID.
+   */
+  id: string;
+
+  /**
+   * Location type code.
+   */
+  code: 'building' | 'section' | 'aisle' | 'rack' | 'shelf' | 'bin';
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'location_type';
+
+  /**
+   * Last-updated timestamp.
+   */
+  updated_at: string;
+}
+
+export interface LocationTypeListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+export declare namespace LocationTypes {
+  export {
+    type ListLocationType as ListLocationType,
+    type LocationType as LocationType,
+    type LocationTypeListParams as LocationTypeListParams,
+  };
+}