Variable ENDPOINTSConst

Type declaration

• Readonly changeDocument: {
      _payloadT: ChangeManifestParams;
      _responseT: ManifestDocumentResponse;
      method: "post";
      route: "/v1/nodes/documents";
  }

  Append /[uuid]/actions

  • Readonly _payloadT: ChangeManifestParams

  • Readonly _responseT: ManifestDocumentResponse

  • Readonly method: "post"

  • Readonly route: "/v1/nodes/documents"

• Readonly createDpid: {
      _payloadT: {
          uuid: string;
      };
      _responseT: {
          dpid: number;
      };
      method: "post";
      route: "/v1/nodes/createDpid";
  }

  • Readonly _payloadT: {
        uuid: string;
    }

    • uuid: string

  • Readonly _responseT: {
        dpid: number;
    }

    • dpid: number

  • Readonly method: "post"

  • Readonly route: "/v1/nodes/createDpid"

• Readonly createDraft: {
      _payloadT: CreateDraftParams;
      _responseT: CreateDraftResponse;
      method: "post";
      route: "/v1/nodes/createDraft";
  }

  • Readonly _payloadT: CreateDraftParams

  • Readonly _responseT: CreateDraftResponse

  • Readonly method: "post"

  • Readonly route: "/v1/nodes/createDraft"

• Readonly createFolder: {
      _payloadT: CreateFolderParams;
      _responseT: CreateFolderResponse;
      method: "post";
      route: "/v1/data/update";
  }

  • Readonly _payloadT: CreateFolderParams

  • Readonly _responseT: CreateFolderResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/update"

• Readonly deleteData: {
      _payloadT: DeleteDataParams;
      _responseT: DeleteDataResponse;
      method: "post";
      route: "/v1/data/delete";
  }

  • Readonly _payloadT: DeleteDataParams

  • Readonly _responseT: DeleteDataResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/delete"

• Readonly deleteDraft: {
      _payloadT: undefined;
      _responseT: undefined;
      method: "delete";
      route: "/v1/nodes";
  }

  Append /[uuid]

  • Readonly _payloadT: undefined

  • Readonly _responseT: undefined

  • Readonly method: "delete"

  • Readonly route: "/v1/nodes"

• Readonly dpidHistory: {
      _payloadT: undefined;
      _responseT: IndexedNode;
      method: "get";
      route: "/v1/pub/versions";
  }

  Append /[uuid]

  • Readonly _payloadT: undefined

  • Readonly _responseT: IndexedNode

  • Readonly method: "get"

  • Readonly route: "/v1/pub/versions"

• Readonly getDocument: {
      _payloadT: undefined;
      _responseT: ManifestDocumentResponse;
      method: "get";
      route: "/v1/nodes/documents";
  }

  Append /[uuid]

  • Readonly _payloadT: undefined

  • Readonly _responseT: ManifestDocumentResponse

  • Readonly method: "get"

  • Readonly route: "/v1/nodes/documents"

• Readonly listNodes: {
      _payloadT: undefined;
      _responseT: {
          nodes: ListedNode[];
      };
      method: "get";
      route: "/v1/nodes/";
  }

  • Readonly _payloadT: undefined

  • Readonly _responseT: {
        nodes: ListedNode[];
    }

    • nodes: ListedNode[]

  • Readonly method: "get"

  • Readonly route: "/v1/nodes/"

• Readonly moveData: {
      _payloadT: MoveDataParams;
      _responseT: MoveDataResponse;
      method: "post";
      route: "/v1/data/move";
  }

  • Readonly _payloadT: MoveDataParams

  • Readonly _responseT: MoveDataResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/move"

• Readonly prepublish: {
      _payloadT: {
          uuid: string;
      };
      _responseT: PrepublishResponse;
      method: "post";
      route: "/v1/nodes/prepublish";
  }

  • Readonly _payloadT: {
        uuid: string;
    }

    • uuid: string

  • Readonly _responseT: PrepublishResponse

  • Readonly method: "post"

  • Readonly route: "/v1/nodes/prepublish"

• Readonly publish: {
      _payloadT: PublishParams;
      _responseT: PublishResponse;
      method: "post";
      route: "/v1/nodes/publish";
  }

  • Readonly _payloadT: PublishParams

  • Readonly _responseT: PublishResponse

  • Readonly method: "post"

  • Readonly route: "/v1/nodes/publish"

• Readonly retrieveTree: {
      _payloadT: undefined;
      _responseT: RetrieveResponse;
      method: "get";
      route: "/v1/data/retrieveTree";
  }

  Append /[uuid]/tree tree does nothing but a string needs to be there because of derp routing

  • Readonly _payloadT: undefined

  • Readonly _responseT: RetrieveResponse

  • Readonly method: "get"

  • Readonly route: "/v1/data/retrieveTree"

• Readonly showNode: {
      _payloadT: undefined;
      _responseT: NodeResponse;
      method: "get";
      route: "/v1/nodes/objects";
  }

  Append /[uuid]

  • Readonly _payloadT: undefined

  • Readonly _responseT: NodeResponse

  • Readonly method: "get"

  • Readonly route: "/v1/nodes/objects"

• Readonly updateExternalCid: {
      _payloadT: AddExternalTreeParams;
      _responseT: UploadFilesResponse;
      method: "post";
      route: "/v1/data/updateExternalCid";
  }

  • Readonly _payloadT: AddExternalTreeParams

  • Readonly _responseT: UploadFilesResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/updateExternalCid"

• Readonly uploadExternal: {
      _payloadT: UploadPdfFromUrlParams | UploadGithubRepoFromUrlParams;
      _responseT: UploadFilesResponse;
      method: "post";
      route: "/v1/data/update";
  }

  • Readonly _payloadT: UploadPdfFromUrlParams | UploadGithubRepoFromUrlParams

  • Readonly _responseT: UploadFilesResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/update"

• Readonly uploadFiles: {
      _payloadT: UploadParams;
      _responseT: UploadFilesResponse;
      method: "post";
      route: "/v1/data/update";
  }

  • Readonly _payloadT: UploadParams

  • Readonly _responseT: UploadFilesResponse

  • Readonly method: "post"

  • Readonly route: "/v1/data/update"