@silkline/arena 1.0.0

package/src/resources/files/index.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Content, type ContentUploadParams } from './content';
+export {
+  Corrections,
+  type FileCorrection,
+  type CorrectionListResponse,
+  type CorrectionCreateParams,
+  type CorrectionRetrieveParams,
+} from './corrections';
+export { Editions, type EditionListResponse, type EditionCreateParams } from './editions';
+export {
+  Files,
+  type ChangeLite,
+  type FileAssociationItem,
+  type FileAssociationProject,
+  type FileAssociationQuality,
+  type FileAssociationRequest,
+  type FileAssociationSupplier,
+  type FileAssociationTicket,
+  type FileAssociationTraining,
+  type FileAuthor,
+  type FileCategory,
+  type FileCreateMetadata,
+  type FileDetail,
+  type SupplierCompact,
+  type FileListResponse,
+  type FileDeleteResponse,
+  type FileRetrieveAssociationResponse,
+  type FileRetrieveAssociationsResponse,
+  type FileCreateParams,
+  type FileUpdateParams,
+  type FileListParams,
+  type FileCheckinParams,
+  type FileRetrieveAssociationParams,
+  type FileRetrieveAssociationsParams,
+  type FileRetrieveItemAssociationParams,
+  type FileUploadParams,
+  type FileListResponsesOffset,
+} from './files';
+export {
+  Markups,
+  type FileAssociationMarkup,
+  type FileMarkupCreate,
+  type MarkupListResponse,
+  type MarkupDeleteResponse,
+  type MarkupCreateParams,
+  type MarkupRetrieveParams,
+  type MarkupUpdateParams,
+  type MarkupDeleteParams,
+  type MarkupDownloadContentParams,
+  type MarkupUpdateContentParams,
+} from './markups';

package/src/resources/files/markups.ts

@@ -0,0 +1,374 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as FilesAPI from './files';
+import * as ImageAPI from '../items/image';
+import * as ItemsAPI from '../items/items';
+import * as AdministratorsAPI from '../settings/administrators';
+import { APIPromise } from '../../core/api-promise';
+import { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Markups extends APIResource {
+  /**
+   * Creates a File Markup File object.
+   *
+   * If you wish to create a File record and upload file content to the Arena
+   * servers, construct a request that is content type
+   * <code>multipart/form-data</code> (specified in the header) and has a
+   * <code>storageMethodName</code> of <code>FILE</code> (stored on Arena servers).
+   *
+   * If you wish to create a File record with no uploaded content, construct a JSON
+   * request with a <code>storageMethodName</code> of <code>FTP</code> (stored on
+   * user FTP server), <code>WEB</code> (web link), or <code>PLACE_HOLDER</code>
+   * (will upload content later).
+   *
+   * When the storageMethod is <code>FTP</code> or <code>WEB</code>, the
+   * <code>location</code> attribute should be the web or ftp address where the file
+   * resides. For Files with <code>storageMethodName</code> <code>FILE</code>, the
+   * <code>location</code> attribute is not used.
+   *
+   * Currently, only Files less than 2GB can be uploaded through this endpoint.
+   */
+  create(
+    fileGuid: string,
+    body: MarkupCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<FileAssociationMarkup> {
+    return this._client.post(
+      path`/files/${fileGuid}/markups`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Returns a File Markup object with a given GUID. This is the latest edition of
+   * the File.
+   */
+  retrieve(
+    markupFileAssociationGuid: string,
+    params: MarkupRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<FileAssociationMarkup> {
+    const { fileGuid } = params;
+    return this._client.get(path`/files/${fileGuid}/markups/${markupFileAssociationGuid}`, options);
+  }
+
+  /**
+   * Updates a File object.
+   *
+   * Also supports updating <code>storageMethodName</code> from <code>FILE</code>,
+   * <code>FTP</code>, <code>WEB</code>, or <code>PLACE_HOLDER</code> to
+   * <code>FTP</code>, <code>WEB</code>, or <code>PLACE_HOLDER</code>. This update
+   * can only be performed on unlocked Files.
+   *
+   * Updating <code>storageMethodName</code> to <code>FTP</code>, <code>WEB</code>,
+   * or <code>PLACE_HOLDER</code> also requires including the attribute
+   * <code>location</code>.
+   *
+   * This endpoint does not support updating the <code>storageMethodName</code> from
+   * <code>FTP</code>, <code>WEB</code>, or <code>PLACE_HOLDER</code> to
+   * <code>FILE</code>. This requires a POST call. See POST File Update.
+   */
+  update(
+    markupFileAssociationGuid: string,
+    params: MarkupUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<FileAssociationMarkup> {
+    const { fileGuid, ...body } = params;
+    return this._client.put(path`/files/${fileGuid}/markups/${markupFileAssociationGuid}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a collection of Markup Files associated with a specific File.
+   */
+  list(fileGuid: string, options?: RequestOptions): APIPromise<MarkupListResponse> {
+    return this._client.get(path`/files/${fileGuid}/markups`, options);
+  }
+
+  /**
+   * Deletes a 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(
+    markupFileAssociationGuid: string,
+    params: MarkupDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<string> {
+    const { fileGuid } = params;
+    return this._client.delete(path`/files/${fileGuid}/markups/${markupFileAssociationGuid}`, options);
+  }
+
+  /**
+   * Returns file content belonging to a file markup with a given GUID.
+   */
+  downloadContent(
+    markupFileAssociationGuid: string,
+    params: MarkupDownloadContentParams,
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    const { fileGuid } = params;
+    return this._client.get(path`/files/${fileGuid}/markups/${markupFileAssociationGuid}/content`, {
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
+  /**
+   * Update file markup content by its GUID
+   */
+  updateContent(
+    markupFileAssociationGuid: string,
+    params: MarkupUpdateContentParams,
+    options?: RequestOptions,
+  ): APIPromise<FileAssociationMarkup> {
+    const { fileGuid, ...body } = params;
+    return this._client.post(
+      path`/files/${fileGuid}/markups/${markupFileAssociationGuid}`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+export interface FileAssociationMarkup {
+  guid?: string;
+
+  markup?: FileAssociationMarkup.Markup;
+
+  markupOf?: FileAssociationMarkup.MarkupOf;
+
+  reserved?: boolean;
+
+  reservedUser?: AdministratorsAPI.UserCompactAdmin;
+}
+
+export namespace FileAssociationMarkup {
+  export interface Markup {
+    author?: ItemsAPI.UserMinimal;
+
+    category?: ItemsAPI.CategoryMinimal;
+
+    creationDateTime?: string;
+
+    format?: string;
+
+    guid?: string;
+
+    haveContent?: boolean;
+
+    lastModifiedDateTime?: string;
+
+    location?: string;
+
+    locked?: boolean;
+
+    mimeType?: string;
+
+    name?: string;
+
+    size?: number;
+
+    storageMethodName?: string;
+
+    title?: string;
+  }
+
+  export interface MarkupOf {
+    author?: ItemsAPI.UserMinimal;
+
+    edition?: string;
+
+    guid?: string;
+
+    number?: string;
+  }
+}
+
+/**
+ * File option when creating new file markup
+ */
+export interface FileMarkupCreate {
+  /**
+   * Markup file author full name
+   */
+  'markup.author.fullName'?: string;
+
+  /**
+   * Markup file category GUID
+   */
+  'markup.category.guid'?: string;
+
+  'markup.content'?: Uploadable;
+
+  /**
+   * Markup file format
+   */
+  'markup.format'?: string;
+
+  /**
+   * Markup file storage method
+   */
+  'markup.storageMethodName'?: string;
+
+  /**
+   * Markup file title
+   */
+  'markup.title'?: string;
+
+  /**
+   * Whether to reserve the markup file
+   */
+  reserved?: boolean;
+}
+
+export interface MarkupListResponse {
+  count?: number;
+
+  results?: Array<FileAssociationMarkup>;
+}
+
+export type MarkupDeleteResponse = string;
+
+export interface MarkupCreateParams {
+  /**
+   * Markup file author full name
+   */
+  'markup.author.fullName'?: string;
+
+  /**
+   * Markup file category GUID
+   */
+  'markup.category.guid'?: string;
+
+  'markup.content'?: Uploadable;
+
+  /**
+   * Markup file format
+   */
+  'markup.format'?: string;
+
+  /**
+   * Markup file storage method
+   */
+  'markup.storageMethodName'?: string;
+
+  /**
+   * Markup file title
+   */
+  'markup.title'?: string;
+
+  /**
+   * Whether to reserve the markup file
+   */
+  reserved?: boolean;
+}
+
+export interface MarkupRetrieveParams {
+  fileGuid: string;
+}
+
+export interface MarkupUpdateParams {
+  /**
+   * Path param:
+   */
+  fileGuid: string;
+
+  /**
+   * Body param:
+   */
+  markup?: MarkupUpdateParams.Markup;
+
+  /**
+   * Body param:
+   */
+  reserved?: boolean;
+}
+
+export namespace MarkupUpdateParams {
+  export interface Markup {
+    author?: FilesAPI.FileAuthor;
+
+    category?: ImageAPI.SingleGuid;
+
+    format?: string;
+
+    location?: string;
+
+    storageMethodName?: string;
+
+    title?: string;
+  }
+}
+
+export interface MarkupDeleteParams {
+  fileGuid: string;
+}
+
+export interface MarkupDownloadContentParams {
+  fileGuid: string;
+}
+
+export interface MarkupUpdateContentParams {
+  /**
+   * Path param:
+   */
+  fileGuid: string;
+
+  /**
+   * Body param: Markup file author full name
+   */
+  'markup.author.fullName'?: string;
+
+  /**
+   * Body param: Markup file category GUID
+   */
+  'markup.category.guid'?: string;
+
+  /**
+   * Body param:
+   */
+  'markup.content'?: Uploadable;
+
+  /**
+   * Body param: Markup file format
+   */
+  'markup.format'?: string;
+
+  /**
+   * Body param: Markup file storage method
+   */
+  'markup.storageMethodName'?: string;
+
+  /**
+   * Body param: Markup file title
+   */
+  'markup.title'?: string;
+
+  /**
+   * Body param: Whether to reserve the markup file
+   */
+  reserved?: boolean;
+}
+
+export declare namespace Markups {
+  export {
+    type FileAssociationMarkup as FileAssociationMarkup,
+    type FileMarkupCreate as FileMarkupCreate,
+    type MarkupListResponse as MarkupListResponse,
+    type MarkupDeleteResponse as MarkupDeleteResponse,
+    type MarkupCreateParams as MarkupCreateParams,
+    type MarkupRetrieveParams as MarkupRetrieveParams,
+    type MarkupUpdateParams as MarkupUpdateParams,
+    type MarkupDeleteParams as MarkupDeleteParams,
+    type MarkupDownloadContentParams as MarkupDownloadContentParams,
+    type MarkupUpdateContentParams as MarkupUpdateContentParams,
+  };
+}

package/src/resources/files.ts

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

package/src/resources/imports/imports.ts

@@ -0,0 +1,221 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RunsAPI from './runs';
+import {
+  RunCompleteParams,
+  RunCreateParams,
+  RunDownloadErrorContentParams,
+  RunDownloadErrorContentResponse,
+  RunDownloadResultContentParams,
+  RunDownloadResultContentResponse,
+  RunDownloadSubmitContentParams,
+  RunDownloadSubmitContentResponse,
+  RunListParams,
+  RunResponseWithGuidVo,
+  RunResponseWithGuidVosOffset,
+  RunRetrieveParams,
+  RunUpdateParams,
+  Runs,
+} from './runs';
+import * as AdministratorsAPI from '../settings/administrators';
+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 Imports extends APIResource {
+  runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
+
+  /**
+   * Creates a new Import Definition object. Note that all Import Engine endpoints
+   * are only supported in Access Policies workspaces.
+   */
+  create(body: ImportCreateParams, options?: RequestOptions): APIPromise<DefinitionResponseWithGuidVo> {
+    return this._client.post('/imports', { body, ...options });
+  }
+
+  /**
+   * Returns an Import Definition with a given GUID.
+   */
+  retrieve(importGuid: string, options?: RequestOptions): APIPromise<DefinitionResponseWithGuidVo> {
+    return this._client.get(path`/imports/${importGuid}`, options);
+  }
+
+  /**
+   * Edits the Import Definition name and description. Import Engine endpoints are
+   * only supported in Access Policies workspaces.
+   */
+  update(
+    importGuid: string,
+    body: ImportUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DefinitionResponseWithGuidVo> {
+    return this._client.put(path`/imports/${importGuid}`, { body, ...options });
+  }
+
+  /**
+   * Returns a collection of Import Definition objects matching the given search
+   * criteria.
+   */
+  list(
+    query: ImportListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DefinitionResponseWithGuidVosOffset, DefinitionResponseWithGuidVo> {
+    return this._client.getAPIList('/imports', Offset<DefinitionResponseWithGuidVo>, { query, ...options });
+  }
+}
+
+export type DefinitionResponseWithGuidVosOffset = Offset<DefinitionResponseWithGuidVo>;
+
+export interface DefinitionResponseWithGuidVo {
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  description?: string;
+
+  guid?: string;
+
+  mode?: string;
+
+  name?: string;
+
+  number?: number;
+
+  options?: Options;
+
+  resource?: string;
+}
+
+export interface Options {
+  checkRefDes?: string;
+
+  createDuplicates?: string;
+
+  fileEditionDelete?: string;
+
+  fileEditionEdit?: string;
+
+  filePlaceHolder?: string;
+
+  mapping?: Array<Options.Mapping>;
+
+  matchDuplicateParents?: string;
+
+  matchDuplicates?: string;
+
+  mergeIdenticalBOMLines?: string;
+
+  multiSelectDelimiter?: string;
+
+  numberingFreeTextHeader?: string;
+
+  removeValue?: string;
+
+  stripWhiteSpace?: string;
+
+  timeZone?: string;
+
+  useCategoryNumberFormat?: string;
+}
+
+export namespace Options {
+  export interface Mapping {
+    apiName?: string;
+
+    inResponse?: boolean;
+
+    notes?: string;
+
+    resource?: string;
+
+    sourceName?: string;
+  }
+}
+
+export interface ImportCreateParams {
+  description?: string;
+
+  mode?: string;
+
+  name?: string;
+
+  options?: Options;
+
+  resource?: string;
+
+  uniqueRequestID?: string;
+
+  userId?: number;
+
+  workspaceId?: number;
+}
+
+export interface ImportUpdateParams {
+  definitionId?: number;
+
+  description?: string;
+
+  name?: string;
+
+  uniqueRequestID?: string;
+
+  userId?: number;
+
+  workspaceId?: number;
+}
+
+export interface ImportListParams extends OffsetParams {
+  creator?: ImportListParams.Creator;
+
+  description?: string;
+
+  mode?: string;
+
+  name?: string;
+
+  number?: string;
+
+  resource?: string;
+}
+
+export namespace ImportListParams {
+  export interface Creator {
+    email?: string;
+
+    fullName?: string;
+
+    guid?: string;
+  }
+}
+
+Imports.Runs = Runs;
+
+export declare namespace Imports {
+  export {
+    type DefinitionResponseWithGuidVo as DefinitionResponseWithGuidVo,
+    type Options as Options,
+    type DefinitionResponseWithGuidVosOffset as DefinitionResponseWithGuidVosOffset,
+    type ImportCreateParams as ImportCreateParams,
+    type ImportUpdateParams as ImportUpdateParams,
+    type ImportListParams as ImportListParams,
+  };
+
+  export {
+    Runs as Runs,
+    type RunResponseWithGuidVo as RunResponseWithGuidVo,
+    type RunDownloadErrorContentResponse as RunDownloadErrorContentResponse,
+    type RunDownloadResultContentResponse as RunDownloadResultContentResponse,
+    type RunDownloadSubmitContentResponse as RunDownloadSubmitContentResponse,
+    type RunResponseWithGuidVosOffset as RunResponseWithGuidVosOffset,
+    type RunCreateParams as RunCreateParams,
+    type RunRetrieveParams as RunRetrieveParams,
+    type RunUpdateParams as RunUpdateParams,
+    type RunListParams as RunListParams,
+    type RunCompleteParams as RunCompleteParams,
+    type RunDownloadErrorContentParams as RunDownloadErrorContentParams,
+    type RunDownloadResultContentParams as RunDownloadResultContentParams,
+    type RunDownloadSubmitContentParams as RunDownloadSubmitContentParams,
+  };
+}

package/src/resources/imports/index.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Imports,
+  type DefinitionResponseWithGuidVo,
+  type Options,
+  type ImportCreateParams,
+  type ImportUpdateParams,
+  type ImportListParams,
+  type DefinitionResponseWithGuidVosOffset,
+} from './imports';
+export {
+  Runs,
+  type RunResponseWithGuidVo,
+  type RunDownloadErrorContentResponse,
+  type RunDownloadResultContentResponse,
+  type RunDownloadSubmitContentResponse,
+  type RunCreateParams,
+  type RunRetrieveParams,
+  type RunUpdateParams,
+  type RunListParams,
+  type RunCompleteParams,
+  type RunDownloadErrorContentParams,
+  type RunDownloadResultContentParams,
+  type RunDownloadSubmitContentParams,
+  type RunResponseWithGuidVosOffset,
+} from './runs';