@silkline/arena 1.0.0

package/src/resources/items/items.ts

@@ -0,0 +1,748 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ItemsAPI from './items';
+import * as ComplianceAPI from './compliance';
+import {
+  Compliance,
+  ComplianceCreateParams,
+  ComplianceDeleteParams,
+  ComplianceDeleteResponse,
+  ComplianceListResponse,
+  ComplianceRetrieveParams,
+  ComplianceUpdateParams,
+  ItemCompliance,
+} from './compliance';
+import * as FuturechangesAPI from './futurechanges';
+import {
+  FuturechangeListResponse,
+  FuturechangeRetrieveParams,
+  Futurechanges,
+  ItemFutureChange,
+} from './futurechanges';
+import * as ImageAPI from './image';
+import {
+  Image,
+  ImageDeleteResponse,
+  ImageRetrieveContentResponse,
+  ImageUploadParams,
+  SingleGuid,
+} from './image';
+import * as ItemsItemsAPI from './items_';
+import {
+  ItemDeleteParams,
+  ItemGuidAndURL,
+  ItemListResponse,
+  ItemToItem,
+  Items as ItemsAPIItems,
+} from './items_';
+import * as QualityAPI from './quality';
+import { ItemQuality, Quality, QualityListResponse, QualityRetrieveParams } from './quality';
+import * as SourcingAPI from './sourcing';
+import {
+  ItemSourcing,
+  ItemSourcingResult,
+  Sourcing,
+  SourcingCreateParams,
+  SourcingDeleteParams,
+  SourcingDeleteResponse,
+  SourcingItem,
+  SourcingRetrieveParams,
+  SourcingUpdateParams,
+} from './sourcing';
+import * as TicketsAPI from './tickets';
+import { TicketRetrieveParams, Tickets } from './tickets';
+import * as TrainingplansAPI from './trainingplans';
+import {
+  TrainingplanListResponse,
+  TrainingplanRetrieveParams,
+  TrainingplanRetrieveResponse,
+  Trainingplans,
+} from './trainingplans';
+import * as TrainingrecordsAPI from './trainingrecords';
+import {
+  ItemTrainingRecord,
+  TrainingMinimal,
+  TrainingrecordListResponse,
+  TrainingrecordRetrieveParams,
+  Trainingrecords,
+} from './trainingrecords';
+import * as RequestsItemsAPI from '../requests/items';
+import * as AdministratorsAPI from '../settings/administrators';
+import * as TicketsTicketsAPI from '../tickets/tickets';
+import * as BomAPI from './bom/bom';
+import {
+  Bom,
+  BomCreateParams,
+  BomDeleteParams,
+  BomDeleteResponse,
+  BomListParams,
+  BomListResponse,
+  BomRetrieveParams,
+  BomUpdateParams,
+  ItemBom,
+} from './bom/bom';
+import * as FilesAPI from './files/files';
+import {
+  FileCreateParams,
+  FileDeleteParams,
+  FileDeleteResponse,
+  FileListResponse,
+  FileRetrieveParams,
+  FileRetrieveWatermarkContentParams,
+  FileUpdateParams,
+  Files,
+  ItemFile,
+} from './files/files';
+import { APIPromise } from '../../core/api-promise';
+import { Offset, type OffsetParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Items extends APIResource {
+  sourcing: SourcingAPI.Sourcing = new SourcingAPI.Sourcing(this._client);
+  items: ItemsItemsAPI.Items = new ItemsItemsAPI.Items(this._client);
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+  compliance: ComplianceAPI.Compliance = new ComplianceAPI.Compliance(this._client);
+  bom: BomAPI.Bom = new BomAPI.Bom(this._client);
+  image: ImageAPI.Image = new ImageAPI.Image(this._client);
+  trainingrecords: TrainingrecordsAPI.Trainingrecords = new TrainingrecordsAPI.Trainingrecords(this._client);
+  trainingplans: TrainingplansAPI.Trainingplans = new TrainingplansAPI.Trainingplans(this._client);
+  tickets: TicketsAPI.Tickets = new TicketsAPI.Tickets(this._client);
+  quality: QualityAPI.Quality = new QualityAPI.Quality(this._client);
+  futurechanges: FuturechangesAPI.Futurechanges = new FuturechangesAPI.Futurechanges(this._client);
+
+  /**
+   * Creates a new Item object.
+   *
+   * You can specify no number format, the basic number format, or a valid number
+   * format for the workspace (with or without an auto-generating sequence). In these
+   * cases, you must specify valid values for each field type in the number format.
+   * Each case is shown below.
+   *
+   * <b>NOTES:</b>
+   *
+   * 1. The values you specify for attributes must match the attribute types
+   *    specified in the workspace. For example, when specifying a value for a
+   *    predefined list, the value must be one of the allowed values.
+   * 2. Category and other IDs must exist in the workspace.
+   * 3. A category GUID is required.
+   */
+  create(body: ItemCreateParams, options?: RequestOptions): APIPromise<ItemFull> {
+    return this._client.post('/items', { body, ...options });
+  }
+
+  /**
+   * Returns an Item object with a given GUID. Note that while the standard practice
+   * is to retrieve an item GUID using the GET Items endpoint and then use an item
+   * GUID here (returning the effective revision), you can also use a GUID for a
+   * specific revision of an item here.
+   */
+  retrieve(
+    itemGuid: string,
+    query: ItemRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemFull> {
+    return this._client.get(path`/items/${itemGuid}`, { query, ...options });
+  }
+
+  /**
+   * Updates the metadata of an item with a given GUID.
+   *
+   * Editable attributes: Additional attribute values, <code>category</code>,
+   * <code>description</code>, <code>name</code>, <code>offTheShelf</code>,
+   * <code>owner</code>, <code>shared</code>, <code>standardCost</code>,
+   * <code>targetCost</code>, <code>targetPrice</code>, <code>uom</code>.
+   */
+  update(itemGuid: string, body: ItemUpdateParams, options?: RequestOptions): APIPromise<ItemFull> {
+    return this._client.put(path`/items/${itemGuid}`, { body, ...options });
+  }
+
+  /**
+   * Returns a collection of Compact Item objects matching the given search criteria.
+   */
+  list(
+    query: ItemListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ItemFullsOffset, ItemFull> {
+    return this._client.getAPIList('/items', Offset<ItemFull>, { query, ...options });
+  }
+
+  /**
+   * Deletes an item with a given GUID.
+   */
+  delete(itemGuid: string, options?: RequestOptions): APIPromise<string> {
+    return this._client.delete(path`/items/${itemGuid}`, options);
+  }
+
+  /**
+   * Returns an array of item history records. This endpoint is functionally
+   * equivalent to viewing the Items > History > General subview.
+   */
+  retrieveHistory(itemGuid: string, options?: RequestOptions): APIPromise<ItemRetrieveHistoryResponse> {
+    return this._client.get(path`/items/${itemGuid}/history`, options);
+  }
+
+  /**
+   * Returns all Item Revision objects for an item with a given GUID. The revision
+   * type is specified by the value of the "status" attribute. 0 is working revision,
+   * 1 is effective revision, 2 is past revisions.
+   */
+  retrieveRevisions(itemGuid: string, options?: RequestOptions): APIPromise<ItemRetrieveRevisionsResponse> {
+    return this._client.get(path`/items/${itemGuid}/revisions`, options);
+  }
+
+  /**
+   * Returns an array of Item objects in which the given Item appears as a BOM line,
+   * along with the line number and other attributes.
+   *
+   * Note: When <code>lineNumber</code> is null for an assembly line, either (a) line
+   * number generation is set to manual but the user has not yet entered line
+   * numbers, or (b) line number generation is set to automatic.
+   */
+  retrieveWhereUsed(itemGuid: string, options?: RequestOptions): APIPromise<ItemRetrieveWhereUsedResponse> {
+    return this._client.get(path`/items/${itemGuid}/whereused`, options);
+  }
+
+  /**
+   * Releases a new revision of an item with a given GUID to a target lifecycle phase
+   * specified within the request.
+   *
+   * Returns revision GUIDs for effective, superseded, and working revisions of the
+   * item.
+   *
+   * The following phase transitions are allowed:
+   *
+   * 1. Release to Design (move an unreleased Item to a Design stage lifecycle
+   *    phase.)
+   * 2. Make Effective in Design (make working modifications effective in a new
+   *    revision while remaining in the same Design phase.)
+   * 3. Release to Production (move a Design stage Item to a Production stage
+   *    lifecycle phase.)
+   * 4. Make Effective in Production (make working modifications effective in a new
+   *    revision while remaining in the same Production phase.)
+   *
+   * Release to Design, Make Effective in Design, and Make Effective in Production
+   * require the working revision of the item. Release to Production requires the
+   * item GUID to be the effective revision. The target lifecycle phase can be any
+   * defined for the workspace, including custom phases.
+   *
+   * This API request can generate errors, warnings, and notices. The request will
+   * fail if there is at least one error or warning. If <code>proceedOnNotice</code>
+   * is True, the request will continue if it generates notices.
+   */
+  updateLifecyclePhase(
+    body: ItemUpdateLifecyclePhaseParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemUpdateLifecyclePhaseResponse> {
+    return this._client.post('/items/lifecyclephasechanges', { body, ...options });
+  }
+}
+
+export type ItemFullsOffset = Offset<ItemFull>;
+
+export interface CategoryMinimal {
+  guid?: string;
+
+  name?: string;
+}
+
+export interface CreateFieldVo {
+  guid?: string;
+
+  value?: string;
+}
+
+export interface CreateNumberFormat {
+  fields?: Array<CreateFieldVo>;
+
+  guid?: string;
+}
+
+export interface ItemFull {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCompact>;
+
+  assemblyType?: 'TOP_LEVEL_ASSEMBLY' | 'SUB_ASSEMBLY' | 'NOT_AN_ASSEMBLY';
+
+  category?: CategoryMinimal;
+
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  description?: string;
+
+  deviated?: boolean;
+
+  effectiveDateTime?: string;
+
+  guid?: string;
+
+  inAssembly?: boolean;
+
+  isAssembly?: boolean;
+
+  isLocked?: boolean;
+
+  lifecyclePhase?: LifecyclePhaseMinimal;
+
+  materialEffectivityDateTime?: string;
+
+  modifiedBom?: boolean;
+
+  modifiedFiles?: boolean;
+
+  modifiedSourcing?: boolean;
+
+  modifiedSpecs?: boolean;
+
+  name?: string;
+
+  number?: string;
+
+  offTheShelf?: boolean;
+
+  onShape?: ItemFull.OnShape;
+
+  owner?: UserMinimal;
+
+  procurementType?: 'OTS' | 'MTS';
+
+  productionCost?: number;
+
+  prototypeCost?: number;
+
+  revisionNumber?: string;
+
+  revisionStatus?: 'WORKING' | 'EFFECTIVE' | 'SUPERSEDED' | 'PENDING';
+
+  shared?: boolean;
+
+  standardCost?: number;
+
+  status?: number;
+
+  supersededDateTime?: string;
+
+  targetCost?: number;
+
+  targetPrice?: number;
+
+  uom?: string;
+
+  url?: URL;
+}
+
+export namespace ItemFull {
+  export interface OnShape {
+    cadFileUrl?: string;
+
+    cadPackageID?: string;
+
+    diffUrl?: string;
+
+    drawingFileUrl?: string;
+
+    drawingFileUrls?: Array<string>;
+
+    mainUrl?: string;
+
+    onshape?: boolean;
+
+    viewable3DFileUrl?: string;
+  }
+}
+
+export interface LifecyclePhaseMinimal {
+  guid?: string;
+
+  name?: string;
+}
+
+export interface OwnerCreate {
+  fullName?: string;
+}
+
+export interface URL {
+  api?: string;
+
+  app?: string;
+}
+
+export interface UserMinimal {
+  fullName?: string;
+}
+
+export type ItemDeleteResponse = string;
+
+export interface ItemRetrieveHistoryResponse {
+  count?: number;
+
+  results?: Array<ItemRetrieveHistoryResponse.Result>;
+}
+
+export namespace ItemRetrieveHistoryResponse {
+  export interface Result {
+    action?: string;
+
+    date?: string;
+
+    guid?: string;
+
+    newValue?: string;
+
+    originalValue?: string;
+
+    property?: string;
+
+    revision?: string;
+
+    rowNum?: number;
+
+    user?: string;
+  }
+}
+
+export interface ItemRetrieveRevisionsResponse {
+  count?: number;
+
+  results?: Array<ItemRetrieveRevisionsResponse.Result>;
+}
+
+export namespace ItemRetrieveRevisionsResponse {
+  export interface Result {
+    change?: Result.Change;
+
+    guid?: string;
+
+    lifecyclePhase?: ItemsAPI.LifecyclePhaseMinimal;
+
+    notes?: string;
+
+    number?: string;
+
+    revisionStatus?: string;
+
+    status?: number;
+
+    supersededDateTime?: string;
+
+    url?: ItemsAPI.URL;
+  }
+
+  export namespace Result {
+    export interface Change {
+      creationDateTime?: string;
+
+      deviated?: boolean;
+
+      effectiveDateTime?: string;
+
+      guid?: string;
+
+      number?: string;
+    }
+  }
+}
+
+export interface ItemRetrieveWhereUsedResponse {
+  count?: number;
+
+  results?: Array<ItemRetrieveWhereUsedResponse.Result>;
+}
+
+export namespace ItemRetrieveWhereUsedResponse {
+  export interface Result {
+    guid?: string;
+
+    item?: RequestsItemsAPI.ItemShort;
+
+    lineNumber?: number;
+
+    notes?: string;
+
+    proceedOnNotice?: boolean;
+
+    quantity?: number;
+
+    refDes?: string;
+  }
+}
+
+export interface ItemUpdateLifecyclePhaseResponse {
+  effectiveRevItem?: ItemsItemsAPI.ItemGuidAndURL;
+
+  supersededRevItem?: ItemsItemsAPI.ItemGuidAndURL;
+
+  workingRevItem?: ItemsItemsAPI.ItemGuidAndURL;
+}
+
+export interface ItemCreateParams {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCreate>;
+
+  category?: ImageAPI.SingleGuid;
+
+  description?: string;
+
+  name?: string;
+
+  numberFormat?: CreateNumberFormat;
+
+  offTheShelf?: boolean;
+
+  owner?: OwnerCreate;
+
+  productionCost?: number;
+
+  prototypeCost?: number;
+
+  revisionNumber?: string;
+
+  shared?: boolean;
+
+  standardCost?: number;
+
+  targetCost?: number;
+
+  targetPrice?: number;
+
+  uom?: string;
+}
+
+export interface ItemRetrieveParams {
+  includeEmptyAdditionalAttributes?: boolean;
+
+  responseview?: string;
+}
+
+export interface ItemUpdateParams {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCreate>;
+
+  category?: ImageAPI.SingleGuid;
+
+  description?: string;
+
+  name?: string;
+
+  numberFormat?: CreateNumberFormat;
+
+  offTheShelf?: boolean;
+
+  owner?: OwnerCreate;
+
+  revisionNumber?: string;
+
+  shared?: boolean;
+
+  standardCost?: number;
+
+  targetCost?: number;
+
+  targetPrice?: number;
+
+  uom?: string;
+}
+
+export interface ItemListParams extends OffsetParams {
+  assemblyType?: 'TOP_LEVEL_ASSEMBLY' | 'SUB_ASSEMBLY' | 'NOT_AN_ASSEMBLY';
+
+  category?: ItemListParams.Category;
+
+  creator?: ItemListParams.Creator;
+
+  description?: string;
+
+  effectiveDateTime?: string;
+
+  inAssembly?: boolean;
+
+  includeChildCategories?: boolean;
+
+  lifecyclePhase?: ItemListParams.LifecyclePhase;
+
+  modifiedBom?: boolean;
+
+  modifiedFiles?: boolean;
+
+  modifiedSourcing?: boolean;
+
+  modifiedSpecs?: boolean;
+
+  name?: string;
+
+  number?: string;
+
+  owner?: ItemListParams.Owner;
+
+  responseview?: string;
+
+  revisionNumber?: string;
+}
+
+export namespace ItemListParams {
+  export interface Category {
+    guid?: string;
+
+    name?: string;
+  }
+
+  export interface Creator {
+    email?: string;
+
+    fullName?: string;
+
+    guid?: string;
+  }
+
+  export interface LifecyclePhase {
+    guid?: string;
+
+    stage?: string;
+  }
+
+  export interface Owner {
+    fullName?: string;
+  }
+}
+
+export interface ItemUpdateLifecyclePhaseParams {
+  item?: ImageAPI.SingleGuid;
+
+  notes?: string;
+
+  proceedOnNotice?: boolean;
+
+  revisionNumber?: string;
+
+  toLifecyclePhase?: ImageAPI.SingleGuid;
+}
+
+Items.Sourcing = Sourcing;
+Items.Items = ItemsAPIItems;
+Items.Files = Files;
+Items.Compliance = Compliance;
+Items.Bom = Bom;
+Items.Image = Image;
+Items.Trainingrecords = Trainingrecords;
+Items.Trainingplans = Trainingplans;
+Items.Tickets = Tickets;
+Items.Quality = Quality;
+Items.Futurechanges = Futurechanges;
+
+export declare namespace Items {
+  export {
+    type CategoryMinimal as CategoryMinimal,
+    type CreateFieldVo as CreateFieldVo,
+    type CreateNumberFormat as CreateNumberFormat,
+    type ItemFull as ItemFull,
+    type LifecyclePhaseMinimal as LifecyclePhaseMinimal,
+    type OwnerCreate as OwnerCreate,
+    type URL as URL,
+    type UserMinimal as UserMinimal,
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemRetrieveHistoryResponse as ItemRetrieveHistoryResponse,
+    type ItemRetrieveRevisionsResponse as ItemRetrieveRevisionsResponse,
+    type ItemRetrieveWhereUsedResponse as ItemRetrieveWhereUsedResponse,
+    type ItemUpdateLifecyclePhaseResponse as ItemUpdateLifecyclePhaseResponse,
+    type ItemFullsOffset as ItemFullsOffset,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemRetrieveParams as ItemRetrieveParams,
+    type ItemUpdateParams as ItemUpdateParams,
+    type ItemListParams as ItemListParams,
+    type ItemUpdateLifecyclePhaseParams as ItemUpdateLifecyclePhaseParams,
+  };
+
+  export {
+    Sourcing as Sourcing,
+    type ItemSourcing as ItemSourcing,
+    type ItemSourcingResult as ItemSourcingResult,
+    type SourcingItem as SourcingItem,
+    type SourcingDeleteResponse as SourcingDeleteResponse,
+    type SourcingCreateParams as SourcingCreateParams,
+    type SourcingRetrieveParams as SourcingRetrieveParams,
+    type SourcingUpdateParams as SourcingUpdateParams,
+    type SourcingDeleteParams as SourcingDeleteParams,
+  };
+
+  export {
+    ItemsAPIItems as Items,
+    type ItemGuidAndURL as ItemGuidAndURL,
+    type ItemToItem as ItemToItem,
+    type ItemListResponse as ItemListResponse,
+    type ItemDeleteParams as ItemDeleteParams,
+  };
+
+  export {
+    Files as Files,
+    type ItemFile as ItemFile,
+    type FileListResponse as FileListResponse,
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileRetrieveWatermarkContentParams as FileRetrieveWatermarkContentParams,
+  };
+
+  export {
+    Compliance as Compliance,
+    type ItemCompliance as ItemCompliance,
+    type ComplianceListResponse as ComplianceListResponse,
+    type ComplianceDeleteResponse as ComplianceDeleteResponse,
+    type ComplianceCreateParams as ComplianceCreateParams,
+    type ComplianceRetrieveParams as ComplianceRetrieveParams,
+    type ComplianceUpdateParams as ComplianceUpdateParams,
+    type ComplianceDeleteParams as ComplianceDeleteParams,
+  };
+
+  export {
+    Bom as Bom,
+    type ItemBom as ItemBom,
+    type BomListResponse as BomListResponse,
+    type BomDeleteResponse as BomDeleteResponse,
+    type BomCreateParams as BomCreateParams,
+    type BomRetrieveParams as BomRetrieveParams,
+    type BomUpdateParams as BomUpdateParams,
+    type BomListParams as BomListParams,
+    type BomDeleteParams as BomDeleteParams,
+  };
+
+  export {
+    Image as Image,
+    type SingleGuid as SingleGuid,
+    type ImageDeleteResponse as ImageDeleteResponse,
+    type ImageRetrieveContentResponse as ImageRetrieveContentResponse,
+    type ImageUploadParams as ImageUploadParams,
+  };
+
+  export {
+    Trainingrecords as Trainingrecords,
+    type ItemTrainingRecord as ItemTrainingRecord,
+    type TrainingMinimal as TrainingMinimal,
+    type TrainingrecordListResponse as TrainingrecordListResponse,
+    type TrainingrecordRetrieveParams as TrainingrecordRetrieveParams,
+  };
+
+  export {
+    Trainingplans as Trainingplans,
+    type TrainingplanRetrieveResponse as TrainingplanRetrieveResponse,
+    type TrainingplanListResponse as TrainingplanListResponse,
+    type TrainingplanRetrieveParams as TrainingplanRetrieveParams,
+  };
+
+  export { Tickets as Tickets, type TicketRetrieveParams as TicketRetrieveParams };
+
+  export {
+    Quality as Quality,
+    type ItemQuality as ItemQuality,
+    type QualityListResponse as QualityListResponse,
+    type QualityRetrieveParams as QualityRetrieveParams,
+  };
+
+  export {
+    Futurechanges as Futurechanges,
+    type ItemFutureChange as ItemFutureChange,
+    type FuturechangeListResponse as FuturechangeListResponse,
+    type FuturechangeRetrieveParams as FuturechangeRetrieveParams,
+  };
+}