Class SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>

A class for organizing all SObject access

Type Parameters

S extends Schema
N extends SObjectNames<S>
FieldNames extends SObjectFieldNames<S, N> = SObjectFieldNames<S, N>
RetrieveRecord extends SObjectRecord<S, N, "*"> = SObjectRecord<S, N, "*">
InputRecord extends SObjectInputRecord<S, N> = SObjectInputRecord<S, N>
UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>

Constructors

constructor

new SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>(conn, type): SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>
Type Parameters
- S extends Schema
- N extends string
- FieldNames extends string = Extract<keyof S["SObjects"][N]["Fields"], string>
- RetrieveRecord extends Record | (({ [name: string]: SObjectFieldType | null; } | RecordWithChildRelations<S["SObjects"][N], true, S["SObjects"][N]["ChildRelationships"]>) & Record) = SObjectRecord<S, N, "*", Record, {}>
- InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
- UpdateRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>
Parameters
- conn: Connection<S>
- type: N
Returns SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>
- Defined in src/sobject.ts:78

Properties

_conn

_conn: Connection<S>

_logger

_logger: Logger

del

del: {
    (ids, options?): Promise<SaveResult[]>;
    (ids, options?): Promise<SaveResult>;
    (ids, options?): Promise<SaveResult | SaveResult[]>;
} = ...

Synonym of SObject#destroy()

Type declaration

- (ids, options?): Promise<SaveResult[]>
- Parameters
  - ids: string[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult[]>
- (ids, options?): Promise<SaveResult>
- Parameters
  - ids: string
  - Optional options: DmlOptions
  Returns Promise<SaveResult>
- (ids, options?): Promise<SaveResult | SaveResult[]>
- Parameters
  - ids: string | string[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

delete

delete: {
    (ids, options?): Promise<SaveResult[]>;
    (ids, options?): Promise<SaveResult>;
    (ids, options?): Promise<SaveResult | SaveResult[]>;
} = ...

Synonym of SObject#destroy()

Type declaration

- (ids, options?): Promise<SaveResult[]>
- Parameters
  - ids: string[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult[]>
- (ids, options?): Promise<SaveResult>
- Parameters
  - ids: string
  - Optional options: DmlOptions
  Returns Promise<SaveResult>
- (ids, options?): Promise<SaveResult | SaveResult[]>
- Parameters
  - ids: string | string[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

deleteBulk

deleteBulk: ((input?) => Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">) = ...

Synonym of SObject#destroyBulk()

Type declaration

- (input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Parameters
  - Optional input: string | Readable | Record[]
  Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

deleteHardBulk

deleteHardBulk: ((input) => Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">) = ...

Synonym of SObject#destroyHardBulk()

Type declaration

- (input): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Parameters
  - input: Readable | Record[]
  Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

insert

insert: {
    (records, options?): Promise<SaveResult[]>;
    (records, options?): Promise<SaveResult>;
    (records, options?): Promise<SaveResult | SaveResult[]>;
} = ...

Synonym of SObject#create()

Type declaration

- (records, options?): Promise<SaveResult[]>
- Parameters
  - records: InputRecord[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult[]>
- (records, options?): Promise<SaveResult>
- Parameters
  - records: InputRecord
  - Optional options: DmlOptions
  Returns Promise<SaveResult>
- (records, options?): Promise<SaveResult | SaveResult[]>
- Parameters
  - records: InputRecord | InputRecord[]
  - Optional options: DmlOptions
  Returns Promise<SaveResult | SaveResult[]>

insertBulk

insertBulk: ((input?) => Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">) = ...

Synonym of SObject#createBulk()

Type declaration

- (input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Parameters
  - Optional input: string | Readable | Record[]
  Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

layouts$

layouts$: CachedFunction<((ln?) => Promise<DescribeLayoutResult>)>

Type declaration

- (ln?): Promise<DescribeLayoutResult>
- Parameters
  - Optional ln: string
  Returns Promise<DescribeLayoutResult>

layouts$$

layouts$$: CachedFunction<((ln?) => DescribeLayoutResult)>

Type declaration

- (ln?): DescribeLayoutResult
- Parameters
  - Optional ln: string
  Returns DescribeLayoutResult

type

type: N

`Static` _logger

_logger: Logger = ...

Methods

approvalLayouts

approvalLayouts(): Promise<DescribeApprovalLayoutsResult>
Describe compact layout information defined for SObject

Returns Promise<DescribeApprovalLayoutsResult>
- Defined in src/sobject.ts:370

bulkload

bulkload(operation, optionsOrInput?, input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Call Bulk#load() to execute bulkload, returning batch object
Parameters
- operation: "insert" | "update" | "upsert" | "delete" | "hardDelete"
- Optional optionsOrInput: string | Object | Readable | Record[]
- Optional input: string | Readable | Record[]
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:228

compactLayouts

compactLayouts(): Promise<DescribeCompactLayoutsResult>
Describe compact layout information defined for SObject

Returns Promise<DescribeCompactLayoutsResult>
- Defined in src/sobject.ts:358

count

count(conditions?): Query<S, N, SObjectRecord<S, N, "*" | FieldPathScopedProjection<S, N, Extract<keyof S["SObjects"][N]["Fields"], string>> | FieldPathScopedProjection<S, N, {
[K in string]?: "*" | FieldPath_1<Extract<(...)[(...)][K], SObjectDefinition<string>>, Extract<(...)[(...)], SObjectDefinition<(...)>>["ParentReferences"]>[]
}>, Record, {}>, "Count">
Count num of records which matches given conditions
Parameters
- Optional conditions: Optional<QueryCondition<S, N>>
Returns Query<S, N, SObjectRecord<S, N, "*" | FieldPathScopedProjection<S, N, Extract<keyof S["SObjects"][N]["Fields"], string>> | FieldPathScopedProjection<S, N, {
[K in string]?: "*" | FieldPath_1<Extract<(...)[(...)][K], SObjectDefinition<string>>, Extract<(...)[(...)], SObjectDefinition<(...)>>["ParentReferences"]>[]
}>, Record, {}>, "Count">
- Defined in src/sobject.ts:450

create

create(records, options?): Promise<SaveResult[]>
Create records
Parameters
- records: InputRecord[]
- Optional options: DmlOptions
Returns Promise<SaveResult[]>
- Defined in src/sobject.ts:135
create(records, options?): Promise<SaveResult>
Parameters
- records: InputRecord
- Optional options: DmlOptions
Returns Promise<SaveResult>
- Defined in src/sobject.ts:136
create(records, options?): Promise<SaveResult | SaveResult[]>
Parameters
- records: InputRecord | InputRecord[]
- Optional options: DmlOptions
Returns Promise<SaveResult | SaveResult[]>
- Defined in src/sobject.ts:137

createBulk

createBulk(input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Bulkly insert input data using bulk API
Parameters
- Optional input: string | Readable | Record[]
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:239

deleted

deleted(start, end): Promise<DeletedResult>
Retrieve the deleted records
Parameters
- start: string | Date
- end: string | Date
Returns Promise<DeletedResult>
- Defined in src/sobject.ts:331

describe

describe(): Promise<DescribeSObjectResult>
Describe SObject metadata

Returns Promise<DescribeSObjectResult>
- Defined in src/sobject.ts:289

describe$

describe$(): Promise<DescribeSObjectResult>
Returns Promise<DescribeSObjectResult>
- Defined in src/sobject.ts:296

describe$$

describe$$(): DescribeSObjectResult
Returns DescribeSObjectResult
- Defined in src/sobject.ts:303

destroy

destroy(ids, options?): Promise<SaveResult[]>
Delete records
Parameters
- ids: string[]
- Optional options: DmlOptions
Returns Promise<SaveResult[]>
- Defined in src/sobject.ts:205
destroy(ids, options?): Promise<SaveResult>
Parameters
- ids: string
- Optional options: DmlOptions
Returns Promise<SaveResult>
- Defined in src/sobject.ts:206
destroy(ids, options?): Promise<SaveResult | SaveResult[]>
Parameters
- ids: string | string[]
- Optional options: DmlOptions
Returns Promise<SaveResult | SaveResult[]>
- Defined in src/sobject.ts:207

destroyBulk

destroyBulk(input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Bulkly delete records specified by input data using bulk API
Parameters
- Optional input: string | Readable | Record[]
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:265

destroyHardBulk

destroyHardBulk(input): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Bulkly hard delete records specified in input data using bulk API
Parameters
- input: Readable | Record[]
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:277

find

find<R>(conditions?): Query<S, N, SObjectRecord<S, N, "*", R, {}>, "Records">
Find and fetch records which matches given conditions
Type Parameters
- R extends Record = Record
Parameters
- Optional conditions: Optional<QueryCondition<S, N>>
Returns Query<S, N, SObjectRecord<S, N, "*", R, {}>, "Records">
- Defined in src/sobject.ts:379
find<R, FP, FPC>(conditions, fields?, options?): Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "Records">
Type Parameters
- R extends Record = Record
- FP extends string | {
  [K in string]?: "*" | FieldPath_1<Extract<S["SObjects"][N]["ParentReferences"][K], SObjectDefinition<string>>, Extract<(...)[(...)][N]["ParentReferences"][K], SObjectDefinition<string>>["ParentReferences"]>[]
  } = FieldPathSpecifier<S, N>
- FPC extends FieldProjectionConfig = FieldPathScopedProjection<S, N, FP>
Parameters
- conditions: Optional<QueryCondition<S, N>>
- Optional fields: Optional<QueryField<S, N, FP>>
- Optional options: Partial<QueryOptions & Pick<QueryConfig<S, N, FieldPathSpecifier<S, N>>, "includes" | "sort"> & {
  limit: number;
  offset: number;
  }>
Returns Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "Records">
- Defined in src/sobject.ts:382

findOne

findOne<R>(conditions?): Query<S, N, SObjectRecord<S, N, "*", R, {}>, "SingleRecord">
Fetch one record which matches given conditions
Type Parameters
- R extends Record = Record
Parameters
- Optional conditions: Optional<QueryCondition<S, N>>
Returns Query<S, N, SObjectRecord<S, N, "*", R, {}>, "SingleRecord">
- Defined in src/sobject.ts:413
findOne<R, FP, FPC>(conditions, fields?, options?): Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "SingleRecord">
Type Parameters
- R extends Record = Record
- FP extends string | {
  [K in string]?: "*" | FieldPath_1<Extract<S["SObjects"][N]["ParentReferences"][K], SObjectDefinition<string>>, Extract<(...)[(...)][N]["ParentReferences"][K], SObjectDefinition<string>>["ParentReferences"]>[]
  } = FieldPathSpecifier<S, N>
- FPC extends FieldProjectionConfig = FieldPathScopedProjection<S, N, FP>
Parameters
- conditions: Optional<QueryCondition<S, N>>
- Optional fields: Optional<QueryField<S, N, FP>>
- Optional options: Partial<QueryOptions & Pick<QueryConfig<S, N, FieldPathSpecifier<S, N>>, "includes" | "sort"> & {
  limit: number;
  offset: number;
  }>
Returns Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "SingleRecord">
- Defined in src/sobject.ts:416

layouts

layouts(layoutName?): Promise<DescribeLayoutResult>
Describe layout information for SObject
Parameters
- Optional layoutName: string
Returns Promise<DescribeLayoutResult>
- Defined in src/sobject.ts:338

listview

listview(id): ListView
Returns the list view info in specifed view id
Parameters
- id: string
  List view ID
Returns ListView
- Defined in src/sobject.ts:472

listviews

listviews(): StreamPromise<unknown>
Returns the list of list views for the SObject

Returns StreamPromise<unknown>
- Defined in src/sobject.ts:461

quickAction

quickAction(actionName): QuickAction<S>
Get reference for specified quick aciton in the SObject
Parameters
- actionName: string
  Name of the quick action
Returns QuickAction<S>
- Defined in src/sobject.ts:492

quickActions

quickActions(): StreamPromise<unknown>
Returns all registered quick actions for the SObject

Returns StreamPromise<unknown>
- Defined in src/sobject.ts:482

recent

recent(): Promise<Record[]>
Retrieve recently accessed records

Returns Promise<Record[]>
- Defined in src/sobject.ts:317

record

record(id): RecordReference<S, N, Partial<SObjectRecord<S, N, "*", Record, {}>>, SObjectUpdateRecord<S, N>>
Get record representation instance by given id
Parameters
- id: string
Returns RecordReference<S, N, Partial<SObjectRecord<S, N, "*", Record, {}>>, SObjectUpdateRecord<S, N>>
- Defined in src/sobject.ts:310

retrieve

retrieve(ids, options?): Promise<RetrieveRecord[]>
Retrieve specified records
Parameters
- ids: string[]
- Optional options: RetrieveOptions
Returns Promise<RetrieveRecord[]>
- Defined in src/sobject.ts:153
retrieve(ids, options?): Promise<RetrieveRecord>
Parameters
- ids: string
- Optional options: RetrieveOptions
Returns Promise<RetrieveRecord>
- Defined in src/sobject.ts:154
retrieve(ids, options?): Promise<RetrieveRecord | RetrieveRecord[]>
Parameters
- ids: string | string[]
- Optional options: RetrieveOptions
Returns Promise<RetrieveRecord | RetrieveRecord[]>
- Defined in src/sobject.ts:155

select

select<R, FP, FPC>(fields): Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "Records">
Find and fetch records only by specifying fields to fetch.
Type Parameters
- R extends Record = Record
- FP extends string | {
  [K in string]?: "*" | FieldPath_1<Extract<S["SObjects"][N]["ParentReferences"][K], SObjectDefinition<string>>, Extract<(...)[(...)][N]["ParentReferences"][K], SObjectDefinition<string>>["ParentReferences"]>[]
  } = FieldPathSpecifier<S, N>
- FPC extends FieldProjectionConfig = FieldPathScopedProjection<S, N, FP>
Parameters
- fields: QueryField<S, N, FP>
Returns Query<S, N, SObjectRecord<S, N, FPC, R, {}>, "Records">
- Defined in src/sobject.ts:437

update

update(records, options?): Promise<SaveResult[]>
Update records
Parameters
- records: UpdateRecord[]
- Optional options: DmlOptions
Returns Promise<SaveResult[]>
- Defined in src/sobject.ts:166
update(records, options?): Promise<SaveResult>
Parameters
- records: UpdateRecord
- Optional options: DmlOptions
Returns Promise<SaveResult>
- Defined in src/sobject.ts:167
update(records, options?): Promise<SaveResult | SaveResult[]>
Parameters
- records: UpdateRecord | UpdateRecord[]
- Optional options: DmlOptions
Returns Promise<SaveResult | SaveResult[]>
- Defined in src/sobject.ts:168

updateBulk

updateBulk(input?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Bulkly update records by input data using bulk API
Parameters
- Optional input: string | Readable | Record[]
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:251

updated

updated(start, end): Promise<UpdatedResult>
Retrieve the updated records
Parameters
- start: string | Date
- end: string | Date
Returns Promise<UpdatedResult>
- Defined in src/sobject.ts:324

upsert

upsert(records, extIdField, options?): Promise<UpsertResult[]>
Upsert records
Parameters
- records: InputRecord[]
- extIdField: FieldNames
- Optional options: DmlOptions
Returns Promise<UpsertResult[]>
- Defined in src/sobject.ts:179
upsert(records, extIdField, options?): Promise<UpsertResult>
Parameters
- records: InputRecord
- extIdField: FieldNames
- Optional options: DmlOptions
Returns Promise<UpsertResult>
- Defined in src/sobject.ts:184
upsert(records, extIdField, options?): Promise<UpsertResult | UpsertResult[]>
Parameters
- records: InputRecord | InputRecord[]
- extIdField: FieldNames
- Optional options: DmlOptions
Returns Promise<UpsertResult | UpsertResult[]>
- Defined in src/sobject.ts:189

upsertBulk

upsertBulk(input?, extIdField?): Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
Bulkly upsert records by input data using bulk API
Parameters
- Optional input: string | Readable | Record[]
- Optional extIdField: string
Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">
- Defined in src/sobject.ts:258

Class SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SObject<S, N, FieldNames, RetrieveRecord, InputRecord, UpdateRecord>

Properties

_conn

_logger

approvalLayouts$

Type declaration

Returns Promise<DescribeApprovalLayoutsResult>

approvalLayouts$$

Type declaration

Returns DescribeApprovalLayoutsResult

compactLayouts$

Type declaration

Returns Promise<DescribeCompactLayoutsResult>

compactLayouts$$

Type declaration

Returns DescribeCompactLayoutsResult

del

Type declaration

Parameters

Returns Promise<SaveResult[]>

Parameters

Returns Promise<SaveResult>

Parameters

Returns Promise<SaveResult | SaveResult[]>

delete

Type declaration

Parameters

Returns Promise<SaveResult[]>

Parameters

Returns Promise<SaveResult>

Parameters

Returns Promise<SaveResult | SaveResult[]>

deleteBulk

Type declaration

Parameters

Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

deleteHardBulk

Type declaration

Parameters

Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

insert

Type declaration

Parameters

Returns Promise<SaveResult[]>

Parameters

Returns Promise<SaveResult>

Parameters

Returns Promise<SaveResult | SaveResult[]>

insertBulk

Type declaration

Parameters

Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

layouts$

Type declaration

Parameters

Returns Promise<DescribeLayoutResult>

layouts$$

Type declaration

Parameters

Returns DescribeLayoutResult

type

Static _logger

Methods

approvalLayouts

Returns Promise<DescribeApprovalLayoutsResult>

bulkload

Parameters

Returns Batch<S, "insert" | "update" | "upsert" | "delete" | "hardDelete">

compactLayouts

Returns Promise<DescribeCompactLayoutsResult>

`Static` _logger