3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
11 KiB
Class: AdminDiscountsResource
Hierarchy
-
default↳
AdminDiscountsResource
Methods
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
packages/medusa-js/src/resources/admin/discounts.ts:24
create
▸ create(payload, customHeaders?): ResponsePromise<AdminDiscountsRes>
description Creates discounts
Parameters
| Name | Type |
|---|---|
payload |
AdminPostDiscountsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDiscountsRes>
Defined in
packages/medusa-js/src/resources/admin/discounts.ts:36
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
packages/medusa-js/src/resources/admin/discounts.ts:145
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
packages/medusa-js/src/resources/admin/discounts.ts:59
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
description Deletes a discount
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Defined in
packages/medusa-js/src/resources/admin/discounts.ts:71
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
packages/medusa-js/src/resources/admin/discounts.ts:184
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
packages/medusa-js/src/resources/admin/discounts.ts:82
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
packages/medusa-js/src/resources/admin/discounts.ts:196
list
▸ list(query?, customHeaders?): ResponsePromise<AdminDiscountsListRes>
description Lists discounts
Parameters
| Name | Type |
|---|---|
query? |
AdminGetDiscountsParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDiscountsListRes>
Defined in
packages/medusa-js/src/resources/admin/discounts.ts:116
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
packages/medusa-js/src/resources/admin/discounts.ts:133
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminDiscountsRes>
description Retrieves a discount
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminDiscountsRes>
Defined in
packages/medusa-js/src/resources/admin/discounts.ts:94
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
packages/medusa-js/src/resources/admin/discounts.ts:105
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
packages/medusa-js/src/resources/admin/discounts.ts:47
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>