Files

Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174 )

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error

2023-09-21 20:57:15 +03:00

13 KiB

Raw Blame History

Class: AdminDiscountsResource

Hierarchy

default

↳ AdminDiscountsResource

Methods

addConditionResourceBatch

▸ addConditionResourceBatch(discountId, conditionId, payload, query?, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Add a batch of items to a discount condition

Parameters

Name	Type
`discountId`	`string`
`conditionId`	`string`
`payload`	`AdminPostDiscountsDiscountConditionsConditionBatchReq`
`query?`	`AdminPostDiscountsDiscountConditionsConditionBatchParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:218

addRegion

▸ addRegion(id, regionId, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Adds region to discount

Parameters

Name	Type
`id`	`string`
`regionId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:27

create

▸ create(payload, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Creates discounts

Parameters

Name	Type
`payload`	`AdminPostDiscountsReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:39

createCondition

▸ createCondition(discountId, payload, query?, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

creates a discount condition

Parameters

Name	Type
`discountId`	`string`
`payload`	`AdminPostDiscountsDiscountConditions`
`query`	`AdminPostDiscountsDiscountConditionsParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:148

createDynamicCode

▸ createDynamicCode(id, payload, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Creates a dynamic discount code

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostDiscountsDiscountDynamicCodesReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:62

delete

▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Description

Deletes a discount

Parameters

Name	Type
`id`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/discounts.ts:74

deleteCondition

▸ deleteCondition(discountId, conditionId, customHeaders?): ResponsePromise<DeleteResponse>

Description

Removes a condition from a discount

Parameters

Name	Type
`discountId`	`string`
`conditionId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/discounts.ts:187

deleteConditionResourceBatch

▸ deleteConditionResourceBatch(discountId, conditionId, payload, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Delete a batch of items from a discount condition

Parameters

Name	Type
`discountId`	`string`
`conditionId`	`string`
`payload`	`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:238

deleteDynamicCode

▸ deleteDynamicCode(id, code, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Deletes a dynamic discount

Parameters

Name	Type
`id`	`string`
`code`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:85

getCondition

▸ getCondition(discountId, conditionId, query?, customHeaders?): ResponsePromise<AdminDiscountConditionsRes>

Description

Gets a condition from a discount

Parameters

Name	Type
`discountId`	`string`
`conditionId`	`string`
`query?`	`AdminGetDiscountsDiscountConditionsConditionParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountConditionsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:199

list

▸ list(query?, customHeaders?): ResponsePromise<AdminDiscountsListRes>

Description

Lists discounts

Parameters

Name	Type
`query?`	`AdminGetDiscountsParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsListRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:119

removeRegion

▸ removeRegion(id, regionId, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Removes a region from a discount

Parameters

Name	Type
`id`	`string`
`regionId`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:136

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Retrieves a discount

Parameters

Name	Type
`id`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:97

retrieveByCode

▸ retrieveByCode(code, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Retrieves a discount by code

Parameters

Name	Type
`code`	`string`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:108

update

▸ update(id, payload, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Updates discount

Parameters

Name	Type
`id`	`string`
`payload`	`AdminPostDiscountsDiscountReq`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:50

updateCondition

▸ updateCondition(discountId, conditionId, payload, query?, customHeaders?): ResponsePromise<AdminDiscountsRes>

Description

Updates a discount condition

Parameters

Name	Type
`discountId`	`string`
`conditionId`	`string`
`payload`	`AdminPostDiscountsDiscountConditionsCondition`
`query`	`AdminPostDiscountsDiscountConditionsConditionParams`
`customHeaders`	`Record`<`string`, `any`>

Returns

ResponsePromise<AdminDiscountsRes>

Defined in

medusa-js/src/resources/admin/discounts.ts:167

13 KiB Raw Blame History

Class: AdminDiscountsResource

Hierarchy

Methods

addConditionResourceBatch

Parameters

Returns

Defined in

addRegion

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

createCondition

Parameters

Returns

Defined in

createDynamicCode

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

deleteCondition

Parameters

Returns

Defined in

deleteConditionResourceBatch

Parameters

Returns

Defined in

deleteDynamicCode

Parameters

Returns

Defined in

getCondition

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

removeRegion

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

retrieveByCode

Parameters

Returns

Defined in

update

Parameters

Returns

Defined in

updateCondition

Parameters

Returns

Defined in

13 KiB

Raw Blame History