SalesforceDescribeClient

@kysoql/codegen / SalesforceDescribeClient

Describe client contract used by schema loading and generation.

MethodsCopy Anchor Link

describeGlobal()Copy Anchor Link

describeGlobal(): Promise<SalesforceGlobalDescription>;

Loads Salesforce global describe metadata.

ReturnsCopy Anchor Link

Promise<SalesforceGlobalDescription>

describe()Copy Anchor Link

describe(objectName): Promise<SalesforceObjectDescription>;

Loads Describe metadata for one Salesforce object API name.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SalesforceObjectDescription>

describeBigObjectIndex()?Copy Anchor Link

optional describeBigObjectIndex(objectName): Promise<readonly string[] | undefined>;

Loads ordered custom Big Object index fields when available.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly string[] | undefined>

describeDataCategoryGroups()?Copy Anchor Link

optional describeDataCategoryGroups(objectName): Promise<
  | SalesforceDataCategoryGroupsResponse
| undefined>;

Loads data-category groups for an object when the backing client supports them.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise< | SalesforceDataCategoryGroupsResponse | undefined>