@itentialopensource/adapter-scansource
Version:
This adapter integrates with system described as: apis.
1,858 lines (1,857 loc) • 129 kB
JSON
{
"id": "@itentialopensource/adapter-scansource",
"type": "Adapter",
"export": "Scansource",
"title": "Scansource",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name" : "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type" : "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "addressGetAddress",
"summary": "Returns address for a given address Id",
"description": "Returns address for a given address Id",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address Collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "addressId",
"type": "number",
"info": "Optional Address id: 123",
"required": true,
"schema": {
"title": "addressId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressGetAddress"
},
"task": true
},
{
"name": "addressDelete",
"summary": "Delete Address",
"description": "Delete Address",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "collection Key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "addressId",
"type": "number",
"info": "Id of address to delete: 123",
"required": true,
"schema": {
"title": "addressId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressDelete"
},
"task": true
},
{
"name": "addressExists",
"summary": "Determines if collection exists and contains addresses",
"description": "Determines if collection exists and contains addresses",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressExists"
},
"task": true
},
{
"name": "addressUpdateAddress",
"summary": "Update address in collection",
"description": "Update address in collection",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "addressUpdateModel",
"type": "object",
"info": "Address model: object",
"required": true,
"schema": {
"title": "addressUpdateModel",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressUpdateAddress"
},
"task": true
},
{
"name": "addressAddAddress",
"summary": "Create new address in collection\r\nCreates new collection if one does not exist",
"description": "Create new address in collection\r\nCreates new collection if one does not exist",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "addressModel",
"type": "object",
"info": "Address model: object",
"required": true,
"schema": {
"title": "addressModel",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressAddAddress"
},
"task": true
},
{
"name": "addressCopyAddress",
"summary": "Copy existing address to new address",
"description": "Copy existing address to new address",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "addressId",
"type": "number",
"info": "Id of Address to copy: 123",
"required": true,
"schema": {
"title": "addressId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressCopyAddress"
},
"task": true
},
{
"name": "addressClear",
"summary": "Delete all addresses in collection",
"description": "Delete all addresses in collection",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Region: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressClear"
},
"task": true
},
{
"name": "addressMoveAddress",
"summary": "Moves an address from one collection to another.",
"description": "Moves an address from one collection to another.",
"input": [
{
"name": "sourceCollectionKey",
"type": "string",
"info": "Source collection to move from: string",
"required": true,
"schema": {
"title": "sourceCollectionKey",
"type": "string"
}
},
{
"name": "destinationCollectionKey",
"type": "string",
"info": "Destination collection: string",
"required": true,
"schema": {
"title": "destinationCollectionKey",
"type": "string"
}
},
{
"name": "addressId",
"type": "number",
"info": "Address Id to move: 123",
"required": true,
"schema": {
"title": "addressId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressMoveAddress"
},
"task": true
},
{
"name": "addressSearch",
"summary": "Search for addresses in collection",
"description": "Search for addresses in collection",
"input": [
{
"name": "collectionKey",
"type": "string",
"info": "Address collection key: string",
"required": true,
"schema": {
"title": "collectionKey",
"type": "string"
}
},
{
"name": "page",
"type": "number",
"info": "Page number: 123",
"required": false,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "pageSize",
"type": "number",
"info": "Number of results per page: 123",
"required": false,
"schema": {
"title": "pageSize",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "Optional search by address name: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "stateProvince",
"type": "string",
"info": "Optional search by state/province: string",
"required": false,
"schema": {
"title": "stateProvince",
"type": "string"
}
},
{
"name": "postalCode",
"type": "string",
"info": "Optional search by postal code: string",
"required": false,
"schema": {
"title": "postalCode",
"type": "string"
}
},
{
"name": "countryCode",
"type": "string",
"info": "Optional search by country code: string",
"required": false,
"schema": {
"title": "countryCode",
"type": "string"
}
},
{
"name": "searchText",
"type": "string",
"info": "Full text search against all address fields - overrides other search parameters: string",
"required": false,
"schema": {
"title": "searchText",
"type": "string"
}
},
{
"name": "useAndOperator",
"type": "boolean",
"info": ": boolean",
"required": false,
"schema": {
"title": "useAndOperator",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressSearch"
},
"task": true
},
{
"name": "addressGetAddressCountries",
"summary": "Get Countries codes and validation pattern for a given region",
"description": "Get Countries codes and validation pattern for a given region",
"input": [
{
"name": "region",
"type": "number",
"info": "Specifies Region (North America - 0, Europe - 1, Latin America - 2): 123",
"required": true,
"schema": {
"title": "region",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressGetAddressCountries"
},
"task": true
},
{
"name": "addressGetAddressProvinceStates",
"summary": "Get provinces / state codes for given countryCode",
"description": "Get provinces / state codes for given countryCode",
"input": [
{
"name": "countryCode",
"type": "string",
"info": "Standard ISO-3166 2-Character country code: string",
"required": true,
"schema": {
"title": "countryCode",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressGetAddressProvinceStates"
},
"task": true
},
{
"name": "addressValidate",
"summary": "Validate address",
"description": "Validate address",
"input": [
{
"name": "addressModel",
"type": "object",
"info": "Address model: object",
"required": true,
"schema": {
"title": "addressModel",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/addressValidate"
},
"task": true
},
{
"name": "cartGetCart",
"summary": "Returns current cart for the given cartCollectionKey\r\noptional id returns cart specified in cart collection",
"description": "Returns current cart for the given cartCollectionKey\r\noptional id returns cart specified in cart collection",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "cartId",
"type": "number",
"info": "Optional cart id: 123",
"required": false,
"schema": {
"title": "cartId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartGetCart"
},
"task": true
},
{
"name": "cartUpdateCart",
"summary": "Update cart in cart collection",
"description": "Update cart in cart collection",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "cartModel",
"type": "object",
"info": "Cart model: object",
"required": true,
"schema": {
"title": "cartModel",
"type": "object"
}
},
{
"name": "updateCartItems",
"type": "boolean",
"info": ": boolean",
"required": false,
"schema": {
"title": "updateCartItems",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartUpdateCart"
},
"task": true
},
{
"name": "cartAddCart",
"summary": "Create new cart in cart collection, optionally set as current cart\r\nCreates new cart collection if one does not exist",
"description": "Create new cart in cart collection, optionally set as current cart\r\nCreates new cart collection if one does not exist",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "cartModel",
"type": "object",
"info": "Cart model: object",
"required": true,
"schema": {
"title": "cartModel",
"type": "object"
}
},
{
"name": "currentCart",
"type": "boolean",
"info": "Flag indicating if new cart should become current cart for collection: boolean",
"required": false,
"schema": {
"title": "currentCart",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartAddCart"
},
"task": true
},
{
"name": "cartDelete",
"summary": "Delete current cart or specific cart",
"description": "Delete current cart or specific cart",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Collection Key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "cartId",
"type": "number",
"info": "Optional Cart ID: 123",
"required": false,
"schema": {
"title": "cartId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartDelete"
},
"task": true
},
{
"name": "cartExists",
"summary": "Determines if cart collection exists and contains carts",
"description": "Determines if cart collection exists and contains carts",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartExists"
},
"task": true
},
{
"name": "cartCopyCart",
"summary": "Copy existing cart to new cart \r\nOptionally set new cart as current cart",
"description": "Copy existing cart to new cart \r\nOptionally set new cart as current cart",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "cartId",
"type": "number",
"info": "Id of cart to copy: 123",
"required": true,
"schema": {
"title": "cartId",
"type": "number"
}
},
{
"name": "currentCart",
"type": "boolean",
"info": "Flag indicating if new cart should become current cart for collection: boolean",
"required": false,
"schema": {
"title": "currentCart",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/cartCopyCart"
},
"task": true
},
{
"name": "cartGetCartList",
"summary": "Returns an array of carts contained by the collection matching the received \"cartCollectionKey\".\r\nThis method can be used for client applications to display a list of carts for the user to select\r\nas their current cart for systems which allow multiple carts per user.",
"description": "Returns an array of carts contained by the collection matching the received \"cartCollectionKey\".\r\nThis method can be used for client applications to display a list of carts for the user to select\r\nas their current cart for systems which allow multiple carts per user.",
"input": [
{
"name": "cartCollectionKey",
"type": "string",
"info": "Cart collection key: string",
"required": true,
"schema": {
"title": "cartCollectionKey",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Optional filter by name of cart: string",
"required": false,
"schema": {
"title": "name",