@augno/sdk 0.1.6

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

@@ -0,0 +1,267 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as PropertiesAPI from './properties';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage properties and their attributes.
+ */
+export class Attributes extends APIResource {
+  /**
+   * Creates an attribute under a property.
+   *
+   * @example
+   * ```ts
+   * const attribute =
+   *   await client.catalog.properties.attributes.create(
+   *     'pp_01e21344878064372f69e67093',
+   *     { sort_order: 1, value: 'Red' },
+   *   );
+   * ```
+   */
+  create(
+    propertyID: string,
+    body: AttributeCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PropertiesAPI.Attribute> {
+    return this._client.post(path`/v1/catalog/properties/${propertyID}/attributes`, { body, ...options });
+  }
+
+  /**
+   * Returns an attribute by ID within a property.
+   *
+   * @example
+   * ```ts
+   * const attribute =
+   *   await client.catalog.properties.attributes.retrieve(
+   *     'at_01c9493ec0c46bb0ed12708ae4',
+   *     { property_id: 'pp_01e21344878064372f69e67093' },
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    params: AttributeRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<PropertiesAPI.Attribute> {
+    const { property_id } = params;
+    return this._client.get(path`/v1/catalog/properties/${property_id}/attributes/${id}`, options);
+  }
+
+  /**
+   * Partially updates an attribute.
+   *
+   * @example
+   * ```ts
+   * const attribute =
+   *   await client.catalog.properties.attributes.update(
+   *     'at_01c9493ec0c46bb0ed12708ae4',
+   *     {
+   *       property_id: 'pp_01e21344878064372f69e67093',
+   *       value: 'Blue',
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: AttributeUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PropertiesAPI.Attribute> {
+    const { property_id, ...body } = params;
+    return this._client.patch(path`/v1/catalog/properties/${property_id}/attributes/${id}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of attributes for a property.
+   *
+   * @example
+   * ```ts
+   * const listAttribute =
+   *   await client.catalog.properties.attributes.list(
+   *     'pp_01e21344878064372f69e67093',
+   *   );
+   * ```
+   */
+  list(
+    propertyID: string,
+    query: AttributeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PropertiesAPI.ListAttribute> {
+    return this._client.get(path`/v1/catalog/properties/${propertyID}/attributes`, { query, ...options });
+  }
+
+  /**
+   * Deletes an attribute from a property.
+   *
+   * @example
+   * ```ts
+   * const attribute =
+   *   await client.catalog.properties.attributes.delete(
+   *     'at_01c9493ec0c46bb0ed12708ae4',
+   *     { property_id: 'pp_01e21344878064372f69e67093' },
+   *   );
+   * ```
+   */
+  delete(
+    id: string,
+    params: AttributeDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<AttributeDeleteResponse> {
+    const { property_id } = params;
+    return this._client.delete(path`/v1/catalog/properties/${property_id}/attributes/${id}`, options);
+  }
+}
+
+/**
+ * Request to create an attribute.
+ */
+export interface CreateAttributeRequest {
+  /**
+   * Display order. Defaults to last position if not provided.
+   */
+  sort_order: number | null;
+
+  /**
+   * Attribute value.
+   */
+  value: string;
+
+  /**
+   * Color code. Randomly assigned if not provided.
+   */
+  color?:
+    | 'blue'
+    | 'brown'
+    | 'default'
+    | 'gray'
+    | 'green'
+    | 'orange'
+    | 'pink'
+    | 'purple'
+    | 'red'
+    | 'yellow'
+    | null;
+}
+
+/**
+ * Request to update an attribute.
+ */
+export interface UpdateAttributeRequest {
+  /**
+   * Color code.
+   */
+  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+
+  /**
+   * Display order. Must be a positive integer.
+   */
+  sort_order?: number;
+
+  /**
+   * Attribute value.
+   */
+  value?: string;
+}
+
+export interface AttributeDeleteResponse {}
+
+export interface AttributeCreateParams {
+  /**
+   * Display order. Defaults to last position if not provided.
+   */
+  sort_order: number | null;
+
+  /**
+   * Attribute value.
+   */
+  value: string;
+
+  /**
+   * Color code. Randomly assigned if not provided.
+   */
+  color?:
+    | 'blue'
+    | 'brown'
+    | 'default'
+    | 'gray'
+    | 'green'
+    | 'orange'
+    | 'pink'
+    | 'purple'
+    | 'red'
+    | 'yellow'
+    | null;
+}
+
+export interface AttributeRetrieveParams {
+  /**
+   * Property ID.
+   */
+  property_id: string;
+}
+
+export interface AttributeUpdateParams {
+  /**
+   * Path param: Property ID.
+   */
+  property_id: string;
+
+  /**
+   * Body param: Color code.
+   */
+  color?: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+
+  /**
+   * Body param: Display order. Must be a positive integer.
+   */
+  sort_order?: number;
+
+  /**
+   * Body param: Attribute value.
+   */
+  value?: string;
+}
+
+export interface AttributeListParams {
+  /**
+   * 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 interface AttributeDeleteParams {
+  /**
+   * Property ID.
+   */
+  property_id: string;
+}
+
+export declare namespace Attributes {
+  export {
+    type CreateAttributeRequest as CreateAttributeRequest,
+    type UpdateAttributeRequest as UpdateAttributeRequest,
+    type AttributeDeleteResponse as AttributeDeleteResponse,
+    type AttributeCreateParams as AttributeCreateParams,
+    type AttributeRetrieveParams as AttributeRetrieveParams,
+    type AttributeUpdateParams as AttributeUpdateParams,
+    type AttributeListParams as AttributeListParams,
+    type AttributeDeleteParams as AttributeDeleteParams,
+  };
+}

package/src/resources/catalog/properties/index.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Attributes,
+  type CreateAttributeRequest,
+  type UpdateAttributeRequest,
+  type AttributeDeleteResponse,
+  type AttributeCreateParams,
+  type AttributeRetrieveParams,
+  type AttributeUpdateParams,
+  type AttributeListParams,
+  type AttributeDeleteParams,
+} from './attributes';
+export {
+  Properties,
+  type Attribute,
+  type CreatePropertyRequest,
+  type ListAttribute,
+  type ListProperty,
+  type Property,
+  type UpdatePropertyRequest,
+  type PropertyDeleteResponse,
+  type PropertyCreateParams,
+  type PropertyRetrieveParams,
+  type PropertyUpdateParams,
+  type PropertyListParams,
+} from './properties';

package/src/resources/catalog/properties/properties.ts

@@ -0,0 +1,337 @@
+// 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 * as AttributesAPI from './attributes';
+import {
+  AttributeCreateParams,
+  AttributeDeleteParams,
+  AttributeDeleteResponse,
+  AttributeListParams,
+  AttributeRetrieveParams,
+  AttributeUpdateParams,
+  Attributes,
+  CreateAttributeRequest,
+  UpdateAttributeRequest,
+} from './attributes';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage properties and their attributes.
+ */
+export class Properties extends APIResource {
+  attributes: AttributesAPI.Attributes = new AttributesAPI.Attributes(this._client);
+
+  /**
+   * Creates a property.
+   *
+   * @example
+   * ```ts
+   * const property = await client.catalog.properties.create({
+   *   name: 'Color',
+   * });
+   * ```
+   */
+  create(params: PropertyCreateParams, options?: RequestOptions): APIPromise<Property> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/catalog/properties', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a property by ID.
+   *
+   * @example
+   * ```ts
+   * const property = await client.catalog.properties.retrieve(
+   *   'pp_01e21344878064372f69e67093',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: PropertyRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Property> {
+    return this._client.get(path`/v1/catalog/properties/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a property.
+   *
+   * @example
+   * ```ts
+   * const property = await client.catalog.properties.update(
+   *   'pp_01e21344878064372f69e67093',
+   *   { name: 'Size' },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: PropertyUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Property> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/catalog/properties/${id}`, { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of properties for the target account.
+   *
+   * @example
+   * ```ts
+   * const listProperty = await client.catalog.properties.list();
+   * ```
+   */
+  list(
+    query: PropertyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListProperty> {
+    return this._client.get('/v1/catalog/properties', { query, ...options });
+  }
+
+  /**
+   * Deletes a property and all associated attributes.
+   *
+   * @example
+   * ```ts
+   * const property = await client.catalog.properties.delete(
+   *   'pp_01e21344878064372f69e67093',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PropertyDeleteResponse> {
+    return this._client.delete(path`/v1/catalog/properties/${id}`, options);
+  }
+}
+
+/**
+ * Value option within a property.
+ */
+export interface Attribute {
+  /**
+   * Attribute ID.
+   */
+  id: string;
+
+  /**
+   * Color code.
+   */
+  color: 'blue' | 'brown' | 'default' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow';
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'attribute';
+
+  /**
+   * Property that groups attributes.
+   */
+  property: Property | null;
+
+  /**
+   * Display order.
+   */
+  sort_order: number;
+
+  /**
+   * Last update timestamp.
+   */
+  updated_at: string;
+
+  /**
+   * Attribute value.
+   */
+  value: string;
+}
+
+/**
+ * Request to create a property.
+ */
+export interface CreatePropertyRequest {
+  /**
+   * Name.
+   */
+  name: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAttribute {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Attribute>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListProperty {
+  /**
+   * Resources in this page.
+   */
+  data: Array<Property>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Property that groups attributes.
+ */
+export interface Property {
+  /**
+   * Property ID.
+   */
+  id: string;
+
+  /**
+   * List represents a paginated list of resources.
+   */
+  attributes: ListAttribute | null;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'property';
+
+  /**
+   * Last update timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to update a property.
+ */
+export interface UpdatePropertyRequest {
+  /**
+   * Name.
+   */
+  name?: string;
+}
+
+export interface PropertyDeleteResponse {}
+
+export interface PropertyCreateParams {
+  /**
+   * Body param: Name.
+   */
+  name: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'attributes'>;
+}
+
+export interface PropertyRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'attributes'>;
+}
+
+export interface PropertyUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'attributes'>;
+
+  /**
+   * Body param: Name.
+   */
+  name?: string;
+}
+
+export interface PropertyListParams {
+  /**
+   * 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<'attributes'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+Properties.Attributes = Attributes;
+
+export declare namespace Properties {
+  export {
+    type Attribute as Attribute,
+    type CreatePropertyRequest as CreatePropertyRequest,
+    type ListAttribute as ListAttribute,
+    type ListProperty as ListProperty,
+    type Property as Property,
+    type UpdatePropertyRequest as UpdatePropertyRequest,
+    type PropertyDeleteResponse as PropertyDeleteResponse,
+    type PropertyCreateParams as PropertyCreateParams,
+    type PropertyRetrieveParams as PropertyRetrieveParams,
+    type PropertyUpdateParams as PropertyUpdateParams,
+    type PropertyListParams as PropertyListParams,
+  };
+
+  export {
+    Attributes as Attributes,
+    type CreateAttributeRequest as CreateAttributeRequest,
+    type UpdateAttributeRequest as UpdateAttributeRequest,
+    type AttributeDeleteResponse as AttributeDeleteResponse,
+    type AttributeCreateParams as AttributeCreateParams,
+    type AttributeRetrieveParams as AttributeRetrieveParams,
+    type AttributeUpdateParams as AttributeUpdateParams,
+    type AttributeListParams as AttributeListParams,
+    type AttributeDeleteParams as AttributeDeleteParams,
+  };
+}

package/src/resources/catalog/properties.ts

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

package/src/resources/catalog/unit-groups/index.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  UnitGroups,
+  type CreateUnitGroupRequest,
+  type CreateUnitGroupUnitParam,
+  type ListUnitGroup,
+  type ListUnitGroupUnit,
+  type UnitGroup,
+  type UnitGroupUnit,
+  type UpdateUnitGroupRequest,
+  type UnitGroupDeleteResponse,
+  type UnitGroupCreateParams,
+  type UnitGroupRetrieveParams,
+  type UnitGroupUpdateParams,
+  type UnitGroupListParams,
+} from './unit-groups';
+export {
+  Units,
+  type CreateUnitGroupUnitRequest,
+  type UpdateUnitGroupUnitRequest,
+  type UnitDeleteResponse,
+  type UnitCreateParams,
+  type UnitRetrieveParams,
+  type UnitUpdateParams,
+  type UnitListParams,
+  type UnitDeleteParams,
+} from './units';