@silkline/arena 1.0.0

package/src/resources/changes/changes.ts

@@ -0,0 +1,640 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FilesAPI from './files';
+import { FileCreateParams, FileDeleteParams, FileDeleteResponse, FileRetrieveParams, Files } from './files';
+import * as ImplementationfilesAPI from './implementationfiles';
+import {
+  ImplementationfileCreateParams,
+  ImplementationfileDeleteParams,
+  ImplementationfileDeleteResponse,
+  ImplementationfileRetrieveParams,
+  Implementationfiles,
+} from './implementationfiles';
+import * as ItemsAPI from './items';
+import {
+  ChangeItemAssociation,
+  ChangeModifiedView,
+  ChangeModifiedViewCreate,
+  DispositionAttributeCreate,
+  ItemAddParams,
+  ItemDeleteParams,
+  ItemDeleteResponse,
+  ItemListResponse,
+  ItemRetrieveParams,
+  ItemUpdateParams,
+  Items,
+} from './items';
+import * as MarkupfilesAPI from './markupfiles';
+import {
+  ChangeMarkupFileAssociation,
+  MarkupfileCreateParams,
+  MarkupfileDeleteParams,
+  MarkupfileDeleteResponse,
+  MarkupfileListResponse,
+  MarkupfileRetrieveParams,
+  Markupfiles,
+} from './markupfiles';
+import * as QualityAPI from './quality';
+import { Quality, QualityRetrieveParams } from './quality';
+import * as RequestsAPI from './requests';
+import {
+  ChangeRequestAssociation,
+  RequestCreateParams,
+  RequestDeleteParams,
+  RequestDeleteResponse,
+  RequestListResponse,
+  RequestRetrieveParams,
+  Requests,
+} from './requests';
+import * as TicketsAPI from './tickets';
+import { ChangeTicketAssociation, TicketListResponse, TicketRetrieveParams, Tickets } from './tickets';
+import * as ImageAPI from '../items/image';
+import * as ItemsItemsAPI from '../items/items';
+import * as RequestsRequestsAPI from '../requests/requests';
+import * as AdministratorsAPI from '../settings/administrators';
+import * as TicketsTicketsAPI from '../tickets/tickets';
+import * as ImplementationtasksAPI from './implementationtasks/implementationtasks';
+import {
+  ChangeImplementationTask,
+  ImplementationAssigneeCreate,
+  ImplementationtaskCreateParams,
+  ImplementationtaskDeleteParams,
+  ImplementationtaskDeleteResponse,
+  ImplementationtaskListResponse,
+  ImplementationtaskRetrieveParams,
+  ImplementationtaskUpdateParams,
+  Implementationtasks,
+} from './implementationtasks/implementationtasks';
+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 Changes extends APIResource {
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
+  implementationtasks: ImplementationtasksAPI.Implementationtasks =
+    new ImplementationtasksAPI.Implementationtasks(this._client);
+  requests: RequestsAPI.Requests = new RequestsAPI.Requests(this._client);
+  markupfiles: MarkupfilesAPI.Markupfiles = new MarkupfilesAPI.Markupfiles(this._client);
+  implementationfiles: ImplementationfilesAPI.Implementationfiles =
+    new ImplementationfilesAPI.Implementationfiles(this._client);
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+  tickets: TicketsAPI.Tickets = new TicketsAPI.Tickets(this._client);
+  quality: QualityAPI.Quality = new QualityAPI.Quality(this._client);
+
+  /**
+   * Creates a new Change object. You can create changes with three different types
+   * of effectivity:
+   *
+   * 1. <b>Permanent on Approval</b>: The Change becomes effective immediately upon
+   *    the last necessary vote being entered.
+   * 2. <b>Permanent on Date</b>: The Change enters the Approved state upon the last
+   *    necessary vote being entered, but does not become effective until the
+   *    specified date. Requires the attribute
+   *    <code>plannedEffectivityDateTime</code>.
+   * 3. <b>Temporary</b>: Changes with temporary effectivity (often called
+   *    Deviations) become effective immediately upon the last necessary vote being
+   *    entered, and expire on a specified date. Requires the attribute
+   *    <code>expirationDate</code>.
+   *
+   * In all cases, <code>numberSequencePrefix</code> is required. If a default
+   * <code>numberSequencePrefix</code> is associated with the specified change
+   * category, not specifying a <code>numberSequencePrefix</code> will result in
+   * automatically selecting the default.
+   *
+   * Below are examples of each type of Change, including all fields that can be
+   * created for each effectivity type.
+   */
+  create(body: ChangeCreateParams, options?: RequestOptions): APIPromise<ChangeFull> {
+    return this._client.post('/changes', { body, ...options });
+  }
+
+  /**
+   * Returns a Change object with a given GUID. The attributes returned in the
+   * response differ according to the effectivityType. For example, a Change with a
+   * future effectivity (effectivityType=PERMANENT_ON_DATE) includes the attribute
+   * effectivityPlannedDateTime.
+   */
+  retrieve(
+    changeGuid: string,
+    query: ChangeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChangeFull> {
+    return this._client.get(path`/changes/${changeGuid}`, { query, ...options });
+  }
+
+  /**
+   * Updates attribute information for a change with a given GUID.
+   *
+   * For an overview of the Change Lifecycle in Arena, including a summary of
+   * Lifecycle Rules, see About the Change Lifecycle.
+   *
+   * Changes cannot be edited after they are submitted, with the following
+   * exceptions:
+   *
+   * 1. <b>Approval Deadline</b> and <b>Expiration Date</b> can be edited on
+   *    Submitted and Effective Changes by Change Administrator users.
+   * 2. <b>Implementation Status</b> can be edited in any lifecycle phase.
+   */
+  update(changeGuid: string, body: ChangeUpdateParams, options?: RequestOptions): APIPromise<ChangeFull> {
+    return this._client.put(path`/changes/${changeGuid}`, { body, ...options });
+  }
+
+  /**
+   * Returns a collection of Change objects matching the given search criteria. The
+   * Changes returned here are a compact version. For a full Change object, use the
+   * GET Change endpoint GET/changes/{guid}.
+   *
+   * Changes include different attributes depending on the effectivityType
+   * (PERMANENT_ON_APPROVAL, PERMANENT_ON_DATE, or TEMPORARY) and lifecyclePhase
+   * (OPEN_AND_UNLOCKED, OPEN_AND_LOCKED, SUBMITTED_FOR_ROUTING,
+   * SUBMITTED_FOR_APPROVAL, REJECTED, CANCELED, APPROVED, EFFECTIVE, COMPLETED, or
+   * EXPIRED).
+   */
+  list(
+    query: ChangeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ChangeListResponsesOffset, ChangeListResponse> {
+    return this._client.getAPIList('/changes', Offset<ChangeListResponse>, { query, ...options });
+  }
+
+  /**
+   * Deletes a change with a given GUID. Changes can only be deleted in the Open and
+   * Unlocked, Canceled, and Rejected lifecycle phases.
+   */
+  delete(changeGuid: string, options?: RequestOptions): APIPromise<string> {
+    return this._client.delete(path`/changes/${changeGuid}`, options);
+  }
+
+  /**
+   * View alerts related to the lifecycle of a change
+   */
+  alertsList(changeGuid: string, options?: RequestOptions): APIPromise<ChangeAlertsListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/alerts`, options);
+  }
+
+  /**
+   * Returns an array of change history records for the specified change. This
+   * endpoint is functionally equivalent to viewing the Change > History > General
+   * subview.
+   */
+  historyList(changeGuid: string, options?: RequestOptions): APIPromise<ChangeHistoryListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/history`, options);
+  }
+
+  /**
+   * Move a change to a new lifecycle phase
+   */
+  moveStatus(body: ChangeMoveStatusParams, options?: RequestOptions): APIPromise<ChangeMoveStatusResponse> {
+    return this._client.post('/changes/statuschanges', { body, ...options });
+  }
+}
+
+export type ChangeListResponsesOffset = Offset<ChangeListResponse>;
+
+export interface ChangeFull {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCompact>;
+
+  approvalDeadlineDateTime?: string;
+
+  canceledDateTime?: string;
+
+  category?: RequestsRequestsAPI.CategoryCompact;
+
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  description?: string;
+
+  deviated?: boolean;
+
+  effectiveDateTime?: string;
+
+  effectivityPlannedDateTime?: string;
+
+  effectivityType?: 'PERMANENT_ON_APPROVAL' | 'PERMANENT_ON_DATE' | 'TEMPORARY' | 'PERMANENT' | 'IMMEDIATE';
+
+  enforceApprovalDeadline?: boolean;
+
+  expirationDateTime?: string;
+
+  guid?: string;
+
+  implementationStatus?: 'NOT_STARTED' | 'IN_PROGRESS' | 'NEEDS_ATTENTION' | 'DONE' | 'BLANK' | 'CANCELED';
+
+  implementationStatusDateTime?: string;
+
+  implementationStatusEditor?: AdministratorsAPI.UserCompactAdmin;
+
+  lifecycleDateTime?: string;
+
+  lifecycleStatus?: ChangeLifecycleStatus;
+
+  number?: string;
+
+  routingAdmins?: Array<AdministratorsAPI.UserCompactAdmin>;
+
+  routings?: Array<ChangeRoutingMinimal>;
+
+  submissionDateTime?: string;
+
+  submitter?: AdministratorsAPI.UserCompactAdmin;
+
+  title?: string;
+
+  url?: ItemsItemsAPI.URL;
+
+  withdrawnDateTime?: string;
+}
+
+export interface ChangeLifecycleStatus {
+  type?:
+    | 'OPEN'
+    | 'SUBMITTED_FOR_APPROVAL'
+    | 'SUBMITTED'
+    | 'APPROVED'
+    | 'EFFECTIVE'
+    | 'EXPIRED'
+    | 'REJECTED'
+    | 'OPEN_AND_UNLOCKED'
+    | 'OPEN_AND_LOCKED'
+    | 'SUBMITTED_FOR_ROUTING'
+    | 'CANCELED'
+    | 'COMPLETED';
+}
+
+export interface ChangeRoutingMinimal {
+  description?: string;
+
+  guid?: string;
+
+  name?: string;
+}
+
+export interface ChangeListResponse {
+  category?: ItemsItemsAPI.CategoryMinimal;
+
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  effectiveDateTime?: string;
+
+  expirationDateTime?: string;
+
+  guid?: string;
+
+  implementationStatus?: 'NOT_STARTED' | 'IN_PROGRESS' | 'NEEDS_ATTENTION' | 'DONE' | 'BLANK' | 'CANCELED';
+
+  lifecycleDateTime?: string;
+
+  lifecycleStatus?: ChangeLifecycleStatus;
+
+  number?: string;
+
+  submissionDateTime?: string;
+
+  title?: string;
+
+  url?: ItemsItemsAPI.URL;
+}
+
+export type ChangeDeleteResponse = string;
+
+export interface ChangeAlertsListResponse {
+  count?: number;
+
+  results?: Array<ChangeAlertsListResponse.Result>;
+}
+
+export namespace ChangeAlertsListResponse {
+  export interface Result {
+    code?: number;
+
+    message?: string;
+  }
+}
+
+export interface ChangeHistoryListResponse {
+  count?: number;
+
+  results?: Array<ChangeHistoryListResponse.Result>;
+}
+
+export namespace ChangeHistoryListResponse {
+  export interface Result {
+    action?: string;
+
+    date?: string;
+
+    guid?: string;
+
+    newValue?: string;
+
+    originalValue?: string;
+
+    property?: string;
+
+    rowNum?: number;
+
+    user?: string;
+  }
+}
+
+export interface ChangeMoveStatusResponse {
+  administrators?: Array<AdministratorsAPI.UserCompactAdmin>;
+
+  change?: ChangeMoveStatusResponse.Change;
+
+  comment?: string;
+
+  implStatus?: ChangeMoveStatusResponse.ImplStatus;
+
+  status?:
+    | 'OPEN'
+    | 'SUBMITTED_FOR_APPROVAL'
+    | 'SUBMITTED'
+    | 'APPROVED'
+    | 'EFFECTIVE'
+    | 'EXPIRED'
+    | 'REJECTED'
+    | 'OPEN_AND_UNLOCKED'
+    | 'OPEN_AND_LOCKED'
+    | 'SUBMITTED_FOR_ROUTING'
+    | 'CANCELED'
+    | 'COMPLETED';
+}
+
+export namespace ChangeMoveStatusResponse {
+  export interface Change {
+    guid?: string;
+
+    number?: string;
+
+    url?: ItemsItemsAPI.URL;
+  }
+
+  export interface ImplStatus {
+    guid?: string;
+
+    value?: string;
+  }
+}
+
+export interface ChangeCreateParams {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCreate>;
+
+  approvalDeadlineDateTime?: string;
+
+  category?: ImageAPI.SingleGuid;
+
+  description?: string;
+
+  effectivityPlannedDateTime?: string;
+
+  effectivityType?: string;
+
+  enforceApprovalDeadline?: string;
+
+  expirationDateTime?: string;
+
+  numberSequencePrefix?: RequestsRequestsAPI.SingleValue;
+
+  routings?: Array<ImageAPI.SingleGuid>;
+
+  supplierVisibility?: boolean;
+
+  title?: string;
+}
+
+export interface ChangeRetrieveParams {
+  includeEmptyAdditionalAttributes?: boolean;
+}
+
+export interface ChangeUpdateParams {
+  additionalAttributes?: Array<TicketsTicketsAPI.AdditionalAttributeCreate>;
+
+  approvalDeadlineDateTime?: string;
+
+  category?: ImageAPI.SingleGuid;
+
+  description?: string;
+
+  effectivityPlannedDateTime?: string;
+
+  effectivityType?: string;
+
+  enforceApprovalDeadline?: string;
+
+  expirationDateTime?: string;
+
+  implementationStatus?: string;
+
+  supplierVisibility?: boolean;
+
+  title?: string;
+}
+
+export interface ChangeListParams extends OffsetParams {
+  /**
+   * change any search
+   */
+  any?: string;
+
+  category?: ChangeListParams.Category;
+
+  creator?: ChangeListParams.Creator;
+
+  /**
+   * change effective date
+   */
+  effectiveDateTime?: string;
+
+  /**
+   * implementation status
+   */
+  implementationStatus?: string;
+
+  includeChildCategories?: boolean;
+
+  lifecycleStatus?: ChangeListParams.LifecycleStatus;
+
+  /**
+   * change number
+   */
+  number?: string;
+
+  /**
+   * change submission date
+   */
+  submissionDateTime?: string;
+
+  /**
+   * change title
+   */
+  title?: string;
+}
+
+export namespace ChangeListParams {
+  export interface Category {
+    /**
+     * category guid
+     */
+    guid?: string;
+  }
+
+  export interface Creator {
+    /**
+     * creator guid
+     */
+    guid?: string;
+  }
+
+  export interface LifecycleStatus {
+    /**
+     * lifecycle status type
+     */
+    type?: string;
+  }
+}
+
+export interface ChangeMoveStatusParams {
+  administrators?: Array<ImageAPI.SingleGuid>;
+
+  adminNeedConfig?: boolean;
+
+  change?: ImageAPI.SingleGuid;
+
+  comment?: string;
+
+  fromStatus?:
+    | 'OPEN'
+    | 'SUBMITTED_FOR_APPROVAL'
+    | 'SUBMITTED'
+    | 'APPROVED'
+    | 'EFFECTIVE'
+    | 'EXPIRED'
+    | 'REJECTED'
+    | 'OPEN_AND_UNLOCKED'
+    | 'OPEN_AND_LOCKED'
+    | 'SUBMITTED_FOR_ROUTING'
+    | 'CANCELED'
+    | 'COMPLETED';
+
+  implementationStatus?: RequestsRequestsAPI.SingleValue;
+
+  status?:
+    | 'OPEN'
+    | 'SUBMITTED_FOR_APPROVAL'
+    | 'SUBMITTED'
+    | 'APPROVED'
+    | 'EFFECTIVE'
+    | 'EXPIRED'
+    | 'REJECTED'
+    | 'OPEN_AND_UNLOCKED'
+    | 'OPEN_AND_LOCKED'
+    | 'SUBMITTED_FOR_ROUTING'
+    | 'CANCELED'
+    | 'COMPLETED';
+}
+
+Changes.Items = Items;
+Changes.Implementationtasks = Implementationtasks;
+Changes.Requests = Requests;
+Changes.Markupfiles = Markupfiles;
+Changes.Implementationfiles = Implementationfiles;
+Changes.Files = Files;
+Changes.Tickets = Tickets;
+Changes.Quality = Quality;
+
+export declare namespace Changes {
+  export {
+    type ChangeFull as ChangeFull,
+    type ChangeLifecycleStatus as ChangeLifecycleStatus,
+    type ChangeRoutingMinimal as ChangeRoutingMinimal,
+    type ChangeListResponse as ChangeListResponse,
+    type ChangeDeleteResponse as ChangeDeleteResponse,
+    type ChangeAlertsListResponse as ChangeAlertsListResponse,
+    type ChangeHistoryListResponse as ChangeHistoryListResponse,
+    type ChangeMoveStatusResponse as ChangeMoveStatusResponse,
+    type ChangeListResponsesOffset as ChangeListResponsesOffset,
+    type ChangeCreateParams as ChangeCreateParams,
+    type ChangeRetrieveParams as ChangeRetrieveParams,
+    type ChangeUpdateParams as ChangeUpdateParams,
+    type ChangeListParams as ChangeListParams,
+    type ChangeMoveStatusParams as ChangeMoveStatusParams,
+  };
+
+  export {
+    Items as Items,
+    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,
+  };
+
+  export {
+    Implementationtasks as Implementationtasks,
+    type ChangeImplementationTask as ChangeImplementationTask,
+    type ImplementationAssigneeCreate as ImplementationAssigneeCreate,
+    type ImplementationtaskListResponse as ImplementationtaskListResponse,
+    type ImplementationtaskDeleteResponse as ImplementationtaskDeleteResponse,
+    type ImplementationtaskCreateParams as ImplementationtaskCreateParams,
+    type ImplementationtaskRetrieveParams as ImplementationtaskRetrieveParams,
+    type ImplementationtaskUpdateParams as ImplementationtaskUpdateParams,
+    type ImplementationtaskDeleteParams as ImplementationtaskDeleteParams,
+  };
+
+  export {
+    Requests as Requests,
+    type ChangeRequestAssociation as ChangeRequestAssociation,
+    type RequestListResponse as RequestListResponse,
+    type RequestDeleteResponse as RequestDeleteResponse,
+    type RequestCreateParams as RequestCreateParams,
+    type RequestRetrieveParams as RequestRetrieveParams,
+    type RequestDeleteParams as RequestDeleteParams,
+  };
+
+  export {
+    Markupfiles as Markupfiles,
+    type ChangeMarkupFileAssociation as ChangeMarkupFileAssociation,
+    type MarkupfileListResponse as MarkupfileListResponse,
+    type MarkupfileDeleteResponse as MarkupfileDeleteResponse,
+    type MarkupfileCreateParams as MarkupfileCreateParams,
+    type MarkupfileRetrieveParams as MarkupfileRetrieveParams,
+    type MarkupfileDeleteParams as MarkupfileDeleteParams,
+  };
+
+  export {
+    Implementationfiles as Implementationfiles,
+    type ImplementationfileDeleteResponse as ImplementationfileDeleteResponse,
+    type ImplementationfileCreateParams as ImplementationfileCreateParams,
+    type ImplementationfileRetrieveParams as ImplementationfileRetrieveParams,
+    type ImplementationfileDeleteParams as ImplementationfileDeleteParams,
+  };
+
+  export {
+    Files as Files,
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileDeleteParams as FileDeleteParams,
+  };
+
+  export {
+    Tickets as Tickets,
+    type ChangeTicketAssociation as ChangeTicketAssociation,
+    type TicketListResponse as TicketListResponse,
+    type TicketRetrieveParams as TicketRetrieveParams,
+  };
+
+  export { Quality as Quality, type QualityRetrieveParams as QualityRetrieveParams };
+}

package/src/resources/changes/files.ts

@@ -0,0 +1,80 @@
+// 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 TrainingplansFilesAPI from '../trainingplans/files';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * Associates an existing File Association object with the Files view of a Change
+   * with a given GUID.
+   */
+  create(
+    changeGuid: string,
+    body: FileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<TrainingplansFilesAPI.FileAssociation> {
+    return this._client.post(path`/changes/${changeGuid}/files`, { body, ...options });
+  }
+
+  /**
+   * Returns a specific File from the Files view of a specific Change with a given
+   * GUID.
+   */
+  retrieve(
+    changeFileAssociationGuid: string,
+    params: FileRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<TrainingplansFilesAPI.FileAssociation> {
+    const { changeGuid } = params;
+    return this._client.get(path`/changes/${changeGuid}/files/${changeFileAssociationGuid}`, options);
+  }
+
+  /**
+   * Returns a list of Files for a Change with a given GUID.
+   */
+  list(
+    changeGuid: string,
+    options?: RequestOptions,
+  ): APIPromise<TrainingplansFilesAPI.FileAssociationResult> {
+    return this._client.get(path`/changes/${changeGuid}/files`, options);
+  }
+
+  /**
+   * Removes a File association from the Files view of a Change with a given GUID.
+   */
+  delete(
+    changeFileAssociationGuid: string,
+    params: FileDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { changeGuid } = params;
+    return this._client.delete(path`/changes/${changeGuid}/files/${changeFileAssociationGuid}`, options);
+  }
+}
+
+export type FileDeleteResponse = string;
+
+export interface FileCreateParams {
+  file?: ImageAPI.SingleGuid;
+}
+
+export interface FileRetrieveParams {
+  changeGuid: string;
+}
+
+export interface FileDeleteParams {
+  changeGuid: string;
+}
+
+export declare namespace Files {
+  export {
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileDeleteParams as FileDeleteParams,
+  };
+}