chore(docs): Generated JS Client Reference (#5434)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-20 11:47:19 +00:00
parent 8203dec3e2
commit 39de54e2e8
96 changed files with 12353 additions and 525 deletions
@@ -74,7 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -137,7 +137,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -192,7 +192,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -263,7 +263,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -326,7 +326,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -515,7 +515,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -578,7 +578,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -649,7 +649,7 @@ ___
      {
        "name": "AdminDiscountConditionsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount condition details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -704,7 +704,7 @@ ___
      {
        "name": "AdminDiscountsListRes",
        "type": "[`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[]  }",
-        "description": "",
+        "description": "#### Schema AdminDiscountsListRes type: object x-expanded-relations: field: discounts relations: - parent_discount - regions - rule - rule.conditions required: - discounts - count - offset - limit properties: discounts: type: array items: $ref: \"#/components/schemas/Discount\" count: type: integer description: The total number of items available offset: type: integer description: The number of discounts skipped when retrieving the discounts. limit: type: integer description: The number of items per page",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -767,7 +767,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -822,7 +822,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -877,7 +877,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -940,7 +940,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -1019,7 +1019,7 @@ ___
      {
        "name": "AdminDiscountsRes",
        "type": "`object`",
-        "description": "",
+        "description": "#### Schema Discount details.",
        "optional": false,
        "defaultValue": "",
        "children": []
@@ -115,6 +115,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 - [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-1.mdx)
 - [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-2.mdx)
 - [ShippingMethod](../../internal/classes/admin_discounts.internal.ShippingMethod-3.mdx)
+- [Socket](../../internal/classes/admin_discounts.internal.Socket.mdx)
 - [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress.mdx)
 - [StockLocationAddress](../../internal/classes/admin_discounts.internal.StockLocationAddress-1.mdx)
 - [Stream](../../internal/classes/admin_discounts.internal.Stream.mdx)
@@ -125,6 +126,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 ## Interfaces

+- [AddressInfo](../../internal/interfaces/admin_discounts.internal.AddressInfo.mdx)
 - [ArrayBufferView](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx)
 - [ArrayLike](../../internal/interfaces/admin_discounts.internal.ArrayLike.mdx)
 - [AsyncGenerator](../../internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx)
@@ -136,8 +138,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 - [Buffer](../../internal/interfaces/admin_discounts.internal.Buffer.mdx)
 - [BufferConstructor](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx)
 - [CallSite](../../internal/interfaces/admin_discounts.internal.CallSite.mdx)
+- [ConnectOpts](../../internal/interfaces/admin_discounts.internal.ConnectOpts.mdx)
 - [CreateNoteInput](../../internal/interfaces/admin_discounts.internal.CreateNoteInput.mdx)
 - [CreateUserInput](../../internal/interfaces/admin_discounts.internal.CreateUserInput.mdx)
+- [Dict](../../internal/interfaces/admin_discounts.internal.Dict.mdx)
 - [DuplexOptions](../../internal/interfaces/admin_discounts.internal.DuplexOptions.mdx)
 - [ErrnoException](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx)
 - [Error](../../internal/interfaces/admin_discounts.internal.Error.mdx)
@@ -152,6 +156,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 - [ISearchService](../../internal/interfaces/admin_discounts.internal.ISearchService.mdx)
 - [IStockLocationService](../../internal/interfaces/admin_discounts.internal.IStockLocationService.mdx)
 - [ITransactionBaseService](../../internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx)
+- [IncomingHttpHeaders](../../internal/interfaces/admin_discounts.internal.IncomingHttpHeaders.mdx)
+- [IpcSocketConnectOpts](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx)
 - [Iterable](../../internal/interfaces/admin_discounts.internal.Iterable.mdx)
 - [IterableIterator](../../internal/interfaces/admin_discounts.internal.IterableIterator.mdx)
 - [Iterator](../../internal/interfaces/admin_discounts.internal.Iterator.mdx)
@@ -160,8 +166,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 - [JoinerServiceConfig](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx)
 - [JoinerServiceConfigAlias](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfigAlias.mdx)
 - [Logger](../../internal/interfaces/admin_discounts.internal.Logger.mdx)
+- [LookupOneOptions](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx)
+- [LookupOptions](../../internal/interfaces/admin_discounts.internal.LookupOptions.mdx)
 - [NumericalComparisonOperator](../../internal/interfaces/admin_discounts.internal.NumericalComparisonOperator.mdx)
 - [Object](../../internal/interfaces/admin_discounts.internal.Object.mdx)
+- [OnReadOpts](../../internal/interfaces/admin_discounts.internal.OnReadOpts.mdx)
 - [PromiseLike](../../internal/interfaces/admin_discounts.internal.PromiseLike.mdx)
 - [QueuingStrategy](../../internal/interfaces/admin_discounts.internal.QueuingStrategy.mdx)
 - [QueuingStrategySize](../../internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx)
@@ -179,9 +188,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 - [ReadableWritablePair](../../internal/interfaces/admin_discounts.internal.ReadableWritablePair.mdx)
 - [SharedArrayBuffer](../../internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx)
 - [SharedArrayBufferConstructor](../../internal/interfaces/admin_discounts.internal.SharedArrayBufferConstructor.mdx)
+- [SocketConstructorOpts](../../internal/interfaces/admin_discounts.internal.SocketConstructorOpts.mdx)
 - [StaticEventEmitterOptions](../../internal/interfaces/admin_discounts.internal.StaticEventEmitterOptions.mdx)
 - [StreamPipeOptions](../../internal/interfaces/admin_discounts.internal.StreamPipeOptions.mdx)
 - [StringComparisonOperator](../../internal/interfaces/admin_discounts.internal.StringComparisonOperator.mdx)
+- [TcpSocketConnectOpts](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx)
 - [TransformOptions](../../internal/interfaces/admin_discounts.internal.TransformOptions.mdx)
 - [UnderlyingByteSource](../../internal/interfaces/admin_discounts.internal.UnderlyingByteSource.mdx)
 - [UnderlyingSink](../../internal/interfaces/admin_discounts.internal.UnderlyingSink.mdx)
@@ -8783,6 +8794,60 @@ ___

 ___

+### LookupFunction
+
+Ƭ **LookupFunction**: (`hostname`: `string`, `options`: [`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx), `callback`: (`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `address`: `string`, `family`: `number`) => `void`) => `void`
+
+#### Type declaration
+
+▸ (`hostname`, `options`, `callback`): `void`
+
+##### Parameters
+
+<ParameterTypes parameters={[
+  {
+    "name": "hostname",
+    "type": "`string`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "options",
+    "type": "[`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx)",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  },
+  {
+    "name": "callback",
+    "type": "(`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \\| ``null``, `address`: `string`, `family`: `number`) => `void`",
+    "description": "",
+    "optional": false,
+    "defaultValue": "",
+    "children": []
+  }
+]} />
+
+##### Returns
+
+`void`
+
+<ParameterTypes parameters={[
+  {
+    "name": "void",
+    "type": "`void`",
+    "optional": true,
+    "defaultValue": "",
+    "description": "",
+    "children": []
+  }
+]} />
+
+___
+
 ### MedusaContainer

 Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer)  }
@@ -8795,6 +8860,12 @@ ___

 ___

+### MiddlewareVerb
+
+Ƭ **MiddlewareVerb**: ``"USE"`` \| ``"ALL"`` \| [`RouteVerb`](admin_discounts.internal.mdx#routeverb)
+
+___
+
 ### ModuleDefinition

 Ƭ **ModuleDefinition**: `Object`
@@ -8805,7 +8876,7 @@ ___
  {
    "name": "canOverride",
    "type": "`boolean`",
-    "description": "",
+    "description": "#### Deprecated property will be removed in future versions",
    "optional": true,
    "defaultValue": "",
    "children": []
@@ -8853,7 +8924,7 @@ ___
  {
    "name": "isRequired",
    "type": "`boolean`",
-    "description": "",
+    "description": "#### Deprecated property will be removed in future versions",
    "optional": true,
    "defaultValue": "",
    "children": []
@@ -10255,6 +10326,12 @@ ___

 ___

+### RouteVerb
+
+Ƭ **RouteVerb**: typeof [`HTTP_METHODS`](admin_discounts.internal.mdx#http_methods)[`number`]
+
+___
+
 ### SessionOptions

 Ƭ **SessionOptions**: `Object`
@@ -10616,6 +10693,18 @@ ___

 ___

+### SocketConnectOpts
+
+Ƭ **SocketConnectOpts**: [`TcpSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx) \| [`IpcSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx)
+
+___
+
+### SocketReadyState
+
+Ƭ **SocketReadyState**: ``"opening"`` \| ``"open"`` \| ``"readOnly"`` \| ``"writeOnly"`` \| ``"closed"``
+
+___
+
 ### StagedJobServiceProps

 Ƭ **StagedJobServiceProps**: `Object`
@@ -13577,6 +13666,14 @@ ___

 ___

+### HTTP\_METHODS
+
+• `Const` **HTTP\_METHODS**: readonly [``"GET"``, ``"POST"``, ``"PUT"``, ``"PATCH"``, ``"DELETE"``, ``"OPTIONS"``, ``"HEAD"``]
+
+List of all the supported HTTP methods
+
+___
+
 ### IdempotencyKeyRepository

 • `Const` **IdempotencyKeyRepository**: `Repository`