@silkline/arena 1.0.0

package/src/resources/changes/implementationfiles.ts

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

package/src/resources/changes/implementationtasks/files.ts

@@ -0,0 +1,115 @@
+// 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 FilesAPI 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 {
+  /**
+   * Adds a specific, already existing in the workspace, File to a specific
+   * implementation task. Implementation Task Management must be enabled to execute
+   * this endpoint. Not supported for Canceled or Completed Changes.
+   */
+  create(
+    implementationTaskGuid: string,
+    params: FileCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<FilesAPI.FileAssociation> {
+    const { changeGuid, ...body } = params;
+    return this._client.post(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/files`,
+      { body, ...options },
+    );
+  }
+
+  /**
+   * Retrieves a specific file associated with a change implementation task.
+   * Implementation Task Management must be enabled within the specific change
+   * category.
+   */
+  retrieve(
+    fileGuid: string,
+    params: FileRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<FilesAPI.FileAssociation> {
+    const { changeGuid, implementationTaskGuid } = params;
+    return this._client.get(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/files/${fileGuid}`,
+      options,
+    );
+  }
+
+  /**
+   * Retrieves the files associated with a change implementation task. Implementation
+   * Task Management must be enabled within the specific change category.
+   */
+  list(
+    implementationTaskGuid: string,
+    params: FileListParams,
+    options?: RequestOptions,
+  ): APIPromise<FilesAPI.FileAssociationResult> {
+    const { changeGuid } = params;
+    return this._client.get(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/files`,
+      options,
+    );
+  }
+
+  /**
+   * Returns the implementation tasks for a specific change category. Note that
+   * Implementation Task Management and Object Level Override must be enabled for the
+   * category. If it is not enabled, the endpoints shall return an error indicating
+   * it is not enabled. Not supported for Canceled, Completed or Uncategorized
+   * changes.
+   */
+  delete(fileGuid: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<string> {
+    const { changeGuid, implementationTaskGuid } = params;
+    return this._client.delete(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/files/${fileGuid}`,
+      options,
+    );
+  }
+}
+
+export type FileDeleteResponse = string;
+
+export interface FileCreateParams {
+  /**
+   * Path param:
+   */
+  changeGuid: string;
+
+  /**
+   * Body param:
+   */
+  file?: ImageAPI.SingleGuid;
+}
+
+export interface FileRetrieveParams {
+  changeGuid: string;
+
+  implementationTaskGuid: string;
+}
+
+export interface FileListParams {
+  changeGuid: string;
+}
+
+export interface FileDeleteParams {
+  changeGuid: string;
+
+  implementationTaskGuid: string;
+}
+
+export declare namespace Files {
+  export {
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+  };
+}

package/src/resources/changes/implementationtasks/implementationtasks.ts

@@ -0,0 +1,231 @@
+// 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 * as FilesAPI from './files';
+import {
+  FileCreateParams,
+  FileDeleteParams,
+  FileDeleteResponse,
+  FileListParams,
+  FileRetrieveParams,
+  Files,
+} from './files';
+import * as NotesAPI from './notes';
+import {
+  ChangeImplementationNote,
+  ImplementationNoteCreate,
+  NoteCreateParams,
+  NoteDeleteParams,
+  NoteDeleteResponse,
+  NoteListParams,
+  NoteListResponse,
+  NoteRetrieveParams,
+  NoteUpdateParams,
+  Notes,
+} from './notes';
+import * as DecisionsAPI from '../../qualityprocesses/steps/decisions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Implementationtasks extends APIResource {
+  notes: NotesAPI.Notes = new NotesAPI.Notes(this._client);
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+
+  /**
+   * Creates an implementation tasks for a specific change. Note that Implementation
+   * Task Management and Object Level Override must be enabled for the category. If
+   * it is not enabled, the endpoints shall return an error indicating it is not
+   * enabled. Not supported for Canceled, Completed or Uncategorized changes.
+   */
+  create(
+    changeGuid: string,
+    body: ImplementationtaskCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationTask> {
+    return this._client.post(path`/changes/${changeGuid}/implementationtasks`, { body, ...options });
+  }
+
+  /**
+   * Returns an implementation task for a specific change category. Note that
+   * Implementation Task Management must be enabled for the category. If it is not
+   * enabled, the endpoints shall return an error indicating it is not enabled.
+   */
+  retrieve(
+    implementationTaskGuid: string,
+    params: ImplementationtaskRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationTask> {
+    const { changeGuid } = params;
+    return this._client.get(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}`,
+      options,
+    );
+  }
+
+  /**
+   * Edits an implementation task for a specific change. Note that Implementation
+   * Task Management and Object Level Override must be enabled for the category. If
+   * it is not enabled, the endpoints shall return an error indicating it is not
+   * enabled. Not supported for Canceled, Completed or Uncategorized changes. User
+   * must be a change administrator, creator of the change, or the current task
+   * assginee to perform this endpoint.
+   */
+  update(
+    implementationTasksGuid: string,
+    params: ImplementationtaskUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationTask> {
+    const { changeGuid, ...body } = params;
+    return this._client.put(path`/changes/${changeGuid}/implementationtasks/${implementationTasksGuid}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns the implementation tasks for a specific change category. Note that
+   * Implementation Task Management must be enabled for the category. If it is not
+   * enabled, the endpoints shall return an error indicating it is not enabled.
+   */
+  list(changeGuid: string, options?: RequestOptions): APIPromise<ImplementationtaskListResponse> {
+    return this._client.get(path`/changes/${changeGuid}/implementationtasks`, options);
+  }
+
+  /**
+   * Deletes a Change Implementation Task from a Change. Implementation Task
+   * Management and Object Level Override should be enabled. Change status cannot be
+   * canceled or completed. Endpoint can only be performed by the change
+   * administrator or the change creator.
+   */
+  delete(
+    implementationTasksGuid: string,
+    params: ImplementationtaskDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { changeGuid } = params;
+    return this._client.delete(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTasksGuid}`,
+      options,
+    );
+  }
+}
+
+export interface ChangeImplementationTask {
+  assignee?: ChangeImplementationTask.Assignee;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  dueDate?: string;
+
+  guid?: string;
+
+  name?: string;
+
+  status?: string;
+}
+
+export namespace ChangeImplementationTask {
+  export interface Assignee {
+    user?: AdministratorsAPI.UserCompactAdmin;
+
+    userGroup?: DecisionsAPI.UserGroupMinimal;
+  }
+}
+
+export interface ImplementationAssigneeCreate {
+  user?: ImageAPI.SingleGuid;
+
+  userGroup?: ImageAPI.SingleGuid;
+}
+
+export interface ImplementationtaskListResponse {
+  count?: number;
+
+  results?: Array<ChangeImplementationTask>;
+}
+
+export type ImplementationtaskDeleteResponse = string;
+
+export interface ImplementationtaskCreateParams {
+  assignee?: ImplementationAssigneeCreate;
+
+  dueDate?: string;
+
+  name?: string;
+}
+
+export interface ImplementationtaskRetrieveParams {
+  changeGuid: string;
+}
+
+export interface ImplementationtaskUpdateParams {
+  /**
+   * Path param:
+   */
+  changeGuid: string;
+
+  /**
+   * Body param:
+   */
+  assignee?: ImplementationAssigneeCreate;
+
+  /**
+   * Body param:
+   */
+  dueDate?: string;
+
+  /**
+   * Body param:
+   */
+  name?: string;
+
+  /**
+   * Body param:
+   */
+  status?: string;
+}
+
+export interface ImplementationtaskDeleteParams {
+  changeGuid: string;
+}
+
+Implementationtasks.Notes = Notes;
+Implementationtasks.Files = Files;
+
+export declare namespace Implementationtasks {
+  export {
+    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 {
+    Notes as Notes,
+    type ChangeImplementationNote as ChangeImplementationNote,
+    type ImplementationNoteCreate as ImplementationNoteCreate,
+    type NoteListResponse as NoteListResponse,
+    type NoteDeleteResponse as NoteDeleteResponse,
+    type NoteCreateParams as NoteCreateParams,
+    type NoteRetrieveParams as NoteRetrieveParams,
+    type NoteUpdateParams as NoteUpdateParams,
+    type NoteListParams as NoteListParams,
+    type NoteDeleteParams as NoteDeleteParams,
+  };
+
+  export {
+    Files as Files,
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+  };
+}

package/src/resources/changes/implementationtasks/index.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Files,
+  type FileDeleteResponse,
+  type FileCreateParams,
+  type FileRetrieveParams,
+  type FileListParams,
+  type FileDeleteParams,
+} from './files';
+export {
+  Implementationtasks,
+  type ChangeImplementationTask,
+  type ImplementationAssigneeCreate,
+  type ImplementationtaskListResponse,
+  type ImplementationtaskDeleteResponse,
+  type ImplementationtaskCreateParams,
+  type ImplementationtaskRetrieveParams,
+  type ImplementationtaskUpdateParams,
+  type ImplementationtaskDeleteParams,
+} from './implementationtasks';
+export {
+  Notes,
+  type ChangeImplementationNote,
+  type ImplementationNoteCreate,
+  type NoteListResponse,
+  type NoteDeleteResponse,
+  type NoteCreateParams,
+  type NoteRetrieveParams,
+  type NoteUpdateParams,
+  type NoteListParams,
+  type NoteDeleteParams,
+} from './notes';

package/src/resources/changes/implementationtasks/notes.ts

@@ -0,0 +1,192 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Notes extends APIResource {
+  /**
+   * Adds a note to a change implementation task. Implementation Task Management must
+   * be enabled to execute this endpoint. Not supported for Canceled or Completed
+   * Changes.
+   */
+  create(
+    implementationTaskGuid: string,
+    params: NoteCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationNote> {
+    const { changeGuid, ...body } = params;
+    return this._client.post(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/notes`,
+      { body, ...options },
+    );
+  }
+
+  /**
+   * Returns a specific note in a specific implementation task of a specific change.
+   * Only supported in categories that have Implementation Task Management enabled.
+   */
+  retrieve(
+    implementationTaskNoteGuid: string,
+    params: NoteRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationNote> {
+    const { changeGuid, implementationTaskGuid } = params;
+    return this._client.get(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/notes/${implementationTaskNoteGuid}`,
+      options,
+    );
+  }
+
+  /**
+   * Edits an implementation task note for an implementation task. Implementation
+   * Task Management must be enabled to execute this endpoint. Not supported for
+   * Canceled or Completed Changes.
+   */
+  update(
+    noteGuid: string,
+    params: NoteUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChangeImplementationNote> {
+    const { changeGuid, implementationTasksGuid, ...body } = params;
+    return this._client.put(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTasksGuid}/notes/${noteGuid}`,
+      { body, ...options },
+    );
+  }
+
+  /**
+   * Returns the notes in a specific implementation task within a specific change.
+   * Only supported in categories that have Implementation Task Management enabled.
+   */
+  list(
+    implementationTaskGuid: string,
+    params: NoteListParams,
+    options?: RequestOptions,
+  ): APIPromise<NoteListResponse> {
+    const { changeGuid } = params;
+    return this._client.get(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTaskGuid}/notes`,
+      options,
+    );
+  }
+
+  /**
+   * Deletes a specific note from a specific implementation task within a Change.
+   * Implementation Task Management needs to be enabled for this change category. Not
+   * supported for Canceled or Completed changes.
+   */
+  delete(noteGuid: string, params: NoteDeleteParams, options?: RequestOptions): APIPromise<string> {
+    const { changeGuid, implementationTasksGuid } = params;
+    return this._client.delete(
+      path`/changes/${changeGuid}/implementationtasks/${implementationTasksGuid}/notes/${noteGuid}`,
+      options,
+    );
+  }
+}
+
+export interface ChangeImplementationNote {
+  guid?: string;
+
+  label?: string;
+
+  note?: string;
+
+  private?: boolean;
+}
+
+export interface ImplementationNoteCreate {
+  label?: string;
+
+  note?: string;
+
+  private?: boolean;
+}
+
+export interface NoteListResponse {
+  count?: number;
+
+  results?: Array<ChangeImplementationNote>;
+}
+
+export type NoteDeleteResponse = string;
+
+export interface NoteCreateParams {
+  /**
+   * Path param:
+   */
+  changeGuid: string;
+
+  /**
+   * Body param:
+   */
+  label?: string;
+
+  /**
+   * Body param:
+   */
+  note?: string;
+
+  /**
+   * Body param:
+   */
+  private?: boolean;
+}
+
+export interface NoteRetrieveParams {
+  changeGuid: string;
+
+  implementationTaskGuid: string;
+}
+
+export interface NoteUpdateParams {
+  /**
+   * Path param:
+   */
+  changeGuid: string;
+
+  /**
+   * Path param:
+   */
+  implementationTasksGuid: string;
+
+  /**
+   * Body param:
+   */
+  label?: string;
+
+  /**
+   * Body param:
+   */
+  note?: string;
+
+  /**
+   * Body param:
+   */
+  private?: boolean;
+}
+
+export interface NoteListParams {
+  changeGuid: string;
+}
+
+export interface NoteDeleteParams {
+  changeGuid: string;
+
+  implementationTasksGuid: string;
+}
+
+export declare namespace Notes {
+  export {
+    type ChangeImplementationNote as ChangeImplementationNote,
+    type ImplementationNoteCreate as ImplementationNoteCreate,
+    type NoteListResponse as NoteListResponse,
+    type NoteDeleteResponse as NoteDeleteResponse,
+    type NoteCreateParams as NoteCreateParams,
+    type NoteRetrieveParams as NoteRetrieveParams,
+    type NoteUpdateParams as NoteUpdateParams,
+    type NoteListParams as NoteListParams,
+    type NoteDeleteParams as NoteDeleteParams,
+  };
+}

package/src/resources/changes/implementationtasks.ts

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