@salesforce/b2c-tooling-sdk / operations/object-types / ObjectTypesClient
Class: ObjectTypesClient
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:100
Operations over the SCAPI Object Definitions API: system object types, attribute definitions, and attribute groups.
List methods page through all results. Attribute IDs may be passed with or without the c_ prefix.
Example
const ot = new ObjectTypesClient(instance.scapiClientConfig!);
const attrs = await ot.listAttributeDefinitions('Product', {kind: 'custom'});Constructors
Constructor
new ObjectTypesClient(
config):ObjectTypesClient
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:104
Parameters
config
Returns
ObjectTypesClient
Properties
client
readonlyclient:ObjectDefinitionsClient
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:101
organizationId
readonlyorganizationId:string
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:102
Methods
assignAttributeToGroup()
assignAttributeToGroup(
objectType,groupId,attributeId):Promise<void>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:110
Assigns an attribute definition to a group.
Parameters
objectType
string
groupId
string
attributeId
string
Returns
Promise<void>
createOrReplaceAttributeDefinition()
createOrReplaceAttributeDefinition(
objectType,definition):Promise<{created:boolean;definition: { }; }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:128
Creates or fully replaces an attribute definition. Properties omitted from definition are reset to their defaults; use updateAttributeDefinition for partial changes.
Parameters
objectType
string
definition
Returns
Promise<{ created: boolean; definition: { }; }>
createOrReplaceAttributeGroup()
createOrReplaceAttributeGroup(
objectType,group):Promise<{created:boolean;group: { }; }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:145
Creates or fully replaces an attribute group. Replacing a group removes its attribute assignments.
Parameters
objectType
string
group
Returns
Promise<{ created: boolean; group: { }; }>
deleteAttributeDefinition()
deleteAttributeDefinition(
objectType,attributeId):Promise<void>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:159
Deletes a custom attribute definition.
Parameters
objectType
string
attributeId
string
Returns
Promise<void>
deleteAttributeGroup()
deleteAttributeGroup(
objectType,groupId):Promise<void>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:169
Deletes an attribute group.
Parameters
objectType
string
groupId
string
Returns
Promise<void>
getAttributeDefinition()
getAttributeDefinition(
objectType,attributeId,options):Promise<{ }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:183
Gets one attribute definition. With includeValues, uses the search endpoint so enum valueDefinitions are returned (requires .rw scope).
Parameters
objectType
string
attributeId
string
options
includeValues?
boolean
Returns
Promise<{ }>
getAttributeGroup()
getAttributeGroup(
objectType,groupId,options):Promise<{ }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:205
Gets one attribute group, optionally with its assigned definitions.
Parameters
objectType
string
groupId
string
options
ListAttributeGroupsOptions = {}
Returns
Promise<{ }>
getObjectType()
getObjectType(
objectType):Promise<{ }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:225
Gets one system object type with its attribute and group counts.
Parameters
objectType
string
Returns
Promise<{ }>
listAttributeDefinitions()
listAttributeDefinitions(
objectType,options):Promise<object[]>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:239
Lists attribute definitions of an object type. Filtering and enum values go through the search endpoint (requires .rw scope); a plain listing uses the list endpoint and works with the read-only scope.
Parameters
objectType
string
options
ListAttributeDefinitionsOptions = {}
Returns
Promise<object[]>
listAttributeGroups()
listAttributeGroups(
objectType,options):Promise<object[]>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:257
Lists attribute groups of an object type.
Parameters
objectType
string
options
ListAttributeGroupsOptions = {}
Returns
Promise<object[]>
listObjectTypes()
listObjectTypes():
Promise<object[]>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:281
Lists system object types. Custom object types are not addressable by this API; they appear as unnamed CustomObject entries and are omitted.
Returns
Promise<object[]>
searchAttributeDefinitions()
searchAttributeDefinitions(
objectType,query):Promise<object[]>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:292
Runs an attribute definition search and returns all hits (requires .rw scope).
Parameters
objectType
string
query
Returns
Promise<object[]>
unassignAttributeFromGroup()
unassignAttributeFromGroup(
objectType,groupId,attributeId):Promise<void>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:306
Removes an attribute definition from a group.
Parameters
objectType
string
groupId
string
attributeId
string
Returns
Promise<void>
updateAttributeDefinition()
updateAttributeDefinition(
objectType,attributeId,changes):Promise<{ }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:323
Partially updates an attribute definition. valueType cannot be changed, and enum values (valueDefinitions) are ignored by the API.
Parameters
objectType
string
attributeId
string
changes
Partial<ObjectAttributeDefinition>
Returns
Promise<{ }>
updateAttributeGroup()
updateAttributeGroup(
objectType,groupId,changes):Promise<{ }>
Defined in: packages/b2c-tooling-sdk/src/operations/object-types/object-types.ts:338
Partially updates an attribute group.
Parameters
objectType
string
groupId
string
changes
Partial<ObjectAttributeGroup>
Returns
Promise<{ }>