Skip to main content

Class: AttributeService

Defined in: service/AttributeService.ts:211

Backwards-compatible class form. New code should call attributeService(client).

Constructors​

Constructor​

new AttributeService(client): AttributeService

Defined in: service/AttributeService.ts:213

Parameters​

client​

GraphQLClient

Returns​

AttributeService

Methods​

createAttribute()​

createAttribute(input): Promise<Attribute>

Defined in: service/AttributeService.ts:228

Creates a new attribute

Parameters​

input​

AttributeCreateInput

Attribute creation input data

Returns​

Promise<Attribute>

createAttributeDescription()​

createAttributeDescription(input): Promise<AttributeDescription>

Defined in: service/AttributeService.ts:284

Creates a new attribute description

Parameters​

input​

AttributeDescriptionCreateInput

AttributeDescription creation input data

Returns​

Promise<AttributeDescription>

deleteAttribute()​

deleteAttribute(id): Promise<boolean>

Defined in: service/AttributeService.ts:239

Deletes an attribute by ID

Parameters​

id​

string

Attribute ID to delete

Returns​

Promise<boolean>

deleteAttributeDescription()​

deleteAttributeDescription(id): Promise<boolean>

Defined in: service/AttributeService.ts:295

Deletes an attribute description by ID

Parameters​

id​

string

AttributeDescription ID to delete

Returns​

Promise<boolean>

deleteAttributeDescriptionBulk()​

deleteAttributeDescriptionBulk(ids): Promise<BulkDeleteResponse>

Defined in: service/AttributeService.ts:300

Deletes multiple attribute descriptions by IDs

Parameters​

ids​

string[]

Array of AttributeDescription IDs to delete

Returns​

Promise<BulkDeleteResponse>

getAttribute()​

getAttribute(id): Promise<Attribute>

Defined in: service/AttributeService.ts:218

Fetches a single attribute by ID

Parameters​

id​

string

Attribute ID to fetch

Returns​

Promise<Attribute>

getAttributeDescription()​

getAttributeDescription(id): Promise<AttributeDescription>

Defined in: service/AttributeService.ts:274

Fetches a single attribute description by ID

Parameters​

id​

string

AttributeDescription ID to fetch

Returns​

Promise<AttributeDescription>

getAttributeDescriptions()​

getAttributeDescriptions(input): Promise<AttributeDescriptionResponse>

Defined in: service/AttributeService.ts:279

Fetches a list of attribute descriptions with search criteria

Parameters​

input​

AttributeDescriptionSearchInput

AttributeDescription search input parameters

Returns​

Promise<AttributeDescriptionResponse>

getAttributeResultByCategoryId()​

getAttributeResultByCategoryId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:244

Fetches attribute results by category ID

Parameters​

variables​

AttributeResultByCategoryIdVariables

Category ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributeResultByClusterId()​

getAttributeResultByClusterId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:249

Fetches attribute results by cluster ID

Parameters​

variables​

AttributeResultByClusterIdVariables

Cluster ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributeResultByCompanyId()​

getAttributeResultByCompanyId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:254

Fetches attribute results by company ID

Parameters​

variables​

AttributeResultByCompanyIdVariables

Company ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributeResultByContactId()​

getAttributeResultByContactId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:259

Fetches attribute results by contact ID

Parameters​

variables​

AttributeResultByContactIdVariables

Contact ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributeResultByCustomerId()​

getAttributeResultByCustomerId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:264

Fetches attribute results by customer ID

Parameters​

variables​

AttributeResultByCustomerIdVariables

Customer ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributeResultByProductId()​

getAttributeResultByProductId(variables): Promise<AttributeResultResponse>

Defined in: service/AttributeService.ts:269

Fetches attribute results by product ID

Parameters​

variables​

AttributeResultByProductIdVariables

Product ID to fetch attributes for

Returns​

Promise<AttributeResultResponse>

getAttributes()​

getAttributes(input): Promise<AttributeResponse>

Defined in: service/AttributeService.ts:223

Fetches a list of attributes with search criteria

Parameters​

input​

AttributeSearchInput

Attribute search input parameters

Returns​

Promise<AttributeResponse>

importAttributeDescriptionCsv()​

importAttributeDescriptionCsv(input): Promise<CsvImportResponse>

Defined in: service/AttributeService.ts:305

Imports attribute descriptions via CSV

Parameters​

input​

AttributeDescriptionCsvInput

CSV import input data

Returns​

Promise<CsvImportResponse>

updateAttribute()​

updateAttribute(id, input): Promise<Attribute>

Defined in: service/AttributeService.ts:234

Updates an existing attribute

Parameters​

id​

string

Attribute ID to update

input​

AttributeUpdateInput

Attribute update input data

Returns​

Promise<Attribute>

updateAttributeDescription()​

updateAttributeDescription(id, input): Promise<AttributeDescription>

Defined in: service/AttributeService.ts:290

Updates an existing attribute description

Parameters​

id​

string

AttributeDescription ID to update

input​

AttributeDescriptionUpdateInput

AttributeDescription update input data

Returns​

Promise<AttributeDescription>