asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: add TSDoc for payment processor + generate docs (#5917)

Browse Source 
* added tsdocs for payment processor

* generated reference for payment processor
This commit is contained in:
Shahed Nasser
2023-12-18 14:02:18 +02:00
committed by GitHub
parent e63f4e6c7a
commit ddc6cc13a0
73 changed files with 34162 additions and 17470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

717
www/apps/docs/content/references/modules/medusa.mdx
View File

@@ -16,6 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [PriceListStatus](../medusa/enums/medusa.PriceListStatus-1.mdx)
- [PriceListType](../medusa/enums/medusa.PriceListType.mdx)
- [PriceListType](../medusa/enums/medusa.PriceListType-1.mdx)
- [ProductStatus](../medusa/enums/medusa.ProductStatus.mdx)
## Classes
@@ -87,7 +88,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [AdminGetProductTypesParams](../medusa/classes/medusa.AdminGetProductTypesParams.mdx)
- [AdminGetProductsParams](../medusa/classes/medusa.AdminGetProductsParams.mdx)
- [AdminGetProductsVariantsParams](../medusa/classes/medusa.AdminGetProductsVariantsParams.mdx)
- [AdminGetRegionsPaginationParams](../medusa/classes/medusa.AdminGetRegionsPaginationParams.mdx)
- [AdminGetRegionsParams](../medusa/classes/medusa.AdminGetRegionsParams.mdx)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../medusa/classes/medusa.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)
- [AdminGetReservationsParams](../medusa/classes/medusa.AdminGetReservationsParams.mdx)
@@ -333,6 +333,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [StoreGetProductsPaginationParams](../medusa/classes/medusa.StoreGetProductsPaginationParams.mdx)
- [StoreGetProductsParams](../medusa/classes/medusa.StoreGetProductsParams.mdx)
- [StoreGetRegionsParams](../medusa/classes/medusa.StoreGetRegionsParams.mdx)
- [StoreGetRegionsRegionParams](../medusa/classes/medusa.StoreGetRegionsRegionParams.mdx)
- [StoreGetShippingOptionsParams](../medusa/classes/medusa.StoreGetShippingOptionsParams.mdx)
- [StoreGetVariantsParams](../medusa/classes/medusa.StoreGetVariantsParams.mdx)
- [StoreGetVariantsVariantParams](../medusa/classes/medusa.StoreGetVariantsVariantParams.mdx)
@@ -383,8 +384,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [MedusaRequest](../medusa/interfaces/medusa.MedusaRequest.mdx)
- [PaginatedResponse](../medusa/interfaces/medusa.PaginatedResponse.mdx)
- [PaymentProcessor](../medusa/interfaces/medusa.PaymentProcessor.mdx)
- [PaymentProcessorContext](../medusa/interfaces/medusa.PaymentProcessorContext.mdx)
- [PaymentProcessorError](../medusa/interfaces/medusa.PaymentProcessorError.mdx)
- [PaymentProcessorSessionResponse](../medusa/interfaces/medusa.PaymentProcessorSessionResponse.mdx)
- [PaymentService](../medusa/interfaces/medusa.PaymentService.mdx)
- [ProductCategoryDTO](../medusa/interfaces/medusa.ProductCategoryDTO.mdx)
- [ProductCollectionDTO](../medusa/interfaces/medusa.ProductCollectionDTO.mdx)
- [ProductDTO](../medusa/interfaces/medusa.ProductDTO.mdx)
- [ProductImageDTO](../medusa/interfaces/medusa.ProductImageDTO.mdx)
- [ProductOptionDTO](../medusa/interfaces/medusa.ProductOptionDTO.mdx)
- [ProductOptionValueDTO](../medusa/interfaces/medusa.ProductOptionValueDTO.mdx)
- [ProductTagDTO](../medusa/interfaces/medusa.ProductTagDTO.mdx)
- [ProductTypeDTO](../medusa/interfaces/medusa.ProductTypeDTO.mdx)
- [ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)
- [RequestQueryFields](../medusa/interfaces/medusa.RequestQueryFields.mdx)
- [SubscriberContext](../medusa/interfaces/medusa.SubscriberContext.mdx)
@@ -538,6 +550,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [GetUploadedFileType](../medusa/types/medusa.GetUploadedFileType.mdx)
- [GiftCardAllocation](../medusa/types/medusa.GiftCardAllocation.mdx)
- [HttpCompressionOptions](../medusa/types/medusa.HttpCompressionOptions.mdx)
- [InnerSelector](../medusa/types/medusa.InnerSelector.mdx)
- [InternalModuleDeclaration](../medusa/types/medusa.InternalModuleDeclaration.mdx)
- [InventoryItemDTO](../medusa/types/medusa.InventoryItemDTO.mdx)
- [InventoryLevelDTO](../medusa/types/medusa.InventoryLevelDTO.mdx)
@@ -567,8 +580,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [PartialPick](../medusa/types/medusa.PartialPick.mdx)
- [PaymentContext](../medusa/types/medusa.PaymentContext.mdx)
- [PaymentData](../medusa/types/medusa.PaymentData.mdx)
- [PaymentProcessorContext](../medusa/types/medusa.PaymentProcessorContext.mdx)
- [PaymentProcessorSessionResponse](../medusa/types/medusa.PaymentProcessorSessionResponse.mdx)
- [PaymentSessionData](../medusa/types/medusa.PaymentSessionData.mdx)
- [PaymentSessionResponse](../medusa/types/medusa.PaymentSessionResponse.mdx)
- [PriceListLoadConfig](../medusa/types/medusa.PriceListLoadConfig.mdx)
@@ -1039,62 +1050,6 @@ ___
}
]
},
{
"name": "price_list_rules.price_list_rule_values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_list_rules.price_list_rule_values.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_rules.rule_type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_list_rules.rule_type.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amounts",
"type": "`object`",
@@ -1122,6 +1077,34 @@ ___
}
]
},
{
"name": "price_rules",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set",
"type": "`object`",
@@ -1142,120 +1125,6 @@ ___
]
}
]
},
{
"name": "price_set_money_amounts.money_amount",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set_money_amounts.money_amount.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amounts.price_set",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "variant_link",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "variant",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "price_set_money_amounts.price_set.variant_link",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "variant",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "defaultAdminProductRemoteQueryObject.variants.fields",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "price_set_money_amounts.price_set.variant_link.variant",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "defaultAdminProductRemoteQueryObject.variants.fields",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set_money_amounts.price_set.variant_link.variant.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "defaultAdminProductRemoteQueryObject.variants.fields",
"expandable": false,
"children": []
}
]} />
@@ -1307,15 +1176,6 @@ This is temporary.
}
]
},
{
"name": "categories.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "collection",
"type": "`object`",
@@ -1335,15 +1195,6 @@ This is temporary.
}
]
},
{
"name": "collection.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fields",
"type": "keyof [Product](../entities/classes/entities.Product.mdx)[]",
@@ -1372,15 +1223,6 @@ This is temporary.
}
]
},
{
"name": "images.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`object`",
@@ -1419,43 +1261,6 @@ This is temporary.
}
]
},
{
"name": "options.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options.values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "options.values.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "`object`",
@@ -1476,13 +1281,23 @@ This is temporary.
]
},
{
"name": "profile.fields",
"type": "`string`[]",
"name": "sales_channels",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tags",
@@ -1503,15 +1318,6 @@ This is temporary.
}
]
},
{
"name": "tags.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`object`",
@@ -1531,15 +1337,6 @@ This is temporary.
}
]
},
{
"name": "type.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "`object`",
@@ -1577,43 +1374,6 @@ This is temporary.
]
}
]
},
{
"name": "variants.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants.options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "variants.options.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
@@ -1922,15 +1682,6 @@ This is temporary.
}
]
},
{
"name": "collection.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fields",
"type": "keyof [Product](../entities/classes/entities.Product.mdx)[]",
@@ -1959,15 +1710,6 @@ This is temporary.
}
]
},
{
"name": "images.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`object`",
@@ -2006,43 +1748,6 @@ This is temporary.
}
]
},
{
"name": "options.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options.values",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "options.values.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profile",
"type": "`object`",
@@ -2063,13 +1768,23 @@ This is temporary.
]
},
{
"name": "profile.fields",
"type": "`string`[]",
"name": "sales_channels",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "tags",
@@ -2090,15 +1805,6 @@ This is temporary.
}
]
},
{
"name": "tags.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`object`",
@@ -2118,15 +1824,6 @@ This is temporary.
}
]
},
{
"name": "type.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants",
"type": "`object`",
@@ -2164,43 +1861,6 @@ This is temporary.
]
}
]
},
{
"name": "variants.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variants.options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "variants.options.fields",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
@@ -2242,6 +1902,18 @@ ___
___
### defaultStoreRegionFields
`Const` **defaultStoreRegionFields**: `string`[]
___
### defaultStoreRegionRelations
`Const` **defaultStoreRegionRelations**: `string`[]
___
### defaultStoreReturnReasonFields
`Const` **defaultStoreReturnReasonFields**: keyof [ReturnReason](../entities/classes/entities.ReturnReason.mdx)[]
@@ -7940,7 +7612,7 @@ Generate a composed id based on the input parameters and return either the is if
"name": "idProperty",
"type": "`string`",
"description": "",
"optional": false,
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
@@ -7972,66 +7644,6 @@ Generate a composed id based on the input parameters and return either the is if
___
### getProductWithIsolatedProductModule
#### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retrieveConfig",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### getRequestedBatchJob
#### Parameters
@@ -8092,6 +7704,86 @@ ___
___
### getVariantsFromPriceList
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "[MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "createScope",
"type": "() => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "registerAdd",
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ProductVariantDTO[]",
"type": "[ProductVariantDTO](../medusa/interfaces/medusa.ProductVariantDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "ProductVariantDTO",
"type": "`object`",
"description": "A product variant's data.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]} />
___
### hasChanges
Compare two objects and return true if there is changes detected from obj2 compared to obj1
@@ -8548,19 +8240,38 @@ ___
___
### listAndCountProductWithIsolatedProductModule
### listProducts
#### Parameters
<ParameterTypes parameters={[
{
"name": "req",
"type": "`any`",
"name": "container",
"type": "[MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
"children": [
{
"name": "createScope",
"type": "() => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "registerAdd",
"type": "`<T>`(`name`: `string`, `registration`: `T`) => [MedusaContainer](../medusa/types/medusa.MedusaContainer-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "filterableFields",
@@ -14277,6 +13988,66 @@ ___
___
### retrieveProduct
#### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "remoteQueryObject",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
}
]} />
___
### setMetadata
Dedicated method to set metadata.

84
www/apps/docs/content/references/modules/payment.mdx Normal file
View File

@@ -0,0 +1,84 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
# payment
## Classes
- [AbstractPaymentProcessor](../payment/classes/payment.AbstractPaymentProcessor.mdx)
## Interfaces
- [PaymentProcessor](../payment/interfaces/payment.PaymentProcessor.mdx)
- [PaymentProcessorContext](../payment/interfaces/payment.PaymentProcessorContext.mdx)
- [PaymentProcessorError](../payment/interfaces/payment.PaymentProcessorError.mdx)
- [PaymentProcessorSessionResponse](../payment/interfaces/payment.PaymentProcessorSessionResponse.mdx)
___
## Functions
### isPaymentProcessor
Return if the input object is AbstractPaymentProcessor
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### isPaymentProcessorError
Utility function to determine if an object is a processor error
#### Parameters
<ParameterTypes parameters={[
{
"name": "obj",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "obj",
"type": "obj is PaymentProcessorError",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />