CarfaxServer

CarfaxServer

Facilitates interaction with a Carfax server instance.

Constructor

new CarfaxServer(sdk, serverUrl, opts)

Create a new Carfax instance.

Source:
Parameters:
Name Type Description
sdk ShelfNetwork

Parent SDK instance.
serverUrl string

Carfax URL.
opts Object
Name Type Attributes Description
allowHttp boolean <optional>

Allow connecting to http servers, default: false. This must be set to false in production deployments!
proxy Object <optional>

Proxy configuration. Look axios docs for more info
httpBasicAuth Object <optional>

HTTP basic auth credentials. Look axios docs for more info.
customHeaders Object <optional>

Custom headers for request.

Classes

CarfaxServer

Methods

checkVin(vin) → {Promise.<JsonApiResponse>}

Free VIN check.

Source:
Parameters:
Name Type Description
vin string

Vehicle identification number.
Returns:
Type:
Promise.<JsonApiResponse>

Report response.

createDeposit(depositOptionId, platformIdopt) → {Promise}

Create deposit for top-up

Source:
Parameters:
Name Type Attributes Description
depositOptionId
platformId <optional>
Returns:
Type:
Promise

createSubscription(opts) → {Promise.<JsonApiResponse>}

Create Carfax subscription.

Source:
Parameters:
Name Type Description
opts
Name Type Description
name string

Subscriber name.
requestsLeft Number

Left requests number.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax subscription response.

generatePromoCodes(quantity, expireAt) → {Promise}

Generate carfax promo-codes. Requires Admin's permissions.

Source:
Parameters:
Name Type Description
quantity number

Amount of codes to generate.
expireAt string

Promo codes expiration date.
Returns:
Type:
Promise

getBalance(accountIdopt, platformIdopt) → {Promise.<JsonApiResponse>}

Get Carfax reports balance.

Source:
Parameters:
Name Type Attributes Description
accountId string <optional>

Requester account ID.
platformId string <optional>

Platform ID.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax reports page.

getDepositOptions(platformIdopt) → {Promise.<JsonApiResponse>}

Get Carfax reports deposit options for top up.

Source:
Parameters:
Name Type Attributes Description
platformId string <optional>

Platform ID.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax reports page.

getDocumentUrl(documentId) → {string}

Get Carfax document URL.

Source:
Parameters:
Name Type Description
documentId string

Carfax report document ID
Returns:
Type:
string

Carfax report document URL.

getReportById(id, accessTokenopt) → {Promise.<JsonApiResponse>}

Get Carfax report by its ID.

Source:
Parameters:
Name Type Attributes Description
id string

Carfax report ID
accessToken string <optional>

Use the report's access token.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax report.

getReportPrice() → {Promise.<JsonApiResponse>}

Get carfax report price.

Source:
Returns:
Type:
Promise.<JsonApiResponse>

Report price response.

getReportsPage(queryopt) → {Promise.<JsonApiResponse>}

Get Carfax reports list page.

Source:
Parameters:
Name Type Attributes Description
query Object <optional>

Request query

Name Type Attributes Description
filter Object <optional>

Request query filter

Name Type Attributes Description
requestor string <optional>

Requestor account ID.
vin string <optional>

Vehicle identification number.
state string <optional>

Request state.
created_after string <optional>

Minimum request creation date.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax reports page.

getSubscription(subscriptionId) → {Promise.<JsonApiResponse>}

Get Carfax subscription by ID.

Source:
Parameters:
Name Type Description
subscriptionId string

Carfax subscription ID.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax subscription response.

getSubscriptionToken(subscriptionId) → {Promise.<JsonApiResponse>}

Get Carfax subscription token by subscription ID.

Source:
Parameters:
Name Type Description
subscriptionId string

Carfax subscription ID.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax subscription token response.

invalidateSubscriptionToken(subscriptionId) → {Promise.<JsonApiResponse>}

Delete Carfax subscription token by subscription ID.

Source:
Parameters:
Name Type Description
subscriptionId string

Carfax subscription ID.
Returns:
Type:
Promise.<JsonApiResponse>

Empty response.

requestReport(opts) → {Promise.<JsonApiResponse>}

Request Carfax report.

Source:
Parameters:
Name Type Description
opts Object
Name Type Attributes Description
email string <optional>

Requestor email.
phone string <optional>

Requestor phone number.
vin string

Vehicle identification number.
currency string

Currency for carfax report payment
Returns:
Type:
Promise.<JsonApiResponse>

Created request response.

updateBalance(accountId, availableReports, platformIdopt) → {Promise.<JsonApiResponse>}

Update user Carfax reports balance. Allowed by admin only.

Source:
Parameters:
Name Type Attributes Description
accountId string

Target account ID.
availableReports number

New balance value.
platformId string <optional>

Platform ID.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax reports page.

updateSubscription(subscriptionId, opts) → {Promise.<JsonApiResponse>}

Update Carfax subscription by ID.

Source:
Parameters:
Name Type Description
subscriptionId string

Carfax subscription ID.
opts
Name Type Description
name string

Subscriber name.
requestsLeft Number

Left requests number.
Returns:
Type:
Promise.<JsonApiResponse>

Carfax subscription response.