Class IMI

constructor

• new IMI(api: Api): IMI

  Parameters

  • api: Api

  Returns IMI

api

createJobs

• createJobs(
      shopOrders: [string, string][],
  ): Promise<
      ApiResponse<
          JobsOutputResponse<CreatedJobStatus>,
          JobsOutputResponse<CreatedJobStatus>,
      >,
  >

  Parameters

  • shopOrders: [string, string][]

  Returns Promise<
      ApiResponse<
          JobsOutputResponse<CreatedJobStatus>,
          JobsOutputResponse<CreatedJobStatus>,
      >,
  >

getAllJobsOutputs

• getAllJobsOutputs(): Promise<
      ApiResponse<
          JobsOutputResponse<JobStatus>,
          JobsOutputResponse<JobStatus>,
      >,
  >

  Returns Promise<
      ApiResponse<
          JobsOutputResponse<JobStatus>,
          JobsOutputResponse<JobStatus>,
      >,
  >

getCustomerOrderLine

• getCustomerOrderLine(
      params: { shopOrder: string },
  ): Promise<ApiResponse<ICustomerOrderLine[], { message: string }>>

  Parameters

  • params: { shopOrder: string }

  Returns Promise<ApiResponse<ICustomerOrderLine[], { message: string }>>

getDocumentFileNames

• getDocumentFileNames(
      jobOrderNo: string,
      lineNos: undefined | string[],
      classCode: string,
  ): Promise<ApiResponse<DocumentFileLookupResult[], { message: string }>>

  Parameters

  • jobOrderNo: string
  • lineNos: undefined | string[]
  • classCode: string

  Returns Promise<ApiResponse<DocumentFileLookupResult[], { message: string }>>

getDocumentInfo

• getDocumentInfo(
      params: DocumentQueryParams,
  ): Promise<ApiResponse<IDocumentInfo[], { message: string }>>

  Parameters

  • params: DocumentQueryParams

  Returns Promise<ApiResponse<IDocumentInfo[], { message: string }>>

getHandlingUnits

• getHandlingUnits(
      params: { contract: string; shipment: string },
  ): Promise<ApiResponse<IHandlingUnit[], { message: string }>>

  Parameters

  • params: { contract: string; shipment: string }

  Returns Promise<ApiResponse<IHandlingUnit[], { message: string }>>

getJobOrderData

• getJobOrderData(
      jobOrderNo: string,
  ): Promise<ApiResponse<IJobOrderData, { message: string }>>

  Parameters

  • jobOrderNo: string

  Returns Promise<ApiResponse<IJobOrderData, { message: string }>>

getJobOrderListing

• getJobOrderListing(
      jobOrderNo: string,
  ): Promise<ApiResponse<SmbFolderNode, { message: string }>>

  Parameters

  • jobOrderNo: string

  Returns Promise<ApiResponse<SmbFolderNode, { message: string }>>

getJobOutputs

• getJobOutputs(
      jobIds: number[],
  ): Promise<
      ApiResponse<
          JobsOutputResponse<JobOutput>,
          JobsOutputResponse<JobOutput>,
      >,
  >

  Parameters

  • jobIds: number[]

  Returns Promise<
      ApiResponse<
          JobsOutputResponse<JobOutput>,
          JobsOutputResponse<JobOutput>,
      >,
  >

getJobsStatus

• getJobsStatus(
      jobIds: number[],
  ): Promise<
      ApiResponse<
          JobsOutputResponse<JobStatus>,
          JobsOutputResponse<JobStatus>,
      >,
  >

  Parameters

  • jobIds: number[]

  Returns Promise<
      ApiResponse<
          JobsOutputResponse<JobStatus>,
          JobsOutputResponse<JobStatus>,
      >,
  >

getOperations

• getOperations(
      params: OperationsQueryParams,
  ): Promise<ApiResponse<IOperation[], { message: string }>>

  Always returns an IOperation[] body, for both branches.

  Status-branch calls ({ status, contract, limit?, offset? }) return the current page as the array, with the total count across all pages in the x-count response header — read it off res.headers['x-count']. Callers already know the limit/offset they requested, so page through until offset + rows.length >= total.

  Shop-order-branch calls ({ contract, shopOrder }) return all operations for that shop order, unpaginated; there's no x-count header for these.

  Parameters

  • params: OperationsQueryParams

  Returns Promise<ApiResponse<IOperation[], { message: string }>>

getOSMMaterials

• getOSMMaterials(
      params: OSMMaterialsQueryParams,
  ): Promise<ApiResponse<IOSMMaterial[], { message: string }>>

  Parameters

  • params: OSMMaterialsQueryParams

  Returns Promise<ApiResponse<IOSMMaterial[], { message: string }>>

getPurchaseOrderLines

• getPurchaseOrderLines(
      params: { contract: string; purchaseOrderId: string },
  ): Promise<ApiResponse<IPurchaseOrderLine[], { message: string }>>

  Parameters

  • params: { contract: string; purchaseOrderId: string }

  Returns Promise<ApiResponse<IPurchaseOrderLine[], { message: string }>>

getRequisitionsStatus

• getRequisitionsStatus(
      contract: string,
      requisitions: string[],
  ): Promise<ApiResponse<IRequisitionStatus[], { message: string }>>

  Parameters

  • contract: string
  • requisitions: string[]

  Returns Promise<ApiResponse<IRequisitionStatus[], { message: string }>>

getRoutingAlternates

• getRoutingAlternates(
      params: RoutingAlternatesQueryParams,
  ): Promise<ApiResponse<IRoutingAlternate[], { message: string }>>

  Parameters

  • params: RoutingAlternatesQueryParams

  Returns Promise<ApiResponse<IRoutingAlternate[], { message: string }>>

getShipmentLines

• getShipmentLines(
      params: { shipmentId: string },
  ): Promise<ApiResponse<IShipmentLine[], { message: string }>>

  Parameters

  • params: { shipmentId: string }

  Returns Promise<ApiResponse<IShipmentLine[], { message: string }>>

getShipments

• getShipments(
      params: { contract: string; shipments: string[] },
  ): Promise<ApiResponse<IShipment[], { message: string }>>

  Parameters

  • params: { contract: string; shipments: string[] }

  Returns Promise<ApiResponse<IShipment[], { message: string }>>

getShopOrderPartBreakdown

• getShopOrderPartBreakdown(
      contract: string,
      shopOrders: string[],
  ): Promise<ApiResponse<IShopOrderPartBreakdown[], { message: string }>>

  Parameters

  • contract: string
  • shopOrders: string[]

  Returns Promise<ApiResponse<IShopOrderPartBreakdown[], { message: string }>>

getShopOrders

• getShopOrders(
      contract: string,
      shopOrders: string[],
  ): Promise<ApiResponse<IShopOrder[], { message: string }>>

  Parameters

  • contract: string
  • shopOrders: string[]

  Returns Promise<ApiResponse<IShopOrder[], { message: string }>>

getSmbFileUrl

• getSmbFileUrl(logicalShareName: string, shareRelativePath: string): string

  Parameters

  • logicalShareName: string
  • shareRelativePath: string

  Returns string

getSupplier

• getSupplier(
      params: SupplierQueryParams,
  ): Promise<ApiResponse<ISupplierInfo[], { message: string }>>

  Parameters

  • params: SupplierQueryParams

  Returns Promise<ApiResponse<ISupplierInfo[], { message: string }>>

listSmbFilesByPrefix

• listSmbFilesByPrefix(
      logicalShareName: string,
      prefix: string,
  ): Promise<ApiResponse<SmbShareListingResponse, { message: string }>>

  Parameters

  • logicalShareName: string
  • prefix: string

  Returns Promise<ApiResponse<SmbShareListingResponse, { message: string }>>

uploadExternalFilesUrl

• uploadExternalFilesUrl(
      data: PresignedUrlData,
  ): Promise<ApiResponse<PresignedUrlResponse, { message: string }>>

  Parameters

  • data: PresignedUrlData

  Returns Promise<ApiResponse<PresignedUrlResponse, { message: string }>>