docs: fix tsdocs following typedoc update + 1.20 release (#6033)

* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting
This commit is contained in:
Shahed Nasser
2024-01-09 17:15:29 +02:00
committed by GitHub
parent 125879ada4
commit 18de90e603
32 changed files with 460 additions and 111 deletions
@@ -29,7 +29,6 @@ export interface IFileService extends TransactionBaseService {
/**
* upload file to fileservice from stream
* @param fileData file metadata relevant for fileservice to create and upload the file
* @param fileStream readable stream of the file to upload
* */
getUploadStreamDescriptor(
fileData: UploadStreamDescriptorType
@@ -390,12 +390,21 @@ export interface FulfillmentService extends TransactionBaseService {
): Promise<any>
}
/**
* @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction
*/
export abstract class AbstractFulfillmentService
extends TransactionBaseService
implements FulfillmentService
{
/**
* @ignore
*/
static _isFulfillmentService = true
/**
* @ignore
*/
static isFulfillmentService(object): boolean {
return object?.constructor?._isFulfillmentService
}
@@ -8,16 +8,23 @@ export interface IPriceSelectionStrategy extends ITransactionBaseService {
/**
* Calculate the original and discount price for a given variant in a set of
* circumstances described in the context.
* @param variantId The variant id of the variant for which to retrieve prices
* @param context Details relevant to determine the correct pricing of the variant
* @return pricing details in an object containing the calculated lowest price,
* the default price an all valid prices for the given variant
*/
calculateVariantPrice(
data: {
/**
* The variant id of the variant for which to retrieve prices
*/
variantId: string
/**
* The variant's quantity.
*/
quantity?: number
}[],
/**
* Details relevant to determine the correct pricing of the variant
*/
context: PriceSelectionContext
): Promise<Map<string, PriceSelectionResult>>