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

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-01-05 17:03:38 +02:00
1 parent 6fc6a9de6a
commit 7d650771d1
2811 files changed
+231856 -455063
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/services/classes/services.AnalyticsConfigService.mdx
+18 -297
View File
@@ -10,87 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "analyticsConfigRepository_",
"type": "Repository&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "userService_",
"type": "[UserService](services.UserService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"analyticsConfigRepository_","type":"Repository&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"userService_","type":"[UserService](services.UserService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -100,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -124,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -199,40 +58,11 @@ Creates an analytics config.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`CreateAnalyticsConfig`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`CreateAnalyticsConfig`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -242,31 +72,11 @@ Deletes an analytics config.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -274,31 +84,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -306,31 +96,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -340,40 +110,11 @@ Updates an analytics config. If the config does not exist, it will be created in
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateAnalyticsConfig`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateAnalyticsConfig`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -381,28 +122,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AnalyticsConfigService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"AnalyticsConfigService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.AuthService.mdx
+18 -306
View File
@@ -12,87 +12,13 @@ Can authenticate a user based on email password combination
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerService_",
"type": "[CustomerService](services.CustomerService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "userService_",
"type": "[UserService](services.UserService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerService_","type":"[CustomerService](services.CustomerService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../medusa/types/medusa.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"userService_","type":"[UserService](services.UserService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -102,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -126,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -202,40 +61,11 @@ scrypt to match password with hashed value.
#### Parameters
<ParameterTypes parameters={[
{
"name": "email",
"type": "`string`",
"description": "the email of the user",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "password",
"type": "`string`",
"description": "the password of the user",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"email","type":"`string`","description":"the email of the user","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"the password of the user","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;AuthenticateResult&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
@@ -245,31 +75,11 @@ Authenticates a given user with an API token
#### Parameters
<ParameterTypes parameters={[
{
"name": "token",
"type": "`string`",
"description": "the api\\_token of the user to authenticate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"token","type":"`string`","description":"the api\\_token of the user to authenticate","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;AuthenticateResult&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
@@ -280,40 +90,11 @@ scrypt to match password with hashed value.
#### Parameters
<ParameterTypes parameters={[
{
"name": "email",
"type": "`string`",
"description": "the email of the user",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "password",
"type": "`string`",
"description": "the password of the user",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"email","type":"`string`","description":"the email of the user","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"the password of the user","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;AuthenticateResult&#62;",
"optional": false,
"defaultValue": "",
"description": "success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;AuthenticateResult&#62;","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message","expandable":false,"children":[]}]} />
___
@@ -323,40 +104,11 @@ Verifies if a password is valid given the provided password hash
#### Parameters
<ParameterTypes parameters={[
{
"name": "password",
"type": "`string`",
"description": "the raw password to check",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "hash",
"type": "`string`",
"description": "the hash to compare against",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"password","type":"`string`","description":"the raw password to check","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hash","type":"`string`","description":"the hash to compare against","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the comparison",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;boolean&#62;","optional":false,"defaultValue":"","description":"the result of the comparison","expandable":false,"children":[]}]} />
___
@@ -364,31 +116,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -396,28 +128,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AuthService",
"type": "`object`",
"description": "Can authenticate a user based on email password combination",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"AuthService","type":"`object`","description":"Can authenticate a user based on email password combination","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.BatchJobService.mdx
+34 -608
View File
@@ -10,186 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "batchJobRepository_",
"type": "Repository&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "batchJobStatusMapToProps",
"type": "Map&#60;[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx), object&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "strategyResolver_",
"type": "[StrategyResolverService](services.StrategyResolverService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CANCELED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.canceled\"",
"expandable": false,
"children": []
},
{
"name": "Events.COMPLETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.completed\"",
"expandable": false,
"children": []
},
{
"name": "Events.CONFIRMED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.confirmed\"",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.FAILED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.failed\"",
"expandable": false,
"children": []
},
{
"name": "Events.PRE_PROCESSED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.pre_processed\"",
"expandable": false,
"children": []
},
{
"name": "Events.PROCESSING",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.processing\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"batch.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"batchJobRepository_","type":"Repository&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"batchJobStatusMapToProps","type":"Map&#60;[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"strategyResolver_","type":"[StrategyResolverService](services.StrategyResolverService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.canceled\"","expandable":false,"children":[]},{"name":"Events.COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.completed\"","expandable":false,"children":[]},{"name":"Events.CONFIRMED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.confirmed\"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.created\"","expandable":false,"children":[]},{"name":"Events.FAILED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.failed\"","expandable":false,"children":[]},{"name":"Events.PRE_PROCESSED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.pre_processed\"","expandable":false,"children":[]},{"name":"Events.PROCESSING","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.processing\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -199,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -223,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -296,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -328,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -360,31 +80,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -392,31 +92,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[BatchJobCreateProps](../../medusa/types/medusa.BatchJobCreateProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"[BatchJobCreateProps](../../medusa/types/medusa.BatchJobCreateProps.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -424,40 +104,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[FilterableBatchJobProps](../../medusa/classes/medusa.FilterableBatchJobProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[FilterableBatchJobProps](../../medusa/classes/medusa.FilterableBatchJobProps.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[BatchJob](../../entities/classes/entities.BatchJob.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[BatchJob](../../entities/classes/entities.BatchJob.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -465,40 +116,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "req",
"type": "Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -506,40 +128,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -547,40 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "error",
"type": "`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -588,31 +152,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -620,31 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -652,31 +176,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -684,40 +188,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "Partial&#60;Pick&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx), \"context\" \\| \"result\"&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;Pick&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx), \"context\" \\| \"result\"&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -725,40 +200,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "batchJobOrId",
"type": "`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -766,28 +212,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "BatchJobService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"BatchJobService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.CartService.mdx
+94 -1808
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.ClaimItemService.mdx
+18 -369
View File
@@ -10,150 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.claimImageRepository","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.claimItemRepository","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.claimTagRepository","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.eventBusService","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.lineItemService","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimImageRepository_",
"type": "Repository&#60;[ClaimImage](../../entities/classes/entities.ClaimImage.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimItemRepository_",
"type": "Repository&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimTagRepository_",
"type": "Repository&#60;[ClaimTag](../../entities/classes/entities.ClaimTag.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CANCELED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim_item.canceled\"",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim_item.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim_item.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimImageRepository_","type":"Repository&#60;[ClaimImage](../../entities/classes/entities.ClaimImage.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimItemRepository_","type":"Repository&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimTagRepository_","type":"Repository&#60;[ClaimTag](../../entities/classes/entities.ClaimTag.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim_item.canceled\"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim_item.created\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim_item.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -163,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -187,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -260,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateClaimItemInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateClaimItemInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -292,40 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","description":"the config object for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -335,40 +82,11 @@ Gets a claim item by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "claimItemId",
"type": "`string`",
"description": "id of ClaimItem to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"description": "configuration for the find operation",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"claimItemId","type":"`string`","description":"id of ClaimItem to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","description":"configuration for the find operation","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the ClaimItem",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the ClaimItem","expandable":false,"children":[]}]} />
___
@@ -376,31 +94,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -408,40 +106,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -449,28 +118,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ClaimItemService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ClaimItemService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ClaimService.mdx
+32 -739
View File
@@ -10,276 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "addressRepository_",
"type": "Repository&#60;[Address](../../entities/classes/entities.Address.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimItemService_",
"type": "[ClaimItemService](services.ClaimItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimRepository_",
"type": "Repository&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentProviderService_",
"type": "[FulfillmentProviderService](services.FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentService_",
"type": "[FulfillmentService](services.FulfillmentService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentProviderService_",
"type": "[PaymentProviderService](services.PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantInventoryService_",
"type": "[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnService_",
"type": "[ReturnService](services.ReturnService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingMethodRepository_",
"type": "Repository&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderService_",
"type": "[TaxProviderService](services.TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "totalsService_",
"type": "[TotalsService](services.TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CANCELED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.canceled\"",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.FULFILLMENT_CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.fulfillment_created\"",
"expandable": false,
"children": []
},
{
"name": "Events.REFUND_PROCESSED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.refund_processed\"",
"expandable": false,
"children": []
},
{
"name": "Events.SHIPMENT_CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.shipment_created\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"claim.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"addressRepository_","type":"Repository&#60;[Address](../../entities/classes/entities.Address.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimItemService_","type":"[ClaimItemService](services.ClaimItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimRepository_","type":"Repository&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentProviderService_","type":"[FulfillmentProviderService](services.FulfillmentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentService_","type":"[FulfillmentService](services.FulfillmentService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemRepository_","type":"Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentProviderService_","type":"[PaymentProviderService](services.PaymentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantInventoryService_","type":"[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionService_","type":"[RegionService](services.RegionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnService_","type":"[ReturnService](services.ReturnService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingMethodRepository_","type":"Repository&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingOptionService_","type":"[ShippingOptionService](services.ShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderService_","type":"[TaxProviderService](services.TaxProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsService_","type":"[TotalsService](services.TotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.canceled\"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.created\"","expandable":false,"children":[]},{"name":"Events.FULFILLMENT_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.fulfillment_created\"","expandable":false,"children":[]},{"name":"Events.REFUND_PROCESSED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.refund_processed\"","expandable":false,"children":[]},{"name":"Events.SHIPMENT_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.shipment_created\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"claim.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -289,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -313,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -386,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -418,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillmentId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fulfillmentId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -454,31 +84,11 @@ shipping address that the new items will be shipped to
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateClaimInput`",
"description": "the object containing all data required to create a claim",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateClaimInput`","description":"the object containing all data required to create a claim","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created claim",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"created claim","expandable":false,"children":[]}]} />
___
@@ -486,67 +96,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the object containing all data required to create a claim",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "config object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.location_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.metadata",
"type": "`Record<string, unknown>`",
"description": "config metadata",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.no_notification",
"type": "`boolean`",
"description": "config no notification",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the object containing all data required to create a claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"config object","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config.location_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"config.metadata","type":"`Record<string, unknown>`","description":"config metadata","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"config.no_notification","type":"`boolean`","description":"config no notification","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created claim",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"created claim","expandable":false,"children":[]}]} />
___
@@ -554,76 +108,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "trackingLinks",
"type": "`object`[]",
"description": "",
"optional": false,
"defaultValue": "[]",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.metadata",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config.no_notification",
"type": "`undefined`",
"description": "",
"optional": false,
"defaultValue": "undefined",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"trackingLinks","type":"`object`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config.metadata","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config.no_notification","type":"`undefined`","description":"","optional":false,"defaultValue":"undefined","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -638,40 +127,11 @@ Note, it will attempt to return early from each of these places to avoid having
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "[Order](../../entities/classes/entities.Order.mdx)",
"description": "the order to find claim lines on",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "claimItems",
"type": "`CreateClaimItemInput`[]",
"description": "the claim items to match against",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"the order to find claim lines on","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimItems","type":"`CreateClaimItemInput`[]","description":"the claim items to match against","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "the refund amount",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;number&#62;","optional":false,"defaultValue":"","description":"the refund amount","expandable":false,"children":[]}]} />
___
@@ -679,40 +139,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`any`",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"description": "the config object containing query settings",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`any`","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","description":"the config object containing query settings","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -720,31 +151,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -754,40 +165,11 @@ Gets an order by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "claimId",
"type": "`string`",
"description": "id of the claim order to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"description": "the config object containing query settings",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"claimId","type":"`string`","description":"id of the claim order to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","description":"the config object containing query settings","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the order document",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
___
@@ -795,31 +177,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -827,40 +189,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`UpdateClaimInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`UpdateClaimInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -868,31 +201,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateClaimInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateClaimInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -900,28 +213,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ClaimService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ClaimService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.CurrencyService.mdx
+16 -302
View File
@@ -10,114 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currencyRepository_",
"type": "Repository&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"currency.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currencyRepository_","type":"Repository&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"currency.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -127,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -151,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -227,40 +59,11 @@ currencies that match the query.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"description": "an object that defines rules to filter currencies\n by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"description": "object that defines the scope for what should be\n returned",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","description":"an object that defines rules to filter currencies\n by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","description":"object that defines the scope for what should be\n returned","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[Currency](../../entities/classes/entities.Currency.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "an array containing the currencies as\n the first element and the total count of products that matches the query\n as the second element.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Currency](../../entities/classes/entities.Currency.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"an array containing the currencies as\n the first element and the total count of products that matches the query\n as the second element.","expandable":false,"children":[]}]} />
___
@@ -270,31 +73,11 @@ Return the currency
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "The code of the currency that must be retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency that must be retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The currency",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","optional":false,"defaultValue":"","description":"The currency","expandable":false,"children":[]}]} />
___
@@ -302,31 +85,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -336,40 +99,11 @@ Update a currency
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "The code of the currency to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`UpdateCurrencyInput`",
"description": "The data that must be updated on the currency",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`UpdateCurrencyInput`","description":"The data that must be updated on the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| [Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The updated currency",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [Currency](../../entities/classes/entities.Currency.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated currency","expandable":false,"children":[]}]} />
___
@@ -377,28 +111,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "CurrencyService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"CurrencyService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.CustomShippingOptionService.mdx
+17 -286
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customShippingOptionRepository_",
"type": "Repository&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customShippingOptionRepository_","type":"Repository&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -190,54 +58,15 @@ Creates a custom shipping option
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`T`",
"description": "the custom shipping option to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`T`","description":"the custom shipping option to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the creation result",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"resolves to the creation result","expandable":false,"children":[]}]} />
___
@@ -247,40 +76,11 @@ Fetches all custom shipping options based on the given selector
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;","description":"the configuration used to find the objects. contains relations, skip, and take.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "custom shipping options matching the query",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)[]&#62;","optional":false,"defaultValue":"","description":"custom shipping options matching the query","expandable":false,"children":[]}]} />
___
@@ -290,40 +90,11 @@ Retrieves a specific shipping option.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the custom shipping option to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;",
"description": "any options needed to query for the result.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the custom shipping option to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;","description":"any options needed to query for the result.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the requested custom shipping option.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the requested custom shipping option.","expandable":false,"children":[]}]} />
___
@@ -331,31 +102,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -363,28 +114,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "CustomShippingOptionService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"CustomShippingOptionService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.CustomerGroupService.mdx
+28 -461
View File
@@ -10,87 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`CustomerGroupConstructorProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`CustomerGroupConstructorProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerGroupRepository_",
"type": "Repository&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerService_",
"type": "[CustomerService](services.CustomerService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerGroupRepository_","type":"Repository&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerService_","type":"[CustomerService](services.CustomerService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -100,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -122,40 +38,11 @@ Add a batch of customers to a customer group at once
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the customer group to add customers to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerIds",
"type": "`string` \\| `string`[]",
"description": "customer id's to add to the group",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the customer group to add customers to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerIds","type":"`string` \\| `string`[]","description":"customer id's to add to the group","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the customer group after insertion",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","optional":false,"defaultValue":"","description":"the customer group after insertion","expandable":false,"children":[]}]} />
___
@@ -167,72 +54,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -242,31 +72,11 @@ Creates a customer group with the provided data.
#### Parameters
<ParameterTypes parameters={[
{
"name": "group",
"type": "DeepPartial&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"description": "the customer group to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"group","type":"DeepPartial&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","description":"the customer group to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
___
@@ -276,31 +86,11 @@ Remove customer group
#### Parameters
<ParameterTypes parameters={[
{
"name": "groupId",
"type": "`string`",
"description": "id of the customer group to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"groupId","type":"`string`","description":"id of the customer group to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "a promise",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"a promise","expandable":false,"children":[]}]} />
___
@@ -308,49 +98,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "ids",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "error",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;never&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;never&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -360,40 +112,11 @@ List customer groups.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62; & `object`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.discount_condition_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -403,40 +126,11 @@ Retrieve a list of customer groups and total count of records that match the que
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62; & `object`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.discount_condition_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -446,40 +140,11 @@ Remove list of customers from a customergroup
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the customer group from which the customers are removed",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerIds",
"type": "`string` \\| `string`[]",
"description": "id's of the customer to remove from group",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the customer group from which the customers are removed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerIds","type":"`string` \\| `string`[]","description":"id's of the customer to remove from group","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the customergroup with the provided id",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","optional":false,"defaultValue":"","description":"the customergroup with the provided id","expandable":false,"children":[]}]} />
___
@@ -487,40 +152,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "customerGroupId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"customerGroupId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -528,31 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -562,40 +178,11 @@ Update a customer group.
#### Parameters
<ParameterTypes parameters={[
{
"name": "customerGroupId",
"type": "`string`",
"description": "id of the customer group",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`CustomerGroupUpdate`",
"description": "customer group partial data",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"customerGroupId","type":"`string`","description":"id of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`CustomerGroupUpdate`","description":"customer group partial data","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resulting customer group",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)&#62;","optional":false,"defaultValue":"","description":"resulting customer group","expandable":false,"children":[]}]} />
___
@@ -603,28 +190,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "CustomerGroupService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"CustomerGroupService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.CustomerService.mdx
+47 -778
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.DiscountConditionService.mdx
+20 -319
View File
@@ -14,87 +14,13 @@ Provides layer to manipulate discount conditions.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountConditionRepository_",
"type": "Repository&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountConditionRepository_","type":"Repository&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -104,17 +30,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -128,72 +44,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -201,31 +60,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "discountConditionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"discountConditionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -233,31 +72,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "Omit&#60;DiscountConditionInput, \"id\"&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"Omit&#60;DiscountConditionInput, \"id\"&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -265,40 +84,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "conditionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"conditionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -306,31 +96,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -338,40 +108,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`DiscountConditionInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "overrideExisting",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`DiscountConditionInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"overrideExisting","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([DiscountConditionProduct](../../entities/classes/entities.DiscountConditionProduct.mdx) \\| [DiscountConditionProductType](../../entities/classes/entities.DiscountConditionProductType.mdx) \\| [DiscountConditionProductCollection](../../entities/classes/entities.DiscountConditionProductCollection.mdx) \\| [DiscountConditionProductTag](../../entities/classes/entities.DiscountConditionProductTag.mdx) \\| [DiscountConditionCustomerGroup](../../entities/classes/entities.DiscountConditionCustomerGroup.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;([DiscountConditionProduct](../../entities/classes/entities.DiscountConditionProduct.mdx) \\| [DiscountConditionProductType](../../entities/classes/entities.DiscountConditionProductType.mdx) \\| [DiscountConditionProductCollection](../../entities/classes/entities.DiscountConditionProductCollection.mdx) \\| [DiscountConditionProductTag](../../entities/classes/entities.DiscountConditionProductTag.mdx) \\| [DiscountConditionCustomerGroup](../../entities/classes/entities.DiscountConditionCustomerGroup.mdx))[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -379,31 +120,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "DiscountConditionService",
"type": "`object`",
"description": "Provides layer to manipulate discount conditions.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"DiscountConditionService","type":"`object`","description":"Provides layer to manipulate discount conditions.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -411,28 +132,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`DiscountConditionInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`DiscountConditionInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "undefined \\| object",
"type": "`undefined` \\| `object`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"undefined \\| object","type":"`undefined` \\| `object`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.DiscountService.mdx
+57 -942
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.DraftOrderService.mdx
+26 -520
View File
@@ -14,177 +14,13 @@ Handles draft orders
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartService_",
"type": "[CartService](services.CartService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customShippingOptionService_",
"type": "[CustomShippingOptionService](services.CustomShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "draftOrderRepository_",
"type": "Repository&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "orderRepository_",
"type": "Repository&#60;[Order](../../entities/classes/entities.Order.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentRepository_",
"type": "Repository&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"draft_order.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"draft_order.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cartService_","type":"[CartService](services.CartService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customShippingOptionService_","type":"[CustomShippingOptionService](services.CustomShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draftOrderRepository_","type":"Repository&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderRepository_","type":"Repository&#60;[Order](../../entities/classes/entities.Order.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentRepository_","type":"Repository&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantService_","type":"[ProductVariantService](services.ProductVariantService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingOptionService_","type":"[ShippingOptionService](services.ShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"draft_order.created\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"draft_order.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -194,17 +30,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -218,72 +44,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -293,31 +62,11 @@ Creates a draft order.
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`DraftOrderCreateProps`",
"description": "data to create draft order from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`DraftOrderCreateProps`","description":"data to create draft order from","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created draft order",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"the created draft order","expandable":false,"children":[]}]} />
___
@@ -327,31 +76,11 @@ Deletes draft order idempotently.
#### Parameters
<ParameterTypes parameters={[
{
"name": "draftOrderId",
"type": "`string`",
"description": "id of draft order to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"draftOrderId","type":"`string`","description":"id of draft order to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| [DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "empty promise",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
___
@@ -361,40 +90,11 @@ Lists draft orders
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`any`",
"description": "query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"description": "configurable attributes for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`any`","description":"query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","description":"configurable attributes for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "list of draft orders",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[]&#62;","optional":false,"defaultValue":"","description":"list of draft orders","expandable":false,"children":[]}]} />
___
@@ -404,40 +104,11 @@ Lists draft orders alongside the count
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`any`",
"description": "query selector to filter draft orders",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"description": "query config",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`any`","description":"query selector to filter draft orders","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","description":"query config","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "draft orders",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"draft orders","expandable":false,"children":[]}]} />
___
@@ -447,40 +118,11 @@ Registers a draft order as completed, when an order has been completed.
#### Parameters
<ParameterTypes parameters={[
{
"name": "draftOrderId",
"type": "`string`",
"description": "id of draft order to complete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "orderId",
"type": "`string`",
"description": "id of order completed from draft order cart",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"draftOrderId","type":"`string`","description":"id of draft order to complete","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderId","type":"`string`","description":"id of order completed from draft order cart","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;UpdateResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the created order",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;UpdateResult&#62;","optional":false,"defaultValue":"","description":"the created order","expandable":false,"children":[]}]} />
___
@@ -490,40 +132,11 @@ Retrieves a draft order with the given id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "draftOrderId",
"type": "`string`",
"description": "id of the draft order to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"description": "query object for findOne",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"draftOrderId","type":"`string`","description":"id of the draft order to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","description":"query object for findOne","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the draft order",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"the draft order","expandable":false,"children":[]}]} />
___
@@ -533,40 +146,11 @@ Retrieves a draft order based on its associated cart id
#### Parameters
<ParameterTypes parameters={[
{
"name": "cartId",
"type": "`string`",
"description": "cart id that the draft orders's cart has",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"description": "query object for findOne",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cartId","type":"`string`","description":"cart id that the draft orders's cart has","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","description":"query object for findOne","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the draft order",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"the draft order","expandable":false,"children":[]}]} />
___
@@ -574,31 +158,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -608,49 +172,11 @@ Updates a draft order with the given data
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the draft order",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`object`",
"description": "values to update the order with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data.no_notification_order",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the draft order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`object`","description":"values to update the order with","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data.no_notification_order","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated draft order",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated draft order","expandable":false,"children":[]}]} />
___
@@ -658,28 +184,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "DraftOrderService",
"type": "`object`",
"description": "Handles draft orders",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"DraftOrderService","type":"`object`","description":"Handles draft orders","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.EventBusService.mdx
+26 -466
View File
@@ -13,132 +13,13 @@ subscribers when events happen. Events will run asynchronously.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isSingleton",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isSingleton","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config_",
"type": "[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "enqueue_",
"type": "Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "logger_",
"type": "[Logger](../../medusa/types/medusa.Logger.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shouldEnqueuerRun",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stagedJobService_",
"type": "[StagedJobService](services.StagedJobService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config_","type":"[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enqueue_","type":"Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../medusa/types/medusa.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldEnqueuerRun","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stagedJobService_","type":"[StagedJobService](services.StagedJobService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -148,17 +29,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -166,17 +37,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "IEventBusModuleService",
"type": "`IEventBusModuleService`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"IEventBusModuleService","type":"`IEventBusModuleService`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -190,72 +51,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -267,45 +71,15 @@ Calls all subscribers when an event occurs.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "EmitData&#60;T&#62;[]",
"description": "The data to use to process the events",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"EmitData&#60;T&#62;[]","description":"The data to use to process the events","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the jobs from our queue",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the jobs from our queue","expandable":false,"children":[]}]} />
`**emit**<TypeParameter T>(eventName, data, options?): Promise&#60;void \| [StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;`
@@ -313,63 +87,15 @@ Calls all subscribers when an event occurs.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "eventName",
"type": "`string`",
"description": "the name of the event to be process.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`T`",
"description": "the data to send to the subscriber.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`Record<string, unknown>`",
"description": "options to add the job with",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"eventName","type":"`string`","description":"the name of the event to be process.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`T`","description":"the data to send to the subscriber.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"options to add the job with","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the job from our queue",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;","optional":false,"defaultValue":"","description":"the job from our queue","expandable":false,"children":[]}]} />
___
@@ -377,17 +103,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -395,31 +111,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "listConfig",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"listConfig","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;never[] \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;never[] \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -427,31 +123,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -459,17 +135,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -477,17 +143,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -497,49 +153,11 @@ Adds a function to a list of event subscribers.
#### Parameters
<ParameterTypes parameters={[
{
"name": "event",
"type": "`string` \\| `symbol`",
"description": "the event that the subscriber will listen for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subscriber",
"type": "Subscriber&#60;unknown&#62;",
"description": "the function to be called when a certain event\nhappens. Subscribers must return a Promise.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "[SubscriberContext](../../medusa/interfaces/medusa.SubscriberContext.mdx)",
"description": "subscriber context",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"event","type":"`string` \\| `symbol`","description":"the event that the subscriber will listen for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subscriber","type":"Subscriber&#60;unknown&#62;","description":"the function to be called when a certain event\nhappens. Subscribers must return a Promise.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[SubscriberContext](../../medusa/interfaces/medusa.SubscriberContext.mdx)","description":"subscriber context","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "EventBusService",
"type": "`object`",
"description": "Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EventBusService","type":"`object`","description":"Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -549,49 +167,11 @@ Removes function from the list of event subscribers.
#### Parameters
<ParameterTypes parameters={[
{
"name": "event",
"type": "`string` \\| `symbol`",
"description": "the event of the subcriber.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subscriber",
"type": "Subscriber&#60;unknown&#62;",
"description": "the function to be removed",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "[SubscriberContext](../../medusa/interfaces/medusa.SubscriberContext.mdx)",
"description": "subscriber context",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"event","type":"`string` \\| `symbol`","description":"the event of the subcriber.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subscriber","type":"Subscriber&#60;unknown&#62;","description":"the function to be removed","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[SubscriberContext](../../medusa/interfaces/medusa.SubscriberContext.mdx)","description":"subscriber context","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "EventBusService",
"type": "`object`",
"description": "Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EventBusService","type":"`object`","description":"Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -599,28 +179,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "EventBusService",
"type": "`object`",
"description": "Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EventBusService","type":"`object`","description":"Can keep track of multiple subscribers to different events and run the\nsubscribers when events happen. Events will run asynchronously.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.FulfillmentProviderService.mdx
+33 -525
View File
@@ -12,87 +12,13 @@ Helps retrieve fulfillment providers
### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "`FulfillmentProviderContainer`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"container","type":"`FulfillmentProviderContainer`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "container_",
"type": "`FulfillmentProviderContainer`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentProviderRepository_",
"type": "Repository&#60;[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container_","type":"`FulfillmentProviderContainer`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentProviderRepository_","type":"Repository&#60;[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -102,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -126,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -199,49 +58,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Order](../../entities/classes/entities.Order.mdx) \\| [Cart](../../entities/classes/entities.Cart.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Order](../../entities/classes/entities.Order.mdx) \\| [Cart](../../entities/classes/entities.Cart.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;number&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -249,31 +70,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "`CalculateOptionPriceInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"`CalculateOptionPriceInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;boolean&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -281,31 +82,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillment",
"type": "[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fulfillment","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -313,58 +94,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "method",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "order",
"type": "`CreateFulfillmentOrder`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillment",
"type": "Omit&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx), \"beforeInsert\"&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"method","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`CreateFulfillmentOrder`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"Omit&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx), \"beforeInsert\"&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -372,31 +106,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnOrder",
"type": "[CreateReturnType](../../medusa/types/medusa.CreateReturnType.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnOrder","type":"[CreateReturnType](../../medusa/types/medusa.CreateReturnType.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -404,17 +118,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -422,31 +126,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "providerIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providerIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;FulfillmentOptions[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;FulfillmentOptions[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -454,31 +138,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "providers",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providers","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -488,49 +152,11 @@ Fetches documents from the fulfillment provider
#### Parameters
<ParameterTypes parameters={[
{
"name": "providerId",
"type": "`string`",
"description": "the id of the provider",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentData",
"type": "`Record<string, unknown>`",
"description": "the data relating to the fulfillment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "documentType",
"type": "`\"label\"` \\| `\"invoice\"`",
"description": "the typ of",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providerId","type":"`string`","description":"the id of the provider","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentData","type":"`Record<string, unknown>`","description":"the data relating to the fulfillment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"documentType","type":"`\"label\"` \\| `\"invoice\"`","description":"the typ of","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "document to fetch",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;any&#62;","optional":false,"defaultValue":"","description":"document to fetch","expandable":false,"children":[]}]} />
___
@@ -538,31 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "providerId",
"type": "`string`",
"description": "the provider id",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providerId","type":"`string`","description":"the provider id","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "any",
"type": "`any`",
"optional": true,
"defaultValue": "",
"description": "the payment fulfillment provider",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"the payment fulfillment provider","expandable":false,"children":[]}]} />
___
@@ -570,31 +176,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -602,49 +188,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "`Record<string, unknown>` \\| [Cart](../../entities/classes/entities.Cart.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"`Record<string, unknown>` \\| [Cart](../../entities/classes/entities.Cart.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -652,31 +200,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;boolean&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;boolean&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -684,28 +212,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "FulfillmentProviderService",
"type": "`object`",
"description": "Helps retrieve fulfillment providers",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"FulfillmentProviderService","type":"`object`","description":"Helps retrieve fulfillment providers","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.FulfillmentService.mdx
+24 -471
View File
@@ -12,141 +12,13 @@ Handles Fulfillments
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentProviderService_",
"type": "[FulfillmentProviderService](services.FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentRepository_",
"type": "Repository&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantInventoryService_",
"type": "[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingProfileService_",
"type": "[ShippingProfileService](services.ShippingProfileService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "totalsService_",
"type": "[TotalsService](services.TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "trackingLinkRepository_",
"type": "Repository&#60;[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentProviderService_","type":"[FulfillmentProviderService](services.FulfillmentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentRepository_","type":"Repository&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemRepository_","type":"Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantInventoryService_","type":"[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingProfileService_","type":"[ShippingProfileService](services.ShippingProfileService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsService_","type":"[TotalsService](services.TotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"trackingLinkRepository_","type":"Repository&#60;[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -156,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -180,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -257,31 +62,11 @@ Throws if the fulfillment has already been shipped.
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillmentOrId",
"type": "`string` \\| [Fulfillment](../../entities/classes/entities.Fulfillment.mdx)",
"description": "the fulfillment object or id.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fulfillmentOrId","type":"`string` \\| [Fulfillment](../../entities/classes/entities.Fulfillment.mdx)","description":"the fulfillment object or id.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the save operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the save operation","expandable":false,"children":[]}]} />
___
@@ -294,49 +79,11 @@ those partitions.
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "`CreateFulfillmentOrder`",
"description": "order to create fulfillment for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "itemsToFulfill",
"type": "`FulFillmentItemType`[]",
"description": "the items in the order to fulfill",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "custom",
"type": "Partial&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"description": "potential custom values to add",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"order","type":"`CreateFulfillmentOrder`","description":"order to create fulfillment for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"itemsToFulfill","type":"`FulFillmentItemType`[]","description":"the items in the order to fulfill","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom","type":"Partial&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"potential custom values to add","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the created fulfillments",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the created fulfillments","expandable":false,"children":[]}]} />
___
@@ -347,49 +94,11 @@ tracking links and potentially more metadata.
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillmentId",
"type": "`string`",
"description": "the fulfillment to ship",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "trackingLinks",
"type": "`object`[]",
"description": "tracking links for the shipment",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`CreateShipmentConfig`",
"description": "potential configuration settings, such as no\\_notification and metadata",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fulfillmentId","type":"`string`","description":"the fulfillment to ship","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`CreateShipmentConfig`","description":"potential configuration settings, such as no\\_notification and metadata","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"trackingLinks","type":"`object`[]","description":"tracking links for the shipment","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipped fulfillment",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the shipped fulfillment","expandable":false,"children":[]}]} />
___
@@ -399,40 +108,11 @@ Retrieves the order line items, given an array of items.
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "`CreateFulfillmentOrder`",
"description": "the order to get line items from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "`FulFillmentItemType`[]",
"description": "the items to get",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"order","type":"`CreateFulfillmentOrder`","description":"the order to get line items from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`FulFillmentItemType`[]","description":"the items to get","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;(null \\| [LineItem](../../entities/classes/entities.LineItem.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the line items generated by the transformer.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;(null \\| [LineItem](../../entities/classes/entities.LineItem.mdx))[]&#62;","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]} />
___
@@ -440,40 +120,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethods",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"shippingMethods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "FulfillmentItemPartition[]",
"type": "`FulfillmentItemPartition`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"FulfillmentItemPartition[]","type":"`FulfillmentItemPartition`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -483,40 +134,11 @@ Retrieves a fulfillment by its id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "fulfillmentId",
"type": "`string`",
"description": "the id of the fulfillment to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"description": "optional values to include with fulfillmentRepository query",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fulfillmentId","type":"`string`","description":"the id of the fulfillment to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"optional values to include with fulfillmentRepository query","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the fulfillment",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the fulfillment","expandable":false,"children":[]}]} />
___
@@ -524,31 +146,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -561,40 +163,11 @@ quantity from the quantity that was originally purchased.
#### Parameters
<ParameterTypes parameters={[
{
"name": "item",
"type": "`undefined` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)",
"description": "the line item to check has sufficient fulfillable\n quantity.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "the quantity that is requested to be fulfilled.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"item","type":"`undefined` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item to check has sufficient fulfillable\n quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"the quantity that is requested to be fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "null \\| LineItem",
"type": "`null` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)",
"optional": true,
"defaultValue": "",
"description": "a line item that has the requested fulfillment quantity\n set.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"null \\| LineItem","type":"`null` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","optional":false,"defaultValue":"","description":"a line item that has the requested fulfillment quantity\n set.","expandable":false,"children":[]}]} />
___
@@ -602,28 +175,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "FulfillmentService",
"type": "`object`",
"description": "Handles Fulfillments",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"FulfillmentService","type":"`object`","description":"Handles Fulfillments","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.GiftCardService.mdx
+31 -521
View File
@@ -12,123 +12,13 @@ Provides layer to manipulate gift cards.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "giftCardRepository_",
"type": "Repository&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "giftCardTransactionRepo_",
"type": "Repository&#60;[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"gift_card.created\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"giftCardRepository_","type":"Repository&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"giftCardTransactionRepo_","type":"Repository&#60;[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionService_","type":"[RegionService](services.RegionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"gift_card.created\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -138,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -162,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -237,31 +60,11 @@ Creates a gift card with provided data given that the data is validated.
#### Parameters
<ParameterTypes parameters={[
{
"name": "giftCard",
"type": "`CreateGiftCardInput`",
"description": "the gift card data to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"giftCard","type":"`CreateGiftCardInput`","description":"the gift card data to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
___
@@ -269,31 +72,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateGiftCardTransactionInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateGiftCardTransactionInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -303,31 +86,11 @@ Deletes a gift card idempotently
#### Parameters
<ParameterTypes parameters={[
{
"name": "giftCardId",
"type": "`string`",
"description": "id of gift card to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"giftCardId","type":"`string`","description":"id of gift card to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
@@ -335,40 +98,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"the configuration used to find the objects. contains relations, skip, and take.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -376,40 +110,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"the configuration used to find the objects. contains relations, skip, and take.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[GiftCard](../../entities/classes/entities.GiftCard.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[GiftCard](../../entities/classes/entities.GiftCard.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -419,40 +124,11 @@ Gets a gift card by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "giftCardId",
"type": "`string`",
"description": "id of gift card to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "optional values to include with gift card query",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"giftCardId","type":"`string`","description":"id of gift card to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"optional values to include with gift card query","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the gift card",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the gift card","expandable":false,"children":[]}]} />
___
@@ -460,40 +136,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -501,40 +148,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -542,31 +160,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -576,40 +174,11 @@ Updates a giftCard.
#### Parameters
<ParameterTypes parameters={[
{
"name": "giftCardId",
"type": "`string`",
"description": "giftCard id of giftCard to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateGiftCardInput`",
"description": "the data to update the giftCard with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"giftCardId","type":"`string`","description":"giftCard id of giftCard to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateGiftCardInput`","description":"the data to update the giftCard with","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[GiftCard](../../entities/classes/entities.GiftCard.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
___
@@ -617,31 +186,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "GiftCardService",
"type": "`object`",
"description": "Provides layer to manipulate gift cards.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"GiftCardService","type":"`object`","description":"Provides layer to manipulate gift cards.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -651,17 +200,7 @@ Generates a 16 character gift card code
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "the generated gift card code",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"the generated gift card code","expandable":false,"children":[]}]} />
___
@@ -672,37 +211,8 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang
#### Parameters
<ParameterTypes parameters={[
{
"name": "giftCardTaxRate",
"type": "`null` \\| `number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "[Region](../../entities/classes/entities.Region.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"giftCardTaxRate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "null \\| number",
"type": "`null` \\| `number`",
"optional": true,
"defaultValue": "",
"description": "the tax rate for the gift card",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"null \\| number","type":"`null` \\| `number`","optional":false,"defaultValue":"","description":"the tax rate for the gift card","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.IdempotencyKeyService.mdx
+22 -359
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotencyKeyRepository_",
"type": "Repository&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKeyRepository_","type":"Repository&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -192,31 +60,11 @@ identifier.
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "`CreateIdempotencyKeyInput`",
"description": "payload of request to create idempotency key for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"payload","type":"`CreateIdempotencyKeyInput`","description":"payload of request to create idempotency key for","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the created idempotency key","expandable":false,"children":[]}]} />
___
@@ -226,58 +74,11 @@ Execute the initial steps in a idempotent request.
#### Parameters
<ParameterTypes parameters={[
{
"name": "headerKey",
"type": "`string`",
"description": "potential idempotency key from header",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqMethod",
"type": "`string`",
"description": "method of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqParams",
"type": "`Record<string, unknown>`",
"description": "params of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqPath",
"type": "`string`",
"description": "path of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"headerKey","type":"`string`","description":"potential idempotency key from header","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqMethod","type":"`string`","description":"method of request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqParams","type":"`Record<string, unknown>`","description":"params of request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqPath","type":"`string`","description":"path of request","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the existing or created idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the existing or created idempotency key","expandable":false,"children":[]}]} />
___
@@ -287,31 +88,11 @@ Locks an idempotency.
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "key to lock",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"key to lock","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
@@ -321,31 +102,11 @@ Retrieves an idempotency key
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKeyOrSelector",
"type": "`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "key or selector to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKeyOrSelector","type":"`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"key or selector to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"idempotency key","expandable":false,"children":[]}]} />
___
@@ -353,31 +114,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -387,40 +128,11 @@ Locks an idempotency.
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "key to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "DeepPartial&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "update object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"key to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"DeepPartial&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"update object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
@@ -428,31 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "IdempotencyKeyService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"IdempotencyKeyService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -466,37 +158,8 @@ always consist of 2 or more of these phases. The required phases are
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "current idempotency key",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "callback",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;IdempotencyCallbackResult&#62;",
"description": "functionality to execute within the phase",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"current idempotency key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"callback","type":"(`transactionManager`: `EntityManager`) => Promise&#60;IdempotencyCallbackResult&#62;","description":"functionality to execute within the phase","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "new updated idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"new updated idempotency key","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.LineItemAdjustmentService.mdx
+26 -430
View File
@@ -12,87 +12,13 @@ Provides layer to manipulate line item adjustments.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`LineItemAdjustmentServiceProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`LineItemAdjustmentServiceProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "discountService",
"type": "[DiscountService](services.DiscountService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemAdjustmentRepo_",
"type": "Repository&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountService","type":"[DiscountService](services.DiscountService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemAdjustmentRepo_","type":"Repository&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -102,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -126,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -201,31 +60,11 @@ Creates a line item adjustment
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "Partial&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"description": "the line item adjustment to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"Partial&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","description":"the line item adjustment to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "line item adjustment",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","optional":false,"defaultValue":"","description":"line item adjustment","expandable":false,"children":[]}]} />
___
@@ -235,40 +74,11 @@ Creates adjustment for a line item
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart object holding discounts",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItem",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)",
"description": "the line item for which a line item adjustment might be created",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart object holding discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItem","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item for which a line item adjustment might be created","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a line item adjustment or undefined if no adjustment was created",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"a line item adjustment or undefined if no adjustment was created","expandable":false,"children":[]}]} />
___
@@ -278,40 +88,11 @@ Creates adjustment for a line item
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart object holding discounts",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItem",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)",
"description": "the line item for which a line item adjustment might be created",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart object holding discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItem","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item for which a line item adjustment might be created","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[] \\| [LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[][]&#62;",
"optional": false,
"defaultValue": "",
"description": "if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created\notherwise returns an array of line item adjustments for each line item in the cart",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[] \\| [LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[][]&#62;","optional":false,"defaultValue":"","description":"if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created\notherwise returns an array of line item adjustments for each line item in the cart","expandable":false,"children":[]}]} />
___
@@ -321,31 +102,11 @@ Deletes line item adjustments matching a selector
#### Parameters
<ParameterTypes parameters={[
{
"name": "selectorOrIds",
"type": "`string` \\| `string`[] \\| `FilterableLineItemAdjustmentProps` & `object`",
"description": "the query object for find or the line item adjustment id",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selectorOrIds","type":"`string` \\| `string`[] \\| `FilterableLineItemAdjustmentProps` & `object`","description":"the query object for find or the line item adjustment id","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
@@ -355,49 +116,11 @@ Creates adjustment for a line item
#### Parameters
<ParameterTypes parameters={[
{
"name": "calculationContextData",
"type": "`CalculationContextData`",
"description": "the calculationContextData object holding discounts",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "generatedLineItem",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)",
"description": "the line item for which a line item adjustment might be created",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`AdjustmentContext`",
"description": "the line item for which a line item adjustment might be created",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"calculationContextData","type":"`CalculationContextData`","description":"the calculationContextData object holding discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generatedLineItem","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item for which a line item adjustment might be created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`AdjustmentContext`","description":"the line item for which a line item adjustment might be created","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;GeneratedAdjustment[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a line item adjustment or undefined if no adjustment was created",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;GeneratedAdjustment[]&#62;","optional":false,"defaultValue":"","description":"a line item adjustment or undefined if no adjustment was created","expandable":false,"children":[]}]} />
___
@@ -407,40 +130,11 @@ Lists line item adjustments
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`FilterableLineItemAdjustmentProps`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`FilterableLineItemAdjustmentProps`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -450,40 +144,11 @@ Retrieves a line item adjustment by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "lineItemAdjustmentId",
"type": "`string`",
"description": "the id of the line item adjustment to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"description": "the config to retrieve the line item adjustment by",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"lineItemAdjustmentId","type":"`string`","description":"the id of the line item adjustment to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","description":"the config to retrieve the line item adjustment by","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the line item adjustment.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","optional":false,"defaultValue":"","description":"the line item adjustment.","expandable":false,"children":[]}]} />
___
@@ -491,31 +156,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -525,40 +170,11 @@ Creates a line item adjustment
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the line item adjustment id to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "Partial&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"description": "the line item adjustment to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the line item adjustment id to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","description":"the line item adjustment to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "line item adjustment",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)&#62;","optional":false,"defaultValue":"","description":"line item adjustment","expandable":false,"children":[]}]} />
___
@@ -566,28 +182,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "LineItemAdjustmentService",
"type": "`object`",
"description": "Provides layer to manipulate line item adjustments.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"LineItemAdjustmentService","type":"`object`","description":"Provides layer to manipulate line item adjustments.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.LineItemService.mdx
+37 -785
View File
@@ -10,159 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](../../entities/classes/entities.Cart.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "itemTaxLineRepo_",
"type": "Repository&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemAdjustmentService_",
"type": "[LineItemAdjustmentService](services.LineItemAdjustmentService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "pricingService_",
"type": "[PricingService](services.PricingService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productService_",
"type": "[ProductService](services.ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantService_",
"type": "[ProductVariantService](services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderService_",
"type": "[TaxProviderService](services.TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cartRepository_","type":"Repository&#60;[Cart](../../entities/classes/entities.Cart.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"itemTaxLineRepo_","type":"Repository&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemAdjustmentService_","type":"[LineItemAdjustmentService](services.LineItemAdjustmentService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemRepository_","type":"Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingService_","type":"[PricingService](services.PricingService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productService_","type":"[ProductService](services.ProductService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantService_","type":"[ProductVariantService](services.ProductVariantService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionService_","type":"[RegionService](services.RegionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderService_","type":"[TaxProviderService](services.TaxProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -172,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -196,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -269,58 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "ids",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "DeepPartial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options.setOriginalLineItemId",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ids","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"DeepPartial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options.setOriginalLineItemId","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -330,54 +70,15 @@ Create a line item
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`T`",
"description": "the line item object to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`T`","description":"the line item object to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the created line item",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the created line item","expandable":false,"children":[]}]} />
___
@@ -388,40 +89,11 @@ return.
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "the id to generate return items from.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cartId",
"type": "`string`",
"description": "the cart to assign the return line items to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"the id to generate return items from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cartId","type":"`string`","description":"the cart to assign the return line items to.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the created line items",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the created line items","expandable":false,"children":[]}]} />
___
@@ -431,31 +103,11 @@ Create a line item tax line.
#### Parameters
<ParameterTypes parameters={[
{
"name": "args",
"type": "DeepPartial&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62;",
"description": "tax line partial passed to the repo create method",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"args","type":"DeepPartial&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62;","description":"tax line partial passed to the repo create method","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "LineItemTaxLine",
"type": "`object`",
"description": "A Line Item Tax Line represents the taxes applied on a line item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"LineItemTaxLine","type":"`object`","description":"A Line Item Tax Line represents the taxes applied on a line item.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -465,31 +117,11 @@ Deletes a line item.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the line item to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the line item to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| null \\| [LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| null \\| [LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
@@ -497,31 +129,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the line item to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the line item to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| null \\| [LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| null \\| [LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
#### Deprecated
@@ -536,81 +148,15 @@ Generate a single or multiple line item without persisting the data into the db
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "variantIdOrData",
"type": "`T`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionIdOrContext",
"type": "`T` extends `string` ? `string` : `GenerateLineItemContext`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`GenerateLineItemContext`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"variantIdOrData","type":"`T`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionIdOrContext","type":"`T` extends `string` ? `string` : `GenerateLineItemContext`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`GenerateLineItemContext`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -618,121 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "variant",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product.discountable",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product.is_giftcard",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product.thumbnail",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product.title",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.product_id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variant.title",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`GenerateLineItemContext` & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"variant","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product.discountable","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product.is_giftcard","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product.thumbnail","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product.title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.product_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant.title","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`GenerateLineItemContext` & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -740,40 +176,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -783,40 +190,11 @@ Retrieves a line item by its id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the line item to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "the config to be used at query building",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the line item to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"the config to be used at query building","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the line item",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"the line item","expandable":false,"children":[]}]} />
___
@@ -824,31 +202,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -858,40 +216,11 @@ Updates a line item
#### Parameters
<ParameterTypes parameters={[
{
"name": "idOrSelector",
"type": "`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"description": "the id or selector of the line item(s) to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "Partial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"description": "the properties to update the line item(s)",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idOrSelector","type":"`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","description":"the id or selector of the line item(s) to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","description":"the properties to update the line item(s)","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated line item(s)",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the updated line item(s)","expandable":false,"children":[]}]} />
___
@@ -899,72 +228,15 @@ ___
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "variantIdOrData",
"type": "`string` \\| `T`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionIdOrContext",
"type": "`T` extends `string` ? `string` : `GenerateLineItemContext`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"variantIdOrData","type":"`string` \\| `T`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionIdOrContext","type":"`T` extends `string` ? `string` : `GenerateLineItemContext`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -972,28 +244,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "LineItemService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"LineItemService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.MiddlewareService.mdx
+18 -252
View File
@@ -14,44 +14,7 @@ ___
## Properties
<ParameterTypes parameters={[
{
"name": "postAuthentication_",
"type": "`middlewareType`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "preAuthentication_",
"type": "`middlewareType`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "preCartCreation_",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "routers",
"type": "`Record<string, Router[]>`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"postAuthentication_","type":"`middlewareType`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"preAuthentication_","type":"`middlewareType`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"preCartCreation_","type":"RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"routers","type":"`Record<string, Router[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -63,40 +26,11 @@ Adds a middleware function to be called after authentication is completed.
#### Parameters
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "`middlewareHandlerType`",
"description": "the middleware function. Should return a\n middleware function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`Record<string, unknown>`",
"description": "the arguments that will be passed to the\n middleware",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"middleware","type":"`middlewareHandlerType`","description":"the middleware function. Should return a\n middleware function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"the arguments that will be passed to the\n middleware","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "void",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
___
@@ -106,40 +40,11 @@ Adds a middleware function to be called before authentication is completed.
#### Parameters
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "`middlewareHandlerType`",
"description": "the middleware function. Should return a\n middleware function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`Record<string, unknown>`",
"description": "the arguments that will be passed to the\n middleware",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"middleware","type":"`middlewareHandlerType`","description":"the middleware function. Should return a\n middleware function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"the arguments that will be passed to the\n middleware","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "void",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
___
@@ -149,31 +54,11 @@ Adds a middleware function to be called before cart creation
#### Parameters
<ParameterTypes parameters={[
{
"name": "middleware",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;",
"description": "the middleware function. Should return a\n middleware function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"middleware","type":"RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;","description":"the middleware function. Should return a\n middleware function.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -181,40 +66,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "path",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "router",
"type": "`Router`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"router","type":"`Router`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -222,31 +78,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "path",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"path","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Router[]",
"type": "`Router`[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Router[]","type":"`Router`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -256,31 +92,11 @@ Adds post authentication middleware to an express app.
#### Parameters
<ParameterTypes parameters={[
{
"name": "app",
"type": "`Router`",
"description": "the express app to add the middleware to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"app","type":"`Router`","description":"the express app to add the middleware to","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -290,31 +106,11 @@ Adds pre authentication middleware to an express app.
#### Parameters
<ParameterTypes parameters={[
{
"name": "app",
"type": "`Router`",
"description": "the express app to add the middleware to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"app","type":"`Router`","description":"the express app to add the middleware to","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -322,17 +118,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"type": "RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]","type":"RequestHandler&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -342,28 +128,8 @@ Validates a middleware function, throws if fn is not of type function.
#### Parameters
<ParameterTypes parameters={[
{
"name": "fn",
"type": "`unknown`",
"description": "the middleware function to validate.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"fn","type":"`unknown`","description":"the middleware function to validate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "nothing if the middleware is a function",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"nothing if the middleware is a function","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.NewTotalsService.mdx
+33 -993
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.NoteService.mdx
+22 -413
View File
@@ -10,123 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "noteRepository_",
"type": "Repository&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"note.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"note.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"note.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"noteRepository_","type":"Repository&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"note.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"note.deleted\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"note.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -136,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -160,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -235,49 +58,11 @@ Creates a note associated with a given author
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateNoteInput`",
"description": "the note to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "any configurations if needed, including meta data",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.metadata",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateNoteInput`","description":"the note to create","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"any configurations if needed, including meta data","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config.metadata","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the creation result",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","optional":false,"defaultValue":"","description":"resolves to the creation result","expandable":false,"children":[]}]} />
___
@@ -287,31 +72,11 @@ Deletes a given note
#### Parameters
<ParameterTypes parameters={[
{
"name": "noteId",
"type": "`string`",
"description": "id of the note to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"noteId","type":"`string`","description":"id of the note to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -321,40 +86,11 @@ Fetches all notes related to the given selector
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"the configuration used to find the objects. contains relations, skip, and take.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Note](../../entities/classes/entities.Note.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "notes related to the given search.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Note](../../entities/classes/entities.Note.mdx)[]&#62;","optional":false,"defaultValue":"","description":"notes related to the given search.","expandable":false,"children":[]}]} />
___
@@ -364,40 +100,11 @@ Fetches all notes related to the given selector
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "the configuration used to find the objects. contains relations, skip, and take.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"the configuration used to find the objects. contains relations, skip, and take.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[Note](../../entities/classes/entities.Note.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "notes related to the given search.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Note](../../entities/classes/entities.Note.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"notes related to the given search.","expandable":false,"children":[]}]} />
___
@@ -407,40 +114,11 @@ Retrieves a specific note.
#### Parameters
<ParameterTypes parameters={[
{
"name": "noteId",
"type": "`string`",
"description": "the id of the note to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"description": "any options needed to query for the result.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"noteId","type":"`string`","description":"the id of the note to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","description":"any options needed to query for the result.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "which resolves to the requested note.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","optional":false,"defaultValue":"","description":"which resolves to the requested note.","expandable":false,"children":[]}]} />
___
@@ -448,31 +126,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -482,40 +140,11 @@ Updates a given note with a new value
#### Parameters
<ParameterTypes parameters={[
{
"name": "noteId",
"type": "`string`",
"description": "the id of the note to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "the new value",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"noteId","type":"`string`","description":"the id of the note to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"the new value","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the updated element",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Note](../../entities/classes/entities.Note.mdx)&#62;","optional":false,"defaultValue":"","description":"resolves to the updated element","expandable":false,"children":[]}]} />
___
@@ -523,28 +152,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "NoteService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"NoteService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.NotificationService.mdx
+30 -519
View File
@@ -10,123 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"container","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "attachmentGenerator_",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "null",
"expandable": false,
"children": []
},
{
"name": "container_",
"type": "`InjectedDependencies` & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "logger_",
"type": "[Logger](../../medusa/types/medusa.Logger.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "notificationProviderRepository_",
"type": "Repository&#60;[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "notificationRepository_",
"type": "Repository&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "subscribers_",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attachmentGenerator_","type":"`unknown`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"container_","type":"`InjectedDependencies` & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../medusa/types/medusa.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notificationProviderRepository_","type":"Repository&#60;[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notificationRepository_","type":"Repository&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subscribers_","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -136,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -160,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -237,40 +60,11 @@ order to allow for resends. Will log any errors that are encountered.
#### Parameters
<ParameterTypes parameters={[
{
"name": "eventName",
"type": "`string`",
"description": "the event to handle",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "the data the event was sent with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"eventName","type":"`string`","description":"the event to handle","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"the data the event was sent with","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| void \\| [Notification](../../entities/classes/entities.Notification.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of notification subscribed",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| void \\| [Notification](../../entities/classes/entities.Notification.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of notification subscribed","expandable":false,"children":[]}]} />
___
@@ -280,40 +74,11 @@ Retrieves a list of notifications.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "the params to select the notifications by.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"the params to select the notifications by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"the configuration to apply to the query","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the notifications that satisfy the query.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the notifications that satisfy the query.","expandable":false,"children":[]}]} />
___
@@ -323,40 +88,11 @@ Retrieves a list of notifications and total count.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "the params to select the notifications by.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"the params to select the notifications by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"the configuration to apply to the query","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[Notification](../../entities/classes/entities.Notification.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the notifications that satisfy the query as well as the count.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Notification](../../entities/classes/entities.Notification.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the notifications that satisfy the query as well as the count.","expandable":false,"children":[]}]} />
___
@@ -367,31 +103,11 @@ used to generate on demand invoices or other documents.
#### Parameters
<ParameterTypes parameters={[
{
"name": "service",
"type": "`unknown`",
"description": "the service to assign to the attachmentGenerator",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"service","type":"`unknown`","description":"the service to assign to the attachmentGenerator","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -401,31 +117,11 @@ Takes a list of notification provider ids and persists them in the database.
#### Parameters
<ParameterTypes parameters={[
{
"name": "providerIds",
"type": "`string`[]",
"description": "a list of provider ids",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providerIds","type":"`string`[]","description":"a list of provider ids","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -436,40 +132,11 @@ underlying provider's resendNotification method.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the notification",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "any configuration that might override the previous\n send",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the notification","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"any configuration that might override the previous\n send","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created notification",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","optional":false,"defaultValue":"","description":"the newly created notification","expandable":false,"children":[]}]} />
___
@@ -479,40 +146,11 @@ Retrieves a notification with a given id
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the notification",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"description": "the configuration to apply to the query",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the notification","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","description":"the configuration to apply to the query","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the notification",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Notification](../../entities/classes/entities.Notification.mdx)&#62;","optional":false,"defaultValue":"","description":"the notification","expandable":false,"children":[]}]} />
___
@@ -523,31 +161,11 @@ resolution fails.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the provider",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the provider","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AbstractNotificationService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"AbstractNotificationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -558,49 +176,11 @@ method. Persists the Notification in the database.
#### Parameters
<ParameterTypes parameters={[
{
"name": "event",
"type": "`string`",
"description": "the name of the event",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventData",
"type": "`Record<string, unknown>`",
"description": "the data the event was sent with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "providerId",
"type": "`string`",
"description": "the provider that should handle the event.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"event","type":"`string`","description":"the name of the event","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventData","type":"`Record<string, unknown>`","description":"the data the event was sent with","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerId","type":"`string`","description":"the provider that should handle the event.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| [Notification](../../entities/classes/entities.Notification.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created notification",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [Notification](../../entities/classes/entities.Notification.mdx)&#62;","optional":false,"defaultValue":"","description":"the created notification","expandable":false,"children":[]}]} />
___
@@ -608,31 +188,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -642,40 +202,11 @@ Subscribes a given provider to an event.
#### Parameters
<ParameterTypes parameters={[
{
"name": "eventName",
"type": "`string`",
"description": "the event to subscribe to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "providerId",
"type": "`string`",
"description": "the provider that the event will be sent to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"eventName","type":"`string`","description":"the event to subscribe to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerId","type":"`string`","description":"the provider that the event will be sent to","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -683,28 +214,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "NotificationService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"NotificationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.OauthService.mdx
+26 -430
View File
@@ -10,123 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "cradle",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cradle","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "container_",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "oauthRepository_",
"type": "Repository&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.TOKEN_GENERATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"oauth.token_generated\"",
"expandable": false,
"children": []
},
{
"name": "Events.TOKEN_REFRESHED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"oauth.token_refreshed\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container_","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"oauthRepository_","type":"Repository&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.TOKEN_GENERATED","type":"`string`","description":"","optional":false,"defaultValue":"\"oauth.token_generated\"","expandable":false,"children":[]},{"name":"Events.TOKEN_REFRESHED","type":"`string`","description":"","optional":false,"defaultValue":"\"oauth.token_refreshed\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -136,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -160,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -233,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateOauthInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateOauthInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -265,49 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "appName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "code",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "state",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"appName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"state","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -315,31 +80,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -347,31 +92,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "appName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"appName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -379,31 +104,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "appDetails",
"type": "`CreateOauthInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"appDetails","type":"`CreateOauthInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -411,31 +116,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "oauthId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"oauthId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -443,31 +128,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "appName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"appName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -475,31 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -507,40 +152,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateOauthInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateOauthInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Oauth](../../entities/classes/entities.Oauth.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -548,28 +164,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "OauthService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"OauthService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.OrderEditItemChangeService.mdx
+18 -342
View File
@@ -10,132 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "orderItemChangeRepository_",
"type": "Repository&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderService_",
"type": "[TaxProviderService](services.TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"order-edit-item-change.CREATED\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"order-edit-item-change.DELETED\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"`IEventBusService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderItemChangeRepository_","type":"Repository&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderService_","type":"[TaxProviderService](services.TaxProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit-item-change.CREATED\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"order-edit-item-change.DELETED\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -145,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -169,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -242,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateOrderEditItemChangeInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateOrderEditItemChangeInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -274,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "itemChangeIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"itemChangeIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -306,40 +80,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -347,40 +92,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -388,31 +104,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -420,28 +116,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "OrderEditItemChangeService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"OrderEditItemChangeService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.OrderEditService.mdx
+49 -962
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.OrderService.mdx
+71 -1564
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.PaymentCollectionService.mdx
+30 -573
View File
@@ -10,150 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerService_",
"type": "[CustomerService](services.CustomerService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentCollectionRepository_",
"type": "Repository&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentProviderService_",
"type": "[PaymentProviderService](services.PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment-collection.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment-collection.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.PAYMENT_AUTHORIZED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment-collection.payment_authorized\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment-collection.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerService_","type":"[CustomerService](services.CustomerService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentCollectionRepository_","type":"Repository&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentProviderService_","type":"[PaymentProviderService](services.PaymentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment-collection.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment-collection.deleted\"","expandable":false,"children":[]},{"name":"Events.PAYMENT_AUTHORIZED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment-collection.payment_authorized\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment-collection.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -163,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -187,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -262,49 +58,11 @@ Authorizes the payment sessions of a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sessionIds",
"type": "`string`[]",
"description": "array of payment session ids to be authorized",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`Record<string, unknown>`",
"description": "additional data required by payment providers",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionIds","type":"`string`[]","description":"array of payment session ids to be authorized","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"additional data required by payment providers","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection and its payment session.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection and its payment session.","expandable":false,"children":[]}]} />
___
@@ -314,31 +72,11 @@ Creates a new payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreatePaymentCollectionInput`",
"description": "info to create the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreatePaymentCollectionInput`","description":"info to create the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection created.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection created.","expandable":false,"children":[]}]} />
___
@@ -348,31 +86,11 @@ Deletes a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection to be removed",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection to be removed","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| [PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection removed.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection removed.","expandable":false,"children":[]}]} />
___
@@ -380,40 +98,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "total",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sessionsInput",
"type": "`PaymentCollectionsSessionsBatchInput`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"total","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionsInput","type":"`PaymentCollectionsSessionsBatchInput`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -423,31 +112,11 @@ Marks a payment collection as authorized bypassing the payment flow.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment session authorized.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment session authorized.","expandable":false,"children":[]}]} />
___
@@ -457,49 +126,11 @@ Removes and recreate a payment session of a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sessionId",
"type": "`string`",
"description": "the id of the payment session to be replaced",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerId",
"type": "`string`",
"description": "the id of the customer",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionId","type":"`string`","description":"the id of the payment session to be replaced","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerId","type":"`string`","description":"the id of the customer","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the new payment session created.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)&#62;","optional":false,"defaultValue":"","description":"the new payment session created.","expandable":false,"children":[]}]} />
___
@@ -509,40 +140,11 @@ Retrieves a payment collection by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"description": "the config to retrieve the payment collection",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","description":"the config to retrieve the payment collection","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection.","expandable":false,"children":[]}]} />
___
@@ -552,49 +154,11 @@ Manages a single payment sessions of a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sessionInput",
"type": "`PaymentCollectionsSessionsInput`",
"description": "object containing payment session info",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerId",
"type": "`string`",
"description": "the id of the customer",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionInput","type":"`PaymentCollectionsSessionsInput`","description":"object containing payment session info","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerId","type":"`string`","description":"the id of the customer","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection and its payment session.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection and its payment session.","expandable":false,"children":[]}]} />
___
@@ -604,49 +168,11 @@ Manages multiple payment sessions of a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionOrId",
"type": "`string` \\| [PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)",
"description": "the id of the payment collection",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "sessionsInput",
"type": "`PaymentCollectionsSessionsBatchInput`[]",
"description": "array containing payment session info",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerId",
"type": "`string`",
"description": "the id of the customer",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionOrId","type":"`string` \\| [PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"the id of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionsInput","type":"`PaymentCollectionsSessionsBatchInput`[]","description":"array containing payment session info","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerId","type":"`string`","description":"the id of the customer","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection and its payment sessions.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection and its payment sessions.","expandable":false,"children":[]}]} />
___
@@ -654,31 +180,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -688,40 +194,11 @@ Updates a payment collection.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentCollectionId",
"type": "`string`",
"description": "the id of the payment collection to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "DeepPartial&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"description": "info to be updated",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentCollectionId","type":"`string`","description":"the id of the payment collection to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"DeepPartial&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","description":"info to be updated","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment collection updated.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment collection updated.","expandable":false,"children":[]}]} />
___
@@ -729,28 +206,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "PaymentCollectionService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"PaymentCollectionService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.PaymentProviderService.mdx
+61 -1121
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.PaymentService.mdx
+20 -436
View File
@@ -10,159 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentProviderService_",
"type": "[PaymentProviderService](services.PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "paymentRepository_",
"type": "Repository&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.PAYMENT_CAPTURED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.payment_captured\"",
"expandable": false,
"children": []
},
{
"name": "Events.PAYMENT_CAPTURE_FAILED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.payment_capture_failed\"",
"expandable": false,
"children": []
},
{
"name": "Events.REFUND_CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.payment_refund_created\"",
"expandable": false,
"children": []
},
{
"name": "Events.REFUND_FAILED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.payment_refund_failed\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"payment.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentProviderService_","type":"[PaymentProviderService](services.PaymentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"paymentRepository_","type":"Repository&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.created\"","expandable":false,"children":[]},{"name":"Events.PAYMENT_CAPTURED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.payment_captured\"","expandable":false,"children":[]},{"name":"Events.PAYMENT_CAPTURE_FAILED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.payment_capture_failed\"","expandable":false,"children":[]},{"name":"Events.REFUND_CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.payment_refund_created\"","expandable":false,"children":[]},{"name":"Events.REFUND_FAILED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.payment_refund_failed\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"payment.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -172,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -196,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -271,31 +58,11 @@ Captures a payment.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentOrId",
"type": "`string` \\| [Payment](../../entities/classes/entities.Payment.mdx)",
"description": "the id or the class instance of the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentOrId","type":"`string` \\| [Payment](../../entities/classes/entities.Payment.mdx)","description":"the id or the class instance of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment captured.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment captured.","expandable":false,"children":[]}]} />
___
@@ -305,31 +72,11 @@ Created a new payment.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentInput",
"type": "`PaymentDataInput`",
"description": "info to create the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentInput","type":"`PaymentDataInput`","description":"info to create the payment","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment created.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment created.","expandable":false,"children":[]}]} />
___
@@ -339,58 +86,11 @@ refunds a payment.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentOrId",
"type": "`string` \\| [Payment](../../entities/classes/entities.Payment.mdx)",
"description": "the id or the class instance of the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "amount",
"type": "`number`",
"description": "the amount to be refunded from the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reason",
"type": "`string`",
"description": "the refund reason",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "note",
"type": "`string`",
"description": "additional note of the refund",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentOrId","type":"`string` \\| [Payment](../../entities/classes/entities.Payment.mdx)","description":"the id or the class instance of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"the amount to be refunded from the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"additional note of the refund","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Refund](../../entities/classes/entities.Refund.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the refund created.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Refund](../../entities/classes/entities.Refund.mdx)&#62;","optional":false,"defaultValue":"","description":"the refund created.","expandable":false,"children":[]}]} />
___
@@ -400,40 +100,11 @@ Retrieves a payment by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentId",
"type": "`string`",
"description": "the id of the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"description": "the config to retrieve the payment",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentId","type":"`string`","description":"the id of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","description":"the config to retrieve the payment","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment.","expandable":false,"children":[]}]} />
___
@@ -441,31 +112,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -475,58 +126,11 @@ Updates a payment in order to link it to an order or a swap.
#### Parameters
<ParameterTypes parameters={[
{
"name": "paymentId",
"type": "`string`",
"description": "the id of the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`object`",
"description": "order\\_id or swap\\_id to link the payment",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data.order_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data.swap_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"paymentId","type":"`string`","description":"the id of the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`object`","description":"order\\_id or swap\\_id to link the payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data.order_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data.swap_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the payment updated.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Payment](../../entities/classes/entities.Payment.mdx)&#62;","optional":false,"defaultValue":"","description":"the payment updated.","expandable":false,"children":[]}]} />
___
@@ -534,28 +138,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "PaymentService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"PaymentService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.PriceListService.mdx
+43 -752
View File
@@ -12,141 +12,13 @@ Provides layer to manipulate product tags.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`PriceListConstructorProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`PriceListConstructorProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerGroupService_",
"type": "[CustomerGroupService](services.CustomerGroupService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "moneyAmountRepo_",
"type": "Repository&#60;[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceListRepo_",
"type": "Repository&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productService_",
"type": "[ProductService](services.ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantRepo_",
"type": "Repository&#60;[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variantService_",
"type": "[ProductVariantService](services.ProductVariantService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerGroupService_","type":"[CustomerGroupService](services.CustomerGroupService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moneyAmountRepo_","type":"Repository&#60;[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priceListRepo_","type":"Repository&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productService_","type":"[ProductService](services.ProductService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantRepo_","type":"Repository&#60;[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionService_","type":"[RegionService](services.RegionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variantService_","type":"[ProductVariantService](services.ProductVariantService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -156,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -178,45 +40,15 @@ Add `currency_code` to an MA record if `region_id`is passed.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "[PriceListPriceUpdateInput](../../medusa/types/medusa.PriceListPriceUpdateInput.mdx) \\| [PriceListPriceCreateInput](../../medusa/types/medusa.PriceListPriceCreateInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"[PriceListPriceUpdateInput](../../medusa/types/medusa.PriceListPriceUpdateInput.mdx) \\| [PriceListPriceCreateInput](../../medusa/types/medusa.PriceListPriceCreateInput.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "prices",
"type": "`T`[]",
"description": "a list of PriceListPrice(Create/Update)Input records",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"prices","type":"`T`[]","description":"a list of PriceListPrice(Create/Update)Input records","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;T[]&#62;",
"optional": false,
"defaultValue": "",
"description": "updated `prices` list",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;T[]&#62;","optional":false,"defaultValue":"","description":"updated `prices` list","expandable":false,"children":[]}]} />
___
@@ -226,49 +58,11 @@ Adds prices to a price list in bulk, optionally replacing all existing prices
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the price list",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "prices",
"type": "[PriceListPriceCreateInput](../../medusa/types/medusa.PriceListPriceCreateInput.mdx)[]",
"description": "prices to add",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "replace",
"type": "`boolean`",
"description": "whether to replace existing prices",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the price list","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceListPriceCreateInput](../../medusa/types/medusa.PriceListPriceCreateInput.mdx)[]","description":"prices to add","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"replace","type":"`boolean`","description":"whether to replace existing prices","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "updated Price List",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
___
@@ -280,72 +74,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -355,31 +92,11 @@ Removes all prices from a price list and deletes the removed prices in bulk
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the price list",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the price list","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "updated Price List",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
___
@@ -389,31 +106,11 @@ Creates a Price List
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListObject",
"type": "[CreatePriceListInput](../../medusa/types/medusa.CreatePriceListInput.mdx)",
"description": "the Price List to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListObject","type":"[CreatePriceListInput](../../medusa/types/medusa.CreatePriceListInput.mdx)","description":"the Price List to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created Price List",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","optional":false,"defaultValue":"","description":"created Price List","expandable":false,"children":[]}]} />
___
@@ -424,31 +121,11 @@ Will never fail due to delete being idempotent.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the price list",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the price list","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "empty promise",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
___
@@ -458,40 +135,11 @@ Removes prices from a price list and deletes the removed prices in bulk
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the price list",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceIds",
"type": "`string`[]",
"description": "ids of the prices to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the price list","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priceIds","type":"`string`[]","description":"ids of the prices to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "updated Price List",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
___
@@ -499,40 +147,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[string[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[string[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -540,40 +159,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "variantIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variantIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[string[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[string[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -583,40 +173,11 @@ Lists Price Lists
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[FilterablePriceListProps](../../medusa/classes/medusa.FilterablePriceListProps.mdx)",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[FilterablePriceListProps](../../medusa/classes/medusa.FilterablePriceListProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -626,40 +187,11 @@ Lists Price Lists and adds count
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[FilterablePriceListProps](../../medusa/classes/medusa.FilterablePriceListProps.mdx)",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[FilterablePriceListProps](../../medusa/classes/medusa.FilterablePriceListProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[PriceList](../../entities/classes/entities.PriceList.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[PriceList](../../entities/classes/entities.PriceList.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -667,31 +199,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;object&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -699,58 +211,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "selector",
"type": "[FilterableProductProps](../../medusa/classes/medusa.FilterableProductProps.mdx) \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Product](../../entities/classes/entities.Product.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Product](../../entities/classes/entities.Product.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requiresPriceList",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector","type":"[FilterableProductProps](../../medusa/classes/medusa.FilterableProductProps.mdx) \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Product](../../entities/classes/entities.Product.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Product](../../entities/classes/entities.Product.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requiresPriceList","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[Product](../../entities/classes/entities.Product.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Product](../../entities/classes/entities.Product.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -758,58 +223,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "selector",
"type": "[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requiresPriceList",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requiresPriceList","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -819,40 +237,11 @@ Retrieves a product tag by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "the id of the product tag to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"description": "the config to retrieve the tag by",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"the id of the product tag to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","description":"the config to retrieve the tag by","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the collection.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
___
@@ -860,31 +249,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -894,40 +263,11 @@ Updates a Price List
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the Product List to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "[UpdatePriceListInput](../../medusa/types/medusa.UpdatePriceListInput.mdx)",
"description": "the update to apply",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the Product List to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"[UpdatePriceListInput](../../medusa/types/medusa.UpdatePriceListInput.mdx)","description":"the update to apply","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "updated Price List",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[PriceList](../../entities/classes/entities.PriceList.mdx)&#62;","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
___
@@ -935,40 +275,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceListId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customerGroups",
"type": "`object`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customerGroups","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -976,28 +287,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "PriceListService",
"type": "`object`",
"description": "Provides layer to manipulate product tags.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"PriceListService","type":"`object`","description":"Provides layer to manipulate product tags.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.PricingService.mdx
+46 -749
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.ProductCategoryService.mdx
+36 -666
View File
@@ -12,123 +12,13 @@ Provides layer to manipulate product categories.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryRepo_",
"type": "TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-category.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-category.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-category.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryRepo_","type":"TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.deleted\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-category.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -138,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -160,40 +40,11 @@ Add a batch of product to a product category
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryId",
"type": "`string`",
"description": "The id of the product category on which to add the products",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "The products ids to attach to the product category",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryId","type":"`string`","description":"The id of the product category on which to add the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to attach to the product category","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the product category on which the products have been added",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the product category on which the products have been added","expandable":false,"children":[]}]} />
___
@@ -205,72 +56,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -280,31 +74,11 @@ Creates a product category
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryInput",
"type": "`CreateProductCategoryInput`",
"description": "parameters to create a product category",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryInput","type":"`CreateProductCategoryInput`","description":"parameters to create a product category","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created product category",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","optional":false,"defaultValue":"","description":"created product category","expandable":false,"children":[]}]} />
___
@@ -314,31 +88,11 @@ Deletes a product category
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryId",
"type": "`string`",
"description": "is the id of the product category to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryId","type":"`string`","description":"is the id of the product category to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "a promise",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"a promise","expandable":false,"children":[]}]} />
___
@@ -346,49 +100,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategory",
"type": "[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "input",
"type": "`UpdateProductCategoryInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shouldDeleteElement",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategory","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"input","type":"`UpdateProductCategoryInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldDeleteElement","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ReorderConditions",
"type": "`ReorderConditions`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ReorderConditions","type":"`ReorderConditions`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -399,49 +115,11 @@ product category that match the query.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[TreeQuerySelector](../../medusa/types/medusa.TreeQuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "Filter options for product category.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "Configuration for query.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "treeSelector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "Filter options for product category tree relations",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[TreeQuerySelector](../../medusa/types/medusa.TreeQuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"Filter options for product category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"Configuration for query.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"treeSelector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"Filter options for product category tree relations","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "an array containing the product category as\n the first element and the total count of product category that matches the query\n as the second element.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"an array containing the product category as\n the first element and the total count of product category that matches the query\n as the second element.","expandable":false,"children":[]}]} />
___
@@ -449,40 +127,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "repository",
"type": "TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "conditions",
"type": "`ReorderConditions`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"repository","type":"TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"`ReorderConditions`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -492,40 +141,11 @@ Remove a batch of product from a product category
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryId",
"type": "`string`",
"description": "The id of the product category on which to remove the products",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "The products ids to remove from the product category",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryId","type":"`string`","description":"The id of the product category on which to remove the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to remove from the product category","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the product category on which the products have been removed",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the product category on which the products have been removed","expandable":false,"children":[]}]} />
___
@@ -535,58 +155,11 @@ Retrieves a product category by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryId",
"type": "`string`",
"description": "the id of the product category to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "the config of the product category to retrieve.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "treeSelector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryId","type":"`string`","description":"the id of the product category to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"the config of the product category to retrieve.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"treeSelector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the product category.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
___
@@ -596,58 +169,11 @@ Retrieves a product category by handle.
#### Parameters
<ParameterTypes parameters={[
{
"name": "handle",
"type": "`string`",
"description": "the handle of the category",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "the config of the product category to retrieve.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "treeSelector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"handle","type":"`string`","description":"the handle of the category","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"the config of the product category to retrieve.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"treeSelector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the product category.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
___
@@ -657,49 +183,11 @@ A generic retrieve for fining product categories by different attributes.
#### Parameters
<ParameterTypes parameters={[
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "the config of the product category to retrieve.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "treeSelector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"the config of the product category to retrieve.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"treeSelector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the product category.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
___
@@ -707,40 +195,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "repository",
"type": "TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "conditions",
"type": "`ReorderConditions`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"repository","type":"TreeRepository&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"`ReorderConditions`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -748,31 +207,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -783,31 +222,11 @@ into product\_category entity.
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryInput",
"type": "`CreateProductCategoryInput` \\| `UpdateProductCategoryInput`",
"description": "params used to create/update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryInput","type":"`CreateProductCategoryInput` \\| `UpdateProductCategoryInput`","description":"params used to create/update","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;CreateProductCategoryInput \\| UpdateProductCategoryInput&#62;",
"optional": false,
"defaultValue": "",
"description": "transformed productCategoryInput",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;CreateProductCategoryInput \\| UpdateProductCategoryInput&#62;","optional":false,"defaultValue":"","description":"transformed productCategoryInput","expandable":false,"children":[]}]} />
___
@@ -817,40 +236,11 @@ Updates a product category
#### Parameters
<ParameterTypes parameters={[
{
"name": "productCategoryId",
"type": "`string`",
"description": "id of product category to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCategoryInput",
"type": "`UpdateProductCategoryInput`",
"description": "parameters to update in product category",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productCategoryId","type":"`string`","description":"id of product category to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryInput","type":"`UpdateProductCategoryInput`","description":"parameters to update in product category","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "updated product category",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)&#62;","optional":false,"defaultValue":"","description":"updated product category","expandable":false,"children":[]}]} />
___
@@ -858,28 +248,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ProductCategoryService",
"type": "`object`",
"description": "Provides layer to manipulate product categories.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ProductCategoryService","type":"`object`","description":"Provides layer to manipulate product categories.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ProductCollectionService.mdx
+28 -533
View File
@@ -12,150 +12,13 @@ Provides layer to manipulate product collections.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productCollectionRepository_",
"type": "Repository&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-collection.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-collection.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.PRODUCTS_ADDED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-collection.products_added\"",
"expandable": false,
"children": []
},
{
"name": "Events.PRODUCTS_REMOVED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-collection.products_removed\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"product-collection.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCollectionRepository_","type":"Repository&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productRepository_","type":"Repository&#60;[Product](../../entities/classes/entities.Product.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.deleted\"","expandable":false,"children":[]},{"name":"Events.PRODUCTS_ADDED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.products_added\"","expandable":false,"children":[]},{"name":"Events.PRODUCTS_REMOVED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.products_removed\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"product-collection.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -165,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -185,40 +38,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -230,72 +54,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -305,31 +72,11 @@ Creates a product collection
#### Parameters
<ParameterTypes parameters={[
{
"name": "collection",
"type": "`CreateProductCollection`",
"description": "the collection to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collection","type":"`CreateProductCollection`","description":"the collection to create","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "created collection",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"created collection","expandable":false,"children":[]}]} />
___
@@ -339,31 +86,11 @@ Deletes a product collection idempotently
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionId",
"type": "`string`",
"description": "id of collection to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionId","type":"`string`","description":"id of collection to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "empty promise",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
___
@@ -373,58 +100,11 @@ Lists product collections
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62; & `object`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config.skip",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "config.take",
"type": "`number`",
"description": "",
"optional": false,
"defaultValue": "20",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config.skip","type":"`number`","description":"","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"config.take","type":"`number`","description":"","optional":false,"defaultValue":"20","expandable":false,"children":[]},{"name":"selector.discount_condition_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -434,40 +114,11 @@ Lists product collections and add count.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`ListAndCountSelector`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`ListAndCountSelector`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -475,40 +126,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -518,40 +140,11 @@ Retrieves a product collection by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionId",
"type": "`string`",
"description": "the id of the collection to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"description": "the config of the collection to retrieve.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionId","type":"`string`","description":"the id of the collection to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","description":"the config of the collection to retrieve.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the collection.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
___
@@ -561,40 +154,11 @@ Retrieves a product collection by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionHandle",
"type": "`string`",
"description": "the handle of the collection to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"description": "query config for request",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionHandle","type":"`string`","description":"the handle of the collection to retrieve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","description":"query config for request","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the collection.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
___
@@ -602,31 +166,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -636,40 +180,11 @@ Updates a product collection
#### Parameters
<ParameterTypes parameters={[
{
"name": "collectionId",
"type": "`string`",
"description": "id of collection to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateProductCollection`",
"description": "update object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"collectionId","type":"`string`","description":"id of collection to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateProductCollection`","description":"update object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "update collection",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)&#62;","optional":false,"defaultValue":"","description":"update collection","expandable":false,"children":[]}]} />
___
@@ -677,28 +192,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ProductCollectionService",
"type": "`object`",
"description": "Provides layer to manipulate product collections.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ProductCollectionService","type":"`object`","description":"Provides layer to manipulate product collections.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ProductService.mdx
+84 -990
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.ProductTypeService.mdx
+16 -275
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.productTypeRepository","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "typeRepository_",
"type": "Repository&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeRepository_","type":"Repository&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -190,40 +58,11 @@ Lists product types
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62; & `object`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.discount_condition_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -233,40 +72,11 @@ Lists product types and adds count.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62; & `object`",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;",
"description": "the config to be used for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`object`","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;","description":"the config to be used for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.discount_condition_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"selector.q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[ProductType](../../entities/classes/entities.ProductType.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[ProductType](../../entities/classes/entities.ProductType.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -277,40 +87,11 @@ Throws in case of DB Error and if product was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "id of the product to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;",
"description": "object that defines what should be included in the\n query response",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"id of the product to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;","description":"object that defines what should be included in the\n query response","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find one operation.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductType](../../entities/classes/entities.ProductType.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
___
@@ -318,31 +99,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -350,28 +111,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ProductTypeService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ProductTypeService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ProductVariantInventoryService.mdx
+48 -834
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.ProductVariantService.mdx
+59 -1009
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.RegionService.mdx
+47 -832
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.ReturnReasonService.mdx
+20 -319
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retReasonRepo_",
"type": "Repository&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retReasonRepo_","type":"Repository&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -188,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateReturnReason`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateReturnReason`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -220,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnReasonId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnReasonId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -252,40 +80,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"description": "config object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","description":"config object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -295,40 +94,11 @@ Gets an order by id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnReasonId",
"type": "`string`",
"description": "id of order to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"description": "config object",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnReasonId","type":"`string`","description":"id of order to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","description":"config object","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the order document",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
___
@@ -336,31 +106,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -368,40 +118,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`UpdateReturnReason`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`UpdateReturnReason`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -409,28 +130,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ReturnReasonService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ReturnReasonService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ReturnService.mdx
+34 -680
View File
@@ -10,168 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "fulfillmentProviderService_",
"type": "[FulfillmentProviderService](services.FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "lineItemService_",
"type": "[LineItemService](services.LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "orderService_",
"type": "[OrderService](services.OrderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productVariantInventoryService_",
"type": "[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnItemRepository_",
"type": "Repository&#60;[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnReasonService_",
"type": "[ReturnReasonService](services.ReturnReasonService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "returnRepository_",
"type": "Repository&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderService_",
"type": "[TaxProviderService](services.TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "totalsService_",
"type": "[TotalsService](services.TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentProviderService_","type":"[FulfillmentProviderService](services.FulfillmentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orderService_","type":"[OrderService](services.OrderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantInventoryService_","type":"[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnItemRepository_","type":"Repository&#60;[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnReasonService_","type":"[ReturnReasonService](services.ReturnReasonService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnRepository_","type":"Repository&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingOptionService_","type":"[ShippingOptionService](services.ShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderService_","type":"[TaxProviderService](services.TaxProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsService_","type":"[TotalsService](services.TotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -181,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -205,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -280,31 +58,11 @@ Cancels a return if possible. Returns can be canceled if it has not been receive
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "the id of the return to cancel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"the id of the return to cancel.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Return",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Return","expandable":false,"children":[]}]} />
___
@@ -316,31 +74,11 @@ the return lines and the shipping cost.
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateReturnInput`",
"description": "data to use for the return e.g. shipping\\_method,\n items or refund\\_amount",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateReturnInput`","description":"data to use for the return e.g. shipping\\_method,\n items or refund\\_amount","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created return",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"the created return","expandable":false,"children":[]}]} />
___
@@ -348,31 +86,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -382,49 +100,11 @@ Retrieves the order line items, given an array of items
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "[Order](../../entities/classes/entities.Order.mdx)",
"description": "the order to get line items from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "items",
"type": "[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]",
"description": "the items to get",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transformer",
"type": "`Transformer`",
"description": "a function to apply to each of the items\n retrieved from the order, should return a line item. If the transformer\n returns an undefined value the line item will be filtered from the\n returned array.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"the order to get line items from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]","description":"the items to get","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transformer","type":"`Transformer`","description":"a function to apply to each of the items\n retrieved from the order, should return a line item. If the transformer\n returns an undefined value the line item will be filtered from the\n returned array.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx) & object[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the line items generated by the transformer.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[LineItem](../../entities/classes/entities.LineItem.mdx) & object[]&#62;","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]} />
___
@@ -432,40 +112,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"the config object for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -473,40 +124,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"the config object for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[Return](../../entities/classes/entities.Return.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Return](../../entities/classes/entities.Return.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -522,76 +144,11 @@ mismatches.
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "the orderId to return to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "receivedItems",
"type": "[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]",
"description": "the items received after return.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "refundAmount",
"type": "`number`",
"description": "the amount to return",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "allowMismatch",
"type": "`boolean`",
"description": "whether to ignore return/received\nproduct mismatch",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
},
{
"name": "context",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "context.locationId",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"the orderId to return to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"receivedItems","type":"[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]","description":"the items received after return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowMismatch","type":"`boolean`","description":"whether to ignore return/received\nproduct mismatch","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"context","type":"`object`","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"refundAmount","type":"`number`","description":"the amount to return","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context.locationId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
___
@@ -601,40 +158,11 @@ Retrieves a return by its id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "the id of the return to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"description": "the config object",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"the id of the return to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","description":"the config object","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the return",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"the return","expandable":false,"children":[]}]} />
___
@@ -642,40 +170,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "swapId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relations",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "[]",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"swapId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -683,31 +182,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -715,40 +194,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "returnId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateReturnInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"returnId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateReturnInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Return](../../entities/classes/entities.Return.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -760,67 +210,11 @@ the quantity that is requested to be returned.
#### Parameters
<ParameterTypes parameters={[
{
"name": "item",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)",
"description": "the line item to check has sufficient returnable\n quantity.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "quantity",
"type": "`number`",
"description": "the quantity that is requested to be returned.",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "additional",
"type": "`object`",
"description": "the quantity that is requested to be returned.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "additional.note",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "additional.reason_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"quantity","type":"`number`","description":"the quantity that is requested to be returned.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"additional","type":"`object`","description":"the quantity that is requested to be returned.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"item","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item to check has sufficient returnable\n quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional.note","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional.reason_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "DeepPartial",
"type": "DeepPartial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "a line item where the quantity is set to the requested\n return quantity.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"DeepPartial","type":"DeepPartial&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62;","optional":false,"defaultValue":"","description":"a line item where the quantity is set to the requested\n return quantity.","expandable":false,"children":[]}]} />
___
@@ -832,31 +226,11 @@ payment\_status must be captured.
#### Parameters
<ParameterTypes parameters={[
{
"name": "order",
"type": "[Order](../../entities/classes/entities.Order.mdx)",
"description": "the order to check statuses on",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"the order to check statuses on","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "void",
"type": "`void`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
#### Throws
@@ -868,28 +242,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ReturnService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ReturnService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.SalesChannelInventoryService.mdx
+13 -233
View File
@@ -10,87 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelLocationService_",
"type": "[SalesChannelLocationService](services.SalesChannelLocationService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"`IEventBusService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannelLocationService_","type":"[SalesChannelLocationService](services.SalesChannelLocationService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -100,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -118,17 +34,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "IInventoryService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"IInventoryService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -142,72 +48,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -217,40 +66,11 @@ Retrieves the available quantity of an item across all sales channel locations
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "Sales channel id",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inventoryItemId",
"type": "`string`",
"description": "Item id",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"Sales channel id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventoryItemId","type":"`string`","description":"Item id","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "available quantity of item across all sales channel locations",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;number&#62;","optional":false,"defaultValue":"","description":"available quantity of item across all sales channel locations","expandable":false,"children":[]}]} />
___
@@ -258,31 +78,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -290,28 +90,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "SalesChannelInventoryService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"SalesChannelInventoryService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.SalesChannelLocationService.mdx
+19 -308
View File
@@ -12,87 +12,13 @@ Service for managing the stock locations of sales channels
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelService_",
"type": "[SalesChannelService](services.SalesChannelService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"`IEventBusService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannelService_","type":"[SalesChannelService](services.SalesChannelService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -102,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -120,17 +36,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "IStockLocationService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"IStockLocationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -142,40 +48,11 @@ Associates a sales channel with a stock location.
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "The ID of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "locationId",
"type": "`string`",
"description": "The ID of the stock location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"The ID of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locationId","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves when the association has been created.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"A promise that resolves when the association has been created.","expandable":false,"children":[]}]} />
___
@@ -187,72 +64,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -262,31 +82,11 @@ Lists the stock locations associated with a sales channel.
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string` \\| `string`[]",
"description": "The ID of the sales channel.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string` \\| `string`[]","description":"The ID of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves with an array of location IDs.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string[]&#62;","optional":false,"defaultValue":"","description":"A promise that resolves with an array of location IDs.","expandable":false,"children":[]}]} />
___
@@ -296,31 +96,11 @@ Lists the sales channels associated with a stock location.
#### Parameters
<ParameterTypes parameters={[
{
"name": "locationId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"locationId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves with an array of sales channel IDs.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string[]&#62;","optional":false,"defaultValue":"","description":"A promise that resolves with an array of sales channel IDs.","expandable":false,"children":[]}]} />
___
@@ -330,40 +110,11 @@ Removes an association between a sales channel and a stock location.
#### Parameters
<ParameterTypes parameters={[
{
"name": "locationId",
"type": "`string`",
"description": "The ID of the stock location.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelId",
"type": "`string`",
"description": "The ID of the sales channel or undefined if all the sales channel will be affected.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"locationId","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannelId","type":"`string`","description":"The ID of the sales channel or undefined if all the sales channel will be affected.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "A promise that resolves when the association has been removed.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"A promise that resolves when the association has been removed.","expandable":false,"children":[]}]} />
___
@@ -371,31 +122,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -403,28 +134,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "SalesChannelLocationService",
"type": "`object`",
"description": "Service for managing the stock locations of sales channels",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"SalesChannelLocationService","type":"`object`","description":"Service for managing the stock locations of sales channels","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.SalesChannelService.mdx
+47 -542
View File
@@ -10,132 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBusService_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "salesChannelRepository_",
"type": "Repository&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "storeService_",
"type": "[StoreService](services.StoreService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"sales_channel.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"sales_channel.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"sales_channel.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBusService_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"salesChannelRepository_","type":"Repository&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeService_","type":"[StoreService](services.StoreService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.deleted\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"sales_channel.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -145,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -167,40 +38,11 @@ Add a batch of product to a sales channel
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "The id of the sales channel on which to add the products",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "The products ids to attach to the sales channel",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"The id of the sales channel on which to add the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to attach to the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the sales channel on which the products have been added",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel on which the products have been added","expandable":false,"children":[]}]} />
___
@@ -212,72 +54,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -290,31 +75,11 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateSalesChannelInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateSalesChannelInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created channel",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the created channel","expandable":false,"children":[]}]} />
___
@@ -324,17 +89,7 @@ Creates a default sales channel, if this does not already exist.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the sales channel",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
___
@@ -346,75 +101,40 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "the id of the sales channel to delete",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"the id of the sales channel to delete","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### list
Lists sales channels based on the provided parameters.
#### Parameters
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]&#62;","optional":false,"defaultValue":"","description":"an array containing the sales channels","expandable":false,"children":[]}]} />
___
### listAndCount
Lists sales channels based on the provided parameters and includes the count of
Lists sales channels based on the provided parameters and include the count of
sales channels that match the query.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[QuerySelector](../../medusa/types/medusa.QuerySelector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "an array containing the sales channels as\n the first element and the total count of sales channels that matches the query\n as the second element.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"an array containing the sales channels as\n the first element and the total count of sales channels that matches the query\n as the second element.","expandable":false,"children":[]}]} />
___
@@ -424,31 +144,11 @@ List all product ids that belongs to the sales channels ids
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;object&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -458,40 +158,11 @@ Remove a batch of product from a sales channel
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "The id of the sales channel on which to remove the products",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string`[]",
"description": "The products ids to remove from the sales channel",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"The id of the sales channel on which to remove the products","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string`[]","description":"The products ids to remove from the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the sales channel on which the products have been removed",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel on which the products have been removed","expandable":false,"children":[]}]} />
___
@@ -501,40 +172,11 @@ Retrieve a SalesChannel by id
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "id of the channel to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "SC config\n This feature is under development and may change in the future.\nTo use this feature please enable the corresponding feature flag in your medusa backend project.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"id of the channel to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"SC config\n This feature is under development and may change in the future.\nTo use this feature please enable the corresponding feature flag in your medusa backend project.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "a sales channel",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"a sales channel","expandable":false,"children":[]}]} />
___
@@ -544,40 +186,11 @@ Find a sales channel by name.
#### Parameters
<ParameterTypes parameters={[
{
"name": "name",
"type": "`string`",
"description": "of the sales channel",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "find config",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"of the sales channel","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"find config","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;unknown&#62;",
"optional": false,
"defaultValue": "",
"description": "a sales channel with matching name",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;unknown&#62;","optional":false,"defaultValue":"","description":"a sales channel with matching name","expandable":false,"children":[]}]} />
___
@@ -587,17 +200,7 @@ Retrieves the default sales channel.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the sales channel",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
___
@@ -607,40 +210,11 @@ A generic retrieve used to find a sales channel by different attributes.
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "SC selector",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"description": "find config",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"SC selector","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","description":"find config","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "a single SC matching the query or throws",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"a single SC matching the query or throws","expandable":false,"children":[]}]} />
___
@@ -648,31 +222,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -680,40 +234,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "salesChannelId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "Partial&#60;CreateSalesChannelInput&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"salesChannelId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;CreateSalesChannelInput&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -721,28 +246,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "SalesChannelService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"SalesChannelService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.SearchService.mdx
+19 -317
View File
@@ -10,60 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "isDefault",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "logger_",
"type": "[Logger](../../medusa/types/medusa.Logger.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options_",
"type": "`Record<string, unknown>`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"isDefault","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../medusa/types/medusa.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options_","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -73,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Record",
"type": "`Record<string, unknown>`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Record","type":"`Record<string, unknown>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -93,49 +36,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "documents",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"documents","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -143,40 +48,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -184,31 +60,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -216,40 +72,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "document_id",
"type": "`string` \\| `number`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"document_id","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -257,31 +84,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -289,49 +96,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "documents",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "type",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"documents","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -339,49 +108,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "query",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;object&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -389,37 +120,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "indexName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "settings",
"type": "`unknown`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"indexName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"settings","type":"`unknown`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ShippingOptionService.mdx
+44 -736
View File
@@ -12,123 +12,13 @@ Provides layer to manipulate profiles.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "methodRepository_",
"type": "Repository&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionRepository_",
"type": "Repository&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "providerService_",
"type": "[FulfillmentProviderService](services.FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionService_",
"type": "[RegionService](services.RegionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requirementRepository_",
"type": "Repository&#60;[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"methodRepository_","type":"Repository&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionRepository_","type":"Repository&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerService_","type":"[FulfillmentProviderService](services.FulfillmentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionService_","type":"[RegionService](services.RegionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requirementRepository_","type":"Repository&#60;[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -138,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -161,40 +41,11 @@ is allowed.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the option to add the requirement to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "requirement",
"type": "[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)",
"description": "the requirement for the option.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`string`","description":"the option to add the requirement to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requirement","type":"[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)","description":"the requirement for the option.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
___
@@ -206,72 +57,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -283,31 +77,11 @@ defaults to false.
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateShippingOptionInput`",
"description": "the data to create shipping options",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateShippingOptionInput`","description":"the data to create shipping options","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
___
@@ -317,49 +91,11 @@ Creates a shipping method for a given cart.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the id of the option to use for the method.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "the optional provider data to use.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`CreateShippingMethodDto`",
"description": "the cart to create the shipping method for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`string`","description":"the id of the option to use for the method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"the optional provider data to use.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`CreateShippingMethodDto`","description":"the cart to create the shipping method for.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the resulting shipping method.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;","optional":false,"defaultValue":"","description":"the resulting shipping method.","expandable":false,"children":[]}]} />
___
@@ -369,31 +105,11 @@ Deletes a profile with a given profile id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the id of the profile to delete. Must be\n castable as an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`string`","description":"the id of the profile to delete. Must be\n castable as an ObjectId","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
___
@@ -403,31 +119,11 @@ Removes a given shipping method
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethods",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx) \\| [ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]",
"description": "the shipping method to remove",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"shippingMethods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx) \\| [ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"the shipping method to remove","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "removed shipping methods",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]&#62;","optional":false,"defaultValue":"","description":"removed shipping methods","expandable":false,"children":[]}]} />
___
@@ -439,49 +135,11 @@ price type "calculated".
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "the shipping option to retrieve the price\n for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`Record<string, unknown>`",
"description": "the shipping data to retrieve the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "`undefined` \\| [Order](../../entities/classes/entities.Order.mdx) \\| [Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the context in which the price should be\n retrieved.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"the shipping option to retrieve the price\n for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"the shipping data to retrieve the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"`undefined` \\| [Order](../../entities/classes/entities.Order.mdx) \\| [Cart](../../entities/classes/entities.Cart.mdx)","description":"the context in which the price should be\n retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;number&#62;",
"optional": false,
"defaultValue": "",
"description": "the price of the shipping option.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;number&#62;","optional":false,"defaultValue":"","description":"the price of the shipping option.","expandable":false,"children":[]}]} />
___
@@ -489,40 +147,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"description": "config object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","description":"config object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -530,40 +159,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"description": "config object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","description":"config object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -573,31 +173,11 @@ Removes a requirement from a shipping option
#### Parameters
<ParameterTypes parameters={[
{
"name": "requirementId",
"type": "`any`",
"description": "the id of the requirement to remove",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"requirementId","type":"`any`","description":"the id of the requirement to remove","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
___
@@ -608,40 +188,11 @@ Throws in case of DB Error and if profile was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`any`",
"description": "the id of the profile to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"description": "the options to get a profile",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`any`","description":"the id of the profile to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","description":"the options to get a profile","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the profile document.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the profile document.","expandable":false,"children":[]}]} />
___
@@ -649,31 +200,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -685,40 +216,11 @@ will throw errors if metadata or product updates are attempted.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the id of the option. Must be a string that\n can be casted to an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateShippingOptionInput`",
"description": "an object with the update values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`string`","description":"the id of the option. Must be a string that\n can be casted to an ObjectId","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateShippingOptionInput`","description":"an object with the update values.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the update result.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
___
@@ -729,40 +231,11 @@ and its methods should be copied to an order/swap entity.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the id of the shipping method to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`ShippingMethodUpdate`",
"description": "the values to update the method with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the id of the shipping method to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`ShippingMethodUpdate`","description":"the values to update the method with","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| [ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the resulting shipping method",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;undefined \\| [ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)&#62;","optional":false,"defaultValue":"","description":"the resulting shipping method","expandable":false,"children":[]}]} />
___
@@ -770,40 +243,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionIds",
"type": "`string` \\| `string`[]",
"description": "ID or IDs of the shipping options to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "profileId",
"type": "`string`",
"description": "Shipping profile ID to update the shipping options with",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionIds","type":"`string` \\| `string`[]","description":"ID or IDs of the shipping options to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profileId","type":"`string`","description":"Shipping profile ID to update the shipping options with","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "updated shipping options",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;","optional":false,"defaultValue":"","description":"updated shipping options","expandable":false,"children":[]}]} />
___
@@ -811,40 +255,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx) \\| `CreateShippingOptionInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priceInput",
"type": "`ValidatePriceTypeAndAmountInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx) \\| `CreateShippingOptionInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priceInput","type":"`ValidatePriceTypeAndAmountInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;CreateShippingOptionInput \\| Omit&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx), \"beforeInsert\"&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;CreateShippingOptionInput \\| Omit&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx), \"beforeInsert\"&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -856,40 +271,11 @@ match, or when the shipping option requirements are not satisfied.
#### Parameters
<ParameterTypes parameters={[
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "the option object to check",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cart",
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart object to check against",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"the option object to check","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart object to check against","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;null \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the validated shipping option",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;null \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)&#62;","optional":false,"defaultValue":"","description":"the validated shipping option","expandable":false,"children":[]}]} />
___
@@ -899,40 +285,11 @@ Validates a shipping option price
#### Parameters
<ParameterTypes parameters={[
{
"name": "priceType",
"type": "[ShippingOptionPriceType](../../entities/enums/entities.ShippingOptionPriceType.mdx)",
"description": "the price to validate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "option",
"type": "[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)",
"description": "the option to validate against",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"priceType","type":"[ShippingOptionPriceType](../../entities/enums/entities.ShippingOptionPriceType.mdx)","description":"the price to validate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"the option to validate against","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOptionPriceType](../../entities/enums/entities.ShippingOptionPriceType.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the validated price",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOptionPriceType](../../entities/enums/entities.ShippingOptionPriceType.mdx)&#62;","optional":false,"defaultValue":"","description":"the validated price","expandable":false,"children":[]}]} />
___
@@ -942,40 +299,11 @@ Validates a requirement
#### Parameters
<ParameterTypes parameters={[
{
"name": "requirement",
"type": "[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)",
"description": "the requirement to validate",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionId",
"type": "`undefined` \\| `string`",
"description": "the id to validate the requirement",
"optional": false,
"defaultValue": "undefined",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"requirement","type":"`ValidateRequirementTypeInput`","description":"the requirement to validate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionId","type":"`undefined` \\| `string`","description":"the id to validate the requirement","optional":false,"defaultValue":"undefined","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "a validated shipping requirement",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)&#62;","optional":false,"defaultValue":"","description":"a validated shipping requirement","expandable":false,"children":[]}]} />
___
@@ -983,28 +311,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ShippingOptionService",
"type": "`object`",
"description": "Provides layer to manipulate profiles.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ShippingOptionService","type":"`object`","description":"Provides layer to manipulate profiles.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.ShippingProfileService.mdx
+40 -620
View File
@@ -14,123 +14,13 @@ Provides layer to manipulate profiles.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customShippingOptionService_",
"type": "[CustomShippingOptionService](services.CustomShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productService_",
"type": "[ProductService](services.ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingProfileRepository_",
"type": "Repository&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customShippingOptionService_","type":"[CustomShippingOptionService](services.CustomShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productRepository_","type":"Repository&#60;[Product](../../entities/classes/entities.Product.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productService_","type":"[ProductService](services.ProductService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingOptionService_","type":"[ShippingOptionService](services.ShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingProfileRepository_","type":"Repository&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -140,17 +30,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -160,40 +40,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productId","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
#### Deprecated
@@ -207,40 +58,11 @@ Adds a product or an array of products to the profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "the ID of the product or multiple products to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"the profile to add the products to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productId","type":"`string` \\| `string`[]","description":"the ID of the product or multiple products to add.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
___
@@ -251,40 +73,11 @@ fulfill the products in the products field.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the profile to apply the shipping option to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionId",
"type": "`string` \\| `string`[]",
"description": "the ID of the option or multiple options to add to the profile",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"the profile to apply the shipping option to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionId","type":"`string` \\| `string`[]","description":"the ID of the option or multiple options to add to the profile","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the model update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the model update operation","expandable":false,"children":[]}]} />
___
@@ -296,72 +89,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -371,31 +107,11 @@ Creates a new shipping profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profile",
"type": "`CreateShippingProfile`",
"description": "the shipping profile to create from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profile","type":"`CreateShippingProfile`","description":"the shipping profile to create from","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
___
@@ -405,17 +121,7 @@ Creates a default shipping profile, if this does not already exist.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the shipping profile","expandable":false,"children":[]}]} />
___
@@ -426,17 +132,7 @@ exists.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the shipping profile","expandable":false,"children":[]}]} />
___
@@ -446,31 +142,11 @@ Deletes a profile with a given profile id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile to delete. Must be\n castable as an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"the id of the profile to delete. Must be\n castable as an ObjectId","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
___
@@ -481,31 +157,11 @@ validates all options that are available for the cart.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "`any`",
"description": "the cart object to find shipping options for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cart","type":"`any`","description":"the cart object to find shipping options for","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of the available shipping options",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;","optional":false,"defaultValue":"","description":"a list of the available shipping options","expandable":false,"children":[]}]} />
___
@@ -513,31 +169,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Map&#60;string, string&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Map&#60;string, string&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -547,31 +183,11 @@ Returns a list of all the productIds in the cart.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart to extract products from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart to extract products from","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of product ids",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string[]&#62;","optional":false,"defaultValue":"","description":"a list of product ids","expandable":false,"children":[]}]} />
___
@@ -579,40 +195,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","description":"the query object for find","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","description":"the config object for find","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -622,40 +209,11 @@ Removes a product or an array of products from the profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`null` \\| `string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "the ID of the product or multiple products to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`null` \\| `string`","description":"the profile to add the products to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productId","type":"`string` \\| `string`[]","description":"the ID of the product or multiple products to add.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
___
@@ -666,40 +224,11 @@ Throws in case of DB Error and if profile was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "options opf the query.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"the id of the profile to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","description":"options opf the query.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the profile document.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the profile document.","expandable":false,"children":[]}]} />
___
@@ -707,17 +236,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -725,31 +244,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;object&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -759,17 +258,7 @@ Retrieves the default gift card profile
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile for gift cards",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"the shipping profile for gift cards","expandable":false,"children":[]}]} />
___
@@ -777,31 +266,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -813,40 +282,11 @@ will throw errors if metadata or product updates are attempted.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile. Must be a string that\n can be casted to an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateShippingProfile`",
"description": "an object with the update values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"profileId","type":"`string`","description":"the id of the profile. Must be a string that\n can be casted to an ObjectId","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateShippingProfile`","description":"an object with the update values.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the update result.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
___
@@ -854,28 +294,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ShippingProfileService",
"type": "`object`",
"description": "Provides layer to manipulate profiles.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ShippingProfileService","type":"`object`","description":"Provides layer to manipulate profiles.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.StagedJobService.mdx
+16 -248
View File
@@ -12,78 +12,13 @@ Provides layer to manipulate users.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`StagedJobServiceProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`StagedJobServiceProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "stagedJobRepository_",
"type": "Repository&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stagedJobRepository_","type":"Repository&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -93,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -117,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -190,31 +58,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "EmitData&#60;unknown&#62; \\| EmitData&#60;unknown&#62;[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"EmitData&#60;unknown&#62; \\| EmitData&#60;unknown&#62;[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -222,31 +70,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "stagedJobIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"stagedJobIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -254,31 +82,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -286,31 +94,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -318,28 +106,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "StagedJobService",
"type": "`object`",
"description": "Provides layer to manipulate users.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"StagedJobService","type":"`object`","description":"Provides layer to manipulate users.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.StoreService.mdx
+21 -321
View File
@@ -12,96 +12,13 @@ Provides layer to manipulate store settings.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currencyRepository_",
"type": "Repository&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "storeRepository_",
"type": "Repository&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currencyRepository_","type":"Repository&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeRepository_","type":"Repository&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -111,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -133,31 +40,11 @@ Add a currency to the store
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "3 character ISO currency code",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"3 character ISO currency code","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "result after update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","optional":false,"defaultValue":"","description":"result after update","expandable":false,"children":[]}]} />
___
@@ -169,72 +56,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -244,17 +74,7 @@ Creates a store if it doesn't already exist.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The store.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","optional":false,"defaultValue":"","description":"The store.","expandable":false,"children":[]}]} />
___
@@ -262,31 +82,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Partial",
"type": "Partial&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Partial","type":"Partial&#60;[Currency](../../entities/classes/entities.Currency.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -296,31 +96,11 @@ Removes a currency from the store
#### Parameters
<ParameterTypes parameters={[
{
"name": "code",
"type": "`string`",
"description": "3 character ISO currency code",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"3 character ISO currency code","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;any&#62;",
"optional": false,
"defaultValue": "",
"description": "result after update",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;any&#62;","optional":false,"defaultValue":"","description":"result after update","expandable":false,"children":[]}]} />
___
@@ -330,31 +110,11 @@ Retrieve the store settings. There is always a maximum of one store.
#### Parameters
<ParameterTypes parameters={[
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"description": "The config object from which the query will be built",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","description":"The config object from which the query will be built","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the store",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","optional":false,"defaultValue":"","description":"the store","expandable":false,"children":[]}]} />
___
@@ -362,31 +122,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -396,31 +136,11 @@ Updates a store
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`UpdateStoreInput`",
"description": "an object with the update values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`UpdateStoreInput`","description":"an object with the update values.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the update result.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Store](../../entities/classes/entities.Store.mdx)&#62;","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
___
@@ -428,28 +148,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "StoreService",
"type": "`object`",
"description": "Provides layer to manipulate store settings.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"StoreService","type":"`object`","description":"Provides layer to manipulate store settings.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.StrategyResolverService.mdx
+12 -204
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"container","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "container",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -188,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "type",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "AbstractBatchJobStrategy",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"AbstractBatchJobStrategy","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -220,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -252,28 +80,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "StrategyResolverService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"StrategyResolverService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.SwapService.mdx
+44 -961
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.SystemPaymentProviderService.mdx
+30 -402
View File
@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "identifier",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"system\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"identifier","type":"`string`","description":"","optional":false,"defaultValue":"\"system\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -188,31 +56,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -220,31 +68,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -252,31 +80,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -284,31 +92,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -316,31 +104,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -348,31 +116,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -380,31 +128,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -412,31 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -444,31 +152,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -476,31 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -508,31 +176,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "_",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"_","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Record&#60;string, unknown&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Record&#60;string, unknown&#62;&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -540,28 +188,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "SystemPaymentProviderService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"SystemPaymentProviderService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.TaxProviderService.mdx
+35 -583
View File
@@ -12,132 +12,13 @@ Finds tax providers and assists in tax related operations.
### Parameters
<ParameterTypes parameters={[
{
"name": "container",
"type": "AwilixContainer&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"container","type":"AwilixContainer&#60;any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "cacheService_",
"type": "`ICacheService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "container_",
"type": "AwilixContainer&#60;any&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "`IEventBusService`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "smTaxLineRepo_",
"type": "Repository&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxLineRepo_",
"type": "Repository&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxProviderRepo_",
"type": "Repository&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxRateService_",
"type": "[TaxRateService](services.TaxRateService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cacheService_","type":"`ICacheService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container_","type":"AwilixContainer&#60;any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"`IEventBusService`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"smTaxLineRepo_","type":"Repository&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxLineRepo_","type":"Repository&#60;[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxProviderRepo_","type":"Repository&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxRateService_","type":"[TaxRateService](services.TaxRateService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -147,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -171,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -244,31 +58,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "itemIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"itemIds","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -276,31 +70,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "cartId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cartId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -311,40 +85,11 @@ for return shipping methods.
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethod",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
"description": "the shipping method to create tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"shippingMethod","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)","description":"the shipping method to create tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created tax lines",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} />
___
@@ -354,40 +99,11 @@ Persists the tax lines relevant for an order to the database.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cartOrLineItems",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[] \\| [Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart or line items to create tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"cartOrLineItems","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[] \\| [Cart](../../entities/classes/entities.Cart.mdx)","description":"the cart or line items to create tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created tax lines",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} />
___
@@ -397,40 +113,11 @@ The cache key to get cache hits by.
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "the entity id to cache",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionId",
"type": "`string`",
"description": "the region id to cache",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"the entity id to cache","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionId","type":"`string`","description":"the region id to cache","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "the cache key to use for the id set",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"the cache key to use for the id set","expandable":false,"children":[]}]} />
___
@@ -441,40 +128,11 @@ calls.
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "`RegionDetails`",
"description": "the region to get configured rates for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"`RegionDetails`","description":"the region to get configured rates for.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Map&#60;string, [TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "the tax rates configured for the shipping option. A map by product id",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;Map&#60;string, [TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;&#62;","optional":false,"defaultValue":"","description":"the tax rates configured for the shipping option. A map by product id","expandable":false,"children":[]}]} />
___
@@ -485,40 +143,11 @@ between calls.
#### Parameters
<ParameterTypes parameters={[
{
"name": "optionId",
"type": "`string`",
"description": "the option id of the shipping method.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "regionDetails",
"type": "`RegionDetails`",
"description": "the region to get configured rates for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"optionId","type":"`string`","description":"the option id of the shipping method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regionDetails","type":"`RegionDetails`","description":"the region to get configured rates for.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the tax rates configured for the shipping option.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the tax rates configured for the shipping option.","expandable":false,"children":[]}]} />
___
@@ -530,40 +159,11 @@ persist the tax lines to the DB layer.
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingMethod",
"type": "[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)",
"description": "the shipping method to get tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"shippingMethod","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)","description":"the shipping method to get tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the computed tax lines",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} />
___
@@ -577,40 +177,11 @@ wish to persist the tax lines to the DB layer.
#### Parameters
<ParameterTypes parameters={[
{
"name": "lineItems",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "the cart or order to get tax lines for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "the calculation context to get tax lines by",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"lineItems","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"the cart or order to get tax lines for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"the calculation context to get tax lines by","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the computed tax lines",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]&#62;","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} />
___
@@ -620,40 +191,11 @@ Return a map of tax lines for line items and shipping methods
#### Parameters
<ParameterTypes parameters={[
{
"name": "items",
"type": "[LineItem](../../entities/classes/entities.LineItem.mdx)[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculationContext",
"type": "[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"calculationContext","type":"[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TaxLinesMaps&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TaxLinesMaps&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -661,17 +203,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -679,31 +211,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "providers",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"providers","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -713,31 +225,11 @@ Retrieves the relevant tax provider for the given region.
#### Parameters
<ParameterTypes parameters={[
{
"name": "region",
"type": "[Region](../../entities/classes/entities.Region.mdx)",
"description": "the region to get tax provider for.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"the region to get tax provider for.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ITaxService",
"type": "`object`",
"description": "Interface to be implemented by tax provider plugins. The interface defines a\nsingle method `getTaxLines` that returns numerical rates to apply to line\nitems and shipping methods.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ITaxService","type":"`object`","description":"Interface to be implemented by tax provider plugins. The interface defines a\nsingle method `getTaxLines` that returns numerical rates to apply to line\nitems and shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -745,31 +237,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -777,28 +249,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "TaxProviderService",
"type": "`object`",
"description": "Finds tax providers and assists in tax related operations.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TaxProviderService","type":"`object`","description":"Finds tax providers and assists in tax related operations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.TaxRateService.mdx
+38 -643
View File
@@ -10,105 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`Object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.productService","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.productTypeService","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.shippingOptionService","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__namedParameters.taxRateRepository","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productService_",
"type": "[ProductService](services.ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productTypeService_",
"type": "[ProductTypeService](services.ProductTypeService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "taxRateRepository_",
"type": "Repository&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productService_","type":"[ProductService](services.ProductService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productTypeService_","type":"[ProductTypeService](services.ProductTypeService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingOptionService_","type":"[ShippingOptionService](services.ShippingOptionService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"taxRateRepository_","type":"Repository&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -118,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -138,49 +36,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "replace",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"replace","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx) \\| [ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx) \\| [ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -188,49 +48,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productTypeIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "replace",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productTypeIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"replace","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ProductTypeTaxRate](../../entities/classes/entities.ProductTypeTaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ProductTypeTaxRate](../../entities/classes/entities.ProductTypeTaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -238,49 +60,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "replace",
"type": "`boolean`",
"description": "",
"optional": false,
"defaultValue": "false",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"replace","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingTaxRate](../../entities/classes/entities.ShippingTaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[ShippingTaxRate](../../entities/classes/entities.ShippingTaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -292,72 +76,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -365,31 +92,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`CreateTaxRateInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`CreateTaxRateInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -397,31 +104,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -429,40 +116,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`FilterableTaxRateProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`FilterableTaxRateProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -470,40 +128,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`FilterableTaxRateProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`FilterableTaxRateProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[[TaxRate](../../entities/classes/entities.TaxRate.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[TaxRate](../../entities/classes/entities.TaxRate.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -511,40 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "productId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`TaxRateListByConfig`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"productId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`TaxRateListByConfig`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -552,31 +152,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "shippingOptionId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"shippingOptionId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -584,40 +164,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -625,40 +176,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "typeIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -666,40 +188,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"optionIds","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -707,40 +200,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "taxRateId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"taxRateId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -748,31 +212,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -780,40 +224,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "data",
"type": "`UpdateTaxRateInput`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`UpdateTaxRateInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[TaxRate](../../entities/classes/entities.TaxRate.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -821,28 +236,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "TaxRateService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TaxRateService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.TokenService.mdx
+6 -93
View File
@@ -10,42 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "configModule_",
"type": "[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "RESOLUTION_KEY",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"configModule_","type":"[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RESOLUTION_KEY","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -55,40 +26,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "`string` \\| `object` \\| `Buffer`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`SignOptions`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"data","type":"`string` \\| `object` \\| `Buffer`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`SignOptions`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string",
"type": "`string`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -96,37 +38,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "token",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "`VerifyOptions`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`VerifyOptions`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "string \\| Jwt \\| JwtPayload",
"type": "`string` \\| `Jwt` \\| `JwtPayload`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"string \\| Jwt \\| JwtPayload","type":"`string` \\| `Jwt` \\| `JwtPayload`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
www/apps/docs/content/references/services/classes/services.TotalsService.mdx
+56 -976
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/services/classes/services.UserService.mdx
+30 -537
View File
@@ -12,150 +12,13 @@ Provides layer to manipulate users.
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`UserServiceProps`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`UserServiceProps`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "analyticsConfigService_",
"type": "[AnalyticsConfigService](services.AnalyticsConfigService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "eventBus_",
"type": "[EventBusService](services.EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "userRepository_",
"type": "Repository&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "Events.CREATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"user.created\"",
"expandable": false,
"children": []
},
{
"name": "Events.DELETED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"user.deleted\"",
"expandable": false,
"children": []
},
{
"name": "Events.PASSWORD_RESET",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"user.password_reset\"",
"expandable": false,
"children": []
},
{
"name": "Events.UPDATED",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "\"user.updated\"",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"analyticsConfigService_","type":"[AnalyticsConfigService](services.AnalyticsConfigService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"featureFlagRouter_","type":"`FlagRouter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"userRepository_","type":"Repository&#60;[User](../../entities/classes/entities.User.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.created\"","expandable":false,"children":[]},{"name":"Events.DELETED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.deleted\"","expandable":false,"children":[]},{"name":"Events.PASSWORD_RESET","type":"`string`","description":"","optional":false,"defaultValue":"\"user.password_reset\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"user.updated\"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -165,17 +28,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -189,72 +42,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -265,40 +61,11 @@ Fails if email is not a valid format.
#### Parameters
<ParameterTypes parameters={[
{
"name": "user",
"type": "`CreateUserInput`",
"description": "the user to create",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "password",
"type": "`string`",
"description": "user's password to hash",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"user","type":"`CreateUserInput`","description":"the user to create","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"user's password to hash","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of create",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of create","expandable":false,"children":[]}]} />
___
@@ -308,31 +75,11 @@ Deletes a user from a given user id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "the id of the user to delete. Must be\n castable as an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"the id of the user to delete. Must be\n castable as an ObjectId","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
___
@@ -346,31 +93,11 @@ is always 15 minutes.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "the id of the user to reset password for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"the id of the user to reset password for","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "the generated JSON web token",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string&#62;","optional":false,"defaultValue":"","description":"the generated JSON web token","expandable":false,"children":[]}]} />
___
@@ -380,31 +107,11 @@ Hashes a password
#### Parameters
<ParameterTypes parameters={[
{
"name": "password",
"type": "`string`",
"description": "the value to hash",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"password","type":"`string`","description":"the value to hash","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string&#62;",
"optional": false,
"defaultValue": "",
"description": "hashed password",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;string&#62;","optional":false,"defaultValue":"","description":"hashed password","expandable":false,"children":[]}]} />
___
@@ -412,40 +119,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "`FilterableUserProps`",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "`object`",
"description": "the configuration object for the query",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"selector","type":"`FilterableUserProps`","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`object`","description":"the configuration object for the query","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
___
@@ -456,40 +134,11 @@ Throws in case of DB Error and if user was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "the id of the user to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"description": "query configs",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"the id of the user to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[User](../../entities/classes/entities.User.mdx)&#62;","description":"query configs","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the user document.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
___
@@ -500,40 +149,11 @@ Throws in case of DB Error and if user was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "apiToken",
"type": "`string`",
"description": "the token of the user to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "relations",
"type": "`string`[]",
"description": "relations to include with the user.",
"optional": false,
"defaultValue": "[]",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"apiToken","type":"`string`","description":"the token of the user to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"relations to include with the user.","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the user document.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
___
@@ -544,40 +164,11 @@ Throws in case of DB Error and if user was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "email",
"type": "`string`",
"description": "the email of the user to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"description": "query config",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"email","type":"`string`","description":"the email of the user to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[User](../../entities/classes/entities.User.mdx)&#62;","description":"query config","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the user document.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
___
@@ -589,40 +180,11 @@ password does not work.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "the userId to set password for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "password",
"type": "`string`",
"description": "the old password to set",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"the userId to set password for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"the old password to set","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
___
@@ -630,31 +192,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -664,40 +206,11 @@ Updates a user.
#### Parameters
<ParameterTypes parameters={[
{
"name": "userId",
"type": "`string`",
"description": "id of the user to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateUserInput`",
"description": "the values to be updated on the user",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"userId","type":"`string`","description":"id of the user to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"`UpdateUserInput`","description":"the values to be updated on the user","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of create",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[User](../../entities/classes/entities.User.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of create","expandable":false,"children":[]}]} />
___
@@ -705,28 +218,8 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "UserService",
"type": "`object`",
"description": "Provides layer to manipulate users.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"UserService","type":"`object`","description":"Provides layer to manipulate users.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />