Class default

Index

Constructors

constructor

Methods

add batchAdd batchList batchUpdate callSPPXML delete getAuthUrl list read refreshUserToken setAccessToken update whoami

Constructors

constructor

new default(options: SPPClientOptions): default
Parameters
- options: SPPClientOptions
Returns default
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:50

Methods

add

add<BO extends BOName>(
bo: BO,
payload: Partial<BORecordMap[BO]> | Partial<BORecordMap[BO]>[],
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- payload: Partial<BORecordMap[BO]> | Partial<BORecordMap[BO]>[]
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:271

batchAdd

batchAdd<BO extends BOName>(
bo: BO,
payloads: Partial<BORecordMap[BO]>[],
): Promise<BORecordMap[BO][]>
Add multiple records for a Business Object (BO).
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- payloads: Partial<BORecordMap[BO]>[]
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:296

batchList

batchList<BO extends BOName>(
    bo: BO,
    filter?: Record<string, any>[],
    limit?: number,
    offset?: number,
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- filter: Record<string, any>[] = []
- limit: number = 1000
- offset: number = 0
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:255

batchUpdate

batchUpdate<BO extends BOName>(
bo: BO,
updates: { changes: Partial<BORecordMap[BO]>; id: string }[],
): Promise<BORecordMap[BO][]>
Update multiple records for a Business Object (BO).
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- updates: { changes: Partial<BORecordMap[BO]>; id: string }[]
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:306

callSPPXML

callSPPXML<T = any>(rawXml: string, retry?: boolean): Promise<T[]>
Type Parameters
- T = any
Parameters
- rawXml: string
- retry: boolean = true
Returns Promise<T[]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:169

delete

delete<BO extends BOName>(
bo: BO,
id: string | string[],
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- id: string | string[]
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:286

getAuthUrl

getAuthUrl(): string
Returns string
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:102

list

list<BO extends BOName>(
    bo: BO,
    filter?: Record<string, any>,
    limit?: number,
    offset?: number,
): Promise<BORecordMap[BO][]>
List records for any Business Object (BO) by name.
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- filter: Record<string, any> = {}
- limit: number = 1000
- offset: number = 0
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:246

read

read<BO extends BOName>(
bo: BO,
id: string,
): Promise<undefined | BORecordMap[BO]>
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- id: string
Returns Promise<undefined | BORecordMap[BO]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:264

refreshUserToken

refreshUserToken(refreshToken: string): Promise<RefreshTokenResponse>
Parameters
- refreshToken: string
Returns Promise<RefreshTokenResponse>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:120

setAccessToken

setAccessToken(token: undefined | null | string): void
Parameters
- token: undefined | null | string
Returns void
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:116

update

update<BO extends BOName>(
    bo: BO,
    id: string,
    changes: Partial<BORecordMap[BO]>,
): Promise<BORecordMap[BO][]>
Type Parameters
- BO extends BOName
Parameters
- bo: BO
- id: string
- changes: Partial<BORecordMap[BO]>
Returns Promise<BORecordMap[BO][]>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:278

whoami

whoami(): Promise<User>
Returns Promise<User>
- Defined in Documents/code2/interns-oaconnect/src/SPPClient.ts:313

Settings

Member Visibility

Theme