02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action 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
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
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
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
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
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
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
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
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
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
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
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
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
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>