Files

Methods

(static) deleteByKey(externalKey) → {Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>}

Source:

• src/index.js, line 3831

Since:

• 1.0.0

Example

// delete the file with File ID of 'f729e367-55f8-42e7-ac7c-a9c9a8a8912e'
const caspio = require('caspio-sdk')(caspioCredentials);

async function deleteFile() {
  const FILE_ID = 'f729e367-55f8-42e7-ac7c-a9c9a8a8912e';
  const deleteResult = await caspio.files.deleteByKey(FILE_ID);
  console.log(deleteResult);
  return deleteResult;
}

deleteFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: 'File successfully deleted.'
}

Parameters:

Returns:

Type

Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>

(static) deleteByPath(filePath) → {Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>}

Source:

• src/index.js, line 3780

Since:

• 1.0.0

Example

// deletes file with full path of '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/somefile1.png'
const caspio = require('caspio-sdk')(caspioCredentials);

async function deleteFile() {
  const FILE_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/somefile1.png';
  const deleteResult = await caspio.files.deleteByPath(FILE_PATH);
  console.log(deleteResult);
  return deleteResult;
}

deleteFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "File 'somefile1.png' successfully deleted."
}

Parameters:

Returns:

Type

Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>

(static) downloadByKey(externalKey, saveAsWithoutExtopt) → {Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>}

Source:

• src/index.js, line 3716

Since:

• 1.0.0

Example

// download file with File ID of 'f729e367-55f8-42e7-ac7c-a9c9a8a8912e'
// and save as '/Users/someuser/Desktop/myFile.<extension-of-downloaded-file>'
const caspio = require('caspio-sdk')(caspioCredentials);

async function downloadFile() {
  const FILE_ID = 'f729e367-55f8-42e7-ac7c-a9c9a8a8912e';
  const SAVE_AS = '/Users/someuser/Desktop/myFile';
  const downloadResult = await caspio.files.downloadByKey(FILE_ID, SAVE_AS);
  console.log(downloadResult);
  return downloadResult;
}

downloadFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "File '/Users/someuser/Desktop/myFile.png' successfully downloaded."
}

Parameters:

Returns:

Type

Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>

(static) downloadByPath(filePath, saveAsWithoutExtopt) → {Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>}

Source:

• src/index.js, line 3652

Since:

• 1.0.0

Example

// download file '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/somefile2.png'
// and save as '/Users/someuser/Desktop/myFile.png'
const caspio = require('caspio-sdk')(caspioCredentials);

async function downloadFile() {
  const FILE_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/somefile2.png';
  const SAVE_AS = '/Users/someuser/Desktop/myFile';
  const downloadResult = await caspio.files.downloadByPath(FILE_PATH, SAVE_AS);
  console.log(downloadResult);
  return downloadResult;
}

downloadFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "File '/Users/someuser/Desktop/myFile.png' successfully downloaded."
}

Parameters:

Returns:

Type

Promise.<{status: (200|403|404), statusText: ('OK'|'Forbidden'|'NotFound'), message: string}>

(static) metadataByKey(externalKeyopt) → {Promise.<{Folders: Array.<{Name: string, ExternalKey: string, ContentType: string, DateCreated: string}>, Files: Array.<{Name: string, ExternalKey: string, Size: number, LastModified: string, ContentType: string, DateCreated: string}>}>}

Source:

• src/index.js, line 3162

Since:

• 1.0.0

Example

// get the files and folders in the 'Demo_Sandbox' folder
const caspio = require('caspio-sdk')(caspioCredentials);

async function getFolderMetadata() {
  // the key below is for the 'Demo_Sandbox' folder
  const FILE_FOLDER_ID = "c5b7f134-dcd0-4c34-bba3-34129ee6e9eb";
  const metadata = await caspio.files.metadataByKey(FILE_FOLDER_ID);
  console.log(metadata);
  return metadata;
}

getFolderMetadata();

// sample return value
{
  Folders: [
    {
      Name: 'Demo_Subfolder_One',
      ExternalKey: '4e2ed81b-b9af-4116-852f-c7cc29cda6a1',
      ContentType: 'caspio/folder',
      DateCreated: '1/12/2022 7:14:50 AM'
    },
    {
      Name: 'Demo_Subfolder_Two',
      ExternalKey: '86eccfcc-e295-405f-978c-3e06495b3d82',
      ContentType: 'caspio/folder',
      DateCreated: '1/12/2022 7:14:01 AM'
    }
  ],
  Files: [
    {
      Name: 'ds1.png',
      ExternalKey: 'b0bd9207-06e2-4932-8c1a-97aff5c93ae5',
      Size: 1449,
      LastModified: '1/28/2022 3:31:03 PM',
      ContentType: 'image/png',
      DateCreated: '1/12/2022 7:16:58 AM'
    }
  ]
}

Parameters:

Returns:

Type

Promise.<{Folders: Array.<{Name: string, ExternalKey: string, ContentType: string, DateCreated: string}>, Files: Array.<{Name: string, ExternalKey: string, Size: number, LastModified: string, ContentType: string, DateCreated: string}>}>

(static) metadataByPath(resourcePath, optionsopt) → {Promise.<({Name: string, ExternalKey: string, ContentType: string, DateCreated: string}|{Name: string, ExternalKey: string, Size: number, LastModified: string, ContentType: string, DateCreated: string})>}

Source:

• src/index.js, line 3099

Since:

• 1.0.0

Examples

// Get metadata for the '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder' directory
const caspio = require('caspio-sdk')(caspioCredentials);

async function getDirectoryMetadata() {
  const DIRECTORY_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder';
  const metadata = await caspio.files.metadataByPath(DIRECTORY_PATH, { resourceType: 'd' });
  console.log(metadata);
  return metadata;
}

getDirectoryMetadata();

// sample return value
{
  Name: 'Demo_Subfolder_One_Subfolder',
  ExternalKey: '6b8dc1eb-8c38-4512-8040-8a847e478778',
  ContentType: 'caspio/folder',
  DateCreated: '1/12/2022 7:15:18 AM'
}

// Get metadata for the '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/dsos1.png' file
const caspio = require('caspio-sdk')(caspioCredentials);

async function getFileMetadata() {
  const FILE_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder/dsos1.png';
  const metadata = await caspio.files.metadataByPath(FILE_PATH, { resourceType: 'f' });
  console.log(metadata);
  return metadata;
}

getFileMetadata();

// sample return value
{
  Name: 'dsos1.png',
  ExternalKey: 'c92e471f-8cd1-49ce-b5d5-2c88bf0ab045',
  Size: 1449,
  LastModified: '1/28/2022 3:31:42 PM',
  ContentType: 'image/png',
  DateCreated: '1/24/2022 8:30:51 PM'
}

Parameters:

Returns:

Type

Promise.<({Name: string, ExternalKey: string, ContentType: string, DateCreated: string}|{Name: string, ExternalKey: string, Size: number, LastModified: string, ContentType: string, DateCreated: string})>

(static) uploadByKey(srcFilePathsArr, externalKeyopt) → {Promise.<{status: 201, statusText: 'Created', message: string, uploadedFiles: Array.<{Name: string, ExternalKey: string}>}>}

Source:

• src/index.js, line 3579

Since:

• 1.0.0

Examples

// upload multiple files to a directory where original and new names are used for the uploaded files
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadFiles() {
  const FOLDER_ID = '6b8dc1eb-8c38-4512-8040-8a847e478778';
  const FILES_ARRAY = ['./somefile1.png', ['./somefile2.png', 'myCoolSecondFile'], './somefile3.png'];
  const uploadResult = await caspio.files.uploadByKey(FILES_ARRAY, FOLDER_ID);
  console.log(uploadResult);
  return uploadResult;
}

uploadFiles();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: 'File(s) uploaded successfully, in part or in whole. If a file was not uploaded, then a file with the same name already exists in the specified location.',
  uploadedFiles: [
    {
      Name: 'somefile1.png',
      ExternalKey: '8337a0b4-e314-4e82-a0ee-4ea2e1e8b38b'
    },
    {
      Name: 'myCoolSecondFile.png',
      ExternalKey: 'ab9c2d44-71a4-4218-977d-62aedc21bb53'
    },
    {
      Name: 'somefile3.png',
      ExternalKey: '452d659c-319c-4ebc-95f1-a2a49cc6a97a'
    }
  ]
}

// attempt upload of multiple files to a directory resulting in only one file being uploaded
// since the other two files already exist in the same location by the same name
// (assumes example above was used prior to this example)
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadFiles() {
  const FOLDER_ID = '6b8dc1eb-8c38-4512-8040-8a847e478778';
  const FILES_ARRAY = ['./somefile1.png', './somefile2.png', './somefile3.png'];
  const uploadResult = await caspio.files.uploadByKey(FILES_ARRAY, FOLDER_ID);
  console.log(uploadResult);
  return uploadResult;
}

uploadFiles();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: 'File(s) uploaded successfully, in part or in whole. If a file was not uploaded, then a file with the same name already exists in the specified location.',
  uploadedFiles: [
    {
      Name: 'somefile2.png',
      ExternalKey: 'f9d70ed7-1cce-425b-87b7-914a743da5af'
    }
  ]
}

Parameters:

Returns:

Type

Promise.<{status: 201, statusText: 'Created', message: string, uploadedFiles: Array.<{Name: string, ExternalKey: string}>}>

(static) uploadByPath(srcFilePathsArr, destDirPathopt) → {Promise.<{status: 201, statusText: 'Created', message: string, uploadedFiles: Array.<{Name: string, ExternalKey: string}>}>}

Source:

• src/index.js, line 3450

Since:

• 1.0.0

Examples

// upload multiple files to a directory where original and new names are used for the uploaded files
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadFiles() {
  const FOLDER_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder';
  const FILES_ARRAY = ['./somefile1.png', ['./somefile2.png', 'myCoolSecondFile'], './somefile3.png'];
  const uploadResult = await caspio.files.uploadByPath(FILES_ARRAY, FOLDER_PATH);
  console.log(uploadResult);
  return uploadResult;
}

uploadFiles();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: 'File(s) uploaded successfully, in part or in whole. If a file was not uploaded, then a file with the same name already exists in the specified location.',
  uploadedFiles: [
    {
      Name: 'somefile1.png',
      ExternalKey: '2098314a-7a3d-4721-aa87-42f72dfce8b9'
    },
    {
      Name: 'myCoolSecondFile.png',
      ExternalKey: '06d55aaa-86e3-4392-a052-6def82380a77'
    },
    {
      Name: 'somefile3.png',
      ExternalKey: '070e2b77-efca-4ba5-b3e8-7868dd3d2091'
    }
  ]
}

// attempt upload of multiple files to a directory resulting in only one file being uploaded
// since the other two files already exist in the same location by the same name
// (assumes example above was used prior to this example)
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadFiles() {
  const FOLDER_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder';
  const FILES_ARRAY = ['./somefile1.png', './somefile2.png', './somefile3.png'];
  const uploadResult = await caspio.files.uploadByPath(FILES_ARRAY, FOLDER_PATH);
  console.log(uploadResult);
  return uploadResult;
}

uploadFiles();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: 'File(s) uploaded successfully, in part or in whole. If a file was not uploaded, then a file with the same name already exists in the specified location.',
  uploadedFiles: [
    {
      Name: 'somefile2.png',
      ExternalKey: 'f729e367-55f8-42e7-ac7c-a9c9a8a8912e'
    }
  ]
}

Parameters:

Returns:

Type

Promise.<{status: 201, statusText: 'Created', message: string, uploadedFiles: Array.<{Name: string, ExternalKey: string}>}>

(static) uploadOverwriteByKey(srcFilePath, externalKeyopt, newFileNameNoExtopt) → {Promise.<{status: (200|201), statusText: ('OK'|'Created'), message: string, Name: string, ExternalKey: string}>}

Source:

• src/index.js, line 3340

Since:

• 1.0.0

Examples

// upload the local file 'somefile1.png' to the Files area as 'dsos2.png' in the folder with
// a key of '6b8dc1eb-8c38-4512-8040-8a847e478778' (i.e., 'Demo_Subfolder_One_Subfolder')
// this results in creating a new file (i.e., no file is overwritten)
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadOrOverwriteFile() {
  const FOLDER_ID = '6b8dc1eb-8c38-4512-8040-8a847e478778';
  const uploadResult = await caspio.files.uploadOverwriteByKey('./somefile1.png', FOLDER_ID, 'dsos2');
  console.log(uploadResult);
  return uploadResult;
}

uploadOrOverwriteFile();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: "File 'dsos2.png' uploaded successfully. No file was overwritten.",
  Name: 'dsos2.png',
  ExternalKey: '59f9f6d1-531d-460e-af57-458c2df2cfc6'
}

// upload the local file 'somefile2.png' to the Files area as 'dsos2.png' in the folder with
// a key of '6b8dc1eb-8c38-4512-8040-8a847e478778' (i.e., 'Demo_Subfolder_One_Subfolder')
// this results in overwriting the 'dsos2.png' file that was added in the previous example
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadOrOverwriteFile() {
  const FOLDER_ID = '6b8dc1eb-8c38-4512-8040-8a847e478778';
  const uploadResult = await caspio.files.uploadOverwriteByKey('./somefile2.png', FOLDER_ID, 'dsos2');
  console.log(uploadResult);
  return uploadResult;
}

uploadOrOverwriteFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "File 'dsos2.png' uploaded successfully. Another file of the same name in the same location was overwritten.",
  Name: 'dsos2.png',
  ExternalKey: '59f9f6d1-531d-460e-af57-458c2df2cfc6'
}

Parameters:

Returns:

Type

Promise.<{status: (200|201), statusText: ('OK'|'Created'), message: string, Name: string, ExternalKey: string}>

(static) uploadOverwriteByPath(srcFilePath, destDirPathopt, newFileNameNoExtopt) → {Promise.<{status: (200|201), statusText: ('OK'|'Created'), message: string, Name: string, ExternalKey: string}>}

Source:

• src/index.js, line 3235

Since:

• 1.0.0

Examples

// uploads a local file 'somefile2.png' to the Files area as 'dsos2.png' in the folder with
// full path '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder'
// this results in creating a new file (i.e., no file is overwritten)
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadOrOverwriteFile() {
  const FOLDER_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder';
  const uploadResult = await caspio.files.uploadOverwriteByPath('./somefile2.png', FOLDER_PATH, 'dsos2');
  console.log(uploadResult);
  return uploadResult;
}

uploadOrOverwriteFile();

// sample return value
{
  status: 201,
  statusText: 'Created',
  message: "File 'dsos2.png' uploaded successfully. No file was overwritten.",
  Name: 'dsos2.png',
  ExternalKey: 'ad2c32c8-ae5a-41d9-885c-5f31f0d3a748'
}

// upload the local file 'somefile2.png' to the Files area as 'dsos2.png' in the folder with
// full path '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder'
// this results in overwriting the 'dsos2.png' file that was added in the previous example
const caspio = require('caspio-sdk')(caspioCredentials);

async function uploadOrOverwriteFile() {
  const FOLDER_PATH = '/Demo_Sandbox/Demo_Subfolder_One/Demo_Subfolder_One_Subfolder';
  const uploadResult = await caspio.files.uploadOverwriteByPath('./somefile2.png', FOLDER_PATH, 'dsos2');
  console.log(uploadResult);
  return uploadResult;
}

uploadOrOverwriteFile();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "File 'dsos2.png' uploaded successfully. Another file of the same name in the same location was overwritten.",
  Name: 'dsos2.png',
  ExternalKey: 'ad2c32c8-ae5a-41d9-885c-5f31f0d3a748'
}

Parameters:

Returns:

Type

Promise.<{status: (200|201), statusText: ('OK'|'Created'), message: string, Name: string, ExternalKey: string}>