Global

Members

(constant) accountTypes :number

Account types.

Source:
Type:
  • number

askCondition

Used when a buyer requests details of a stock vehicle.

Source:

auctionFinished

Auction is finished.

Source:

brokerLeadDueDateExpired

When the timer set by the broker for Lead has expired

Source:

brokerLeadStateChanged

When a broker changes the status for a Lead

Source:

brokerUserLotLost

When assigned user from the broker lost the auction (waiting for final bid)

Source:

brokerUserLotWon

When assigned user from the broker won the auction (waiting for final bid)

Source:

brokerUserMadeDeposit

A followed broker (lead) made a deposit

Source:

buyNowRequested

Buy now requested

Source:

callbackRequested

User has requested a callback.

Source:

carfaxPurchase

User bought a carfax report.

Source:

claimRequestCreated

Lot claim request was created by the dealer

Source:

depositMade

Deposit made and confirmed

Source:

directSaleApproved

Direct sale request was approved.

Source:

directSaleRejected

Direct sale request was rejected.

Source:

(constant) enums :object

New enums.

Source:
Type:
  • object

financingApproved

Financing request is approved.

Source:

financingPending

User 've just requested financing.

Source:

financingRejected

Financing request is rejected

Source:

fulfilledCarfaxReport

Carfax report was received.

Source:

inventoryInquiry

buyer requested seller more info on the lot.

Source:

leadAssigned

When a Lead was assigned to the broker by admin

Source:

leadCommented

When an admin/broker made a comment on a lead

Source:

(constant) leadPriorities :number

Lead priorities

Source:
Type:
  • number

leadReassigned

When a Lead of the broker was reassigned to another broker

Source:

(constant) leadRequestStates :string

Lead request states.

Source:
Type:
  • string

(constant) leadStates :string

Lead states

Source:
Type:
  • string

liveBiddingLiveSoon

Live biding starts soon on users lot.

Source:

lookLiveRequest

User paid for look live request.

Source:

lotLost

Lost a lot

Source:

(constant) lotStates :string

Lot states.

Source:
Type:
  • string

(constant) lotStatesI :string

Lot states.

Source:
Type:
  • string

(constant) lotTypes :string

Lot types.

Source:
Type:
  • string

lotWon

Won a lot

Source:

messageFromBuyer

Message from potential buyer of my direct sale lot.

Source:

messageFromSeller

Message from the seller of the lot I want to buy.

Source:

newActiveTrade

User has registered on a lot(or requested buy now) and paid deposit.

Source:

newUpload

User hase made a lot creation request.

Source:

(constant) notificationTypes :NotificationTypes

All supported notification types.

Source:
Type:

(constant) oauthProviders :string

Supported oAuth providers.

Source:
Type:
  • string

(constant) platformTypes :string

Platform types.

Source:
Type:
  • string

reminderUnpaidDeposit3h

Auction is ending in 3 h but there 's participant with unpaid deposit.

Source:

reminderUnpaidInvoice

Invoice is still 'due' 12h after lot is closed.

Source:

requestQuotation

Used by buyers to inquire about inventory quotes.

Source:

requestSubscribe

User Registration Request.

Source:

requestSubscribeUser

User registration request (user responded for user)

Source:

(constant) reviewableRequestStates :string

Reviewable request states.

Source:
Type:
  • string

sendNotification

Send notifications from the lead panel to sellers and buyers respectively.

Source:

stockResponse

Send inventory inquiries from buyers to sellers and brokers.

Source:

userFinancingApproved

A bank confirmed the financing request of a user

Source:

userLotLost

When assigned user from the broker won the auction

Source:

userLotWon

When assigned user from the broker won the auction

Source:

userMadeDeposit

An assigned user made a deposit

Source:

userRequestedBuyNow

A user requested buy now

Source:

userRequestedFinancing

A user requested financing

Source:

userRequestedWithdrawal

A user requested withdrawal

Source:

userVerified

When a user status from “Guest” changed to “Verified”

Source:

watchlistLotEnded

A lot from user's watchlist has ended.

Source:

watchlistLotEndsSoon

Trading for a lot in the watchlist ends in 12 hours

Source:

Methods

flattenQuery(rawQuery) → {object}

flattenQuery is needed to provide easier interface for complex query params. The following object:

{ arrayParam: ['foo', 'bar', 'baz', 123], objectParam: { foo: 'bar', fizz: 'buz' }, primitiveParam: '12' }

will be transformed to the object:

{ arrayParam: 'foo,bar,baz,123', 'objectParam[foo]' :'bar', 'objectParam[fizz]': 'buzz', primitivePara: '12' }

the main use case for this stuff is building JSON API queries by transforming objects like this: { include: ['comments', 'articles'], filter: { first_name: 'John', min_age: 25 }, page: { number: 3, limit: 15 } } to objects like this: { 'include': 'comments,articles', 'filter[first_name]': 'John', 'filter[min_age]': 25, 'page[number]': 3, 'page[limit]': 15 } so then your http client will build the valid URL:

http://api.com/authors?include=comments,articles&filter[first_name]=John&filter[min_age]=25&page[number]=3&page[limit]=15

Nested objects or nested arrays: { param1: [1,2,[3,4]], param2: { anotherParam: { foo: 'bar' } } } are considered invalid an function will throw Error, if such object passed

Source:
Parameters:
Name Type Description
rawQuery object

request query with the raw, not formatted properties

Returns:
Type:
object

resultQuery - the formatted query object that is valid to use in http-clients

Type Definitions

NotificationTypes

Source:
Type:
  • Object.<string, number>