Function

Static Public Summary
public	createContext(config: object): PVBidContext Creates a authorized context instance.
public	getAssembly(entity: BidEntity): Assembly \| undefined Get the entities assembly if it has one
public	getAuthToken(username: string, password: string, config: object): Promise<object> Obtains a user access token and refresh_token.
public	hasAssembly(entity: BidEntity): boolean Determine if the entity has an assembly
public	setAssembly(entity: BidEntity, assembly: Assembly \| string): BidEntity Set the entity's assembly reference. Omitting or passing null for the assembly will UNSET the assembly reference

Static Public

import {createContext} from 'pvbid-sdk/src/pvbid.js'

Creates a authorized context instance.

Name	Type	Attribute	Description
config	object
config.token	string		The auth token to access account data..
config.base_uri	string	optional default: https://api.pvbid.com/v2

import {getAssembly} from 'pvbid-sdk/src/domain/services/BidEntityAssemblyService.js'

Get the entities assembly if it has one

Name	Type	Attribute	Description
entity	BidEntity

import {getAuthToken} from 'pvbid-sdk/src/pvbid.js'

Obtains a user access token and refresh_token.

Name	Type	Attribute	Description
username	string		The user's email address is used
password	string
config	object
config.base_uri	string	optional default: https://api.pvbid.com/v2

import {hasAssembly} from 'pvbid-sdk/src/domain/services/BidEntityAssemblyService.js'

Determine if the entity has an assembly

Name	Type	Attribute	Description
entity	BidEntity

import {setAssembly} from 'pvbid-sdk/src/domain/services/BidEntityAssemblyService.js'

Set the entity's assembly reference. Omitting or passing null for the assembly will UNSET the assembly reference

Name	Type	Attribute	Description
entity	BidEntity
assembly	Assembly \| string	optional	The assembly reference id OR the assembly entity.