Skip to main content

Function: attributeService()

attributeService(client): object

Defined in: service/AttributeService.ts:39

Service class for Attribute and AttributeDescription-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

createAttribute()​

createAttribute(input): Promise<Attribute>

Creates a new attribute *

Parameters​

input​

AttributeCreateInput

Attribute creation input data *

Returns​

Promise<Attribute>

Promise<Attribute> The created attribute

createAttributeDescription()​

createAttributeDescription(input): Promise&lt;AttributeDescription>

Creates a new attribute description *

Parameters​

input​

AttributeDescriptionCreateInput

AttributeDescription creation input data *

Returns​

Promise&lt;AttributeDescription>

Promise<AttributeDescription> The created attribute description

deleteAttribute()​

deleteAttribute(id): Promise&lt;boolean>

Deletes an attribute by ID *

Parameters​

id​

string

Attribute ID to delete *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

deleteAttributeDescription()​

deleteAttributeDescription(id): Promise&lt;boolean>

Deletes an attribute description by ID *

Parameters​

id​

string

AttributeDescription ID to delete *

Returns​

Promise&lt;boolean>

Promise<boolean> Success status

deleteAttributeDescriptionBulk()​

deleteAttributeDescriptionBulk(ids): Promise&lt;BulkDeleteResponse>

Deletes multiple attribute descriptions by IDs *

Parameters​

ids​

string[]

Array of AttributeDescription IDs to delete *

Returns​

Promise&lt;BulkDeleteResponse>

Promise<BulkDeleteResponse> Bulk delete result

getAttribute()​

getAttribute(id): Promise&lt;Attribute>

Fetches a single attribute by ID *

Parameters​

id​

string

Attribute ID to fetch *

Returns​

Promise&lt;Attribute>

Promise<Attribute> The attribute data

getAttributeDescription()​

getAttributeDescription(id): Promise&lt;AttributeDescription>

Fetches a single attribute description by ID *

Parameters​

id​

string

AttributeDescription ID to fetch *

Returns​

Promise&lt;AttributeDescription>

Promise<AttributeDescription> The attribute description data

getAttributeDescriptions()​

getAttributeDescriptions(input): Promise&lt;AttributeDescriptionResponse>

Fetches a list of attribute descriptions with search criteria *

Parameters​

input​

AttributeDescriptionSearchInput

AttributeDescription search input parameters *

Returns​

Promise&lt;AttributeDescriptionResponse>

Promise<AttributeDescriptionResponse> The attribute descriptions response data

getAttributeResultByCategoryId()​

getAttributeResultByCategoryId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by category ID *

Parameters​

variables​

AttributeResultByCategoryIdVariables

Category ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributeResultByClusterId()​

getAttributeResultByClusterId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by cluster ID *

Parameters​

variables​

AttributeResultByClusterIdVariables

Cluster ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributeResultByCompanyId()​

getAttributeResultByCompanyId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by company ID *

Parameters​

variables​

AttributeResultByCompanyIdVariables

Company ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributeResultByContactId()​

getAttributeResultByContactId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by contact ID *

Parameters​

variables​

AttributeResultByContactIdVariables

Contact ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributeResultByCustomerId()​

getAttributeResultByCustomerId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by customer ID *

Parameters​

variables​

AttributeResultByCustomerIdVariables

Customer ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributeResultByProductId()​

getAttributeResultByProductId(variables): Promise&lt;AttributeResultResponse>

Fetches attribute results by product ID *

Parameters​

variables​

AttributeResultByProductIdVariables

Product ID to fetch attributes for *

Returns​

Promise&lt;AttributeResultResponse>

Promise<AttributeResultResponse> The attribute result data

getAttributes()​

getAttributes(input): Promise&lt;AttributeResponse>

Fetches a list of attributes with search criteria *

Parameters​

input​

AttributeSearchInput

Attribute search input parameters *

Returns​

Promise&lt;AttributeResponse>

Promise<AttributeResponse> The attributes response data

importAttributeDescriptionCsv()​

importAttributeDescriptionCsv(input): Promise&lt;CsvImportResponse>

Imports attribute descriptions via CSV *

Parameters​

input​

AttributeDescriptionCsvInput

CSV import input data *

Returns​

Promise&lt;CsvImportResponse>

Promise<CsvImportResponse> Import result

updateAttribute()​

updateAttribute(id, input): Promise&lt;Attribute>

Updates an existing attribute *

Parameters​

id​

string

Attribute ID to update *

input​

AttributeUpdateInput

Attribute update input data *

Returns​

Promise&lt;Attribute>

Promise<Attribute> The updated attribute

updateAttributeDescription()​

updateAttributeDescription(id, input): Promise&lt;AttributeDescription>

Updates an existing attribute description *

Parameters​

id​

string

AttributeDescription ID to update *

input​

AttributeDescriptionUpdateInput

AttributeDescription update input data *

Returns​

Promise&lt;AttributeDescription>

Promise<AttributeDescription> The updated attribute description