Skip to main content

Function: clusterOptionService()

clusterOptionService(client): object

Defined in: service/ClusterOptionService.ts:19

Service for ClusterOption-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

clusterOptionAssignProducts()​

clusterOptionAssignProducts(variables): Promise<ClusterOption>

Attach existing products to a cluster option so they become selectable for it.

Parameters​

variables​

ClusterOptionAssignProductsVariables

Returns​

Promise<ClusterOption>

clusterOptionMoveAbove()​

clusterOptionMoveAbove(variables): Promise<ClusterOption[]>

Reorder a cluster option within its cluster so it appears immediately before another option.

Parameters​

variables​

ClusterOptionMoveAboveVariables

Returns​

Promise<ClusterOption[]>

clusterOptionMoveBelow()​

clusterOptionMoveBelow(variables): Promise<ClusterOption[]>

Reorder a cluster option within its cluster so it appears immediately after another option.

Parameters​

variables​

ClusterOptionMoveBelowVariables

Returns​

Promise<ClusterOption[]>

clusterOptionProductCreate()​

clusterOptionProductCreate(variables): Promise<Product>

Create a product directly within a cluster option.

Parameters​

variables​

ClusterOptionProductCreateVariables

Returns​

Promise<Product>

clusterOptionProductDelete()​

clusterOptionProductDelete(variables): Promise<boolean>

Remove a product attached to a cluster option from the catalogue.

Parameters​

variables​

ClusterOptionProductDeleteVariables

Returns​

Promise<boolean>

clusterOptionProductUpdate()​

clusterOptionProductUpdate(variables): Promise<Product>

Apply a partial update to a product attached to a cluster option.

Parameters​

variables​

ClusterOptionProductUpdateVariables

Returns​

Promise<Product>

clusterOptionRemoveProducts()​

clusterOptionRemoveProducts(variables): Promise<ClusterOption>

Detach products from a cluster option.

Parameters​

variables​

ClusterOptionRemoveProductsVariables

Returns​

Promise<ClusterOption>

getClusterOption()​

getClusterOption(variables): Promise<ClusterOption>

Retrieve a single cluster option by global identifier.

Parameters​

variables​

ClusterOptionVariables

Returns​

Promise<ClusterOption>

getClusterOptions()​

getClusterOptions(variables): Promise<ClusterOptionsResponse>

Search cluster options with filtering and pagination.

Parameters​

variables​

ClusterOptionsVariables

Returns​

Promise<ClusterOptionsResponse>