@silkline/arena 1.0.0

package/src/resources/qualityprocesses/qualityprocesses.ts

@@ -0,0 +1,405 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as QualityprocessesAPI from './qualityprocesses';
+import * as ImageAPI from '../items/image';
+import * as AdministratorsAPI from '../settings/administrators';
+import * as StepsAPI from './steps/steps';
+import {
+  QualityProcessStep,
+  StepListResponse,
+  StepRetrieveParams,
+  StepUpdateParams,
+  Steps,
+  UserGroupWithUser,
+} from './steps/steps';
+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 Qualityprocesses extends APIResource {
+  steps: StepsAPI.Steps = new StepsAPI.Steps(this._client);
+
+  /**
+   * Creates a new Quality Process.
+   *
+   * <b>NOTES:</b>
+   *
+   * 1. If no default owner is specified for the template, you must include the GUID
+   *    of an eligible owner. Otherwise, the Create Quality Process endpoint will
+   *    return an error. Find eligible owners using the Get Quality Process Owners
+   *    endpoint.
+   * 2. To create a new number for the Quality Process, the API requires that you
+   *    pass the GUID for the number format prefix only. The rest of the number is
+   *    autogenerated.
+   */
+  create(body: QualityprocessCreateParams, options?: RequestOptions): APIPromise<QualityProcess> {
+    return this._client.post('/qualityprocesses', { body, ...options });
+  }
+
+  /**
+   * Returns a Quality Process object with a specific GUID.
+   */
+  retrieve(qualityprocessGuid: string, options?: RequestOptions): APIPromise<QualityProcessResult> {
+    return this._client.get(path`/qualityprocesses/${qualityprocessGuid}`, options);
+  }
+
+  /**
+   * Updates the metadata of a Quality Process object with a given GUID.
+   */
+  update(
+    qualityprocessGuid: string,
+    body: QualityprocessUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<QualityProcess> {
+    return this._client.put(path`/qualityprocesses/${qualityprocessGuid}`, { body, ...options });
+  }
+
+  /**
+   * Returns a collection of Quality Process objects matching the given search
+   * criteria.
+   */
+  list(
+    query: QualityprocessListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<QualityProcessResultResultsOffset, QualityProcessResult.Result> {
+    return this._client.getAPIList('/qualityprocesses', Offset<QualityProcessResult.Result>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Deletes a Quality Process with a given GUID.
+   *
+   * <b>NOTES:</b> Any full user can delete a Quality Process via the API. This
+   * differs from the Arena application, in which users must be the owner of the
+   * process or an Account Administrator to delete a Quality Process.
+   */
+  delete(qualityprocessGuid: string, options?: RequestOptions): APIPromise<string> {
+    return this._client.delete(path`/qualityprocesses/${qualityprocessGuid}`, options);
+  }
+
+  /**
+   * Completes a specific Quality Process step.
+   *
+   * <b>NOTES:</b>
+   *
+   * 1. Assigned Quality Process steps (excluding sign-off steps) can be completed by
+   *    the Quality Process Step Assignee or the Quality Process Owner.
+   * 2. Quality Process steps without an assignee (excluding sign-off steps) can be
+   *    completed by any user with permissions.
+   * 3. Quality Process steps (excluding sign-off steps) cannot be completed if the
+   *    Quality Process itself is completed.
+   * 4. Quality Process sign-off steps cannot be completed by this endpoint.
+   * 5. For Access Policies: A user must have the Quality Edit Details rule enabled
+   *    to complete a Quality Process step. Reopens a Quality Process step.
+   *
+   * <b>NOTES:</b>
+   *
+   * 1. Assigned Quality Process steps (excluding sign-off steps) can be reopened by
+   *    the Quality Process Step Assignee or the Quality Process Owner.
+   * 2. Quality Process steps without an assignee (excluding sign-off steps) can be
+   *    reopened by any user with permissions.
+   * 3. Quality Process steps (excluding sign-off steps) cannot be reopened if the
+   *    Quality Process itself is completed.
+   * 4. Quality Process approved sign-off steps cannot be reopened or reversed by
+   *    this endpoint.
+   * 5. For Access Policies: A user must have the Quality Edit Details rule enabled
+   *    to reopen a Quality Process step.
+   */
+  changeStatus(
+    body: QualityprocessChangeStatusParams,
+    options?: RequestOptions,
+  ): APIPromise<QualityprocessChangeStatusResponse> {
+    return this._client.post('/qualityprocesses/statuschanges', { body, ...options });
+  }
+}
+
+export type QualityProcessResultResultsOffset = Offset<QualityProcessResult.Result>;
+
+export interface CurrentStep {
+  guid?: string;
+
+  name?: string;
+}
+
+export interface QualityProcess {
+  canceledDateTime?: string;
+
+  completedDateTime?: string;
+
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  currentStep?: CurrentStep;
+
+  description?: string;
+
+  guid?: string;
+
+  name?: string;
+
+  number?: string;
+
+  owner?: AdministratorsAPI.UserCompactAdmin;
+
+  qualityProcessNotes?: string;
+
+  status?: string;
+
+  statusComments?: string;
+
+  statusMode?: string;
+
+  targetCompletionDateTime?: string;
+
+  targetDateComments?: string;
+
+  template?: TemplateCompact;
+
+  type?: string;
+}
+
+export interface QualityProcessResult {
+  count?: number;
+
+  results?: Array<QualityProcessResult.Result>;
+}
+
+export namespace QualityProcessResult {
+  export interface Result {
+    canceledDateTime?: string;
+
+    completedDateTime?: string;
+
+    creationDateTime?: string;
+
+    creator?: AdministratorsAPI.UserCompactAdmin;
+
+    currentStep?: QualityprocessesAPI.CurrentStep;
+
+    description?: string;
+
+    guid?: string;
+
+    name?: string;
+
+    number?: string;
+
+    owner?: AdministratorsAPI.UserCompactAdmin;
+
+    qualityProcessNotes?: string;
+
+    sequenceMode?: string;
+
+    status?: string;
+
+    statusComments?: string;
+
+    targetCompletionDateTime?: string;
+
+    targetDateComments?: string;
+
+    template?: QualityprocessesAPI.TemplateCompact;
+
+    type?: string;
+  }
+}
+
+export interface TemplateCompact {
+  active?: boolean;
+
+  guid?: string;
+}
+
+export type QualityprocessDeleteResponse = string;
+
+export interface QualityprocessChangeStatusResponse {
+  comment?: string;
+
+  complete?: boolean;
+
+  qualityProcess?: QualityProcess;
+
+  status?: string;
+}
+
+export interface QualityprocessCreateParams {
+  description?: string;
+
+  name?: string;
+
+  owner?: ImageAPI.SingleGuid;
+
+  targetCompletionDateTime?: string;
+
+  template?: QualityprocessCreateParams.Template;
+
+  type?: string;
+}
+
+export namespace QualityprocessCreateParams {
+  export interface Template {
+    guid?: string;
+
+    numberFormat?: Template.NumberFormat;
+  }
+
+  export namespace Template {
+    export interface NumberFormat {
+      prefix?: ImageAPI.SingleGuid;
+    }
+  }
+}
+
+export interface QualityprocessUpdateParams {
+  description?: string;
+
+  name?: string;
+
+  owner?: ImageAPI.SingleGuid;
+
+  qualityProcessNotes?: string;
+
+  targetCompletionDateTime?: string;
+
+  type?: string;
+}
+
+export interface QualityprocessListParams extends OffsetParams {
+  creator?: QualityprocessListParams.Creator;
+
+  /**
+   * quality description
+   */
+  description?: string;
+
+  /**
+   * quality name
+   */
+  name?: string;
+
+  /**
+   * quality number
+   */
+  number?: string;
+
+  owner?: QualityprocessListParams.Owner;
+
+  /**
+   * status
+   */
+  status?: string;
+
+  template?: QualityprocessListParams.Template;
+
+  /**
+   * quality type
+   */
+  type?: string;
+}
+
+export namespace QualityprocessListParams {
+  export interface Creator {
+    /**
+     * creator fullName
+     */
+    fullName?: string;
+
+    /**
+     * creator guid
+     */
+    guid?: string;
+  }
+
+  export interface Owner {
+    /**
+     * owner fullName
+     */
+    fullName?: string;
+
+    /**
+     * owner guid
+     */
+    guid?: string;
+  }
+
+  export interface Template {
+    /**
+     * template guid
+     */
+    guid?: string;
+  }
+}
+
+export type QualityprocessChangeStatusParams =
+  | QualityprocessChangeStatusParams.QualityStatusChangeVo
+  | QualityprocessChangeStatusParams.QualityStepWorkflowVo;
+
+export declare namespace QualityprocessChangeStatusParams {
+  export interface QualityStatusChangeVo {
+    comment?: string;
+
+    qualityProcess?: QualityStatusChangeVo.QualityProcess;
+  }
+
+  export namespace QualityStatusChangeVo {
+    export interface QualityProcess {
+      guid?: string;
+
+      status?: 'OPEN' | 'COMPLETED' | 'COMPLETED_STATUS' | 'SUBMITTED' | 'CANCELED';
+    }
+  }
+
+  export interface QualityStepWorkflowVo {
+    comment?: string;
+
+    qualityProcess?: QualityStepWorkflowVo.QualityProcess;
+  }
+
+  export namespace QualityStepWorkflowVo {
+    export interface QualityProcess {
+      guid?: string;
+
+      step?: QualityProcess.Step;
+    }
+
+    export namespace QualityProcess {
+      export interface Step {
+        guid?: string;
+
+        status?: 'OPEN' | 'COMPLETED' | 'COMPLETED_STATUS' | 'SUBMITTED' | 'CANCELED';
+      }
+    }
+  }
+}
+
+Qualityprocesses.Steps = Steps;
+
+export declare namespace Qualityprocesses {
+  export {
+    type CurrentStep as CurrentStep,
+    type QualityProcess as QualityProcess,
+    type QualityProcessResult as QualityProcessResult,
+    type TemplateCompact as TemplateCompact,
+    type QualityprocessDeleteResponse as QualityprocessDeleteResponse,
+    type QualityprocessChangeStatusResponse as QualityprocessChangeStatusResponse,
+    type QualityProcessResultResultsOffset as QualityProcessResultResultsOffset,
+    type QualityprocessCreateParams as QualityprocessCreateParams,
+    type QualityprocessUpdateParams as QualityprocessUpdateParams,
+    type QualityprocessListParams as QualityprocessListParams,
+    type QualityprocessChangeStatusParams as QualityprocessChangeStatusParams,
+  };
+
+  export {
+    Steps as Steps,
+    type QualityProcessStep as QualityProcessStep,
+    type UserGroupWithUser as UserGroupWithUser,
+    type StepListResponse as StepListResponse,
+    type StepRetrieveParams as StepRetrieveParams,
+    type StepUpdateParams as StepUpdateParams,
+  };
+}

package/src/resources/qualityprocesses/steps/affected.ts

@@ -0,0 +1,236 @@
+// 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 AdministratorsAPI from '../../settings/administrators';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Affected extends APIResource {
+  /**
+   * Returns an Affected Object with a given GUID that appears in a step with a given
+   * GUID in a Quality Process with a given GUID.
+   */
+  retrieve(
+    affectedGuid: string,
+    params: AffectedRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<QualityAffected> {
+    const { qualityprocessGuid, stepGuid } = params;
+    return this._client.get(
+      path`/qualityprocesses/${qualityprocessGuid}/steps/${stepGuid}/affected/${affectedGuid}`,
+      options,
+    );
+  }
+
+  /**
+   * Updates an existing Affected Object with a given GUID in a step with a given
+   * GUID in a Quality Process with a given GUID. Current supported Affected Objects
+   * are ITEMS, CHANGES, SUPPLIERS, SUPPLIER ITEMS, FILES, QUALITY, and URLs.
+   */
+  update(
+    affectedGuid: string,
+    params: AffectedUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<QualityAffected> {
+    const { qualityprocessGuid, stepGuid, ...body } = params;
+    return this._client.put(
+      path`/qualityprocesses/${qualityprocessGuid}/steps/${stepGuid}/affected/${affectedGuid}`,
+      { body, ...options },
+    );
+  }
+
+  /**
+   * Returns a collection of Affected Objects for a step with a given GUID in a
+   * Quality Process with a given GUID.
+   */
+  list(
+    stepGuid: string,
+    params: AffectedListParams,
+    options?: RequestOptions,
+  ): APIPromise<AffectedListResponse> {
+    const { qualityprocessGuid } = params;
+    return this._client.get(
+      path`/qualityprocesses/${qualityprocessGuid}/steps/${stepGuid}/affected`,
+      options,
+    );
+  }
+
+  /**
+   * Deletes an Affected Object with a given GUID from Quality Process step with a
+   * given GUID in a Quality Process with a given GUID.
+   */
+  delete(affectedGuid: string, params: AffectedDeleteParams, options?: RequestOptions): APIPromise<string> {
+    const { qualityprocessGuid, stepGuid } = params;
+    return this._client.delete(
+      path`/qualityprocesses/${qualityprocessGuid}/steps/${stepGuid}/affected/${affectedGuid}`,
+      options,
+    );
+  }
+
+  /**
+   * Adds an Affected Object in a step with a given GUID in a Quality Process with a
+   * given GUID. The type can be ITEM, REQUEST, CHANGE, SUPPLIER, SUPPLIER ITEM,
+   * FILE, QUALITY, or URL.
+   */
+  add(stepGuid: string, params: AffectedAddParams, options?: RequestOptions): APIPromise<QualityAffected> {
+    const { qualityprocessGuid, ...body } = params;
+    return this._client.post(path`/qualityprocesses/${qualityprocessGuid}/steps/${stepGuid}/affected`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export interface QualityAffected {
+  addedAfterCompletion?: boolean;
+
+  addedBy?: AdministratorsAPI.UserCompactAdmin;
+
+  addedDateTime?: string;
+
+  affected?: QualityAffected.Affected;
+
+  guid?: string;
+
+  notes?: string;
+}
+
+export namespace QualityAffected {
+  export interface Affected {
+    guid?: string;
+
+    specificRevision?: boolean;
+
+    type?: string;
+  }
+}
+
+export interface AffectedListResponse {
+  count?: number;
+
+  results?: Array<QualityAffected>;
+}
+
+export type AffectedDeleteResponse = string;
+
+export interface AffectedRetrieveParams {
+  qualityprocessGuid: string;
+
+  stepGuid: string;
+}
+
+export interface AffectedUpdateParams {
+  /**
+   * Path param:
+   */
+  qualityprocessGuid: string;
+
+  /**
+   * Path param:
+   */
+  stepGuid: string;
+
+  /**
+   * Body param:
+   */
+  notes?: string;
+}
+
+export interface AffectedListParams {
+  qualityprocessGuid: string;
+}
+
+export interface AffectedDeleteParams {
+  qualityprocessGuid: string;
+
+  stepGuid: string;
+}
+
+export type AffectedAddParams =
+  | AffectedAddParams.QualityStepAffectedCreateVo
+  | AffectedAddParams.QualityStepAffectedQualityCreateVo
+  | AffectedAddParams.QualityStepAffectedURLCreateVo;
+
+export declare namespace AffectedAddParams {
+  export interface QualityStepAffectedCreateVo {
+    /**
+     * Path param:
+     */
+    qualityprocessGuid: string;
+
+    /**
+     * Body param:
+     */
+    affected?: ImageAPI.SingleGuid;
+
+    /**
+     * Body param:
+     */
+    notes?: string;
+  }
+
+  export interface QualityStepAffectedQualityCreateVo {
+    /**
+     * Path param:
+     */
+    qualityprocessGuid: string;
+
+    /**
+     * Body param:
+     */
+    affected?: QualityStepAffectedQualityCreateVo.Affected;
+
+    /**
+     * Body param:
+     */
+    guid?: string;
+  }
+
+  export namespace QualityStepAffectedQualityCreateVo {
+    export interface Affected {
+      step?: ImageAPI.SingleGuid;
+    }
+  }
+
+  export interface QualityStepAffectedURLCreateVo {
+    /**
+     * Path param:
+     */
+    qualityprocessGuid: string;
+
+    /**
+     * Body param:
+     */
+    affected?: QualityStepAffectedURLCreateVo.Affected;
+
+    /**
+     * Body param:
+     */
+    guid?: string;
+  }
+
+  export namespace QualityStepAffectedURLCreateVo {
+    export interface Affected {
+      description?: string;
+
+      display?: string;
+
+      link?: string;
+    }
+  }
+}
+
+export declare namespace Affected {
+  export {
+    type QualityAffected as QualityAffected,
+    type AffectedListResponse as AffectedListResponse,
+    type AffectedDeleteResponse as AffectedDeleteResponse,
+    type AffectedRetrieveParams as AffectedRetrieveParams,
+    type AffectedUpdateParams as AffectedUpdateParams,
+    type AffectedListParams as AffectedListParams,
+    type AffectedDeleteParams as AffectedDeleteParams,
+    type AffectedAddParams as AffectedAddParams,
+  };
+}