Class: client

Methods

addModel(params, callback)

Make an API call POST /models/v1 The `file` parameter is base64 + URI encoded before sending to server

Parameters:

Name	Type	Argument	Description
params	object		the model data to use
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 388

addModelFile(modelId, params, callback)

Make an API call POST /models/{modelId}/files/v1 The `file` parameter is base64 + URI encoded before sending to server

Parameters:

Name	Type	Argument	Description
modelId	number		the model the file belongs to
params	object		the file information
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 504

addModelPhoto(modelId, params, callback)

Make an API call POST /models/{modelId}/photos/v1 The `file` parameter is base64 + URI encoded before sending to server

Parameters:

Name	Type	Argument	Description
modelId	number		the model the photo belongs to
params	object		the photo information
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 482

addToCart(params, callback)

Make an API call POST /orders/cart/v1

Parameters:

Name	Type	Argument	Description
params	object		parameters to send with the query
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 306

connect(callback)

Connect to API server and get OAuth request token and authentication url

Parameters:

Name	Type	Argument	Description
callback	client~connectCallback	<optional>	function to call when finished

Source:

• client.js, line 90

delete(url, callback)

Make a HTTP DELETE request to the url using the OAuth credentials

Parameters:

Name	Type	Argument	Description
url	string		the url to make the request to
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 184

deleteModel(modelId, callback)

Make an API call DELETE /models/{modelId}/v1

Parameters:

Name	Type	Argument	Description
modelId	number		the model to delete
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 430

gePrice(params, callback)

Make an API call POST /price/v1

Parameters:

Name	Type	Argument	Description
params	object		the pricing information to get pricing for
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 587

get(url, callback)

Make a HTTP GET request to the url using the OAuth credentials

Parameters:

Name	Type	Argument	Description
url	string		the url to make the request to
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 156

getApiInfo(callback)

Make an API call GET /api/v1

Parameters:

Name	Type	Argument	Description
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 280

getCart(callback)

Make an API call GET /orders/cart/v1

Parameters:

Name	Type	Argument	Description
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 293

getCategories(callback)

Make an API call GET /categories/v1

Parameters:

Name	Type	Argument	Description
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 560

getCategory(catId, callback)

Make an API call GET /categories/{categoryId}/v1

Parameters:

Name	Type	Argument	Description
catId	number		the category id to fetch
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 573

getMaterial(materialId, callback)

Make an API call GET /materials/{materialId}/v1

Parameters:

Name	Type	Argument	Description
materialId	number		material id of the material to get
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 324

getMaterials(callback)

Make an API call GET /materials/v1

Parameters:

Name	Type	Argument	Description
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 338

getModel(modelId, callback)

Make an API call GET /models/{modelId}/v1

Parameters:

Name	Type	Argument	Description
modelId	number		the model to fetch
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 374

getModelFile(modelId, fileVersion, includeFile, callback)

Make an API call GET /models/{modelId}/files/{fileVersion}/v1

Parameters:

Name	Type	Argument	Default	Description
modelId	number			the model the file belongs to
fileVersion	int			the version of the file to get
includeFile	boolean	<optional>	false	whether or not to include the raw file data with the response
callback	client~resultsCallback	<optional>		function to call when finished

Source:

• client.js, line 459

getModelInfo(modelId, callback)

Make an API call GET /models/{modelId}/info/v1

Parameters:

Name	Type	Argument	Description
modelId	number		the model to fetch information for
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 416

getModels(page, callback)

Make an API call GET /models/v1

Parameters:

Name	Type	Argument	Description
page	number	<optional>	which page to fetch
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 351

getPrinters(printerId, callback)

Make an API call GET /printers/{printerId}/v1

Parameters:

Name	Type	Argument	Description
printerId	number		the printer id to get information for
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 546

getPrinters(callback)

Make an API call GET /printers/v1

Parameters:

Name	Type	Argument	Description
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 533

post(url, body, callback)

Make a HTTP POST request to the url using the OAuth credentials

Parameters:

Name	Type	Argument	Description
url	string		the url to make the request to
body	string	<optional>	the POST body data to send with the request
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 212

put(url, body, callback)

Make a HTTP PUT request to the url using the OAuth credentials

Parameters:

Name	Type	Argument	Description
url	string		the url to make the request to
body	string	<optional>	the PUT body data to send with the request
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 246

updateModelInfo(modelId, params, callback)

Make an API call PUT /models/{modelId}/info/v1

Parameters:

Name	Type	Argument	Description
modelId	number		the model to update
params	object		model data to update with
callback	client~resultsCallback	<optional>	function to call when finished

Source:

• client.js, line 444

url(path, params) → {string}

Build a full API url from the portion that is given

Parameters:

Name	Type	Argument	Description
path	string		the api path portion to build
params	object	<optional>	Object of query string parameters to use

Source:

• client.js, line 64

Returns:

Returns full API url from path and params

Type

string

verify(token, verifier, callback)

Request an OAuth access token with the provided oauth_token and oauth_verifier parameters

Parameters:

Name	Type	Argument	Description
token	string		oauth_token from authentication response query string
verifier	string		oauth_verifier from authentication response query string
callback	client~verifyCallback	<optional>	function to call when finished

Source:

• client.js, line 128

verifyUrl(callback)

Parse the required parameters from OAuth authentication response url and pass to client.verify

Parameters:

Name	Type	Argument	Description
callback	client~verifyCallback	<optional>	function to call when finished

Source:

• client.js, line 114

Type Definitions

connectCallback(error, authentication_url)

Parameters:

Name	Type	Description
error	string | null	error message or null
authentication_url	string | null	the oauth authentication url or null

Source:

• client.js, line 5

resultsCallback(error, results)

Parameters:

Name	Type	Description
error	string | null	error message or null
results	object | null	the results from the api call

Source:

• client.js, line 16

verifyCallback(error)

Parameters:

Name	Type	Description
error	string | null	error message or null

Source:

• client.js, line 11