Skip to main content

Class: ClusterService

Defined in: service/ClusterService.ts:176

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

Constructors​

Constructor​

new ClusterService(client): ClusterService

Defined in: service/ClusterService.ts:178

Parameters​

client​

GraphQLClient

Returns​

ClusterService

Methods​

clusterAddToCategory()​

clusterAddToCategory(variables): Promise<BaseProductCategoryRelationship>

Defined in: service/ClusterService.ts:204

Parameters​

variables​

ClusterAddToCategoryVariables

Returns​

Promise<BaseProductCategoryRelationship>

clusterAssignProduct()​

clusterAssignProduct(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:205

Parameters​

variables​

ClusterAssignProductVariables

Returns​

Promise<Cluster>

clusterCategoryMoveAbove()​

clusterCategoryMoveAbove(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ClusterService.ts:206

Parameters​

variables​

ClusterCategoryMoveAboveVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

clusterCategoryMoveBelow()​

clusterCategoryMoveBelow(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ClusterService.ts:207

Parameters​

variables​

ClusterCategoryMoveBelowVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

clusterRemoveFromCategory()​

clusterRemoveFromCategory(variables): Promise<boolean>

Defined in: service/ClusterService.ts:208

Parameters​

variables​

ClusterRemoveFromCategoryVariables

Returns​

Promise<boolean>

clustersBulkAddToCategory()​

clustersBulkAddToCategory(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ClusterService.ts:212

Parameters​

variables​

ClustersBulkAddToCategoryVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

clustersBulkRemoveFromCategory()​

clustersBulkRemoveFromCategory(variables): Promise<boolean>

Defined in: service/ClusterService.ts:213

Parameters​

variables​

ClustersBulkRemoveFromCategoryVariables

Returns​

Promise<boolean>

clusterSetDefaultCategory()​

clusterSetDefaultCategory(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:209

Parameters​

variables​

ClusterSetDefaultCategoryVariables

Returns​

Promise<Cluster>

clusterUnassignProduct()​

clusterUnassignProduct(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:210

Parameters​

variables​

ClusterUnassignProductVariables

Returns​

Promise<Cluster>

createCluster()​

createCluster(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:193

Creates a new cluster

Parameters​

variables​

ClusterCreateVariables

Cluster creation variables

Returns​

Promise<Cluster>

deleteCluster()​

deleteCluster(variables): Promise<boolean>

Defined in: service/ClusterService.ts:203

Deletes a cluster

Parameters​

variables​

ClusterDeleteVariables

Cluster delete variables

Returns​

Promise<boolean>

getCluster()​

getCluster(variables, fetchOptions?): Promise<Cluster>

Defined in: service/ClusterService.ts:188

Fetches a single cluster by ID or slug

Parameters​

variables​

ClusterVariables

Variables for cluster query

fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Cluster>

getClusterConfig()​

getClusterConfig(clusterId, fetchOptions?): Promise<Cluster>

Defined in: service/ClusterService.ts:183

Retrieves a specific cluster configuration

Parameters​

clusterId​

number

Cluster ID to fetch

fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Cluster>

getClusters()​

getClusters(variables): Promise<ClustersResponse>

Defined in: service/ClusterService.ts:211

Parameters​

variables​

ClustersVariables

Returns​

Promise<ClustersResponse>

updateCluster()​

updateCluster(variables): Promise<Cluster>

Defined in: service/ClusterService.ts:198

Updates an existing cluster

Parameters​

variables​

ClusterUpdateVariables

Cluster update variables

Returns​

Promise<Cluster>