Last active
February 10, 2020 05:03
-
-
Save rs77/03a23db90fbd573467bbdfb0d3bc5177 to your computer and use it in GitHub Desktop.
Minor edits applied to JSDoc and @enums to get JetBrains to be able to help with autocomplete and type checking
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* SuiteScript module | |
* | |
* @module N/task | |
* @NApiVersion 2.x | |
* | |
*/ | |
function task() {} | |
/** | |
* Creates a task of the given type and returns the task object. | |
* | |
* @function | |
* @name task#create | |
* @param {Object} options | |
* @param {string} options.taskType specifies the type of task to be created; use values from the task.TaskType enum | |
* @returns {ScheduledScriptTask | MapReduceScriptTask | CsvImportTask | EntityDeduplicationTask | WorkflowTriggerTask | SearchTask } | |
*/ | |
task.prototype.create = function(options) {}; | |
/** | |
* @typedef task.TaskStatus | |
* @property {String} status | |
*/ | |
/** | |
* Check current status of a submitted task. The task to be checked is identified by its task ID. | |
* | |
* @function | |
* @name task#checkStatus | |
* @param {Object} options | |
* @param {String} options.taskId | |
* @returns {task.TaskStatus} | |
*/ | |
task.prototype.checkStatus = function(options) {}; | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.TaskType = { | |
SCHEDULED_SCRIPT : 'SCHEDULED_SCRIPT', | |
MAP_REDUCE : 'MAP_REDUCE', | |
CSV_IMPORT : 'CSV_IMPORT', | |
ENTITY_DEDUPLICATION : 'ENTITY_DEDUPLICATION', | |
WORKFLOW_TRIGGER : 'WORKFLOW_TRIGGER', | |
SEARCH : 'SEARCH' | |
}; | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.TaskStatus = { | |
PENDING : 'PENDING', | |
PROCESSING : 'PROCESSING', | |
COMPLETE : 'COMPLETE', | |
FAILED : 'FAILED' | |
}; | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.MasterSelectionMode = { | |
CREATED_EARLIEST : 'CREATED_EARLIEST', | |
MOST_RECENT_ACTIVITY : 'MOST_RECENT_ACTIVITY', | |
MOST_POPULATED_FIELDS : 'MOST_POPULATED_FIELDS', | |
SELECT_BY_ID : 'SELECT_BY_ID' | |
}; | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.DedupeMode = { | |
MERGE : 'MERGE', | |
DELETE : 'DELETE', | |
MAKE_MASTER_PARENT : 'MAKE_MASTER_PARENT', | |
MARK_AS_NOT_DUPES : 'MARK_AS_NOT_DUPES' | |
}; | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.DedupeEntityType = { | |
CUSTOMER : 'CUSTOMER', | |
CONTACT : 'CONTACT', | |
VENDOR : 'VENDOR', | |
PARTNER : 'PARTNER', | |
LEAD : 'LEAD', | |
PROSPECT : 'PROSPECT' | |
} | |
/** | |
* @enum {String} | |
*/ | |
task.prototype.MapReduceStage = { | |
GET_INPUT : 'GET_INPUT', | |
MAP : 'MAP', | |
SHUFFLE : 'SHUFFLE', | |
REDUCE : 'REDUCE', | |
SUMMARIZE : 'SUMMARIZE' | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function ScheduledScriptTask() { | |
/** | |
* The ID of the task. | |
* @name ScheduledScriptTask#id | |
* @type string | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* The Internal ID or Script ID of the Script record. | |
* @name ScheduledScriptTask#scriptId | |
* @type int | string | |
*/ | |
this.prototype.scriptId = undefined; | |
/** | |
* The Internal ID or Script ID of the Script Deployment record. | |
* @name ScheduledScriptTask#deploymentId | |
* @type int | string | |
*/ | |
this.prototype.deploymentId = undefined; | |
/** | |
* Key/value pairs which override static script parameter field values on the deployment. | |
* Used to dynamically pass context to the script. | |
* @name ScheduledScriptTask#params | |
* @type Object | |
*/ | |
this.prototype.params = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 20 units | |
* @function | |
* @name ScheduledScriptTask#submit | |
* @param {Object} options | |
* @returns {String} taskId | |
* @throws {SuiteScriptError} FAILED_TO_SUBMIT_JOB_REQUEST_1 when task cannot be submitted for some reason | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.ScheduledScriptTask). | |
* @function | |
* @name ScheduledScriptTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name ScheduledScriptTask#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} ScheduledScriptStatus | |
*/ | |
function ScheduledScriptTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name ScheduledScriptTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Script ID. | |
* @name ScheduledScriptTaskStatus#scriptId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.scriptId = undefined; | |
/** | |
* Script deployment ID. | |
* @name ScheduledScriptTaskStatus#deploymentId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.deploymentId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name ScheduledScriptTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Returns the object type name (task.ScheduledScriptTaskStatus). | |
* @function | |
* @name ScheduledScriptTaskStatus#toString | |
* @param {Object} options | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name ScheduledScriptTaskStatus#toJSON | |
* @param {Object} options | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function MapReduceScriptTask() { | |
/** | |
* The ID of the task. | |
* @name MapReduceScriptTask#id | |
* @type string | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* The Internal ID or Script ID of the Script record. | |
* @name MapReduceScriptTask#scriptId | |
* @type int | string | |
*/ | |
this.prototype.scriptId = undefined; | |
/** | |
* The Internal ID or Script ID of the Script Deployment record. | |
* @name MapReduceScriptTask#deploymentId | |
* @type int | string | |
*/ | |
this.prototype.deploymentId = undefined; | |
/** | |
* Key/value pairs which override static script parameter field values on the deployment. | |
* Used to dynamically pass context to the script. | |
* @name MapReduceScriptTask#params | |
* @type Object | |
*/ | |
this.prototype.params = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 20 units | |
* @function | |
* @name MapReduceScriptTask#submit | |
* @param {Object} [options] | |
* @returns {String} taskId | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.MapReduceScriptTask). | |
* @function | |
* @name MapReduceScriptTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name MapReduceScriptTask#toJSON | |
* @param {Object} options | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} MapReduceScriptTaskStatus | |
*/ | |
function MapReduceScriptTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name MapReduceScriptTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Script ID. | |
* @name MapReduceScriptTaskStatus#scriptId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.scriptId = undefined; | |
/** | |
* Script deployment ID. | |
* @name MapReduceScriptTaskStatus#deploymentId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.deploymentId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name MapReduceScriptTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Represents the current stage of the Map/Reduce script. Returns one of the task.MapReduceStage enum values. | |
* @name MapReduceScriptTaskStatus#stage | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.stage = undefined; | |
/** | |
* Get percentage of completion for the current stage. Note that INPUT and SUMMARIZE are either 0% or 100% complete at any given time. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPercentageCompleted | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPercentageCompleted = function(options) {}; | |
/** | |
* Total number of records/rows not yet processed by the MAP phase. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingMapCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingMapCount = function(options) {}; | |
/** | |
* Total number of record/row inputs to the MAP phase. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getTotalMapCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getTotalMapCount = function(options) {}; | |
/** | |
* Total number of bytes not yet processed by the MAP phase (a component of total size). | |
* | |
* @governance 25 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingMapSize | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingMapSize = function(options) {}; | |
/** | |
* Total number of records/rows not yet processed by the REDUCE phase. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingReduceCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingReduceCount = function(options) {}; | |
/** | |
* Total number of record/row inputs to the REDUCE phase. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getTotalReduceCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getTotalReduceCount = function(options) {}; | |
/** | |
* Total number of bytes not yet processed by the REDUCE phase (a component of total size). | |
* | |
* @governance 25 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingReduceSize | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingReduceSize = function(options) {}; | |
/** | |
* Total number of records/rows not yet iterated by the script. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingOutputCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingOutputCount = function(options) {}; | |
/** | |
* Returns the total size in bytes of all key/value pairs written as output (a component of total size). | |
* | |
* @governance 25 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getPendingOutputSize | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getPendingOutputSize = function(options) {}; | |
/** | |
* Total number of record/row inputs to the OUTPUT phase. | |
* | |
* @governance 10 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getTotalOutputCount | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getTotalOutputCount = function(options) {}; | |
/** | |
* Returns the total size in bytes of all stored work in progress. | |
* | |
* @governance 25 units | |
* @function | |
* @name MapReduceScriptTaskStatus#getCurrentTotalSize | |
* @param {Object} [options] | |
* @returns {Number} | |
*/ | |
this.prototype.getCurrentTotalSize = function(options) {}; | |
/** | |
* Returns the object type name (task.MapReduceScriptTaskStatus). | |
* @function | |
* @name MapReduceScriptTaskStatus#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name MapReduceScriptTaskStatus#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function SearchTask() { | |
/** | |
* The ID of the task. | |
* @name SearchTask#id | |
* @type int | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* An ID of saved search to be executed during the task. | |
* @name SearchTask#savedSearchId | |
* @type int | |
*/ | |
this.prototype.savedSearchId = undefined; | |
/** | |
* Id of CVS file to export results of search into. See N/file. | |
* If fileId is provided then parameter filePath is ignored. | |
* There's no synchronization between fileId and filePath attributes. | |
* @name SearchTask#fileId | |
* @throws {error.SuiteScriptError} PROPERTY_VALUE_CONFLICT if trying to se both SearchTask#filePath and SearchTask#fileId | |
* @type int | |
*/ | |
this.prototype.fileId = undefined; | |
/** | |
* Path of CVS file to export results of search into. See N/file. | |
* If fileId is provided then parameter filePath is ignored. | |
* There's no synchronization between fileId and filePath attributes. | |
* @name SearchTask#filePath | |
* @throws {error.SuiteScriptError} PROPERTY_VALUE_CONFLICT if trying to se both SearchTask#filePath and SearchTask#fileId | |
* @type int | |
*/ | |
this.prototype.filePath = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 100 units | |
* @function | |
* @name SearchTask#submit | |
* @param {Object} [options] | |
* @returns {String} taskId | |
* @throws {SuiteScriptError} FAILED_TO_SUBMIT_JOB_REQUEST_1 when task cannot be submitted for some reason | |
* @throws {error.SuiteScriptError} SSS_MISSING_REQD_ARGUMENT if a required parameter is missing | |
* @throws {error.SuiteScriptError} YOU_DO_NOT_HAVE_ACCESS_TO_THE_MEDIA_ITEM_YOU_SELECTED if you do not have permission to access the file | |
* @throws {error.SuiteScriptError} THAT_RECORD_DOES_NOT_EXIST if file object references non existing file | |
* @throws {error.SuiteScriptError} MUST_IDENTIFY_A_FILE if path specifies folder | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.SearchTask). | |
* @function | |
* @name SearchTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name SearchTask#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* Represents the status of | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} SearchTaskStatus | |
*/ | |
function SearchTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name SearchTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name SearchTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Represents the fileId of exported file. | |
* @name SearchTaskStatus#fileId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.fileId = undefined; | |
/** | |
* Represents id of saved search being used for export. | |
* @name SearchTaskStatus#savedSearchId | |
* @type int | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.savedSearchId = undefined; | |
/** | |
* Returns the object type name (task.SearchTaskStatus). | |
* @function | |
* @name SearchTaskStatus#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name SearchTaskStatus#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function CsvImportTask() { | |
/** | |
* The ID of the task. | |
* @name CsvImportTask#id | |
* @type string | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* A file.File object containing data to be imported OR a string containing raw CSV text to be imported. | |
* @name CsvImportTask#importFile | |
* @type file.File | string | |
*/ | |
this.prototype.importFile = undefined; | |
/** | |
* Internal ID or script ID of a saved import map to be used for the import. | |
* @name CsvImportTask#mappingId | |
* @type int | string | |
*/ | |
this.prototype.mappingId = undefined; | |
/** | |
* Overrides the CSV import queue preference. | |
* @name CsvImportTask#queueId | |
* @type int | |
*/ | |
this.prototype.queueId = undefined; | |
/** | |
* The name of the import job to be shown on the status page for CSV imports. | |
* @name CsvImportTask#name | |
* @type string | |
*/ | |
this.prototype.name = undefined; | |
/** | |
* A map of key/value pairs "sublist->file" for a multi-file import job. | |
* The key defines the internal ID of the record sublist for which data is being imported. | |
* The value is a file.File object containing data to be imported OR a string containing raw CSV text to be imported. | |
* @name CsvImportTask#linkedFiles | |
* @type Object | |
*/ | |
this.prototype.linkedFiles = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 100 units | |
* @function | |
* @name CsvImportTask#submit | |
* @param {Object} [options] | |
* @returns {String} taskId | |
* @throws {SuiteScriptError} FAILED_TO_SUBMIT_JOB_REQUEST_1 when task cannot be submitted for some reason | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.CsvImportTask). | |
* @function | |
* @name CsvImportTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name CsvImportTask#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} CsvImportTaskStatus | |
*/ | |
function CsvImportTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name CsvImportTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name CsvImportTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Returns the object type name (task.CsvImportTaskStatus). | |
* @function | |
* @name CsvImportTaskStatus#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name CsvImportTaskStatus#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function EntityDeduplicationTask() { | |
/** | |
* The ID of the task. | |
* @name EntityDeduplicationTask#id | |
* @type string | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* Represents the entity type. Use values from the task.DedupeEntityType enum. | |
* @name EntityDeduplicationTask#entityType | |
* @type string | |
*/ | |
this.prototype.entityType = undefined; | |
/** | |
* Master record ID. | |
* @name EntityDeduplicationTask#masterRecordId | |
* @type int | |
*/ | |
this.prototype.masterRecordId = undefined; | |
/** | |
* Master selection mode. Use values from the task.MasterSelectionMode enum. | |
* @name EntityDeduplicationTask#masterSelectionMode | |
* @type string | |
*/ | |
this.prototype.masterSelectionMode = undefined; | |
/** | |
* Deduplication mode. Use values from the task.DedupeMode enum. | |
* @name EntityDeduplicationTask#dedupeMode | |
* @type string | |
*/ | |
this.prototype.dedupeMode = undefined; | |
/** | |
* Records to deduplicate. | |
* @name EntityDeduplicationTask#recordIds | |
* @type int[] | |
*/ | |
this.prototype.recordIds = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 100 units | |
* @function | |
* @name EntityDeduplicationTask#submit | |
* @param {Object} [options] | |
* @returns {String} taskId | |
* @throws {SuiteScriptError} FAILED_TO_SUBMIT_JOB_REQUEST_1 when task cannot be submitted for some reason | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.EntityDeduplicationTask). | |
* @function | |
* @name EntityDeduplicationTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name EntityDeduplicationTask#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} EntityDeduplicationTaskStatus | |
*/ | |
function EntityDeduplicationTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name EntityDeduplicationTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name EntityDeduplicationTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Returns the object type name (task.EntityDeduplicationTaskStatus). | |
* @function | |
* @name EntityDeduplicationTaskStatus#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name EntityDeduplicationTaskStatus#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* @protected | |
* @constructor | |
*/ | |
function WorkflowTriggerTask() { | |
/** | |
* The ID of the task. | |
* @name WorkflowTriggerTask#id | |
* @type string | |
*/ | |
this.prototype.id = undefined; | |
/** | |
* The record type of the workflow base record. | |
* @name WorkflowTriggerTask#recordType | |
* @type string | |
*/ | |
this.prototype.recordType = undefined; | |
/** | |
* The internal ID of the base record. | |
* @name WorkflowTriggerTask#recordId | |
* @type int | |
*/ | |
this.prototype.recordId = undefined; | |
/** | |
* The internal ID (int) or script ID (string) for the workflow definition. This is the ID that appears in the ID field on the Workflow Definition Page. | |
* @name WorkflowTriggerTask#workflowId | |
* @type int | string | |
*/ | |
this.prototype.workflowId = undefined; | |
/** | |
* Key/value pairs which override static script parameter field values on the deployment. | |
* Used to dynamically pass context to the script. | |
* @name WorkflowTriggerTask#params | |
* @type Object | |
*/ | |
this.prototype.params = undefined; | |
/** | |
* Submits the task and returns an unique ID. | |
* | |
* @governance 20 units | |
* @function | |
* @name WorkflowTriggerTask#submit | |
* @param {Object} [options] | |
* @returns {String} taskId | |
* @throws {SuiteScriptError} FAILED_TO_SUBMIT_JOB_REQUEST_1 when task cannot be submitted for some reason | |
*/ | |
this.prototype.submit = function(options) {}; | |
/** | |
* Returns the object type name (task.WorkflowTriggerTask). | |
* @function | |
* @name WorkflowTriggerTask#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name WorkflowTriggerTask#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
/** | |
* | |
* @protected | |
* @constructor | |
* @typedef {task.TaskStatus} WorkflowTriggerTaskStatus | |
*/ | |
function WorkflowTriggerTaskStatus() { | |
/** | |
* The taskId associated with the specified task. | |
* @name WorkflowTriggerTaskStatus#taskId | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.taskId = undefined; | |
/** | |
* Represents the task status. Returns one of the task.TaskStatus enum values. | |
* @name WorkflowTriggerTaskStatus#status | |
* @type string | |
* @readonly | |
* @throws {SuiteScriptError} READ_ONLY when setting the property is attempted | |
*/ | |
this.prototype.status = undefined; | |
/** | |
* Returns the object type name (task.WorkflowTriggerTaskStatus). | |
* @function | |
* @name WorkflowTriggerTaskStatus#toString | |
* @param {Object} [options] | |
* @returns {string} | |
*/ | |
this.prototype.toString = function(options) {}; | |
/** | |
* JSON.stringify() implementation. | |
* @function | |
* @name WorkflowTriggerTaskStatus#toJSON | |
* @param {Object} [options] | |
* @returns {Object} | |
*/ | |
this.prototype.toJSON = function(options) {}; | |
} | |
task = new task(); | |
/** | |
* @type {task} | |
*/ | |
N.prototype.task = task; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment