Class: CGraphQLClient
frontend.CGraphQLClient
CGraphQLClient - CromwellCMS GraphQL API Client
Table of contents#
Properties#
- AttributeFragment
- CouponFragment
- CustomEntityFragment
- OrderFragment
- PagedMetaFragment
- PluginFragment
- PostFragment
- ProductCategoryFragment
- ProductFragment
- ProductReviewFragment
- TagFragment
- ThemeFragment
- UserFragment
- createAttribute
- createCoupon
- createCustomEntity
- createOrder
- createPost
- createProduct
- createProductCategory
- createProductReview
- createTag
- createUser
- deleteAttribute
- deleteCoupon
- deleteCustomEntity
- deleteManyCoupons
- deleteManyCustomEntities
- deleteManyFilteredCoupons
- deleteManyFilteredCustomEntities
- deleteManyFilteredOrders
- deleteManyFilteredPosts
- deleteManyFilteredProductCategories
- deleteManyFilteredProductReviews
- deleteManyFilteredProducts
- deleteManyFilteredTags
- deleteManyFilteredUsers
- deleteManyOrders
- deleteManyPosts
- deleteManyProductCategories
- deleteManyProductReviews
- deleteManyProducts
- deleteManyTags
- deleteManyUsers
- deleteOrder
- deletePost
- deleteProduct
- deleteProductCategory
- deleteProductReview
- deleteTag
- deleteUser
- getAttributeById
- getCouponById
- getCouponBySlug
- getCoupons
- getCustomEntities
- getCustomEntityById
- getCustomEntitySlug
- getFilteredCoupons
- getFilteredCustomEntities
- getFilteredOrders
- getFilteredPosts
- getFilteredProductCategories
- getFilteredProductReviews
- getFilteredTags
- getFilteredUsers
- getOrderById
- getOrderBySlug
- getOrders
- getPostById
- getPostBySlug
- getPosts
- getProductById
- getProductBySlug
- getProductCategories
- getProductCategoryById
- getProductCategoryBySlug
- getProductReviewById
- getProductReviews
- getProducts
- getTagById
- getTagBySlug
- getTags
- getUserById
- getUserBySlug
- getUsers
- updateAttribute
- updateCoupon
- updateCustomEntity
- updateOrder
- updatePost
- updateProduct
- updateProductCategory
- updateProductReview
- updateTag
- updateUser
Methods#
- createEntity
- getAllEntities
- getAttributes
- getCouponsByCodes
- getEntityById
- getFilteredEntities
- getFilteredProducts
- getOrdersOfUser
- getProductsFromCategory
- getRootCategories
- getUserByEmail
- mutate
- onError
- onUnauthorized
- query
- removeOnError
- removeOnUnauthorized
- updateEntity
Properties#
AttributeFragment#
• AttributeFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:794
CouponFragment#
• CouponFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1154
CustomEntityFragment#
• CustomEntityFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1122
OrderFragment#
• OrderFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:975
PagedMetaFragment#
• PagedMetaFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:269
PluginFragment#
• PluginFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1075
PostFragment#
• PostFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:866
ProductCategoryFragment#
• ProductCategoryFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:730
ProductFragment#
• ProductFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:597
ProductReviewFragment#
• ProductReviewFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:836
TagFragment#
• TagFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1043
ThemeFragment#
• ThemeFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1099
UserFragment#
• UserFragment: DocumentNode
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:919
createAttribute#
• createAttribute: (data: TAttributeInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TAttribute>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TAttribute>
Parameters#
| Name | Type |
|---|---|
data | TAttributeInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TAttribute>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:814
createCoupon#
• createCoupon: (data: TCouponInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TCoupon>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TCoupon>
Parameters#
| Name | Type |
|---|---|
data | TCouponInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TCoupon>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1183
createCustomEntity#
• createCustomEntity: (data: TCustomEntityInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TCustomEntity>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TCustomEntity>
Parameters#
| Name | Type |
|---|---|
data | TCustomEntityInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TCustomEntity>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1144
createOrder#
• createOrder: (data: TOrderInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TOrder>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TOrder>
Parameters#
| Name | Type |
|---|---|
data | TOrderInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TOrder>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1003
createPost#
• createPost: (data: TPostInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPost>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TPost>
Parameters#
| Name | Type |
|---|---|
data | TPostInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPost>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:904
createProduct#
• createProduct: (data: TProductInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProduct>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TProduct>
Parameters#
| Name | Type |
|---|---|
data | TProductInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProduct>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:653
createProductCategory#
• createProductCategory: (data: TProductCategoryInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProductCategory>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TProductCategory>
Parameters#
| Name | Type |
|---|---|
data | TProductCategoryInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProductCategory>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:760
createProductReview#
• createProductReview: (data: TProductReviewInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProductReview>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TProductReview>
Parameters#
| Name | Type |
|---|---|
data | TProductReviewInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProductReview>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:855
createTag#
• createTag: (data: TTagInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TTag>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TTag>
Parameters#
| Name | Type |
|---|---|
data | TTagInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TTag>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1067
createUser#
• createUser: (data: TCreateUser, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TUser>
Type declaration#
â–¸ (data, customFragment?, customFragmentName?): Promise<TUser>
Parameters#
| Name | Type |
|---|---|
data | TCreateUser |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TUser>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:945
deleteAttribute#
• deleteAttribute: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:815
deleteCoupon#
• deleteCoupon: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1184
deleteCustomEntity#
• deleteCustomEntity: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1145
deleteManyCoupons#
• deleteManyCoupons: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1185
deleteManyCustomEntities#
• deleteManyCustomEntities: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1146
deleteManyFilteredCoupons#
• deleteManyFilteredCoupons: (input: TDeleteManyInput, filterParams?: TBaseFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TBaseFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1186
deleteManyFilteredCustomEntities#
• deleteManyFilteredCustomEntities: (input: TDeleteManyInput, filterParams?: TCustomEntityFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TCustomEntityFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1147
deleteManyFilteredOrders#
• deleteManyFilteredOrders: (input: TDeleteManyInput, filterParams?: TOrderFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TOrderFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1006
deleteManyFilteredPosts#
• deleteManyFilteredPosts: (input: TDeleteManyInput, filterParams?: TPostFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TPostFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:907
deleteManyFilteredProductCategories#
• deleteManyFilteredProductCategories: (input: TDeleteManyInput, filterParams?: TProductCategoryFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TProductCategoryFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:763
deleteManyFilteredProductReviews#
• deleteManyFilteredProductReviews: (input: TDeleteManyInput, filterParams?: TProductReviewFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TProductReviewFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:858
deleteManyFilteredProducts#
• deleteManyFilteredProducts: (input: TDeleteManyInput, filterParams?: TProductFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TProductFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:656
deleteManyFilteredTags#
• deleteManyFilteredTags: (input: TDeleteManyInput, filterParams?: TBaseFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TBaseFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1070
deleteManyFilteredUsers#
• deleteManyFilteredUsers: (input: TDeleteManyInput, filterParams?: TUserFilter) => Promise<any>
Type declaration#
â–¸ (input, filterParams?): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
filterParams? | TUserFilter |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:948
deleteManyOrders#
• deleteManyOrders: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1005
deleteManyPosts#
• deleteManyPosts: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:906
deleteManyProductCategories#
• deleteManyProductCategories: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:762
deleteManyProductReviews#
• deleteManyProductReviews: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:857
deleteManyProducts#
• deleteManyProducts: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:655
deleteManyTags#
• deleteManyTags: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1069
deleteManyUsers#
• deleteManyUsers: (input: TDeleteManyInput) => Promise<any>
Type declaration#
â–¸ (input): Promise<any>
Parameters#
| Name | Type |
|---|---|
input | TDeleteManyInput |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:947
deleteOrder#
• deleteOrder: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1004
deletePost#
• deletePost: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:905
deleteProduct#
• deleteProduct: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:654
deleteProductCategory#
• deleteProductCategory: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:761
deleteProductReview#
• deleteProductReview: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:856
deleteTag#
• deleteTag: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1068
deleteUser#
• deleteUser: (id: number) => Promise<any>
Type declaration#
â–¸ (id): Promise<any>
Parameters#
| Name | Type |
|---|---|
id | number |
Returns#
Promise<any>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:946
getAttributeById#
• getAttributeById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TAttribute>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TAttribute>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TAttribute>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:812
getCouponById#
• getCouponById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TCoupon>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TCoupon>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TCoupon>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1179
getCouponBySlug#
• getCouponBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TCoupon>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TCoupon>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TCoupon>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1180
getCoupons#
• getCoupons: (pagedParams?: TPagedParams<TCoupon>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TCoupon>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TCoupon>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TCoupon> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TCoupon>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1178
getCustomEntities#
• getCustomEntities: (pagedParams?: TPagedParams<TCustomEntity>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TCustomEntity>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TCustomEntity>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TCustomEntity> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TCustomEntity>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1139
getCustomEntityById#
• getCustomEntityById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TCustomEntity>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TCustomEntity>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TCustomEntity>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1140
getCustomEntitySlug#
• getCustomEntitySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TCustomEntity>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TCustomEntity>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TCustomEntity>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1141
getFilteredCoupons#
• getFilteredCoupons: (options: TGetFilteredOptions<TCoupon, TBaseFilter>) => Promise<TPagedList<TCoupon>>
Type declaration#
â–¸ (options): Promise<TPagedList<TCoupon>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TCoupon, TBaseFilter> |
Returns#
Promise<TPagedList<TCoupon>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1181
getFilteredCustomEntities#
• getFilteredCustomEntities: (options: TGetFilteredOptions<TCustomEntity, TCustomEntityFilter>) => Promise<TPagedList<TCustomEntity>>
Type declaration#
â–¸ (options): Promise<TPagedList<TCustomEntity>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TCustomEntity, TCustomEntityFilter> |
Returns#
Promise<TPagedList<TCustomEntity>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1142
getFilteredOrders#
• getFilteredOrders: (options: TGetFilteredOptions<TOrder, TOrderFilter>) => Promise<TPagedList<TOrder>>
Type declaration#
â–¸ (options): Promise<TPagedList<TOrder>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TOrder, TOrderFilter> |
Returns#
Promise<TPagedList<TOrder>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1007
getFilteredPosts#
• getFilteredPosts: (options: TGetFilteredOptions<TPost, TPostFilter>) => Promise<TPagedList<TPost>>
Type declaration#
â–¸ (options): Promise<TPagedList<TPost>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TPost, TPostFilter> |
Returns#
Promise<TPagedList<TPost>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:908
getFilteredProductCategories#
• getFilteredProductCategories: (options: TGetFilteredOptions<TProductCategory, TProductCategoryFilter>) => Promise<TPagedList<TProductCategory>>
Type declaration#
â–¸ (options): Promise<TPagedList<TProductCategory>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TProductCategory, TProductCategoryFilter> |
Returns#
Promise<TPagedList<TProductCategory>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:764
getFilteredProductReviews#
• getFilteredProductReviews: (options: TGetFilteredOptions<TProductReview, TProductReviewFilter>) => Promise<TPagedList<TProductReview>>
Type declaration#
â–¸ (options): Promise<TPagedList<TProductReview>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TProductReview, TProductReviewFilter> |
Returns#
Promise<TPagedList<TProductReview>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:859
getFilteredTags#
• getFilteredTags: (options: TGetFilteredOptions<TTag, TBaseFilter>) => Promise<TPagedList<TTag>>
Type declaration#
â–¸ (options): Promise<TPagedList<TTag>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TTag, TBaseFilter> |
Returns#
Promise<TPagedList<TTag>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1065
getFilteredUsers#
• getFilteredUsers: (options: TGetFilteredOptions<TUser, TUserFilter>) => Promise<TPagedList<TUser>>
Type declaration#
â–¸ (options): Promise<TPagedList<TUser>>
Parameters#
| Name | Type |
|---|---|
options | TGetFilteredOptions<TUser, TUserFilter> |
Returns#
Promise<TPagedList<TUser>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:949
getOrderById#
• getOrderById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TOrder>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TOrder>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TOrder>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1000
getOrderBySlug#
• getOrderBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TOrder>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TOrder>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TOrder>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1001
getOrders#
• getOrders: (pagedParams?: TPagedParams<TOrder>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TOrder>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TOrder>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TOrder> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TOrder>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:999
getPostById#
• getPostById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TPost>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TPost>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TPost>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:901
getPostBySlug#
• getPostBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TPost>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TPost>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TPost>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:902
getPosts#
• getPosts: (pagedParams?: TPagedParams<TPost>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TPost>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TPost>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TPost> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TPost>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:900
getProductById#
• getProductById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TProduct>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TProduct>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TProduct>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:650
getProductBySlug#
• getProductBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TProduct>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TProduct>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TProduct>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:651
getProductCategories#
• getProductCategories: (pagedParams?: TPagedParams<TProductCategory>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TProductCategory>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TProductCategory>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TProductCategory> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TProductCategory>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:756
getProductCategoryById#
• getProductCategoryById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TProductCategory>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TProductCategory>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TProductCategory>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:757
getProductCategoryBySlug#
• getProductCategoryBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TProductCategory>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TProductCategory>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TProductCategory>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:758
getProductReviewById#
• getProductReviewById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TProductReview>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TProductReview>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TProductReview>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:853
getProductReviews#
• getProductReviews: (pagedParams?: TPagedParams<TProductReview>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TProductReview>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TProductReview>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TProductReview> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TProductReview>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:852
getProducts#
• getProducts: (pagedParams?: TPagedParams<TProduct>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TProduct>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TProduct>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TProduct> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TProduct>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:649
getTagById#
• getTagById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TTag>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TTag>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TTag>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1063
getTagBySlug#
• getTagBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TTag>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TTag>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TTag>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1064
getTags#
• getTags: (pagedParams?: TPagedParams<TTag>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TTag>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TTag>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TTag> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TTag>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1062
getUserById#
• getUserById: (id: number, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TUser>
Type declaration#
â–¸ (id, customFragment?, customFragmentName?): Promise<undefined | TUser>
Parameters#
| Name | Type |
|---|---|
id | number |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TUser>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:942
getUserBySlug#
• getUserBySlug: (slug: string, customFragment?: DocumentNode, customFragmentName?: string) => Promise<undefined | TUser>
Type declaration#
â–¸ (slug, customFragment?, customFragmentName?): Promise<undefined | TUser>
Parameters#
| Name | Type |
|---|---|
slug | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TUser>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:943
getUsers#
• getUsers: (pagedParams?: TPagedParams<TUser>, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPagedList<TUser>>
Type declaration#
â–¸ (pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TUser>>
Parameters#
| Name | Type |
|---|---|
pagedParams? | TPagedParams<TUser> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TUser>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:941
updateAttribute#
• updateAttribute: (id: number, data: TAttributeInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TAttribute>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TAttribute>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TAttributeInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TAttribute>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:813
updateCoupon#
• updateCoupon: (id: number, data: TCouponInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TCoupon>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TCoupon>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TCouponInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TCoupon>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1182
updateCustomEntity#
• updateCustomEntity: (id: number, data: TCustomEntityInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TCustomEntity>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TCustomEntity>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TCustomEntityInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TCustomEntity>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1143
updateOrder#
• updateOrder: (id: number, data: TOrderInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TOrder>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TOrder>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TOrderInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TOrder>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1002
updatePost#
• updatePost: (id: number, data: TPostInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TPost>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TPost>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TPostInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPost>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:903
updateProduct#
• updateProduct: (id: number, data: TProductInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProduct>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TProduct>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TProductInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProduct>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:652
updateProductCategory#
• updateProductCategory: (id: number, data: TProductCategoryInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProductCategory>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TProductCategory>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TProductCategoryInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProductCategory>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:759
updateProductReview#
• updateProductReview: (id: number, data: TProductReviewInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TProductReview>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TProductReview>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TProductReviewInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TProductReview>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:854
updateTag#
• updateTag: (id: number, data: TTagInput, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TTag>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TTag>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TTagInput |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TTag>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1066
updateUser#
• updateUser: (id: number, data: TUpdateUser, customFragment?: DocumentNode, customFragmentName?: string) => Promise<TUser>
Type declaration#
â–¸ (id, data, customFragment?, customFragmentName?): Promise<TUser>
Parameters#
| Name | Type |
|---|---|
id | number |
data | TUpdateUser |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TUser>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:944
Methods#
createEntity#
â–¸ createEntity<EntityType, EntityInputType>(entityName, entityInputName, fragment, fragmentName, data): Promise<undefined | EntityType>
Create a record by id of a generic entity
auth admin
Type parameters#
| Name |
|---|
EntityType |
EntityInputType |
Parameters#
| Name | Type |
|---|---|
entityName | string |
entityInputName | string |
fragment | DocumentNode |
fragmentName | string |
data | EntityInputType |
Returns#
Promise<undefined | EntityType>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:563
getAllEntities#
â–¸ getAllEntities<EntityType>(entityName, fragment, fragmentName): Promise<EntityType[]>
Get all records of a generic entity
auth admin
Type parameters#
| Name |
|---|
EntityType |
Parameters#
| Name | Type |
|---|---|
entityName | string |
fragment | DocumentNode |
fragmentName | string |
Returns#
Promise<EntityType[]>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:500
getAttributes#
â–¸ getAttributes(): Promise<undefined | TAttribute[]>
Returns#
Promise<undefined | TAttribute[]>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:817
getCouponsByCodes#
â–¸ getCouponsByCodes(codes, customFragment?, customFragmentName?): Promise<undefined | TCoupon[]>
Parameters#
| Name | Type |
|---|---|
codes | string[] |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TCoupon[]>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1188
getEntityById#
â–¸ getEntityById<EntityType>(entityName, fragment, fragmentName, entityId): Promise<undefined | EntityType>
Get a record by id of a generic entity
auth admin
Type parameters#
| Name |
|---|
EntityType |
Parameters#
| Name | Type |
|---|---|
entityName | string |
fragment | DocumentNode |
fragmentName | string |
entityId | number |
Returns#
Promise<undefined | EntityType>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:518
getFilteredEntities#
â–¸ getFilteredEntities<TEntity, TFilter>(entityName, fragment, fragmentName, options): Promise<TPagedList<TEntity>>
Get filtered records of a generic entity
auth admin
Type parameters#
| Name |
|---|
TEntity |
TFilter |
Parameters#
| Name | Type |
|---|---|
entityName | string |
fragment | DocumentNode |
fragmentName | string |
options | TGetFilteredOptions<TEntity, TFilter> |
Returns#
Promise<TPagedList<TEntity>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:585
getFilteredProducts#
â–¸ getFilteredProducts(__namedParameters): Promise<TFilteredProductList>
Parameters#
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.customFragment? | DocumentNode |
__namedParameters.customFragmentName? | string |
__namedParameters.filterParams? | TProductFilter |
__namedParameters.pagedParams? | TPagedParams<TProduct> |
Returns#
Promise<TFilteredProductList>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:687
getOrdersOfUser#
â–¸ getOrdersOfUser(userId, pagedParams, customFragment?, customFragmentName?): Promise<undefined | TPagedList<TOrder>>
Parameters#
| Name | Type |
|---|---|
userId | number |
pagedParams | TPagedParams<TOrder> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TPagedList<TOrder>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:1010
getProductsFromCategory#
â–¸ getProductsFromCategory(categoryId, pagedParams?, customFragment?, customFragmentName?): Promise<TPagedList<TProduct>>
Parameters#
| Name | Type |
|---|---|
categoryId | number |
pagedParams? | TPagedParams<TProduct> |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<TPagedList<TProduct>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:659
getRootCategories#
â–¸ getRootCategories(customFragment?, customFragmentName?): Promise<undefined | TPagedList<TProductCategory>>
Parameters#
| Name | Type |
|---|---|
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TPagedList<TProductCategory>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:766
getUserByEmail#
â–¸ getUserByEmail(email, customFragment?, customFragmentName?): Promise<undefined | TUser>
Parameters#
| Name | Type |
|---|---|
email | string |
customFragment? | DocumentNode |
customFragmentName? | string |
Returns#
Promise<undefined | TUser>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:951
mutate#
â–¸ mutate<T>(options, path): Promise<T>
Type parameters#
| Name | Type |
|---|---|
T | any |
Parameters#
| Name | Type |
|---|---|
options | MutationOptions<Object, OperationVariables> |
path | string |
Returns#
Promise<T>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:184
â–¸ mutate<T>(options): Promise<Promise<FetchResult<unknown, Record<string, any>, Record<string, any>>>>
Type parameters#
| Name | Type |
|---|---|
T | any |
Parameters#
| Name | Type |
|---|---|
options | MutationOptions<Object, OperationVariables> |
Returns#
Promise<Promise<FetchResult<unknown, Record<string, any>, Record<string, any>>>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:185
onError#
â–¸ onError(cb, id?): void
Add on error callback. Triggers if any of methods of this client get any type of error
Parameters#
| Name | Type |
|---|---|
cb | (message: TGraphQLErrorInfo) => any |
id? | string |
Returns#
void
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:257
onUnauthorized#
â–¸ onUnauthorized(callback, id?): void
Add on unauthorized error callback. Triggers if any of methods of this client get unauthorized error
Parameters#
| Name | Type |
|---|---|
callback | () => any |
id? | string |
Returns#
void
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:241
query#
â–¸ query<T>(options, path): Promise<T>
Type parameters#
| Name | Type |
|---|---|
T | any |
Parameters#
| Name | Type |
|---|---|
options | QueryOptions<OperationVariables, any> |
path | string |
Returns#
Promise<T>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:167
â–¸ query<T>(options): Promise<ApolloQueryResult<T>>
Type parameters#
| Name | Type |
|---|---|
T | any |
Parameters#
| Name | Type |
|---|---|
options | QueryOptions<OperationVariables, any> |
Returns#
Promise<ApolloQueryResult<T>>
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:168
removeOnError#
â–¸ removeOnError(id): void
Remove on error callback
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:265
removeOnUnauthorized#
â–¸ removeOnUnauthorized(id): void
Remove on unauthorized error callback
Parameters#
| Name | Type |
|---|---|
id | string |
Returns#
void
Defined in#
system/core/frontend/src/api/CGraphQLClient.ts:249
updateEntity#
â–¸ updateEntity<EntityType, EntityInputType>(entityName, entityInputName, fragment, fragmentName, entityId, data): Promise<undefined | EntityType>
Update a record of a generic entity
auth admin
Type parameters#
| Name |
|---|
EntityType |
EntityInputType |
Parameters#
| Name | Type |
|---|---|
entityName | string |
entityInputName | string |
fragment | DocumentNode |
fragmentName | string |
entityId | number |
data | EntityInputType |
Returns#
Promise<undefined | EntityType>