@silkline/arena 1.0.0

package/src/resources/imports/runs.ts

@@ -0,0 +1,337 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AdministratorsAPI from '../settings/administrators';
+import { APIPromise } from '../../core/api-promise';
+import { Offset, type OffsetParams, PagePromise } from '../../core/pagination';
+import { type Uploadable } from '../../core/uploads';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Runs extends APIResource {
+  /**
+   * Initiates an Import run using an import source file in conjunction with an
+   * existing Import Definition. Creates an Import Run object.
+   *
+   * <b>Notes:</b>
+   *
+   * 1. The import run endpoint executes an import definition.
+   * 2. Import results are saved in Arena and expire after 60 days. Once expired, the
+   *    results files are deleted in Arena and are no longer available.
+   * 3. Import Limits: COMING SOON.
+   *
+   * Import runs can have the following six statuses.
+   */
+  create(
+    importGuid: string,
+    params: RunCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RunResponseWithGuidVo> {
+    const { actor, commit, debug, submitFileType, submitWorksheetName, ...body } = params ?? {};
+    return this._client.post(
+      path`/imports/${importGuid}/runs`,
+      multipartFormRequestOptions(
+        { query: { actor, commit, debug, submitFileType, submitWorksheetName }, body, ...options },
+        this._client,
+      ),
+    );
+  }
+
+  /**
+   * Returns anImport Runs object with a given GUID.
+   */
+  retrieve(
+    importRunGuid: string,
+    params: RunRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<RunResponseWithGuidVo> {
+    const { importGuid } = params;
+    return this._client.get(path`/imports/${importGuid}/runs/${importRunGuid}`, options);
+  }
+
+  /**
+   * Re-run a previous import job using form data
+   */
+  update(
+    importRunGuid: string,
+    params: RunUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<RunResponseWithGuidVo> {
+    const { importGuid, actor, commit, debug } = params;
+    return this._client.put(path`/imports/${importGuid}/runs/${importRunGuid}`, {
+      query: { actor, commit, debug },
+      ...options,
+    });
+  }
+
+  /**
+   * Returns Import Runs objects that are the result of an import definition.
+   */
+  list(
+    importGuid: string,
+    query: RunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RunResponseWithGuidVosOffset, RunResponseWithGuidVo> {
+    return this._client.getAPIList(path`/imports/${importGuid}/runs`, Offset<RunResponseWithGuidVo>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Mark an import run as completed
+   */
+  complete(
+    importRunGuid: string,
+    params: RunCompleteParams,
+    options?: RequestOptions,
+  ): APIPromise<RunResponseWithGuidVo> {
+    const { importGuid } = params;
+    return this._client.put(path`/imports/${importGuid}/runs/${importRunGuid}/complete`, options);
+  }
+
+  /**
+   * Streams the content of the errorContent file of an import run. Unlike the
+   * results content file, this file only contains errors.
+   */
+  downloadErrorContent(
+    importRunGuid: string,
+    params: RunDownloadErrorContentParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { importGuid } = params;
+    return this._client.get(path`/imports/${importGuid}/runs/${importRunGuid}/errorContent`, options);
+  }
+
+  /**
+   * Streams the content of the resultContent file (also called the source file) for
+   * a specific import run. The results content file contains both the successes and
+   * errors of the import run.
+   */
+  downloadResultContent(
+    importRunGuid: string,
+    params: RunDownloadResultContentParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { importGuid } = params;
+    return this._client.get(path`/imports/${importGuid}/runs/${importRunGuid}/resultContent`, options);
+  }
+
+  /**
+   * Streams the content of the submitContent file (also called the source file) of a
+   * specific import run.
+   */
+  downloadSubmitContent(
+    importRunGuid: string,
+    params: RunDownloadSubmitContentParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { importGuid } = params;
+    return this._client.get(path`/imports/${importGuid}/runs/${importRunGuid}/submitContent`, options);
+  }
+}
+
+export type RunResponseWithGuidVosOffset = Offset<RunResponseWithGuidVo>;
+
+export interface RunResponseWithGuidVo {
+  /**
+   * job commit status
+   */
+  commit?: boolean;
+
+  /**
+   * completion datetime in zulu format
+   */
+  completionDateTime?: string;
+
+  /**
+   * creation datetime in zulu format, start when the job start in import engine
+   * service
+   */
+  creationDateTime?: string;
+
+  creator?: AdministratorsAPI.UserCompactAdmin;
+
+  /**
+   * job process records error count
+   */
+  errorCount?: number;
+
+  guid?: string;
+
+  /**
+   * job instance number, auto-generate asc order number for one job definition
+   */
+  number?: number;
+
+  /**
+   * job status
+   */
+  status?: 'CREATED' | 'RUNNING' | 'COMPLETE' | 'PURGED' | 'ERROR';
+
+  /**
+   * [optional] submit file type is the index file type, current support xlsx and csv
+   * only, not support xls, it will be auto-identified by job
+   */
+  submitFileType?: 'EXCEL_WORKSHEET' | 'CSV';
+
+  /**
+   * [optional] specified worksheet name of the xlsx file
+   */
+  submitWorksheetName?: string;
+
+  /**
+   * job process records success count
+   */
+  successCount?: number;
+
+  /**
+   * job process records total count, total = success + error
+   */
+  totalCount?: number;
+
+  warnings?: RunResponseWithGuidVo.Warnings;
+
+  /**
+   * workspace id information
+   */
+  workspaceId?: number;
+}
+
+export namespace RunResponseWithGuidVo {
+  export interface Warnings {
+    count?: number;
+
+    results?: Array<Warnings.Result>;
+  }
+
+  export namespace Warnings {
+    export interface Result {
+      code?: number;
+
+      message?: string;
+    }
+  }
+}
+
+export type RunDownloadErrorContentResponse = unknown;
+
+export type RunDownloadResultContentResponse = unknown;
+
+export type RunDownloadSubmitContentResponse = unknown;
+
+export interface RunCreateParams {
+  /**
+   * Query param:
+   */
+  actor?: number;
+
+  /**
+   * Query param:
+   */
+  commit?: boolean;
+
+  /**
+   * Query param:
+   */
+  debug?: boolean;
+
+  /**
+   * Query param:
+   */
+  submitFileType?: string;
+
+  /**
+   * Query param:
+   */
+  submitWorksheetName?: string;
+
+  /**
+   * Body param:
+   */
+  fileContent?: Uploadable;
+
+  /**
+   * Body param:
+   */
+  submitContent?: Uploadable;
+}
+
+export interface RunRetrieveParams {
+  importGuid: string;
+}
+
+export interface RunUpdateParams {
+  /**
+   * Path param:
+   */
+  importGuid: string;
+
+  /**
+   * Query param:
+   */
+  actor?: number;
+
+  /**
+   * Query param:
+   */
+  commit?: boolean;
+
+  /**
+   * Query param:
+   */
+  debug?: boolean;
+}
+
+export interface RunListParams extends OffsetParams {
+  creator?: RunListParams.Creator;
+
+  number?: string;
+
+  status?: string;
+}
+
+export namespace RunListParams {
+  export interface Creator {
+    email?: string;
+
+    fullName?: string;
+
+    guid?: string;
+  }
+}
+
+export interface RunCompleteParams {
+  importGuid: string;
+}
+
+export interface RunDownloadErrorContentParams {
+  importGuid: string;
+}
+
+export interface RunDownloadResultContentParams {
+  importGuid: string;
+}
+
+export interface RunDownloadSubmitContentParams {
+  importGuid: string;
+}
+
+export declare namespace Runs {
+  export {
+    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.ts

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

package/src/resources/index.ts

@@ -0,0 +1,193 @@
+// 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/changes';
+export {
+  Exports,
+  type ExportDefinition,
+  type ExportCreateParams,
+  type ExportRetrieveParams,
+  type ExportListParams,
+  type ExportDefinitionsOffset,
+} from './exports/exports';
+export {
+  Extracts,
+  type ExtractRetrieveResponse,
+  type ExtractListResponse,
+  type ExtractListParams,
+  type ExtractListResponsesOffset,
+} from './extracts/extracts';
+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/files';
+export {
+  Imports,
+  type DefinitionResponseWithGuidVo,
+  type Options,
+  type ImportCreateParams,
+  type ImportUpdateParams,
+  type ImportListParams,
+  type DefinitionResponseWithGuidVosOffset,
+} from './imports/imports';
+export { Itemrevisions, type ItemrevisionHasImageResponse } from './itemrevisions';
+export {
+  Items,
+  type CategoryMinimal,
+  type CreateFieldVo,
+  type CreateNumberFormat,
+  type ItemFull,
+  type LifecyclePhaseMinimal,
+  type OwnerCreate,
+  type URL,
+  type UserMinimal,
+  type ItemDeleteResponse,
+  type ItemRetrieveHistoryResponse,
+  type ItemRetrieveRevisionsResponse,
+  type ItemRetrieveWhereUsedResponse,
+  type ItemUpdateLifecyclePhaseResponse,
+  type ItemCreateParams,
+  type ItemRetrieveParams,
+  type ItemUpdateParams,
+  type ItemListParams,
+  type ItemUpdateLifecyclePhaseParams,
+  type ItemFullsOffset,
+} from './items/items';
+export { Login, type LoginAuthenticateResponse, type LoginAuthenticateParams } from './login';
+export { Logout } from './logout';
+export {
+  Outboundevents,
+  type OutboundEventIntegration,
+  type OutboundeventListParams,
+  type OutboundEventIntegrationsOffset,
+} from './outboundevents/outboundevents';
+export {
+  Outboundintegrations,
+  type OutboundintegrationRetrieveResponse,
+  type OutboundintegrationListResponse,
+  type OutboundintegrationGetFiltersResponse,
+  type OutboundintegrationListParams,
+  type OutboundintegrationListResponsesOffset,
+} from './outboundintegrations/outboundintegrations';
+export {
+  Qualityprocesses,
+  type CurrentStep,
+  type QualityProcess,
+  type QualityProcessResult,
+  type TemplateCompact,
+  type QualityprocessDeleteResponse,
+  type QualityprocessChangeStatusResponse,
+  type QualityprocessCreateParams,
+  type QualityprocessUpdateParams,
+  type QualityprocessListParams,
+  type QualityprocessChangeStatusParams,
+  type QualityProcessResultResultsOffset,
+} from './qualityprocesses/qualityprocesses';
+export {
+  Requests,
+  type CategoryCompact,
+  type RequestMinimal,
+  type RequestShort,
+  type SingleValue,
+  type RequestDeleteResponse,
+  type RequestChangeStatusResponse,
+  type RequestCreateParams,
+  type RequestRetrieveParams,
+  type RequestUpdateParams,
+  type RequestListParams,
+  type RequestChangeStatusParams,
+  type RequestShortsOffset,
+} from './requests/requests';
+export { Settings, type AccessPolicy, type AttributeDefinitionFullRepResult } from './settings/settings';
+export {
+  Supplieritems,
+  type SupplieritemCreateResponse,
+  type SupplieritemRetrieveResponse,
+  type SupplieritemUpdateResponse,
+  type SupplieritemListResponse,
+  type SupplieritemDeleteResponse,
+  type SupplieritemListWithImagesResponse,
+  type SupplieritemCreateParams,
+  type SupplieritemRetrieveParams,
+  type SupplieritemUpdateParams,
+  type SupplieritemListParams,
+  type SupplieritemListResponsesOffset,
+} from './supplieritems/supplieritems';
+export {
+  Suppliers,
+  type ApprovalStatusMinimal,
+  type PhoneNumber,
+  type SupplierApprovalStatusCompactVo,
+  type SupplierCreateResponse,
+  type SupplierRetrieveResponse,
+  type SupplierUpdateResponse,
+  type SupplierListResponse,
+  type SupplierDeleteResponse,
+  type SupplierCreateParams,
+  type SupplierRetrieveParams,
+  type SupplierUpdateParams,
+  type SupplierListParams,
+  type SupplierListResponsesOffset,
+} from './suppliers/suppliers';
+export {
+  Tickets,
+  type AdditionalAttributeCompact,
+  type AdditionalAttributeCreate,
+  type Ticket,
+  type TicketDeleteResponse,
+  type TicketCreateParams,
+  type TicketUpdateParams,
+  type TicketListParams,
+  type TicketChangeStatusParams,
+  type TicketsOffset,
+} from './tickets/tickets';
+export {
+  Trainingplans,
+  type TrainingShort,
+  type TrainingplanDeleteResponse,
+  type TrainingplanCreateParams,
+  type TrainingplanUpdateParams,
+  type TrainingplanListParams,
+  type TrainingplanChangeStatusParams,
+  type TrainingShortsOffset,
+} from './trainingplans/trainingplans';

package/src/resources/itemrevisions.ts

@@ -0,0 +1,25 @@
+// 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 { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Itemrevisions extends APIResource {
+  /**
+   * Get the item guid which has the thumbnail
+   */
+  hasImage(options?: RequestOptions): APIPromise<ItemrevisionHasImageResponse> {
+    return this._client.get('/itemrevisions/hasimage', options);
+  }
+}
+
+export interface ItemrevisionHasImageResponse {
+  count?: number;
+
+  results?: Array<ImageAPI.SingleGuid>;
+}
+
+export declare namespace Itemrevisions {
+  export { type ItemrevisionHasImageResponse as ItemrevisionHasImageResponse };
+}