Class: DocumentsubmissionsResource

DocumentsubmissionsResource(client)

Documentsubmissions Resource Generated: 2025-04-01T19:44:53.324Z

Constructor

new DocumentsubmissionsResource(client)

Create a new Documentsubmissions resource

Parameters:
Name Type Description
client ApiClient

API client instance
Source:

Classes

DocumentsubmissionsResource
DocumentsubmissionsResource

Methods

(async) create(data) → {Promise.<Object>}

Create a new record

Parameters:
Name Type Description
data Object

Record data
Source:
Returns:
  • Created record with data and headers
Type
Promise.<Object>

(async) create(data) → {Promise.<Object>}

Create a new record

Parameters:
Name Type Description
data Object

Record data
Source:
Returns:
  • Created record with data and headers
Type
Promise.<Object>

(async) deleteDocumentsubmissionsId() → {Promise.<documentsubmission>}

Delete DocumentSubmission (destroy) Delete the DocumentSubmission record with the specified ID.

Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsId() → {Promise.<documentsubmission>}

Delete DocumentSubmission (destroy) Delete the DocumentSubmission record with the specified ID.

Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Remove from for DocumentSubmission Remove a foreign record from one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Remove from for DocumentSubmission Remove a foreign record from one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) destroy(id) → {Promise.<Object>}

Delete a record by id

Parameters:
Name Type Description
id string | number

Record id
Source:
Returns:
  • Deletion result with data and headers
Type
Promise.<Object>

(async) destroy(id) → {Promise.<Object>}

Delete a record by id

Parameters:
Name Type Description
id string | number

Record id
Source:
Returns:
  • Deletion result with data and headers
Type
Promise.<Object>

find(criteria) → {QueryChain}

Starts a new query chain with the given criteria

Parameters:
Name Type Description
criteria Object

Filter criteria
Source:
Returns:
  • Query chain for further operations
Type
QueryChain

find(criteria) → {QueryChain}

Starts a new query chain with the given criteria

Parameters:
Name Type Description
criteria Object

Filter criteria
Source:
Returns:
  • Query chain for further operations
Type
QueryChain

findOne(id, populateopt) → {QueryChain|Promise.<Object>}

Find a single record by id

Parameters:
Name Type Attributes Description
id string | number

Record id
populate string | Array.<string> <optional>

Fields to populate
Source:
Returns:
  • Query chain for further operations or found record with data and headers
Type
QueryChain | Promise.<Object>

findOne(id, populateopt) → {QueryChain|Promise.<Object>}

Find a single record by id

Parameters:
Name Type Attributes Description
id string | number

Record id
populate string | Array.<string> <optional>

Fields to populate
Source:
Returns:
  • Query chain for further operations or found record with data and headers
Type
QueryChain | Promise.<Object>

(async) getDocumentsubmissions(queryopt) → {Promise.<Array.<documentsubmission>>}

List DocumentSubmission (find where) Find a list of DocumentSubmission records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<documentsubmission>>

(async) getDocumentsubmissions(queryopt) → {Promise.<Array.<documentsubmission>>}

List DocumentSubmission (find where) Find a list of DocumentSubmission records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<documentsubmission>>

(async) getDocumentsubmissionsCount(queryopt) → {Promise.<any>}

Count records Count the number of records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsCount(queryopt) → {Promise.<any>}

Count records Count the number of records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsId(queryopt) → {Promise.<documentsubmission>}

Get DocumentSubmission (find one) Look up the DocumentSubmission record with the specified ID.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) getDocumentsubmissionsId(queryopt) → {Promise.<documentsubmission>}

Get DocumentSubmission (find one) Look up the DocumentSubmission record with the specified ID.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) getDocumentsubmissionsIdAssociation(association, queryopt) → {Promise.<Array.<any>>}

Populate association for DocumentSubmission Populate and return foreign record(s) for the given association of this DocumentSubmission record.

Parameters:
Name Type Attributes Description
association string

Path parameter
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<any>>

(async) getDocumentsubmissionsIdAssociation(association, queryopt) → {Promise.<Array.<any>>}

Populate association for DocumentSubmission Populate and return foreign record(s) for the given association of this DocumentSubmission record.

Parameters:
Name Type Attributes Description
association string

Path parameter
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<any>>

(async) getDocumentsubmissionsSum(queryopt) → {Promise.<any>}

Sum field values Calculate the sum of a specified numeric field across filtered records.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsSum(queryopt) → {Promise.<any>}

Sum field values Calculate the sum of a specified numeric field across filtered records.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) patchDocumentsubmissionsId(data) → {Promise.<documentsubmission>}

Update DocumentSubmission Update an existing DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) patchDocumentsubmissionsId(data) → {Promise.<documentsubmission>}

Update DocumentSubmission Update an existing DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) postDocumentsubmissions(data) → {Promise.<documentsubmission>}

Create DocumentSubmission Create a new DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) postDocumentsubmissions(data) → {Promise.<documentsubmission>}

Create DocumentSubmission Create a new DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociation(association, data) → {Promise.<documentsubmission>}

Replace for DocumentSubmission Replace all of the child records in one of this DocumentSubmission record's associations.

Parameters:
Name Type Description
association string

Path parameter
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociation(association, data) → {Promise.<documentsubmission>}

Replace for DocumentSubmission Replace all of the child records in one of this DocumentSubmission record's associations.

Parameters:
Name Type Description
association string

Path parameter
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Add to for DocumentSubmission Add a foreign record to one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Add to for DocumentSubmission Add a foreign record to one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) update(id, data) → {Promise.<Object>}

Update a record by id

Parameters:
Name Type Description
id string | number

Record id
data Object

Update data
Source:
Returns:
  • Updated record with data and headers
Type
Promise.<Object>

(async) update(id, data) → {Promise.<Object>}

Update a record by id

Parameters:
Name Type Description
id string | number

Record id
data Object

Update data
Source:
Returns:
  • Updated record with data and headers
Type
Promise.<Object>

DocumentsubmissionsResourceDocumentsubmissionsResource(client)

Documentsubmissions Resource Generated: 2025-04-01T19:44:53.324Z

Constructor

new DocumentsubmissionsResource(client)

Create a new Documentsubmissions resource

Parameters:
Name Type Description
client ApiClient

API client instance
Source:

Classes

DocumentsubmissionsResource
DocumentsubmissionsResource

Methods

(async) create(data) → {Promise.<Object>}

Create a new record

Parameters:
Name Type Description
data Object

Record data
Source:
Returns:
  • Created record with data and headers
Type
Promise.<Object>

(async) create(data) → {Promise.<Object>}

Create a new record

Parameters:
Name Type Description
data Object

Record data
Source:
Returns:
  • Created record with data and headers
Type
Promise.<Object>

(async) deleteDocumentsubmissionsId() → {Promise.<documentsubmission>}

Delete DocumentSubmission (destroy) Delete the DocumentSubmission record with the specified ID.

Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsId() → {Promise.<documentsubmission>}

Delete DocumentSubmission (destroy) Delete the DocumentSubmission record with the specified ID.

Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Remove from for DocumentSubmission Remove a foreign record from one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) deleteDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Remove from for DocumentSubmission Remove a foreign record from one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) destroy(id) → {Promise.<Object>}

Delete a record by id

Parameters:
Name Type Description
id string | number

Record id
Source:
Returns:
  • Deletion result with data and headers
Type
Promise.<Object>

(async) destroy(id) → {Promise.<Object>}

Delete a record by id

Parameters:
Name Type Description
id string | number

Record id
Source:
Returns:
  • Deletion result with data and headers
Type
Promise.<Object>

find(criteria) → {QueryChain}

Starts a new query chain with the given criteria

Parameters:
Name Type Description
criteria Object

Filter criteria
Source:
Returns:
  • Query chain for further operations
Type
QueryChain

find(criteria) → {QueryChain}

Starts a new query chain with the given criteria

Parameters:
Name Type Description
criteria Object

Filter criteria
Source:
Returns:
  • Query chain for further operations
Type
QueryChain

findOne(id, populateopt) → {QueryChain|Promise.<Object>}

Find a single record by id

Parameters:
Name Type Attributes Description
id string | number

Record id
populate string | Array.<string> <optional>

Fields to populate
Source:
Returns:
  • Query chain for further operations or found record with data and headers
Type
QueryChain | Promise.<Object>

findOne(id, populateopt) → {QueryChain|Promise.<Object>}

Find a single record by id

Parameters:
Name Type Attributes Description
id string | number

Record id
populate string | Array.<string> <optional>

Fields to populate
Source:
Returns:
  • Query chain for further operations or found record with data and headers
Type
QueryChain | Promise.<Object>

(async) getDocumentsubmissions(queryopt) → {Promise.<Array.<documentsubmission>>}

List DocumentSubmission (find where) Find a list of DocumentSubmission records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<documentsubmission>>

(async) getDocumentsubmissions(queryopt) → {Promise.<Array.<documentsubmission>>}

List DocumentSubmission (find where) Find a list of DocumentSubmission records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<documentsubmission>>

(async) getDocumentsubmissionsCount(queryopt) → {Promise.<any>}

Count records Count the number of records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsCount(queryopt) → {Promise.<any>}

Count records Count the number of records that match the specified criteria.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsId(queryopt) → {Promise.<documentsubmission>}

Get DocumentSubmission (find one) Look up the DocumentSubmission record with the specified ID.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) getDocumentsubmissionsId(queryopt) → {Promise.<documentsubmission>}

Get DocumentSubmission (find one) Look up the DocumentSubmission record with the specified ID.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) getDocumentsubmissionsIdAssociation(association, queryopt) → {Promise.<Array.<any>>}

Populate association for DocumentSubmission Populate and return foreign record(s) for the given association of this DocumentSubmission record.

Parameters:
Name Type Attributes Description
association string

Path parameter
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<any>>

(async) getDocumentsubmissionsIdAssociation(association, queryopt) → {Promise.<Array.<any>>}

Populate association for DocumentSubmission Populate and return foreign record(s) for the given association of this DocumentSubmission record.

Parameters:
Name Type Attributes Description
association string

Path parameter
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<Array.<any>>

(async) getDocumentsubmissionsSum(queryopt) → {Promise.<any>}

Sum field values Calculate the sum of a specified numeric field across filtered records.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) getDocumentsubmissionsSum(queryopt) → {Promise.<any>}

Sum field values Calculate the sum of a specified numeric field across filtered records.

Parameters:
Name Type Attributes Description
query Object <optional>

Query parameters
Source:
Returns:
  • Response with data and headers
Type
Promise.<any>

(async) patchDocumentsubmissionsId(data) → {Promise.<documentsubmission>}

Update DocumentSubmission Update an existing DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) patchDocumentsubmissionsId(data) → {Promise.<documentsubmission>}

Update DocumentSubmission Update an existing DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) postDocumentsubmissions(data) → {Promise.<documentsubmission>}

Create DocumentSubmission Create a new DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) postDocumentsubmissions(data) → {Promise.<documentsubmission>}

Create DocumentSubmission Create a new DocumentSubmission record.

Parameters:
Name Type Description
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociation(association, data) → {Promise.<documentsubmission>}

Replace for DocumentSubmission Replace all of the child records in one of this DocumentSubmission record's associations.

Parameters:
Name Type Description
association string

Path parameter
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociation(association, data) → {Promise.<documentsubmission>}

Replace for DocumentSubmission Replace all of the child records in one of this DocumentSubmission record's associations.

Parameters:
Name Type Description
association string

Path parameter
data Object

Request body
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Add to for DocumentSubmission Add a foreign record to one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) putDocumentsubmissionsIdAssociationChildid(association, childid) → {Promise.<documentsubmission>}

Add to for DocumentSubmission Add a foreign record to one of this DocumentSubmission record's collections.

Parameters:
Name Type Description
association string

Path parameter
childid string

Path parameter
Source:
Returns:
  • Response with data and headers
Type
Promise.<documentsubmission>

(async) update(id, data) → {Promise.<Object>}

Update a record by id

Parameters:
Name Type Description
id string | number

Record id
data Object

Update data
Source:
Returns:
  • Updated record with data and headers
Type
Promise.<Object>

(async) update(id, data) → {Promise.<Object>}

Update a record by id

Parameters:
Name Type Description
id string | number

Record id
data Object

Update data
Source:
Returns:
  • Updated record with data and headers
Type
Promise.<Object>