docs: update override price selection strategy documentation (#5438)

* docs: update override price selection strategy documentation

* fix eslint errors
This commit is contained in:
Shahed Nasser
2023-10-20 20:17:45 +03:00
committed by GitHub
parent 8bc902fb0f
commit 1a10822cae
540 changed files with 244366 additions and 18865 deletions
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\>
**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\>
#### Parameters
@@ -169,7 +169,7 @@ ___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
@@ -224,7 +224,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
Retrieves a given user
@@ -277,7 +277,7 @@ ___
### sendResetPasswordToken
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
**sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
#### Parameters
@@ -323,7 +323,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
@@ -10,31 +10,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCreateUserPayload
Ƭ **AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) }
**AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) }
___
### AdminUpdateUserPayload
Ƭ **AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) }
**AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) }
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
**CreateUserRoles**: \`${CreateUserRolesEnum}\`
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\>
**CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\>
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
**NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
@@ -53,10 +53,10 @@ ___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
**UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\>
**UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\>