@silkline/arena 1.0.0

package/src/resources/changes/index.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Changes,
+  type ChangeFull,
+  type ChangeLifecycleStatus,
+  type ChangeRoutingMinimal,
+  type ChangeListResponse,
+  type ChangeDeleteResponse,
+  type ChangeAlertsListResponse,
+  type ChangeHistoryListResponse,
+  type ChangeMoveStatusResponse,
+  type ChangeCreateParams,
+  type ChangeRetrieveParams,
+  type ChangeUpdateParams,
+  type ChangeListParams,
+  type ChangeMoveStatusParams,
+  type ChangeListResponsesOffset,
+} from './changes';
+export {
+  Files,
+  type FileDeleteResponse,
+  type FileCreateParams,
+  type FileRetrieveParams,
+  type FileDeleteParams,
+} from './files';
+export {
+  Implementationfiles,
+  type ImplementationfileDeleteResponse,
+  type ImplementationfileCreateParams,
+  type ImplementationfileRetrieveParams,
+  type ImplementationfileDeleteParams,
+} from './implementationfiles';
+export {
+  Implementationtasks,
+  type ChangeImplementationTask,
+  type ImplementationAssigneeCreate,
+  type ImplementationtaskListResponse,
+  type ImplementationtaskDeleteResponse,
+  type ImplementationtaskCreateParams,
+  type ImplementationtaskRetrieveParams,
+  type ImplementationtaskUpdateParams,
+  type ImplementationtaskDeleteParams,
+} from './implementationtasks/index';
+export {
+  Items,
+  type ChangeItemAssociation,
+  type ChangeModifiedView,
+  type ChangeModifiedViewCreate,
+  type DispositionAttributeCreate,
+  type ItemListResponse,
+  type ItemDeleteResponse,
+  type ItemRetrieveParams,
+  type ItemUpdateParams,
+  type ItemDeleteParams,
+  type ItemAddParams,
+} from './items';
+export {
+  Markupfiles,
+  type ChangeMarkupFileAssociation,
+  type MarkupfileListResponse,
+  type MarkupfileDeleteResponse,
+  type MarkupfileCreateParams,
+  type MarkupfileRetrieveParams,
+  type MarkupfileDeleteParams,
+} from './markupfiles';
+export { Quality, type QualityRetrieveParams } from './quality';
+export {
+  Requests,
+  type ChangeRequestAssociation,
+  type RequestListResponse,
+  type RequestDeleteResponse,
+  type RequestCreateParams,
+  type RequestRetrieveParams,
+  type RequestDeleteParams,
+} from './requests';
+export {
+  Tickets,
+  type ChangeTicketAssociation,
+  type TicketListResponse,
+  type TicketRetrieveParams,
+} from './tickets';

package/src/resources/changes/items.ts

@@ -0,0 +1,296 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ImageAPI from '../items/image';
+import * as ItemsItemsAPI from '../items/items';
+import * as RequestsItemsAPI from '../requests/items';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Items extends APIResource {
+  /**
+   * Returns a Change Affected Item with a given GUID included in a change with a
+   * given GUID. The response includes inventory disposition and information about
+   * each view of the item, including whether or not the view is included in the
+   * change and whether or not it contains modifications to the working revision.
+   *
+   * <b>Permanent Changes:</b>
+   *
+   * 1. If the Item added to the Change is unreleased: a. No
+   *    <code>affectedItemRevision</code> attribute. b. Before effective,
+   *    <code>newItemRevision</code> GUID references the working revision. c. After
+   *    effective, <code>newItemRevision</code> GUID references the revision made
+   *    effective by this Change. d. <code>newLifecyclePhase</code> is the new phase
+   *    introduced when the Change became effective. e.
+   *    <code>newRevisionNumber</code> is the new revision number made effective.
+   * 2. If the Item added to the Change is released: a. Before effective: i.
+   *    <code>newItemRevision</code> GUID references the working revision (may change
+   *    if released elsewhere). ii. <code>affectedItemRevision</code> GUID references
+   *    the effective revision. b. After effective: i. <code>newItemRevision</code>
+   *    GUID references the revision made effective. ii.
+   *    <code>affectedItemRevision</code> GUID references the effective revision. c.
+   *    <code>newLifecyclePhase</code> is the new phase after Change is effective. d.
+   *    <code>newRevisionNumber</code> is the planned revision number, which becomes
+   *    effective.
+   *
+   * <b>Temporary Changes:</b> a. Unreleased Items cannot be added.
+   * <code>newLifecyclePhase</code> and <code>newRevisionNumber</code> are not used.
+   * b. Before effective, <code>affectedItemRevision</code> GUID is the effective
+   * revision. c. After effective, <code>affectedItemRevision</code> GUID is the
+   * superseded revision; <code>newItemRevision</code> GUID is the new revision
+   * inserted. d. After expiration, <code>affectedItemRevision</code> and
+   * <code>newItemRevision</code> GUIDs do not change.
+   */
+  retrieve(
+    changeItemAssociationGuid: string,
+    params: ItemRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeItemAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/items/${changeItemAssociationGuid}`, options);
+  }
+
+  /**
+   * Updates modification information for an item on a change with a given
+   * change-item association GUID, included in a change with a given GUID. This
+   * includes item views/notes, new revision number, new lifecycle phase, and
+   * inventory disposition information.
+   *
+   * Item modifications can only be edited while a change is in the <b>Open and
+   * Unlocked</b> lifecycle phase. As soon as a change is submitted, all included
+   * Items are locked to modification.
+   *
+   * When making edits to an Item's modification information, you must provide
+   * <code>newRevisionNumber</code>, even if you do not wish to change it from the
+   * current value.
+   */
+  update(
+    changeItemAssociationGuid: string,
+    params: ItemUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeItemAssociation> {
+    const { changeGuid, ...body } = params;
+    return this._client.put(path`/changes/${changeGuid}/items/${changeItemAssociationGuid}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns all Change Affected Items included in a change with a given GUID. The
+   * response includes inventory dispostion and information about each view of each
+   * item, including whether it is included in the change and whether it contains
+   * modifications to the working revision.
+   */
+  list(changeGuid: string, options?: RequestOptions): APIPromise<ItemListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/items`, options);
+  }
+
+  /**
+   * Removes an item with a given GUID from a change with a given GUID. Items can
+   * only be removed from changes in the Open and Unlocked lifecycle phase.
+   */
+  delete(
+    changeItemAssociationGuid: string,
+    params: ItemDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { changeGuid } = params;
+    return this._client.delete(path`/changes/${changeGuid}/items/${changeItemAssociationGuid}`, options);
+  }
+
+  /**
+   * Adds an item to a change with a specific GUID.
+   *
+   * For an overview of the Change Lifecycle in Arena, including a summary of
+   * Lifecycle Rules for adding Items to Changes, see About the Change Lifecycle.
+   *
+   * <b>NOTES:</b>
+   *
+   * 1. <code>newItemRevision</code> is the GUID of the working revision of the Item
+   *    being added. In workspaces with Revision Sequences,
+   *    <code>newRevisionNumber</code> can be omitted if a next revision is
+   *    available.
+   * 2. <code>affectedItemRevision</code> is the GUID of the effective revision of
+   *    the Item being added.
+   * 3. The GUID in the response is the Change-Item association GUID, used in the PUT
+   *    Change Affected Item endpoint.
+   * 4. If <code>includedInThisChange=false</code> for any view, the
+   *    <code>notes</code> field is not allowed.
+   * 5. When adding items to a Change with temporary effectivity, no views can be
+   *    specified.
+   */
+  add(changeGuid: string, body: ItemAddParams, options?: RequestOptions): APIPromise<ChangeItemAssociation> {
+    return this._client.post(path`/changes/${changeGuid}/items`, { body, ...options });
+  }
+}
+
+export interface ChangeItemAssociation {
+  affectedItemRevision?: RequestsItemsAPI.ItemShort;
+
+  bomView?: ChangeModifiedView;
+
+  dispositionAttributes?: Array<ChangeItemAssociation.DispositionAttribute>;
+
+  filesView?: ChangeModifiedView;
+
+  guid?: string;
+
+  materialEffectivityDateTime?: string;
+
+  newItemRevision?: RequestsItemsAPI.ItemShort;
+
+  newLifecyclePhase?: ItemsItemsAPI.LifecyclePhaseMinimal;
+
+  newRevisionNumber?: string;
+
+  sourcingView?: ChangeModifiedView;
+
+  specsView?: ChangeModifiedView;
+}
+
+export namespace ChangeItemAssociation {
+  export interface DispositionAttribute {
+    fieldType?: string;
+
+    guid?: string;
+
+    multiSelect?: boolean;
+
+    name?: string;
+
+    notes?: string;
+
+    value?: unknown;
+  }
+}
+
+export interface ChangeModifiedView {
+  includedInThisChange?: boolean;
+
+  lockedByAnotherChange?: boolean;
+
+  modifiedOnWorkingRev?: boolean;
+
+  notes?: string;
+}
+
+export interface ChangeModifiedViewCreate {
+  includedInThisChange?: boolean;
+
+  notes?: string;
+}
+
+export interface DispositionAttributeCreate {
+  guid?: string;
+
+  notes?: string;
+
+  value?: unknown;
+}
+
+export interface ItemListResponse {
+  count?: number;
+
+  results?: Array<ChangeItemAssociation>;
+}
+
+export type ItemDeleteResponse = string;
+
+export interface ItemRetrieveParams {
+  changeGuid: string;
+}
+
+export interface ItemUpdateParams {
+  /**
+   * Path param:
+   */
+  changeGuid: string;
+
+  /**
+   * Body param:
+   */
+  bomView?: ChangeModifiedViewCreate;
+
+  /**
+   * Body param:
+   */
+  dispositionAttributes?: Array<DispositionAttributeCreate>;
+
+  /**
+   * Body param:
+   */
+  filesView?: ChangeModifiedViewCreate;
+
+  /**
+   * Body param:
+   */
+  materialEffectivityDateTime?: string;
+
+  /**
+   * Body param:
+   */
+  newLifecyclePhase?: ImageAPI.SingleGuid;
+
+  /**
+   * Body param:
+   */
+  newRevisionNumber?: string;
+
+  /**
+   * Body param:
+   */
+  retrainingRequired?: boolean;
+
+  /**
+   * Body param:
+   */
+  sourcingView?: ChangeModifiedViewCreate;
+
+  /**
+   * Body param:
+   */
+  specsView?: ChangeModifiedViewCreate;
+}
+
+export interface ItemDeleteParams {
+  changeGuid: string;
+}
+
+export interface ItemAddParams {
+  bomView?: ChangeModifiedViewCreate;
+
+  dispositionAttributes?: Array<DispositionAttributeCreate>;
+
+  filesView?: ChangeModifiedViewCreate;
+
+  materialEffectivityDateTime?: string;
+
+  newItemRevision?: ImageAPI.SingleGuid;
+
+  newLifecyclePhase?: ImageAPI.SingleGuid;
+
+  newRevisionNumber?: string;
+
+  retrainingRequired?: boolean;
+
+  sourcingView?: ChangeModifiedViewCreate;
+
+  specsView?: ChangeModifiedViewCreate;
+}
+
+export declare namespace Items {
+  export {
+    type ChangeItemAssociation as ChangeItemAssociation,
+    type ChangeModifiedView as ChangeModifiedView,
+    type ChangeModifiedViewCreate as ChangeModifiedViewCreate,
+    type DispositionAttributeCreate as DispositionAttributeCreate,
+    type ItemListResponse as ItemListResponse,
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemRetrieveParams as ItemRetrieveParams,
+    type ItemUpdateParams as ItemUpdateParams,
+    type ItemDeleteParams as ItemDeleteParams,
+    type ItemAddParams as ItemAddParams,
+  };
+}

package/src/resources/changes/markupfiles.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ImageAPI from '../items/image';
+import * as RequestsMarkupfilesAPI from '../requests/markupfiles';
+import * as RequestsAPI from '../requests/requests';
+import * as ChangesAPI from '../tickets/changes';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Markupfiles extends APIResource {
+  /**
+   * Creates a Change File Markup File object.
+   */
+  create(
+    changeGuid: string,
+    body: MarkupfileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeMarkupFileAssociation> {
+    return this._client.post(path`/changes/${changeGuid}/markupfiles`, { body, ...options });
+  }
+
+  /**
+   * Returns a Change File Markup object with a given GUID. This is the latest
+   * edition of the File.
+   */
+  retrieve(
+    changeFileAssociationGuid: string,
+    params: MarkupfileRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeMarkupFileAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/markupfiles/${changeFileAssociationGuid}`, options);
+  }
+
+  /**
+   * Returns a collection of Markup Files associated with a specific Change.
+   */
+  list(changeGuid: string, options?: RequestOptions): APIPromise<MarkupfileListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/markupfiles`, options);
+  }
+
+  /**
+   * Deletes a Change File Markup with a given GUID. When a File has more than one
+   * Markup, only the latest, unlocked edition can be deleted--to delete an entire
+   * file, repeat the DELETE request for all editions.
+   */
+  delete(
+    changeFileAssociationGuid: string,
+    params: MarkupfileDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { changeGuid } = params;
+    return this._client.delete(
+      path`/changes/${changeGuid}/markupfiles/${changeFileAssociationGuid}`,
+      options,
+    );
+  }
+}
+
+export interface ChangeMarkupFileAssociation {
+  change?: ChangesAPI.ChangeMinimal;
+
+  markup?: RequestsMarkupfilesAPI.FileMarkupDetail;
+
+  markupOf?: RequestsMarkupfilesAPI.FileDetailMarkupOf;
+
+  request?: RequestsAPI.RequestMinimal;
+}
+
+export interface MarkupfileListResponse {
+  count?: number;
+
+  results?: Array<ChangeMarkupFileAssociation>;
+}
+
+export type MarkupfileDeleteResponse = string;
+
+export interface MarkupfileCreateParams {
+  file?: ImageAPI.SingleGuid;
+}
+
+export interface MarkupfileRetrieveParams {
+  changeGuid: string;
+}
+
+export interface MarkupfileDeleteParams {
+  changeGuid: string;
+}
+
+export declare namespace Markupfiles {
+  export {
+    type ChangeMarkupFileAssociation as ChangeMarkupFileAssociation,
+    type MarkupfileListResponse as MarkupfileListResponse,
+    type MarkupfileDeleteResponse as MarkupfileDeleteResponse,
+    type MarkupfileCreateParams as MarkupfileCreateParams,
+    type MarkupfileRetrieveParams as MarkupfileRetrieveParams,
+    type MarkupfileDeleteParams as MarkupfileDeleteParams,
+  };
+}

package/src/resources/changes/quality.ts

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SuppliersQualityAPI from '../suppliers/quality';
+import * as TicketsQualityAPI from '../tickets/quality';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Quality extends APIResource {
+  /**
+   * Get details of a specific quality process linked to a change
+   */
+  retrieve(
+    changeQualityAssociationGuid: string,
+    params: QualityRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TicketsQualityAPI.QualityAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/quality/${changeQualityAssociationGuid}`, options);
+  }
+
+  /**
+   * Returns a collection of Quality Process objects for a Change with a given GUID
+   * (all Quality Processes in which the Change is an affected object)
+   */
+  list(
+    changeGuid: string,
+    options?: RequestOptions,
+  ): APIPromise<SuppliersQualityAPI.ChangeQualityAssociationResult> {
+    return this._client.get(path`/changes/${changeGuid}/quality`, options);
+  }
+}
+
+export interface QualityRetrieveParams {
+  changeGuid: string;
+}
+
+export declare namespace Quality {
+  export { type QualityRetrieveParams as QualityRetrieveParams };
+}

package/src/resources/changes/requests.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ImageAPI from '../items/image';
+import * as RequestsRequestsAPI from '../requests/requests';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Requests extends APIResource {
+  /**
+   * Adds a Request to a Change. Users must have a Read Change Summary and Edit
+   * Change Requests rule for the Change. Additionally users must have a Read Request
+   * Summary rule for the request being added. The Change must have a lifecycle
+   * status of OPEN_AND_UNLOCKED. The Request being added must have a lifecycle
+   * status of PROMOTED.
+   */
+  create(
+    changeGuid: string,
+    body: RequestCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeRequestAssociation> {
+    return this._client.post(path`/changes/${changeGuid}/requests`, { body, ...options });
+  }
+
+  /**
+   * Returns a specific request associated with a specific change. Users must have a
+   * Read Change Summary and Edit Change Requests rule for the Change. Additionally,
+   * users must have a Read Request Summary rule for the request being added.
+   */
+  retrieve(
+    changeRequestGuid: string,
+    params: RequestRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeRequestAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/requests/${changeRequestGuid}`, options);
+  }
+
+  /**
+   * Returns all the requests associated with a specific change. Users must have a
+   * Read Change Summary and Edit Change Requests rule for the Change. Additionally
+   * users must have a Read Request Summary rule for the request being added.
+   */
+  list(changeGuid: string, options?: RequestOptions): APIPromise<RequestListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/requests`, options);
+  }
+
+  /**
+   * Removes an request with a given GUID from a change with a given GUID.
+   */
+  delete(
+    changeRequestGuid: string,
+    params: RequestDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { changeGuid } = params;
+    return this._client.delete(path`/changes/${changeGuid}/requests/${changeRequestGuid}`, options);
+  }
+}
+
+export interface ChangeRequestAssociation {
+  guid?: string;
+
+  request?: RequestsRequestsAPI.RequestMinimal;
+}
+
+export interface RequestListResponse {
+  count?: number;
+
+  results?: Array<ChangeRequestAssociation>;
+}
+
+export type RequestDeleteResponse = string;
+
+export interface RequestCreateParams {
+  request?: ImageAPI.SingleGuid;
+}
+
+export interface RequestRetrieveParams {
+  changeGuid: string;
+}
+
+export interface RequestDeleteParams {
+  changeGuid: string;
+}
+
+export declare namespace Requests {
+  export {
+    type ChangeRequestAssociation as ChangeRequestAssociation,
+    type RequestListResponse as RequestListResponse,
+    type RequestDeleteResponse as RequestDeleteResponse,
+    type RequestCreateParams as RequestCreateParams,
+    type RequestRetrieveParams as RequestRetrieveParams,
+    type RequestDeleteParams as RequestDeleteParams,
+  };
+}

package/src/resources/changes/tickets.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TicketsTicketsAPI from '../tickets/tickets_';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Tickets extends APIResource {
+  /**
+   * Get details of a specific ticket linked to a change
+   */
+  retrieve(
+    changeVerifiesAssociationGuid: string,
+    params: TicketRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeTicketAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/tickets/${changeVerifiesAssociationGuid}`, options);
+  }
+
+  /**
+   * Returns the Ticket References of a Change object.
+   */
+  list(changeGuid: string, options?: RequestOptions): APIPromise<TicketListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/tickets`, options);
+  }
+}
+
+export interface ChangeTicketAssociation {
+  guid?: string;
+
+  ticket?: TicketsTicketsAPI.TicketMinimal;
+}
+
+export interface TicketListResponse {
+  count?: number;
+
+  results?: Array<ChangeTicketAssociation>;
+}
+
+export interface TicketRetrieveParams {
+  changeGuid: string;
+}
+
+export declare namespace Tickets {
+  export {
+    type ChangeTicketAssociation as ChangeTicketAssociation,
+    type TicketListResponse as TicketListResponse,
+    type TicketRetrieveParams as TicketRetrieveParams,
+  };
+}

package/src/resources/changes.ts

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