caspio-sdk v1.0.3

caspio-sdk

Software development kit (SDK) and REST API wrapper for the Caspio REST API (v2).

Visit the caspio-sdk docs website to see the documentation for this package in a more readable format (as well as in-depth tutorials). If you're already there, great!

Note: This package was developed and tested using Node.js v16.13.0.

Contents

• Features
• Installation
• Usage
  • Getting started without a valid access token
  • Getting started with a valid access token
• Example
• Methods Overview
  • Applications (apps)
  • Files (files)
  • Tables (tables)
  • Tasks (tasks)
  • Utilities (utils)
  • Views (views)
• SDK API (Package Documentation)
• License

Features

• Full coverage of all Caspio REST API resource endpoints
• Extended coverage of many endpoints that offers a cleaner data manipulation interface
• Capabilities not offered directly by Caspio's REST API (e.g., ability to copy records)
• Comprehensive documentation that can be difficult or impossible to find directly on Caspio's website
• Detailed examples that make the documentation come to life
• Detailed tutorials that explain how to meet common development needs

Installation

npm install caspio-sdk

Usage

All requests to Caspio REST API resource endpoints must be made with a valid access token (which expires every 24 hours). The two subsections below outline how to start using this SDK if you do not already have a valid access token or if you do, respectively.

Getting started without a valid access token

If you do not have a valid access token, then you may obtain one by authenticating with Caspio's REST API in the following manner, namely by providing the clientID, clientSecret, and tokenEndpointURL for one of your Caspio account's active web services profiles:

// provide credentials for active web services profile
const caspioAuthCredentials = {
  clientID: '*****',
  clientSecret: '*****',
  tokenEndpointURL: '*****',
}

// obtain function to make request for a new valid access token
const getAccessToken = require('caspio-sdk/auth')(caspioAuthCredentials);

// obtain new access token
async function sdkGetValidAccessToken() {
  const data = await getAccessToken();
  console.log(data.access_token);
}

Once you have a valid access token, you can follow the directions immediately below to begin issuing requests.

Getting started with a valid access token

Require the caspio-sdk module in your project and make all SDK methods available by providing your Caspio account credentials upon requiring the module, namely an object with your Caspio's accountID and a valid accessToken that will make it possible to issue authorized requests:

// provide credentials for Caspio account
const caspioCredentials = {
  accountID: '*****',
  accessToken: '*****'
}

// obtain authenticated SDK methods to start issuing requests
const caspio = require('caspio-sdk')(caspioCredentials);

// start issuing requests
async function sdkUseMethods() {
  // method categories available: apps, tables, views, files, tasks, utils
  const data = await caspio.(apps|tables|views|files|tasks|utils).desiredMethod(args);
  console.log(data);
}

Example

An example of issuing a request using this SDK is provided below, but a brief description of every method in this SDK may be found in the next section. The docs website provides the full details (i.e., extensive documentation, detailed examples, etc.).

With the above in mind, here is a simple example of using this SDK to fetch a list of a Caspio account's applications and their properties:

const caspioCredentials = {
  accountID: '*****',
  accessToken: '*****'
}

const caspio = require('caspio-sdk')(caspioCredentials);

async function docsDemoMethodUse() {
  // use the 'listing' method from the 'apps' category
  const propertiesForAllApps = await caspio.apps.listing();
  return propertiesForAllApps;
}

docsDemoMethodUse();
 
// sample return value
[
  ...,
  {
    AppName: 'Demo - Physician Directory - Caspio SDK',
    ExternalKey: '09d18152-7c45-44f1-a0e6-5ffe18881b60',
    DataPagesCount: 5,
    DateCreated: '2022-01-25T15:17:10.607',
    DateModified: '2022-01-25T15:20:44.850',
    DefaultIcon: true,
    IconFileName: ''
  },
  ...
]

Many of the examples outlined on the docs website run against the Demo - Physician Directory - Caspio SDK application, a slightly modified version of the default application Caspio provides to users of new accounts.

If you want to run some of the examples in the documentation against the same set of data, then you can use Caspio's "Import" functionality to import the following application (accessible on this package's GitHub page): Demo_Physician_Directory_Caspio_SDK.zip.

Methods Overview

The following tables provide very brief descriptions of all methods for each category made available for use in this SDK. Each method is listed first by its name (without the method's signature) and then by a description that provides a very high-level overview of what the method does. The docs website provides the full details for each method.

apps

files

tables

tasks

utils

views

In general, it is recommended to not use the provided methods to create, delete, and/or update records in a view. Why? Because each of these methods is simply a disguised version of creating, deleting, and/or updating records in an underlying table. Usage of these methods may lead to undesirable and/or unpredictable results. The documentation for each method spells out the full details with detailed examples.

SDK API Package Documentation

Check out the caspio-sdk docs website for this package's documentation in its most readable form (use the lefthand menu to find methods of interest).

Documentation for immediate reference may be found below.

Objects

Applications : object

Methods for applications.

Kind: global namespace

• Applications : object
  • .listing() ⇒ Promise.<Array.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>>
  • .propertiesByName(appName) ⇒ Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>
  • .propertiesByKey(externalKey) ⇒ Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>
  • .dpPropertiesByAppName(appName) ⇒ Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>>
  • .dpPropertiesByAppKey(externalKey) ⇒ Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>>
  • .dpPropertiesByNames(appName, dataPageName) ⇒ Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>
  • .dpPropertiesByKeys(externalKey, appKey) ⇒ Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>
  • .dpDeployCodeByNames(appName, dataPageName, deployMethod) ⇒ Promise.<string>
  • .dpDeployCodeByKeys(externalKey, appKey, deployMethod) ⇒ Promise.<string>
  • .dpDeployByNames(appName, dataPageName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDeployByKeys(externalKey, appKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDisableByNames(appName, dataPageName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDisableByKeys(externalKey, appKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDeployAllByAppName(appName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDeployAllByAppKey(externalKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDisableAllByAppName(appName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .dpDisableAllByAppKey(externalKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Applications.listing() ⇒ Promise.<Array.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>>

Returns list of applications (i.e., an array of objects where each object represents an application and its properties).

Kind: static method of Applications
Returns: Promise.<Array.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>> - Array of Caspio applications with each application's properties
Since: 1.0.0
Example

// get list of all Caspio applications linked to a Caspio account
const caspio = require('caspio-sdk')(caspioCredentials);

async function getAllAppProperties() {
  const propertiesForAllApps = await caspio.apps.listing();
  console.log(propertiesForAllApps);
  return propertiesForAllApps;
}

getAllAppProperties();

// sample return value
[
  ...,
  {
    AppName: 'Demo - Physician Directory - Caspio SDK',
    ExternalKey: '09d18152-7c45-44f1-a0e6-5ffe18881b60',
    DataPagesCount: 5,
    DateCreated: '2022-01-25T15:17:10.607',
    DateModified: '2022-01-25T15:20:44.850',
    DefaultIcon: true,
    IconFileName: ''
  },
  ...
]

Applications.propertiesByName(appName) ⇒ Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>

Returns the application's properties (i.e., an object that represents an application's properties given the application's case-insensitive name, appName).

Kind: static method of Applications
Returns: Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}> - Object representing a Caspio application and its properties
Since: 1.0.0

Example

// get properties of the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function getAppProperties() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const appProperties = await caspio.apps.propertiesByName(APP_NAME);
  console.log(appProperties);
  return appProperties;
}

getAppProperties();

// sample return value
{
  AppName: 'Demo - Physician Directory - Caspio SDK',
  ExternalKey: '09d18152-7c45-44f1-a0e6-5ffe18881b60',
  DataPagesCount: 5,
  DateCreated: '2022-01-25T15:17:10.607',
  DateModified: '2022-01-25T15:20:44.850',
  DefaultIcon: true,
  IconFileName: ''
}

Applications.propertiesByKey(externalKey) ⇒ Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}>

Returns the application's properties (i.e., an object that represents an application's properties given the application's ID, externalKey).

Kind: static method of Applications
Returns: Promise.<{AppName: string, ExternalKey: string, DataPagesCount: number, DateCreated: string, DateModified: string, DefaultIcon: boolean, IconFileName: string}> - Object representing a Caspio application and its properties
Since: 1.0.0

Example

// get properties of the 'Demo - Physician Directory - Caspio SDK' application
// whose application ID is '09d18152-7c45-44f1-a0e6-5ffe18881b60'
const caspio = require('caspio-sdk')(caspioCredentials);

async function getAppProperties() {
  const APP_KEY = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const appProperties = await caspio.apps.propertiesByKey(APP_KEY);
  console.log(appProperties);
  return appProperties;
}

getAppProperties();

// sample return value
{
  AppName: 'Demo - Physician Directory - Caspio SDK',
  ExternalKey: '09d18152-7c45-44f1-a0e6-5ffe18881b60',
  DataPagesCount: 5,
  DateCreated: '2022-01-25T15:17:10.607',
  DateModified: '2022-01-25T15:20:44.850',
  DefaultIcon: true,
  IconFileName: ''
}

Applications.dpPropertiesByAppName(appName) ⇒ Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>>

Returns a list of DataPage properties for DataPages associated with an application (i.e., an array of objects where the objects represent an application's DataPages and their properties--the application is identified by its case-insensitive name, appName).

Kind: static method of Applications
Returns: Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>> - Array of DataPages and their properties linked to a specific application
Since: 1.0.0

Example

// get all DataPage properties linked to the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpPropertiesForApp() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const dpProperties = await caspio.apps.dpPropertiesByAppName(APP_NAME);
  console.log(dpProperties);
  return dpProperties;
}

dpPropertiesForApp();

// sample return value
[
  ...,
  {
    Name: 'Physician Registration',
    AppKey: '409550008f83dc4dd4554a07b7bf',
    AppName: 'Demo - Physician Directory - Caspio SDK',
    Path: '/Public Interfaces',
    Type: 'WEBFORM',
    DateCreated: '2022-01-25T15:20:43.787',
    DateModified: '2022-01-25T15:20:43.837',
    CreatedBy: 'user@user.com',
    ModifiedBy: '',
    Note: ''
  },
  ...
]

Applications.dpPropertiesByAppKey(externalKey) ⇒ Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>>

Returns a list of DataPage properties for DataPages associated with an application (i.e., an array of objects where the objects represent an application's DataPages and their properties--the application is identified by its App ID, externalKey).

Kind: static method of Applications
Returns: Promise.<Array.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>> - Array of DataPages and their properties linked to a specific application
Since: 1.0.0

Example

// get all DataPage properties linked to the 'Demo - Physician Directory - Caspio SDK' application
// whose App ID is '09d18152-7c45-44f1-a0e6-5ffe18881b60'
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpPropertiesForApp() {
  const APP_KEY = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const dpProperties = await caspio.apps.dpPropertiesByAppKey(APP_KEY);
  console.log(dpProperties);
  return dpProperties;
}

dpPropertiesForApp();

// sample return value
[
  ...,
  {
    Name: 'Physician Registration',
    AppKey: '409550008f83dc4dd4554a07b7bf',
    AppName: 'Demo - Physician Directory - Caspio SDK',
    Path: '/Public Interfaces',
    Type: 'WEBFORM',
    DateCreated: '2022-01-25T15:20:43.787',
    DateModified: '2022-01-25T15:20:43.837',
    CreatedBy: 'user@user.com',
    ModifiedBy: '',
    Note: ''
  },
  ...
]

Applications.dpPropertiesByNames(appName, dataPageName) ⇒ Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>

Returns the DataPage's properties (object) for the specified DataPage (i.e., dataPageName) linked to the specified application (i.e., appName), where both specifications are case-insensitive.

Kind: static method of Applications
Returns: Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}> - Object representing the properties of the specified DataPage for the specified application
Since: 1.0.0

Example

// get properties of the 'Physician Registration' DataPage which is a DataPage in
// the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpGetProperties() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const DP_NAME = 'Physician Registration';
  const dpProperties = await caspio.apps.dpPropertiesByNames(APP_NAME, DP_NAME);
  console.log(dpProperties);
  return dpProperties;
}

dpGetProperties();

// sample return value
{
  Name: 'Physician Registration',
  AppKey: '409550008f83dc4dd4554a07b7bf',
  AppName: 'Demo - Physician Directory - Caspio SDK',
  Path: '/Public Interfaces',
  Type: 'WEBFORM',
  DateCreated: '2022-01-25T15:20:43.787',
  DateModified: '2022-01-25T15:20:43.837',
  CreatedBy: 'user@user.com',
  ModifiedBy: '',
  Note: ''
}

Applications.dpPropertiesByKeys(externalKey, appKey) ⇒ Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}>

Returns the DataPage's properties (object) for the specified DataPage (i.e., appKey) linked to the specified application (i.e., externalKey).

Kind: static method of Applications
Returns: Promise.<{Name: string, AppKey: string, AppName: string, Path: string, Type: string, DateCreated: string, DateModified: string, CreatedBy: string, ModifiedBy: string, Note: string}> - Object representing the properties of the specified DataPage for the specified application
Since: 1.0.0

Example

// get properties of the 'Physician Registration' DataPage which is a DataPage in
// the 'Demo - Physician Directory - Caspio SDK' application
// 'Physician Registration' DataPage key: '409550008f83dc4dd4554a07b7bf'
// 'Demo - Physician Directory - Caspio SDK' application key: '09d18152-7c45-44f1-a0e6-5ffe18881b60'
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpGetProperties() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const DP_ID = '409550008f83dc4dd4554a07b7bf';
  const dpProperties = await caspio.apps.dpPropertiesByKeys(APP_ID, DP_ID);
  console.log(dpProperties);
  return dpProperties;
}

dpGetProperties();

// sample return value
{
  Name: 'Physician Registration',
  AppKey: '409550008f83dc4dd4554a07b7bf',
  AppName: 'Demo - Physician Directory - Caspio SDK',
  Path: '/Public Interfaces',
  Type: 'WEBFORM',
  DateCreated: '2022-01-25T15:20:43.787',
  DateModified: '2022-01-25T15:20:43.837',
  CreatedBy: 'user@user.com',
  ModifiedBy: '',
  Note: ''
}

Applications.dpDeployCodeByNames(appName, dataPageName, deployMethod) ⇒ Promise.<string>

Returns deploy code (string) for a DataPage given an application name (i.e., appName), DataPage name (i.e., dataPageName), and deploy method (i.e., deployMethod), where all parameters are case-insensitive.

Kind: static method of Applications
Returns: Promise.<string> - String representing the deploy code for the specified DataPage for the specified application
See: Read the Caspio documentation on SEO deployment directions for more details.
Since: 1.0.0

Example

// get the URL deploy code of the 'Physician Registration' DataPage
// which lives in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpGetDeployCode() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const DP_NAME = 'Physician Registration';
  const dpDeployCode = await caspio.apps.dpDeployCodeByNames(APP_NAME, DP_NAME, 'U');
  console.log(dpDeployCode);
  return dpDeployCode;
}

dpGetDeployCode();

// sample return value
'https://ab1de2fg3.caspio.com/dp/409550008f83dc4dd4554a07b7bf'

Applications.dpDeployCodeByKeys(externalKey, appKey, deployMethod) ⇒ Promise.<string>

Returns deploy code (string) for a DataPage given an application's ID (i.e., externalKey), DataPage ID (i.e., appKey), and deploy method (i.e., deployMethod), where the deployMethod is case-insensitive.

Kind: static method of Applications
Returns: Promise.<string> - String representing the deploy code for the specified DataPage for the specified application
See: Read the Caspio documentation on SEO deployment directions for more details.
Since: 1.0.0

Example

// get the URL deploy code of the 'Physician Registration' DataPage
// which lives in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpGetDeployCode() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const DP_ID = '409550008f83dc4dd4554a07b7bf';
  const dpDeployCode = await caspio.apps.dpDeployCodeByKeys(APP_ID, DP_ID, 'U');
  console.log(dpDeployCode);
  return dpDeployCode;
}

dpGetDeployCode();

// sample return value
'https://ab1de2fg3.caspio.com/dp/409550008f83dc4dd4554a07b7bf'

Applications.dpDeployByNames(appName, dataPageName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Deploy a DataPage by specifying the name of the application to which the DataPage is linked (i.e., appName) as well as specifying the name of the DataPage itself (i.e., dataPageName).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted deployment (i.e., status, statusText, and message).
Since: 1.0.0

Example

// deploy the 'Physician Registration' DataPage which is part of the
// 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDeploy() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const DP_NAME = 'Physician Registration';
  const deployResult = await caspio.apps.dpDeployByNames(APP_NAME, DP_NAME);
  console.log(deployResult);
  return deployResult;
}

dpDeploy();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "DataPage 'Physician Registration' has been successfully deployed."
}

Applications.dpDeployByKeys(externalKey, appKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Deploy a DataPage by specifying the ID of the application to which the DataPage is linked (i.e., externalKey) as well as specifying the ID of the DataPage itself (i.e., appKey).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted deployment (i.e., status, statusText, and message).
Since: 1.0.0

Example

// deploy the 'Physician Registration' DataPage which is part of the
// 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDeploy() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const DP_ID = '409550008f83dc4dd4554a07b7bf';
  const deployResult = await caspio.apps.dpDeployByKeys(APP_ID, DP_ID);
  console.log(deployResult);
  return deployResult;
}

dpDeploy();

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

Applications.dpDisableByNames(appName, dataPageName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Disable a DataPage by specifying the name of the application to which the DataPage is linked (i.e., appName) as well as specifying the name of the DataPage itself (i.e., dataPageName).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the disable attempt (i.e., status, statusText, and message).
Since: 1.0.0

Example

// disable the 'Physician Registration' DataPage which is part of the
// 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDisable() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const DP_NAME = 'Physician Registration';
  const disableResult = await caspio.apps.dpDisableByNames(APP_NAME, DP_NAME);
  console.log(disableResult);
  return disableResult;
}

dpDisable();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "DataPage 'Physician Registration' has been successfully disabled."
}

Applications.dpDisableByKeys(externalKey, appKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Disable a DataPage by specifying the ID of the application to which the DataPage is linked (i.e., externalKey) as well as specifying the ID of the DataPage itself (i.e., appKey).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the disable attempt (i.e., status, statusText, and message).
Since: 1.0.0

Example

// disable the 'Physician Registration' DataPage which is part of the
// 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDeploy() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const DP_ID = '409550008f83dc4dd4554a07b7bf';
  const deployResult = await caspio.apps.dpDeployByKeys(APP_ID, DP_ID);
  console.log(deployResult);
  return deployResult;
}

dpDeploy();

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

Applications.dpDeployAllByAppName(appName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Deploys all DataPages in an application where the application is specified by its case-insensitive name (i.e., appName).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted deployment of all DataPages in the specified application (i.e., status, statusText, and message).
Since: 1.0.0

Example

// deploy all DataPages in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDeployAll() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const deployResult = await caspio.apps.dpDeployAllByAppName(APP_NAME);
  console.log(deployResult);
  return deployResult;
}

dpDeployAll();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "All DataPages in application 'Demo - Physician Directory - Caspio SDK' have been successfully deployed."
}

Applications.dpDeployAllByAppKey(externalKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Deploys all DataPages in an application where the application is specified by its ID (i.e., externalKey).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted deployment of all DataPages in the specified application (i.e., status, statusText, and message).
Since: 1.0.0

Example

// deploy all DataPages in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDeployAll() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const deployResult = await caspio.apps.dpDeployAllByAppKey(APP_ID);
  console.log(deployResult);
  return deployResult;
}

dpDeployAll();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: 'All DataPages in the specified application have been successfully deployed.'
}

Applications.dpDisableAllByAppName(appName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Disables all DataPages in an application where the application is specified by its case-insensitive name (i.e., appName).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted disabling of all DataPages in the specified application (i.e., status, statusText, and message).
Since: 1.0.0

Example

// disable all DataPages in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDisableAll() {
  const APP_NAME = 'Demo - Physician Directory - Caspio SDK';
  const disableResult = await caspio.apps.dpDisableAllByAppName(APP_NAME);
  console.log(disableResult);
  return disableResult;
}

dpDisableAll();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: "All DataPages in application 'Demo - Physician Directory - Caspio SDK' have been successfully disabled."
}

Applications.dpDisableAllByAppKey(externalKey) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>

Disables all DataPages in an application where the application is specified by its ID (i.e., externalKey).

Kind: static method of Applications
Returns: Promise.<{status: 200, statusText: 'OK', message: string}> - Object with information about the attempted disabling of all DataPages in the specified application (i.e., status, statusText, and message).
Since: 1.0.0

Example

// disable all DataPages in the 'Demo - Physician Directory - Caspio SDK' application
const caspio = require('caspio-sdk')(caspioCredentials);

async function dpDisableAll() {
  const APP_ID = '09d18152-7c45-44f1-a0e6-5ffe18881b60';
  const disableResult = await caspio.apps.dpDisableAllByAppKey(APP_ID);
  console.log(disableResult);
  return disableResult;
}

dpDisableAll();

// sample return value
{
  status: 200,
  statusText: 'OK',
  message: 'All DataPages in the specified application have been successfully disabled.'
}

Tables : object

Methods for tables.

Kind: global namespace

• Tables : object
  • .listing() ⇒ Promise.<Array.<string>>
  • .create(tableName, fieldDefinitions) ⇒ Promise.<{status: 201, statusText: 'Created', message: string}>
  • .description(tableName) ⇒ Promise.<{Name: string, Note: string}>
  • .definition(tableName) ⇒ Promise.<Array.<{Name: string, Type: string, Unique: boolean, UniqueAllowNulls: boolean, Label: string, Description: string, DisplayOrder: number, OnInsert: boolean, OnUpdate, boolean, TimeZone: string, Format: string, Prefix: string, Length: number, IsFormula: boolean, ListField: object}>>
  • .addField(tableName, fieldToAdd) ⇒ Promise.<{status: 201, statusText: 'Created', message: string}>
  • .fieldDefinition(tableName) ⇒ Promise.<{Name: string, Type: string, Unique: boolean, UniqueAllowNulls: boolean, Label: string, Description: string, DisplayOrder: number, OnInsert: boolean, OnUpdate, boolean, TimeZone: string, Format: string, Prefix: string, Length: number, IsFormula: boolean, ListField: object}>
  • .updateFieldDefinition(tableName, fieldName, updatedFieldDef) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .deleteField(tableName, fieldName) ⇒ Promise.<{status: 200, statusText: 'OK', message: string}>
  • .passwordFields(tableName) ⇒ Promise.<Array.<string>>
  • .updatePasswordFieldValue(tableName, passwordFieldName, newPasswordValue, whereClause) ⇒ Promise.<{status: 200, statusText: 'OK', recordsAffected: number, message: string}>
  • .deletePasswordFieldValue(tableName, passwordFieldName, whereClause) ⇒ Promise.<{status: 200, statusText: 'OK', recordsAffected: number, message: string}>
  • .getRecordsPaginated(tableName, [selectionCriteriaObj]) ⇒ Promise.<Array.<Object>>
  • .getRecords(tableName, [selectionCriteriaObj]) ⇒ Promise.<Array.<Object>>
  • .getRecordsStreamToFile(tableName, filePath, [selectionCriteriaObj]) ⇒ void
  • .updateRecords(tableName, whereClause, newRecordValuesObj, [options]) ⇒ Promise.<({status: 200, statusText: 'OK', message: string, recordsAffected: number}|{status: 200, statusText: 'OK', message: string, recordsAffected: number, updatedRecords: Array.<Object>})>
  • .createRecord(tableName, recordValuesObj, [options]) ⇒ Promise.<({status: 201, statusText: 'Created', message: string}|{status: 201, statusText: 'Created', message: string, createdRecord: object})>
  • .deleteRecords(tableName, whereClause) ⇒ Promise.<{status: 200, statusText: 'OK', message: string, recordsAffected: number}>

Tables.listing() ⇒ Promise.<Array.<string>>

Returns an array of strings where each string represents an available table for a Caspio account.

Kind: static method of Tables
Returns: Promise.<Array.<string>> - Array of strings representing table names for a Caspio account
Since: 1.0.0
Example

// get list of all table names linked to a Caspio account
const caspio = require('caspio-sdk')(caspioCredentials);

async function getTableNames() {
  const tableNames = await caspio.tables.listing();
  console.log(tableNames);
  return tableNames;
}

getTableNames();

// sample return value
[
  ...,
  'Demo_Physicians',
  ...
]

Tables.create(tableName, fieldDefinitions) ⇒ Promise.<{status: 201, statusText: 'Created', message: string}>

Creates a new table using the name and field definitions provided (i.e., tableName and fieldDefinitions, respectively). This is often a slow method and takes a while for the request to be processed by Caspio's servers.

Note (incompatible types): Some properties are not compatible with some field types. For example, it is not possible to specify a Prefix for a field whose Type is 'TIMESTAMP'. Use care and caution when creating field definitions. The example that accompanies this method shows examples of each field Type creation.

Kind: static method of Tables
Returns: Promise.<{status: 201, statusText: 'Created', message: string}> - Object with information about the attempted creation of the specified table (i.e., status, statusText, and message).
See: Caspio documentation for creating tables
Since: 1.0.0

Example

// create a table titled 'my_new_table' that includes an example
// of the creation of each field type that Caspio has to offer
const caspio = require('caspio-sdk')(caspioCredentials);

async function createTable() {
  const tableName = 'my_new_table';
  const tableColumnDefs = [
    {
      "Name": "my_id",
      "Type": "AUTONUMBER",
      "Unique": true,
      "Description": "Data Type: Autonumber\n\nDescription: An automatically-assigned ID field. The value is incremented by 1 for each new record and cannot be changed except by resetting it for the entire table.\n\nExamples: Customer_ID, Record_ID\n\nConversion Compatibility: Text (255), Text (64000), Number, Integer, Currency",
      "DisplayOrder": 1,
      "Label": "Example field with Type of AUTONUMBER",
      "UniqueAllowNulls": false,
      "IsFormula": false
    },
    {
      "Format": "001",
      "Prefix": "some_prefix",
      "Name": "my_prefixed_autonumber",
      "Type": "PREFIXED AUTONUMBER",
      "Unique": true,
      "Description": "Data Type: Prefixed Autonumber\n\nDescription: An automatically-assigned ID field with the ability to add a prefix.\n\nUse the Options area to configure the prefix and number format of the ID code to be generated.\n\nExamples: Customer_ID, Record_ID\n\nConversion Compatibility: Text (255), Text (64000)",
      "DisplayOrder": 2,
      "Label": "Example field with Type of PREFIXED AUTONUMBER",
      "UniqueAllowNulls": false,
      "IsFormula": false
    },
    {
      "Name": "guid",
      "Type":