ShelfNetwork

ShelfNetwork

Shelf.Network Software Development Toolkit.

Constructor

new ShelfNetwork(optsopt)

Make a new ShelfNetwork SDK instance.

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

Shelf.Network platform ID.

gatewayUrl string <optional>

Gateway server url.

horizonUrl string <optional>

Horizon server url.

transportationServerUrl string <optional>

Transportation server url.

feeCalculatorServerUrl string <optional>

Fee server url.

paymentServerUrl string <optional>

Payment server url.

authServerUrl string <optional>

Auth server url.

carfaxUrl string <optional>

Carfax server url.

boosterUrl string <optional>

Booster server url.

backOfficeUrl string <optional>

BackOffice server url.

priceSuggesterUrl string <optional>

Price suggester server url.

exratesUrl string <optional>

Exchange rates server url.

inventoryUrl string <optional>

Inventory server url.

inventoryV2Url string <optional>

Inventory V2 server url.

frontOfficeUrl string <optional>

Front office server url.

platformerUrl string <optional>

Platformer server url.

leasingUrl string <optional>

Leasing server url.

enumerUrl string <optional>

Enumer server url.

notificationRouterUrl string <optional>

NotificationRouter server url.

w8TransFeeUrl string <optional>

W8 Trans Fee server url.

feesUrl string <optional>

Fees server url.

buyingPowerUrl string <optional>

Buying power server url.

priceFillerUrl string <optional>

Price filler server url.

copartBackOfficeUrl string <optional>

Copart back office server url.

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

ShelfNetwork

Members

auth :AuthServer

Notification server instance.

Source:
Type:

backOffice :BackOfficeServer

BackOffice server instance.

Source:
Type:

booster :BoosterServer

Booster server instance.

Source:
Type:
  • BoosterServer

buyingPower :BuyingPower

Buying power server instance.

Source:
Type:

carfax :CarfaxServer

Carfax server instance.

Source:
Type:

copartBackOffice :CopartBackOfficeServer

CopartBackOffice server instance.

Source:
Type:
  • CopartBackOfficeServer

enumer :EnumerServer

Enumer server instance.

Source:
Type:

exrates :ExratesServer

Exchange rates server instance.

Source:
Type:

feeCalculator :FeeCalculatorServer

Fee server instance.

Source:
Type:

fees :FeesServer

Fees server instance.

Source:
Type:

files :FileServer

File server instance.

Source:
Type:

frontOffice :FrontOfficeServer

Front office server instance.

Source:
Type:

gateway :GatewayServer

Blacklist server instance.

Source:
Type:

horizon :HorizonServer

Horizon server instance.

Source:
Type:

identity :IdentityServer

Identity server instance.

Source:
Type:
  • IdentityServer

impactAutoBackOffice :ImpactAutoBackOfficeServer

ImpactAutoBackOffice server instance.

Source:
Type:
  • ImpactAutoBackOfficeServer

inventory :InventoryServer

Inventory server instance.

Source:
Type:
  • InventoryServer

inventoryV2 :InventoryV2Server

Inventory V2 server instance.

Source:
Type:

leasing :LeasingServer

Leasing server instance.

Source:
Type:
  • LeasingServer

messenger :MessengerServer

Messenger server instance.

Source:
Type:
  • MessengerServer

notificationRouter :NotificationRouterServer

SendNotification server instance.

Source:
Type:

payments :PaymentServer

Payment server instance.

Source:
Type:

platformer :PlatformerServer

Platformer server instance.

Source:
Type:

platformId :string

Shelf.Network platform ID.

Source:
Type:
  • string

priceFiller :PriceFillerServer

Price filler server instance.

Source:
Type:

priceSuggester :PriceSuggesterServer

Price suggester server instance.

Source:
Type:

ringer :RingerServer

Notification server instance.

Source:
Type:

token :Token

User's token.

Source:
Type:

transportation :TransportationServer

Transportation server instance.

Source:
Type:

w8TransFee :W8TransFeeServer

W8 Trans Fee server instance.

Source:
Type:

Methods

ejectRequestInterceptor(interceptors)

Eject request interceptor.

Source:
See:
Parameters:
Name Type Description
interceptors Array.<Object>

Axios.js interceptor descriptor.

ejectResponseInterceptor(interceptor)

Eject response interceptor.

Source:
See:
Parameters:
Name Type Description
interceptor Array.<object>

Axios.js interceptor descriptor.

ejectToken()

Eject current JWT token.

Source:

useRequestInterceptor(handleSuccess, handleFailure) → {Array.<object>}

Use request interceptor.

Source:
See:
Parameters:
Name Type Description
handleSuccess function

Handler for successful requests.

handleFailure function

Handler for failed requests.

Returns:
Type:
Array.<object>

Axios.js interceptor objects.

useResponseInterceptor(handleSuccess, handleFailure) → {Array.<object>}

Use response interceptor.

Source:
See:
Parameters:
Name Type Description
handleSuccess function

Handler for successful responses.

handleFailure function

Handler for failed responses.

Returns:
Type:
Array.<object>

Axios.js interceptor objects.

useToken(token)

Use user's token to authenticate requests.

Source:
Parameters:
Name Type Description
token Token

User's token.