File

Operazioni

2 endpoint nel files gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.

/api/upload

{
  fileName?: string | null
  fileType?: string | null
  organizationId?: string | null
  conversationId?: string | null
  fileSize?: number | "Infinity" | "-Infinity" | "NaN" | null
}

{
  upload: {
    id: string
    fileName: string
    s3Key: string
    s3Bucket: string
    s3ContentType: string
    s3Size: number | "Infinity" | "-Infinity" | "NaN"
    objectId: string | null
    objectType: string | null
    ownerId: string
    organizationId: string | null
    createdAt: string
    updatedAt: string
    publicUrl: string
  }
  uploadUrl: string
}

BadRequestEncoded

UnauthorizedEncoded

ForbiddenEncoded

InternalErrorEncoded

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// FilesUploadInput
const result = await client.files.upload({
  fileName: "",
  fileType: "",
  organizationId: "",
  conversationId: "",
  fileSize: 0
})

curl --request POST "${CADCAMFUN_URL}/api/upload" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

/api/download

string

UnauthorizedEncoded

NotFoundEncoded

InternalErrorEncoded

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/download`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl --request GET "${CADCAMFUN_URL}/api/download" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Schemi

Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.

{
  _tag: "BadRequest"
  message: string
}

{
  _tag: "Forbidden"
  message: string
}

{
  _tag: "InternalError"
  message: string
}

{
  _tag: "NotFound"
  message: string
}

{
  _tag: "Unauthorized"
  message: string
}

Chiamando questo gruppo

Gli ID operazione hanno il formato files.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Risoluzione dei problemi