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

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

Browse Source 
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>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/modules/internal-1.md
+102 -3
View File
@@ -1,4 +1,8 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Enumerations
@@ -7,6 +11,8 @@
## Classes
- [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md)
- [BaseEntity](../classes/internal-1.BaseEntity.md)
- [SoftDeletableEntity](../classes/internal-1.SoftDeletableEntity.md)
- [User](../classes/internal-1.User.md)
## Type Aliases
@@ -15,12 +21,105 @@
Ƭ **AdminAuthRes**: `Object`
**`Schema`**
AdminAuthRes
type: object
required:
- user
properties:
user:
description: User details.
$ref: "#/components/schemas/User"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
| `user` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/admin/auth/index.d.ts:4
packages/medusa/dist/api/routes/admin/auth/index.d.ts:14
___
### AdminBearerAuthRes
Ƭ **AdminBearerAuthRes**: `Object`
**`Schema`**
AdminBearerAuthRes
type: object
properties:
accessToken:
description: Access token for subsequent authorization.
type: string
#### Type declaration
| Name | Type |
| :------ | :------ |
| `access_token` | `string` |
#### Defined in
packages/medusa/dist/api/routes/admin/auth/index.d.ts:25
___
### Exclude
Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
#### Type parameters
| Name |
| :------ |
| `T` |
| `U` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.es5.d.ts:1606
___
### Omit
Ƭ **Omit**<`T`, `K`\>: [`Pick`](internal-1.md#pick)<`T`, [`Exclude`](internal-1.md#exclude)<keyof `T`, `K`\>\>
Construct a type with the properties of T except for those in type K.
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `T` |
| `K` | extends keyof `any` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.es5.d.ts:1616
___
### Pick
Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] }
From T, pick a set of properties whose keys are in the union K
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `T` |
| `K` | extends keyof `T` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.es5.d.ts:1592
www/apps/docs/content/references/js-client/modules/internal-10.md
+456 -16
View File
@@ -1,44 +1,484 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Classes
# Module: internal
- [AdminPostInvitesInviteAcceptReq](../classes/internal-10.AdminPostInvitesInviteAcceptReq.md)
- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md)
- [AdminPostInvitesReq](../classes/internal-10.AdminPostInvitesReq.md)
- [Invite](../classes/internal-10.Invite.md)
## Interfaces
- [BlobPropertyBag](../interfaces/internal-10.BlobPropertyBag.md)
- [File](../interfaces/internal-10.File.md)
- [FilePropertyBag](../interfaces/internal-10.FilePropertyBag.md)
- [QueuingStrategy](../interfaces/internal-10.QueuingStrategy.md)
- [QueuingStrategySize](../interfaces/internal-10.QueuingStrategySize.md)
- [ReadableByteStreamController](../interfaces/internal-10.ReadableByteStreamController.md)
- [ReadableStream](../interfaces/internal-10.ReadableStream.md)
- [ReadableStreamBYOBReader](../interfaces/internal-10.ReadableStreamBYOBReader.md)
- [ReadableStreamBYOBRequest](../interfaces/internal-10.ReadableStreamBYOBRequest.md)
- [ReadableStreamDefaultController](../interfaces/internal-10.ReadableStreamDefaultController.md)
- [ReadableStreamDefaultReader](../interfaces/internal-10.ReadableStreamDefaultReader.md)
- [ReadableStreamGenericReader](../interfaces/internal-10.ReadableStreamGenericReader.md)
- [ReadableStreamGetReaderOptions](../interfaces/internal-10.ReadableStreamGetReaderOptions.md)
- [ReadableStreamReadDoneResult](../interfaces/internal-10.ReadableStreamReadDoneResult.md)
- [ReadableStreamReadValueResult](../interfaces/internal-10.ReadableStreamReadValueResult.md)
- [ReadableWritablePair](../interfaces/internal-10.ReadableWritablePair.md)
- [StreamPipeOptions](../interfaces/internal-10.StreamPipeOptions.md)
- [UnderlyingByteSource](../interfaces/internal-10.UnderlyingByteSource.md)
- [UnderlyingDefaultSource](../interfaces/internal-10.UnderlyingDefaultSource.md)
- [UnderlyingSink](../interfaces/internal-10.UnderlyingSink.md)
- [UnderlyingSinkAbortCallback](../interfaces/internal-10.UnderlyingSinkAbortCallback.md)
- [UnderlyingSinkCloseCallback](../interfaces/internal-10.UnderlyingSinkCloseCallback.md)
- [UnderlyingSinkStartCallback](../interfaces/internal-10.UnderlyingSinkStartCallback.md)
- [UnderlyingSinkWriteCallback](../interfaces/internal-10.UnderlyingSinkWriteCallback.md)
- [UnderlyingSource](../interfaces/internal-10.UnderlyingSource.md)
- [UnderlyingSourceCancelCallback](../interfaces/internal-10.UnderlyingSourceCancelCallback.md)
- [UnderlyingSourcePullCallback](../interfaces/internal-10.UnderlyingSourcePullCallback.md)
- [UnderlyingSourceStartCallback](../interfaces/internal-10.UnderlyingSourceStartCallback.md)
- [WritableStream](../interfaces/internal-10.WritableStream.md)
- [WritableStreamDefaultController](../interfaces/internal-10.WritableStreamDefaultController.md)
- [WritableStreamDefaultWriter](../interfaces/internal-10.WritableStreamDefaultWriter.md)
## Type Aliases
### AdminListInvitesRes
### AdminCreateUploadPayload
Ƭ **AdminListInvitesRes**: `Object`
Ƭ **AdminCreateUploadPayload**: [`File`](internal-10.md#file) \| [`File`](internal-10.md#file)[]
#### Defined in
[packages/medusa-js/src/typings.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L51)
___
### BlobPart
Ƭ **BlobPart**: [`BufferSource`](internal-10.md#buffersource) \| `Blob` \| `string`
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:27961
___
### BufferSource
Ƭ **BufferSource**: [`ArrayBufferView`](../interfaces/internal-8.ArrayBufferView.md) \| `ArrayBuffer`
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:27963
___
### EndingType
Ƭ **EndingType**: ``"native"`` \| ``"transparent"``
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:28077
___
### ReadableStreamController
Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller)
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:28012
___
### ReadableStreamReadResult
Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../interfaces/internal-10.ReadableStreamReadValueResult.md)<`T`\> \| [`ReadableStreamReadDoneResult`](../interfaces/internal-10.ReadableStreamReadDoneResult.md)<`T`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:28013
___
### ReadableStreamReader
Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader)
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:28014
## Variables
### File
• **File**: `Object`
#### Call signature
• **new File**(`fileBits`, `fileName`, `options?`): [`File`](internal-10.md#file)
##### Parameters
| Name | Type |
| :------ | :------ |
| `fileBits` | [`BlobPart`](internal-10.md#blobpart)[] |
| `fileName` | `string` |
| `options?` | [`FilePropertyBag`](../interfaces/internal-10.FilePropertyBag.md) |
##### Returns
[`File`](internal-10.md#file)
#### Type declaration
| Name | Type |
| :------ | :------ |
| `invites` | [`Invite`](../classes/internal-10.Invite.md)[] |
| `prototype` | [`File`](internal-10.md#file) |
#### Defined in
medusa/dist/api/routes/admin/invites/index.d.ts:8
docs-util/node_modules/typescript/lib/lib.dom.d.ts:8260
docs-util/node_modules/typescript/lib/lib.dom.d.ts:8269
___
### AdminPostInvitesPayload
### ReadableByteStreamController
Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-10.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-10.md#inviteuserrolesenum) }
• **ReadableByteStreamController**: `Object`
#### Call signature
• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller)
##### Returns
[`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller)
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller) |
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L47)
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18464
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18477
___
### InviteUserRolesEnum
### ReadableStream
Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
• **ReadableStream**: `Object`
#### Call signature
• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`Uint8Array`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `underlyingSource` | [`UnderlyingByteSource`](../interfaces/internal-10.UnderlyingByteSource.md) |
| `strategy?` | `Object` |
| `strategy.highWaterMark?` | `number` |
##### Returns
[`ReadableStream`](internal-10.md#readablestream)<`Uint8Array`\>
• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`R`\>
##### Type parameters
| Name | Type |
| :------ | :------ |
| `R` | `any` |
##### Parameters
| Name | Type |
| :------ | :------ |
| `underlyingSource` | [`UnderlyingDefaultSource`](../interfaces/internal-10.UnderlyingDefaultSource.md)<`R`\> |
| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`R`\> |
##### Returns
[`ReadableStream`](internal-10.md#readablestream)<`R`\>
• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`R`\>
##### Type parameters
| Name | Type |
| :------ | :------ |
| `R` | `any` |
##### Parameters
| Name | Type |
| :------ | :------ |
| `underlyingSource?` | [`UnderlyingSource`](../interfaces/internal-10.UnderlyingSource.md)<`R`\> |
| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`R`\> |
##### Returns
[`ReadableStream`](internal-10.md#readablestream)<`R`\>
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableStream`](internal-10.md#readablestream)<`any`\> |
#### Defined in
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L45)
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18487
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18504
___
### ReadableStreamBYOBReader
• **ReadableStreamBYOBReader**: `Object`
#### Call signature
• **new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader)
##### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](internal-10.md#readablestream)<`any`\> |
##### Returns
[`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader)
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader) |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18512
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18519
___
### ReadableStreamBYOBRequest
• **ReadableStreamBYOBRequest**: `Object`
#### Call signature
• **new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest)
##### Returns
[`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest)
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest) |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18525
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18534
___
### ReadableStreamDefaultController
• **ReadableStreamDefaultController**: `Object`
#### Call signature
• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\>
##### Returns
[`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\>
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\> |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18540
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18551
___
### ReadableStreamDefaultReader
• **ReadableStreamDefaultReader**: `Object`
#### Call signature
• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`R`\>
##### Type parameters
| Name | Type |
| :------ | :------ |
| `R` | `any` |
##### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](internal-10.md#readablestream)<`R`\> |
##### Returns
[`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`R`\>
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`any`\> |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18557
docs-util/node_modules/typescript/lib/lib.dom.d.ts:18564
___
### WritableStream
• **WritableStream**: `Object`
#### Call signature
• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](internal-10.md#writablestream)<`W`\>
##### Type parameters
| Name | Type |
| :------ | :------ |
| `W` | `any` |
##### Parameters
| Name | Type |
| :------ | :------ |
| `underlyingSink?` | [`UnderlyingSink`](../interfaces/internal-10.UnderlyingSink.md)<`W`\> |
| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`W`\> |
##### Returns
[`WritableStream`](internal-10.md#writablestream)<`W`\>
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`WritableStream`](internal-10.md#writablestream)<`any`\> |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26020
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26031
___
### WritableStreamDefaultController
• **WritableStreamDefaultController**: `Object`
#### Call signature
• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller)
##### Returns
[`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller)
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller) |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26041
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26048
___
### WritableStreamDefaultWriter
• **WritableStreamDefaultWriter**: `Object`
#### Call signature
• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`W`\>
##### Type parameters
| Name | Type |
| :------ | :------ |
| `W` | `any` |
##### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`WritableStream`](internal-10.md#writablestream)<`W`\> |
##### Returns
[`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`W`\>
#### Type declaration
| Name | Type |
| :------ | :------ |
| `prototype` | [`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`any`\> |
#### Defined in
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26058
docs-util/node_modules/typescript/lib/lib.dom.d.ts:26075
www/apps/docs/content/references/js-client/modules/internal-11.md
+66 -19
View File
@@ -1,34 +1,81 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Classes
- [AdminGetNotesParams](../classes/internal-11.AdminGetNotesParams.md)
- [AdminPostNotesNoteReq](../classes/internal-11.AdminPostNotesNoteReq.md)
- [AdminPostNotesReq](../classes/internal-11.AdminPostNotesReq.md)
- [Note](../classes/internal-11.Note.md)
# Module: internal
## Type Aliases
### AdminNotesListRes
### AdminCreateUserPayload
Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] }
Ƭ **AdminCreateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-11.md#createuserroles) }
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:10
[packages/medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L31)
___
### AdminNotesRes
### AdminUpdateUserPayload
Ƭ **AdminNotesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `note` | [`Note`](../classes/internal-11.Note.md) |
Ƭ **AdminUpdateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-11.md#updateuserroles) }
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:6
[packages/medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L41)
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[packages/medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[packages/medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[packages/medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[packages/medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[packages/medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L37)
www/apps/docs/content/references/js-client/modules/internal-12.md
+96 -23
View File
@@ -1,40 +1,113 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Classes
- [AdminGetNotificationsParams](../classes/internal-12.AdminGetNotificationsParams.md)
- [AdminPostNotificationsNotificationResendReq](../classes/internal-12.AdminPostNotificationsNotificationResendReq.md)
- [Notification](../classes/internal-12.Notification.md)
- [NotificationProvider](../classes/internal-12.NotificationProvider.md)
- [Axios](../classes/internal-12.Axios.md)
- [Client](../classes/internal-12.Client.md)
## Interfaces
- [AxiosAdapter](../interfaces/internal-12.AxiosAdapter.md)
- [AxiosBasicCredentials](../interfaces/internal-12.AxiosBasicCredentials.md)
- [AxiosDefaults](../interfaces/internal-12.AxiosDefaults.md)
- [AxiosError](../interfaces/internal-12.AxiosError.md)
- [AxiosInstance](../interfaces/internal-12.AxiosInstance.md)
- [AxiosInterceptorManager](../interfaces/internal-12.AxiosInterceptorManager.md)
- [AxiosPromise](../interfaces/internal-12.AxiosPromise.md)
- [AxiosProxyConfig](../interfaces/internal-12.AxiosProxyConfig.md)
- [AxiosRequestTransformer](../interfaces/internal-12.AxiosRequestTransformer.md)
- [AxiosResponse](../interfaces/internal-12.AxiosResponse.md)
- [AxiosResponseTransformer](../interfaces/internal-12.AxiosResponseTransformer.md)
- [Cancel](../interfaces/internal-12.Cancel.md)
- [CancelToken](../interfaces/internal-12.CancelToken.md)
- [Config](../interfaces/internal-12.Config.md)
- [HTTPResponse](../interfaces/internal-12.HTTPResponse.md)
- [HeadersDefaults](../interfaces/internal-12.HeadersDefaults.md)
- [RetryConfig](../interfaces/internal-12.RetryConfig.md)
- [TransitionalOptions](../interfaces/internal-12.TransitionalOptions.md)
## Type Aliases
### AdminNotificationsListRes
### AxiosRequestHeaders
Ƭ **AdminNotificationsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `notifications` | [`Notification`](../classes/internal-12.Notification.md)[] |
Ƭ **AxiosRequestHeaders**: [`Record`](internal.md#record)<`string`, `string`\>
#### Defined in
medusa/dist/api/routes/admin/notifications/index.d.ts:8
packages/medusa-js/node_modules/axios/index.d.ts:3
___
### AdminNotificationsRes
### AxiosResponseHeaders
Ƭ **AdminNotificationsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `notification` | [`Notification`](../classes/internal-12.Notification.md) |
Ƭ **AxiosResponseHeaders**: [`Record`](internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] }
#### Defined in
medusa/dist/api/routes/admin/notifications/index.d.ts:11
packages/medusa-js/node_modules/axios/index.d.ts:5
___
### Method
Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``
#### Defined in
packages/medusa-js/node_modules/axios/index.d.ts:36
___
### RequestMethod
Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"``
#### Defined in
[packages/medusa-js/src/request.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L28)
___
### Response
Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal-12.HTTPResponse.md) }
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[packages/medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L17)
___
### ResponsePromise
Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal-12.md#response)<`T`\>\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
#### Defined in
[packages/medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L21)
___
### ResponseType
Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"``
#### Defined in
packages/medusa-js/node_modules/axios/index.d.ts:48
www/apps/docs/content/references/js-client/modules/internal-13.md
-64
View File
@@ -1,64 +0,0 @@
# Namespace: internal
## Classes
- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md)
- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md)
- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md)
- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md)
- [GetOrderEditsOrderEditParams](../classes/internal-13.GetOrderEditsOrderEditParams.md)
- [GetOrderEditsParams](../classes/internal-13.GetOrderEditsParams.md)
## Type Aliases
### AdminOrderEditItemChangeDeleteRes
Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"item_change"`` |
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:12
___
### AdminOrderEditsListRes
Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal.OrderEdit.md)[] }
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:8
___
### AdminOrderEditsRes
Ƭ **AdminOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order_edit` | [`OrderEdit`](../classes/internal.OrderEdit.md) |
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:5
## Variables
### GetOrderEditsParams\_base
• `Const` **GetOrderEditsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:71
www/apps/docs/content/references/js-client/modules/internal-14.md
-62
View File
@@ -1,62 +0,0 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-14.AdditionalItem.md)
- [AdditionalItem](../classes/internal-14.AdditionalItem-1.md)
- [AdminGetOrdersParams](../classes/internal-14.AdminGetOrdersParams.md)
- [AdminListOrdersSelector](../classes/internal-14.AdminListOrdersSelector.md)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md)
- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md)
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md)
- [AdminPostOrdersOrderClaimsReq](../classes/internal-14.AdminPostOrdersOrderClaimsReq.md)
- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md)
- [AdminPostOrdersOrderRefundsReq](../classes/internal-14.AdminPostOrdersOrderRefundsReq.md)
- [AdminPostOrdersOrderReq](../classes/internal-14.AdminPostOrdersOrderReq.md)
- [AdminPostOrdersOrderReturnsReq](../classes/internal-14.AdminPostOrdersOrderReturnsReq.md)
- [AdminPostOrdersOrderShipmentReq](../classes/internal-14.AdminPostOrdersOrderShipmentReq.md)
- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md)
- [AdminPostOrdersOrderSwapsReq](../classes/internal-14.AdminPostOrdersOrderSwapsReq.md)
- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md)
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md)
- [CustomShippingOption](../classes/internal-14.CustomShippingOption.md)
- [Image](../classes/internal-14.Image.md)
- [Item](../classes/internal-14.Item.md)
- [Item](../classes/internal-14.Item-1.md)
- [Item](../classes/internal-14.Item-2.md)
- [OrdersReturnItem](../classes/internal-14.OrdersReturnItem.md)
- [PaymentMethod](../classes/internal-14.PaymentMethod.md)
- [ReturnItem](../classes/internal-14.ReturnItem.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping-1.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping-2.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod-1.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod-2.md)
- [Tag](../classes/internal-14.Tag.md)
## Type Aliases
### AdminOrdersListRes
Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/admin/orders/index.d.ts:11
___
### AdminOrdersRes
Ƭ **AdminOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/orders/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-15.md
-40
View File
@@ -1,40 +0,0 @@
# Namespace: internal
## Classes
- [AdminUpdatePaymentCollectionsReq](../classes/internal-15.AdminUpdatePaymentCollectionsReq.md)
- [GetPaymentCollectionsParams](../classes/internal-15.GetPaymentCollectionsParams.md)
## Type Aliases
### AdminPaymentCollectionDeleteRes
Ƭ **AdminPaymentCollectionDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"payment_collection"`` |
#### Defined in
medusa/dist/api/routes/admin/payment-collections/index.d.ts:10
___
### AdminPaymentCollectionsRes
Ƭ **AdminPaymentCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
#### Defined in
medusa/dist/api/routes/admin/payment-collections/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-16.md
-42
View File
@@ -1,42 +0,0 @@
# Namespace: internal
## Enumerations
- [RefundReason](../enums/internal-16.RefundReason.md)
## Classes
- [AdminPostPaymentRefundsReq](../classes/internal-16.AdminPostPaymentRefundsReq.md)
- [GetPaymentsParams](../classes/internal-16.GetPaymentsParams.md)
## Type Aliases
### AdminPaymentRes
Ƭ **AdminPaymentRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment` | [`Payment`](../classes/internal.Payment.md) |
#### Defined in
medusa/dist/api/routes/admin/payments/index.d.ts:6
___
### AdminRefundRes
Ƭ **AdminRefundRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `refund` | [`Refund`](../classes/internal.Refund.md) |
#### Defined in
medusa/dist/api/routes/admin/payments/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-17.md
-69
View File
@@ -1,69 +0,0 @@
# Namespace: internal
## Classes
- [AdminDeletePriceListPricesPricesReq](../classes/internal-17.AdminDeletePriceListPricesPricesReq.md)
- [AdminGetPriceListPaginationParams](../classes/internal-17.AdminGetPriceListPaginationParams.md)
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-17.AdminGetPriceListsPriceListProductsParams.md)
- [AdminPostPriceListPricesPricesReq](../classes/internal-17.AdminPostPriceListPricesPricesReq.md)
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md)
- [AdminPostPriceListsPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListReq.md)
- [AdminPriceListPricesCreateReq](../classes/internal-17.AdminPriceListPricesCreateReq.md)
- [AdminPriceListPricesUpdateReq](../classes/internal-17.AdminPriceListPricesUpdateReq.md)
- [CustomerGroup](../classes/internal-17.CustomerGroup.md)
- [CustomerGroup](../classes/internal-17.CustomerGroup-1.md)
- [FilterablePriceListProps](../classes/internal-17.FilterablePriceListProps.md)
## Type Aliases
### AdminPriceListDeleteBatchRes
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `ids` | `string`[] |
| `object` | `string` |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:13
___
### AdminPriceListRes
Ƭ **AdminPriceListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `price_list` | [`PriceList`](../classes/internal.PriceList.md) |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:10
___
### AdminPriceListsListRes
Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] }
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:21
## Variables
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:175
www/apps/docs/content/references/js-client/modules/internal-18.md
-16
View File
@@ -1,16 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetProductTagsPaginationParams](../classes/internal-18.AdminGetProductTagsPaginationParams.md)
- [AdminGetProductTagsParams](../classes/internal-18.AdminGetProductTagsParams.md)
## Type Aliases
### AdminProductTagsListRes
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
#### Defined in
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-19.md
-15
View File
@@ -1,15 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetProductTypesParams](../classes/internal-19.AdminGetProductTypesParams.md)
## Type Aliases
### AdminProductTypesListRes
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/admin/product-types/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-2.md
+46 -6
View File
@@ -1,4 +1,8 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Enumerations
@@ -18,9 +22,34 @@
Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../classes/internal-2.BatchJob.md)[] }
**`Schema`**
AdminBatchJobListRes
type: object
required:
- batch_jobs
- count
- offset
- limit
properties:
batch_jobs:
type: array
description: An array of batch job details.
items:
$ref: "#/components/schemas/BatchJob"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of batch jobs skipped when retrieving the batch jobs.
limit:
type: integer
description: The number of items per page
#### Defined in
medusa/dist/api/routes/admin/batch/index.d.ts:9
packages/medusa/dist/api/routes/admin/batch/index.d.ts:42
___
@@ -28,6 +57,17 @@ ___
Ƭ **AdminBatchJobRes**: `Object`
**`Schema`**
AdminBatchJobRes
type: object
required:
- batch_job
properties:
batch_job:
description: Batch job details.
$ref: "#/components/schemas/BatchJob"
#### Type declaration
| Name | Type |
@@ -36,7 +76,7 @@ ___
#### Defined in
medusa/dist/api/routes/admin/batch/index.d.ts:5
packages/medusa/dist/api/routes/admin/batch/index.d.ts:15
___
@@ -57,7 +97,7 @@ ___
#### Defined in
medusa/dist/types/batch-job.d.ts:18
packages/medusa/dist/types/batch-job.d.ts:18
___
@@ -75,7 +115,7 @@ ___
#### Defined in
medusa/dist/types/batch-job.d.ts:23
packages/medusa/dist/types/batch-job.d.ts:23
___
@@ -93,4 +133,4 @@ ___
#### Defined in
medusa/dist/types/common.d.ts:60
packages/medusa/dist/types/common.d.ts:70
www/apps/docs/content/references/js-client/modules/internal-20.md
-211
View File
@@ -1,211 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetProductsParams](../classes/internal-20.AdminGetProductsParams.md)
- [AdminPostProductsProductMetadataReq](../classes/internal-20.AdminPostProductsProductMetadataReq.md)
- [AdminPostProductsProductOptionsOption](../classes/internal-20.AdminPostProductsProductOptionsOption.md)
- [AdminPostProductsProductOptionsReq](../classes/internal-20.AdminPostProductsProductOptionsReq.md)
- [AdminPostProductsProductReq](../classes/internal-20.AdminPostProductsProductReq.md)
- [AdminPostProductsProductVariantsReq](../classes/internal-20.AdminPostProductsProductVariantsReq.md)
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-20.AdminPostProductsProductVariantsVariantReq.md)
- [AdminPostProductsReq](../classes/internal-20.AdminPostProductsReq.md)
- [FilterableProductProps](../classes/internal-20.FilterableProductProps.md)
- [ProductOptionReq](../classes/internal-20.ProductOptionReq.md)
- [ProductSalesChannelReq](../classes/internal-20.ProductSalesChannelReq.md)
- [ProductTagReq](../classes/internal-20.ProductTagReq.md)
- [ProductTypeReq](../classes/internal-20.ProductTypeReq.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-1.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-2.md)
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-3.md)
- [ProductVariantPricesCreateReq](../classes/internal-20.ProductVariantPricesCreateReq.md)
- [ProductVariantPricesUpdateReq](../classes/internal-20.ProductVariantPricesUpdateReq.md)
- [ProductVariantReq](../classes/internal-20.ProductVariantReq.md)
- [ProductVariantReq](../classes/internal-20.ProductVariantReq-1.md)
## Type Aliases
### AdminProductsDeleteOptionRes
Ƭ **AdminProductsDeleteOptionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"option"`` |
| `option_id` | `string` |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:13
___
### AdminProductsDeleteRes
Ƭ **AdminProductsDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"product"`` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:25
___
### AdminProductsDeleteVariantRes
Ƭ **AdminProductsDeleteVariantRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"product-variant"`` |
| `product` | [`Product`](../classes/internal.Product.md) |
| `variant_id` | `string` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:19
___
### AdminProductsListRes
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-20.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:30
___
### AdminProductsListTagsRes
Ƭ **AdminProductsListTagsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:36
___
### AdminProductsListTypesRes
Ƭ **AdminProductsListTypesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:33
___
### AdminProductsRes
Ƭ **AdminProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:39
___
### PricedProduct
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] }
#### Defined in
medusa/dist/types/pricing.d.ts:31
___
### PricedVariant
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-20.md#productvariantpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:30
___
### ProductVariantPricing
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-20.md#taxedpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:4
___
### TaxServiceRate
Ƭ **TaxServiceRate**: `Object`
The tax rate object as configured in Medusa. These may have an unspecified
numerical rate as they may be used for lookup purposes in the tax provider
plugin.
#### Type declaration
| Name | Type |
| :------ | :------ |
| `code` | `string` \| ``null`` |
| `name` | `string` |
| `rate?` | `number` \| ``null`` |
#### Defined in
medusa/dist/types/tax-service.d.ts:15
___
### TaxedPricing
Ƭ **TaxedPricing**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `calculated_price_incl_tax` | `number` \| ``null`` |
| `calculated_tax` | `number` \| ``null`` |
| `original_price_incl_tax` | `number` \| ``null`` |
| `original_tax` | `number` \| ``null`` |
| `tax_rates` | [`TaxServiceRate`](internal-20.md#taxservicerate)[] \| ``null`` |
#### Defined in
medusa/dist/types/pricing.d.ts:12
www/apps/docs/content/references/js-client/modules/internal-21.md
-58
View File
@@ -1,58 +0,0 @@
# Namespace: internal
## Classes
- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md)
- [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md)
- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md)
- [AdminPostPublishableApiKeysReq](../classes/internal-21.AdminPostPublishableApiKeysReq.md)
- [GetPublishableApiKeySalesChannelsParams](../classes/internal-21.GetPublishableApiKeySalesChannelsParams.md)
- [GetPublishableApiKeysParams](../classes/internal-21.GetPublishableApiKeysParams.md)
- [ProductBatchSalesChannel](../classes/internal-21.ProductBatchSalesChannel.md)
- [PublishableApiKey](../classes/internal-21.PublishableApiKey.md)
## Type Aliases
### AdminPublishableApiKeysListRes
Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md)[] }
#### Defined in
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:8
___
### AdminPublishableApiKeysRes
Ƭ **AdminPublishableApiKeysRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md) |
#### Defined in
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:5
___
### AdminSalesChannelsListRes
Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] }
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:10
## Variables
### GetPublishableApiKeysParams\_base
• `Const` **GetPublishableApiKeysParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61
www/apps/docs/content/references/js-client/modules/internal-22.md
-24
View File
@@ -1,24 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetRegionsPaginationParams](../classes/internal-22.AdminGetRegionsPaginationParams.md)
- [AdminGetRegionsParams](../classes/internal-22.AdminGetRegionsParams.md)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)
- [AdminPostRegionsRegionCountriesReq](../classes/internal-22.AdminPostRegionsRegionCountriesReq.md)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md)
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md)
- [AdminPostRegionsRegionReq](../classes/internal-22.AdminPostRegionsRegionReq.md)
- [AdminPostRegionsReq](../classes/internal-22.AdminPostRegionsReq.md)
- [AdminRegionsRes](../classes/internal-22.AdminRegionsRes.md)
- [FulfillmentOption](../classes/internal-22.FulfillmentOption.md)
## Type Aliases
### AdminRegionsListRes
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
#### Defined in
medusa/dist/api/routes/admin/regions/index.d.ts:12
www/apps/docs/content/references/js-client/modules/internal-23.md
-38
View File
@@ -1,38 +0,0 @@
# Namespace: internal
## Classes
- [AdminPostReturnReasonsReasonReq](../classes/internal-23.AdminPostReturnReasonsReasonReq.md)
- [AdminPostReturnReasonsReq](../classes/internal-23.AdminPostReturnReasonsReq.md)
## Type Aliases
### AdminReturnReasonsListRes
Ƭ **AdminReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
___
### AdminReturnReasonsRes
Ƭ **AdminReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-24.md
-49
View File
@@ -1,49 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetReturnsParams](../classes/internal-24.AdminGetReturnsParams.md)
- [AdminPostReturnsReturnReceiveReq](../classes/internal-24.AdminPostReturnsReturnReceiveReq.md)
- [Item](../classes/internal-24.Item.md)
## Type Aliases
### AdminReturnsCancelRes
Ƭ **AdminReturnsCancelRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:6
___
### AdminReturnsListRes
Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] }
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:9
___
### AdminReturnsRes
Ƭ **AdminReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:12
www/apps/docs/content/references/js-client/modules/internal-25.md
-35
View File
@@ -1,35 +0,0 @@
# Namespace: internal
## Classes
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
- [AdminGetSalesChannelsParams](../classes/internal-25.AdminGetSalesChannelsParams.md)
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md)
- [AdminPostSalesChannelsReq](../classes/internal-25.AdminPostSalesChannelsReq.md)
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md)
## Type Aliases
### AdminSalesChannelsRes
Ƭ **AdminSalesChannelsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
## Variables
### AdminGetSalesChannelsParams\_base
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:142
www/apps/docs/content/references/js-client/modules/internal-26.md
-35
View File
@@ -1,35 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetShippingOptionsParams](../classes/internal-26.AdminGetShippingOptionsParams.md)
- [AdminPostShippingOptionsOptionReq](../classes/internal-26.AdminPostShippingOptionsOptionReq.md)
- [AdminPostShippingOptionsReq](../classes/internal-26.AdminPostShippingOptionsReq.md)
- [OptionRequirement](../classes/internal-26.OptionRequirement.md)
- [OptionRequirement](../classes/internal-26.OptionRequirement-1.md)
## Type Aliases
### AdminShippingOptionsListRes
Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] }
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:8
___
### AdminShippingOptionsRes
Ƭ **AdminShippingOptionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:11
www/apps/docs/content/references/js-client/modules/internal-27.md
-38
View File
@@ -1,38 +0,0 @@
# Namespace: internal
## Classes
- [AdminPostShippingProfilesProfileReq](../classes/internal-27.AdminPostShippingProfilesProfileReq.md)
- [AdminPostShippingProfilesReq](../classes/internal-27.AdminPostShippingProfilesReq.md)
## Type Aliases
### AdminShippingProfilesListRes
Ƭ **AdminShippingProfilesListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12
___
### AdminShippingProfilesRes
Ƭ **AdminShippingProfilesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-28.md
-54
View File
@@ -1,54 +0,0 @@
# Namespace: internal
## Classes
- [AdminPostStoreReq](../classes/internal-28.AdminPostStoreReq.md)
- [Store](../classes/internal-28.Store.md)
## Type Aliases
### AdminPaymentProvidersList
Ƭ **AdminPaymentProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:10
___
### AdminStoresRes
Ƭ **AdminStoresRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `store` | [`Store`](../classes/internal-28.Store.md) |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:4
___
### AdminTaxProvidersList
Ƭ **AdminTaxProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-29.md
-31
View File
@@ -1,31 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetSwapsParams](../classes/internal-29.AdminGetSwapsParams.md)
## Type Aliases
### AdminSwapsListRes
Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] }
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:7
___
### AdminSwapsRes
Ƭ **AdminSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:10
www/apps/docs/content/references/js-client/modules/internal-3.md
+202 -9
View File
@@ -1,23 +1,152 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Enumerations
- [AllocationType](../enums/internal-3.AllocationType.md)
- [CartType](../enums/internal-3.CartType.md)
- [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md)
- [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md)
- [ClaimReason](../enums/internal-3.ClaimReason.md)
- [ClaimType](../enums/internal-3.ClaimType.md)
- [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md)
- [DiscountConditionType](../enums/internal-3.DiscountConditionType.md)
- [DiscountRuleType](../enums/internal-3.DiscountRuleType.md)
- [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md)
- [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md)
- [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal-3.OrderEditStatus.md)
- [OrderStatus](../enums/internal-3.OrderStatus.md)
- [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md)
- [PaymentStatus](../enums/internal-3.PaymentStatus.md)
- [PriceListStatus](../enums/internal-3.PriceListStatus.md)
- [PriceListType](../enums/internal-3.PriceListType.md)
- [ProductStatus](../enums/internal-3.ProductStatus.md)
- [RequirementType](../enums/internal-3.RequirementType.md)
- [ReturnStatus](../enums/internal-3.ReturnStatus.md)
- [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md)
- [ShippingProfileType](../enums/internal-3.ShippingProfileType.md)
- [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md)
- [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md)
## Classes
- [Address](../classes/internal-3.Address.md)
- [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md)
- [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md)
- [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md)
- [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md)
- [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md)
- [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md)
- [Cart](../classes/internal-3.Cart.md)
- [ClaimImage](../classes/internal-3.ClaimImage.md)
- [ClaimItem](../classes/internal-3.ClaimItem.md)
- [ClaimOrder](../classes/internal-3.ClaimOrder.md)
- [ClaimTag](../classes/internal-3.ClaimTag.md)
- [Country](../classes/internal-3.Country.md)
- [Currency](../classes/internal-3.Currency.md)
- [Customer](../classes/internal-3.Customer.md)
- [CustomerGroup](../classes/internal-3.CustomerGroup.md)
- [Discount](../classes/internal-3.Discount.md)
- [DiscountCondition](../classes/internal-3.DiscountCondition.md)
- [DiscountRule](../classes/internal-3.DiscountRule.md)
- [DraftOrder](../classes/internal-3.DraftOrder.md)
- [Fulfillment](../classes/internal-3.Fulfillment.md)
- [FulfillmentItem](../classes/internal-3.FulfillmentItem.md)
- [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md)
- [GiftCard](../classes/internal-3.GiftCard.md)
- [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md)
- [Image](../classes/internal-3.Image.md)
- [LineItem](../classes/internal-3.LineItem.md)
- [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md)
- [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md)
- [MoneyAmount](../classes/internal-3.MoneyAmount.md)
- [Order](../classes/internal-3.Order.md)
- [OrderEdit](../classes/internal-3.OrderEdit.md)
- [OrderItemChange](../classes/internal-3.OrderItemChange.md)
- [Payment](../classes/internal-3.Payment.md)
- [PaymentCollection](../classes/internal-3.PaymentCollection.md)
- [PaymentProvider](../classes/internal-3.PaymentProvider.md)
- [PaymentSession](../classes/internal-3.PaymentSession.md)
- [PriceList](../classes/internal-3.PriceList.md)
- [Product](../classes/internal-3.Product.md)
- [ProductCategory](../classes/internal-3.ProductCategory.md)
- [ProductCollection](../classes/internal-3.ProductCollection.md)
- [ProductOption](../classes/internal-3.ProductOption.md)
- [ProductOptionValue](../classes/internal-3.ProductOptionValue.md)
- [ProductTag](../classes/internal-3.ProductTag.md)
- [ProductType](../classes/internal-3.ProductType.md)
- [ProductVariant](../classes/internal-3.ProductVariant.md)
- [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md)
- [Refund](../classes/internal-3.Refund.md)
- [Region](../classes/internal-3.Region.md)
- [Return](../classes/internal-3.Return.md)
- [ReturnItem](../classes/internal-3.ReturnItem.md)
- [ReturnReason](../classes/internal-3.ReturnReason.md)
- [SalesChannel](../classes/internal-3.SalesChannel.md)
- [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md)
- [ShippingMethod](../classes/internal-3.ShippingMethod.md)
- [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md)
- [ShippingOption](../classes/internal-3.ShippingOption.md)
- [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md)
- [ShippingProfile](../classes/internal-3.ShippingProfile.md)
- [Swap](../classes/internal-3.Swap.md)
- [TaxLine](../classes/internal-3.TaxLine.md)
- [TaxProvider](../classes/internal-3.TaxProvider.md)
- [TaxRate](../classes/internal-3.TaxRate.md)
- [TrackingLink](../classes/internal-3.TrackingLink.md)
## Interfaces
- [Boolean](../interfaces/internal-3.Boolean.md)
## Enumeration Members
### ORDER\_EDIT
• **ORDER\_EDIT**: ``"order_edit"``
#### Defined in
packages/medusa/dist/models/payment-collection.d.ts:11
## Type Aliases
### AdminCollectionsListRes
Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal-3.ProductCollection.md)[] }
**`Schema`**
AdminCollectionsListRes
type: object
required:
- collections
- count
- offset
- limit
properties:
collections:
type: array
description: an array of collection details
items:
$ref: "#/components/schemas/ProductCollection"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of product collections skipped when retrieving the product collections.
limit:
type: integer
description: The number of items per page
#### Defined in
medusa/dist/api/routes/admin/collections/index.d.ts:8
packages/medusa/dist/api/routes/admin/collections/index.d.ts:32
___
@@ -25,30 +154,94 @@ ___
Ƭ **AdminCollectionsRes**: `Object`
**`Schema`**
AdminCollectionsRes
type: object
x-expanded-relations:
field: collection
relations:
- products
required:
- collection
properties:
collection:
type: "Product Collection details."
$ref: "#/components/schemas/ProductCollection"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
| `collection` | [`ProductCollection`](../classes/internal-3.ProductCollection.md) |
#### Defined in
medusa/dist/api/routes/admin/collections/index.d.ts:12
packages/medusa/dist/api/routes/admin/collections/index.d.ts:97
___
### DeleteResponse
### AdminDeleteProductsFromCollectionRes
Ƭ **DeleteResponse**: `Object`
Ƭ **AdminDeleteProductsFromCollectionRes**: `Object`
**`Schema`**
AdminDeleteProductsFromCollectionRes
type: object
required:
- id
- object
- removed_products
properties:
id:
type: string
description: "The ID of the collection"
object:
type: string
description: "The type of object the removal was executed on"
default: product-collection
removed_products:
description: "The IDs of the products removed from the collection"
type: array
items:
description: "The ID of the Product removed from the Product Collection."
type: string
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | `string` |
| `removed_products` | `string`[] |
#### Defined in
medusa/dist/types/common.d.ts:65
packages/medusa/dist/api/routes/admin/collections/index.d.ts:78
## Functions
### Boolean
▸ **Boolean**<`T`\>(`value?`): `boolean`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `value?` | `T` |
#### Returns
`boolean`
#### Defined in
docs-util/node_modules/typescript/lib/lib.es5.d.ts:553
www/apps/docs/content/references/js-client/modules/internal-30.md
-44
View File
@@ -1,44 +0,0 @@
# Namespace: internal
## Classes
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md)
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
- [AdminGetTaxRatesParams](../classes/internal-30.AdminGetTaxRatesParams.md)
- [AdminGetTaxRatesTaxRateParams](../classes/internal-30.AdminGetTaxRatesTaxRateParams.md)
- [AdminPostTaxRatesReq](../classes/internal-30.AdminPostTaxRatesReq.md)
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md)
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md)
- [AdminPostTaxRatesTaxRateReq](../classes/internal-30.AdminPostTaxRatesTaxRateReq.md)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
- [NumericalComparisonOperator](../classes/internal-30.NumericalComparisonOperator.md)
## Type Aliases
### AdminTaxRatesListRes
Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] }
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:8
___
### AdminTaxRatesRes
Ƭ **AdminTaxRatesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
www/apps/docs/content/references/js-client/modules/internal-31.md
-39
View File
@@ -1,39 +0,0 @@
# Namespace: internal
## Classes
- [AdminDeleteUploadsReq](../classes/internal-31.AdminDeleteUploadsReq.md)
- [AdminPostUploadsDownloadUrlReq](../classes/internal-31.AdminPostUploadsDownloadUrlReq.md)
- [IAdminPostUploadsFileReq](../classes/internal-31.IAdminPostUploadsFileReq.md)
## Type Aliases
### AdminUploadsDownloadUrlRes
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `download_url` | `string` |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:10
___
### AdminUploadsRes
Ƭ **AdminUploadsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `uploads` | { `url`: `string` }[] |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:4
www/apps/docs/content/references/js-client/modules/internal-32.md
-116
View File
@@ -1,116 +0,0 @@
# Namespace: internal
## Classes
- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md)
## Type Aliases
### AdminCreateUserPayload
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) }
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L31)
___
### AdminUpdateUserPayload
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### AdminUsersListRes
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L37)
www/apps/docs/content/references/js-client/modules/internal-33.md
-17
View File
@@ -1,17 +0,0 @@
# Namespace: internal
## Classes
- [AdminGetVariantsParams](../classes/internal-33.AdminGetVariantsParams.md)
- [AdminPriceSelectionParams](../classes/internal-33.AdminPriceSelectionParams.md)
- [PriceSelectionParams](../classes/internal-33.PriceSelectionParams.md)
## Type Aliases
### AdminVariantsListRes
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] }
#### Defined in
medusa/dist/api/routes/admin/variants/index.d.ts:10
www/apps/docs/content/references/js-client/modules/internal-34.md
-37
View File
@@ -1,37 +0,0 @@
# Namespace: internal
## Classes
- [StorePostAuthReq](../classes/internal-34.StorePostAuthReq.md)
## Type Aliases
### StoreAuthRes
Ƭ **StoreAuthRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:4
___
### StoreGetAuthEmailRes
Ƭ **StoreGetAuthEmailRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `exists` | `boolean` |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-35.md
-38
View File
@@ -1,38 +0,0 @@
# Namespace: internal
## Classes
- [Discount](../classes/internal-35.Discount.md)
- [GiftCard](../classes/internal-35.GiftCard.md)
- [Item](../classes/internal-35.Item.md)
- [StorePostCartReq](../classes/internal-35.StorePostCartReq.md)
- [StorePostCartsCartPaymentSessionReq](../classes/internal-35.StorePostCartsCartPaymentSessionReq.md)
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md)
- [StorePostCartsCartReq](../classes/internal-35.StorePostCartsCartReq.md)
- [StorePostCartsCartShippingMethodReq](../classes/internal-35.StorePostCartsCartShippingMethodReq.md)
## Type Aliases
### StoreCartsRes
Ƭ **StoreCartsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:8
___
### StoreCompleteCartRes
Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` }
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:11
www/apps/docs/content/references/js-client/modules/internal-36.md
-31
View File
@@ -1,31 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetCollectionsParams](../classes/internal-36.StoreGetCollectionsParams.md)
## Type Aliases
### StoreCollectionsListRes
Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:7
___
### StoreCollectionsRes
Ƭ **StoreCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:10
www/apps/docs/content/references/js-client/modules/internal-37.md
-20
View File
@@ -1,20 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md)
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-37.StoreGetCustomersCustomerOrdersParams.md)
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md)
- [StorePostCustomersCustomerReq](../classes/internal-37.StorePostCustomersCustomerReq.md)
- [StorePostCustomersReq](../classes/internal-37.StorePostCustomersReq.md)
- [StorePostCustomersResetPasswordReq](../classes/internal-37.StorePostCustomersResetPasswordReq.md)
## Type Aliases
### StoreCustomersListOrdersRes
Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:12
www/apps/docs/content/references/js-client/modules/internal-38.md
-17
View File
@@ -1,17 +0,0 @@
# Namespace: internal
## Type Aliases
### StoreGiftCardsRes
Ƭ **StoreGiftCardsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
#### Defined in
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
www/apps/docs/content/references/js-client/modules/internal-39.md
-6
View File
@@ -1,6 +0,0 @@
# Namespace: internal
## Classes
- [StorePostCartsCartLineItemsItemReq](../classes/internal-39.StorePostCartsCartLineItemsItemReq.md)
- [StorePostCartsCartLineItemsReq](../classes/internal-39.StorePostCartsCartLineItemsReq.md)
www/apps/docs/content/references/js-client/modules/internal-4.md
+45 -5
View File
@@ -1,4 +1,8 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Classes
@@ -10,11 +14,36 @@
### AdminCurrenciesListRes
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal.Currency.md)[] }
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal-3.Currency.md)[] }
**`Schema`**
AdminCurrenciesListRes
type: object
required:
- currencies
- count
- offset
- limit
properties:
currencies:
type: array
description: An array of currency details.
items:
$ref: "#/components/schemas/Currency"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of currencies skipped when retrieving the currencies.
limit:
type: integer
description: The number of items per page
#### Defined in
medusa/dist/api/routes/admin/currencies/index.d.ts:5
packages/medusa/dist/api/routes/admin/currencies/index.d.ts:29
___
@@ -22,12 +51,23 @@ ___
Ƭ **AdminCurrenciesRes**: `Object`
**`Schema`**
AdminCurrenciesRes
type: object
required:
- currency
properties:
currency:
description: Currency details.
$ref: "#/components/schemas/Currency"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `currency` | [`Currency`](../classes/internal.Currency.md) |
| `currency` | [`Currency`](../classes/internal-3.Currency.md) |
#### Defined in
medusa/dist/api/routes/admin/currencies/index.d.ts:8
packages/medusa/dist/api/routes/admin/currencies/index.d.ts:42
www/apps/docs/content/references/js-client/modules/internal-40.md
-21
View File
@@ -1,21 +0,0 @@
# Namespace: internal
## Classes
- [StorePostOrderEditsOrderEditDecline](../classes/internal-40.StorePostOrderEditsOrderEditDecline.md)
## Type Aliases
### StoreOrderEditsRes
Ƭ **StoreOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> |
#### Defined in
medusa/dist/api/routes/store/order-edits/index.d.ts:4
www/apps/docs/content/references/js-client/modules/internal-41.md
-24
View File
@@ -1,24 +0,0 @@
# Namespace: internal
## Classes
- [ShippingAddressPayload](../classes/internal-41.ShippingAddressPayload.md)
- [StoreGetOrdersParams](../classes/internal-41.StoreGetOrdersParams.md)
- [StorePostCustomersCustomerAcceptClaimReq](../classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md)
- [StorePostCustomersCustomerOrderClaimReq](../classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md)
## Type Aliases
### StoreOrdersRes
Ƭ **StoreOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/store/orders/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-42.md
-40
View File
@@ -1,40 +0,0 @@
# Namespace: internal
## Classes
- [StorePaymentCollectionSessionsReq](../classes/internal-42.StorePaymentCollectionSessionsReq.md)
- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md)
- [StorePostPaymentCollectionsBatchSessionsReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md)
- [StorePostPaymentCollectionsSessionsReq](../classes/internal-42.StorePostPaymentCollectionsSessionsReq.md)
## Type Aliases
### StorePaymentCollectionsRes
Ƭ **StorePaymentCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
#### Defined in
medusa/dist/api/routes/store/payment-collections/index.d.ts:7
___
### StorePaymentCollectionsSessionRes
Ƭ **StorePaymentCollectionsSessionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_session` | [`PaymentSession`](../classes/internal.PaymentSession.md) |
#### Defined in
medusa/dist/api/routes/store/payment-collections/index.d.ts:10
www/apps/docs/content/references/js-client/modules/internal-43.md
-17
View File
@@ -1,17 +0,0 @@
# Namespace: internal
## Type Aliases
### StoreCustomersListPaymentMethodsRes
Ƭ **StoreCustomersListPaymentMethodsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:15
www/apps/docs/content/references/js-client/modules/internal-44.md
-15
View File
@@ -1,15 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetProductTypesParams](../classes/internal-44.StoreGetProductTypesParams.md)
## Type Aliases
### StoreProductTypesListRes
Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/store/product-types/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-45.md
-31
View File
@@ -1,31 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetVariantsParams](../classes/internal-45.StoreGetVariantsParams.md)
## Type Aliases
### StoreVariantsListRes
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:6
www/apps/docs/content/references/js-client/modules/internal-46.md
-53
View File
@@ -1,53 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetProductsPaginationParams](../classes/internal-46.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-46.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-46.StorePostSearchReq.md)
## Type Aliases
### StorePostSearchRes
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `hits` | `unknown`[] |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:13
___
### StoreProductsListRes
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:17
___
### StoreProductsRes
Ƭ **StoreProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:10
www/apps/docs/content/references/js-client/modules/internal-47.md
-33
View File
@@ -1,33 +0,0 @@
# Namespace: internal
## Type Aliases
### StoreRegionsListRes
Ƭ **StoreRegionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreRegionsRes
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-48.md
-33
View File
@@ -1,33 +0,0 @@
# Namespace: internal
## Type Aliases
### StoreReturnReasonsListRes
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
___
### StoreReturnReasonsRes
Ƭ **StoreReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
www/apps/docs/content/references/js-client/modules/internal-49.md
-23
View File
@@ -1,23 +0,0 @@
# Namespace: internal
## Classes
- [Item](../classes/internal-49.Item.md)
- [ReturnShipping](../classes/internal-49.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-49.StorePostReturnsReq.md)
## Type Aliases
### StoreReturnsRes
Ƭ **StoreReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
www/apps/docs/content/references/js-client/modules/internal-5.md
+6 -49
View File
@@ -1,52 +1,9 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Classes
# Module: internal
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md)
- [AdminGetCustomerGroupsGroupParams](../classes/internal-5.AdminGetCustomerGroupsGroupParams.md)
- [AdminGetCustomerGroupsParams](../classes/internal-5.AdminGetCustomerGroupsParams.md)
- [AdminGetCustomersParams](../classes/internal-5.AdminGetCustomersParams.md)
- [AdminListCustomerSelector](../classes/internal-5.AdminListCustomerSelector.md)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md)
- [AdminPostCustomerGroupsGroupReq](../classes/internal-5.AdminPostCustomerGroupsGroupReq.md)
- [AdminPostCustomerGroupsReq](../classes/internal-5.AdminPostCustomerGroupsReq.md)
- [CustomerGroupsBatchCustomer](../classes/internal-5.CustomerGroupsBatchCustomer.md)
- [FilterableCustomerGroupProps](../classes/internal-5.FilterableCustomerGroupProps.md)
- [FindParams](../classes/internal-5.FindParams.md)
- [StringComparisonOperator](../classes/internal-5.StringComparisonOperator.md)
## Interfaces
## Type Aliases
### AdminCustomerGroupsListRes
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customer-groups/index.d.ts:9
___
### AdminCustomerGroupsRes
Ƭ **AdminCustomerGroupsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) |
#### Defined in
medusa/dist/api/routes/admin/customer-groups/index.d.ts:5
___
### AdminCustomersListRes
Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:9
- [RequestOptions](../interfaces/internal-5.RequestOptions.md)
www/apps/docs/content/references/js-client/modules/internal-50.md
-21
View File
@@ -1,21 +0,0 @@
# Namespace: internal
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-50.StoreGetShippingOptionsParams.md)
## Type Aliases
### StoreShippingOptionsListRes
Ƭ **StoreShippingOptionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
www/apps/docs/content/references/js-client/modules/internal-51.md
-23
View File
@@ -1,23 +0,0 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-51.AdditionalItem.md)
- [Item](../classes/internal-51.Item.md)
- [StorePostSwapsReq](../classes/internal-51.StorePostSwapsReq.md)
## Type Aliases
### StoreSwapsRes
Ƭ **StoreSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:7
www/apps/docs/content/references/js-client/modules/internal-6.md
+65 -8
View File
@@ -1,23 +1,80 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Classes
- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md)
- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md)
- [Group](../classes/internal-6.Group.md)
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md)
- [AdminGetCustomerGroupsGroupParams](../classes/internal-6.AdminGetCustomerGroupsGroupParams.md)
- [AdminGetCustomerGroupsParams](../classes/internal-6.AdminGetCustomerGroupsParams.md)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md)
- [AdminPostCustomerGroupsGroupReq](../classes/internal-6.AdminPostCustomerGroupsGroupReq.md)
- [AdminPostCustomerGroupsReq](../classes/internal-6.AdminPostCustomerGroupsReq.md)
- [CustomerGroupsBatchCustomer](../classes/internal-6.CustomerGroupsBatchCustomer.md)
- [FilterableCustomerGroupProps](../classes/internal-6.FilterableCustomerGroupProps.md)
- [FindParams](../classes/internal-6.FindParams.md)
- [StringComparisonOperator](../classes/internal-6.StringComparisonOperator.md)
## Type Aliases
### AdminCustomersRes
### AdminCustomerGroupsListRes
Ƭ **AdminCustomersRes**: `Object`
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal-3.CustomerGroup.md)[] }
**`Schema`**
AdminCustomerGroupsListRes
type: object
required:
- customer_groups
- count
- offset
- limit
properties:
customer_groups:
type: array
description: An array of customer group details.
items:
$ref: "#/components/schemas/CustomerGroup"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of customer groups skipped when retrieving the customer groups.
limit:
type: integer
description: The number of items per page
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:63
___
### AdminCustomerGroupsRes
Ƭ **AdminCustomerGroupsRes**: `Object`
**`Schema`**
AdminCustomerGroupsRes
type: object
required:
- customer_group
properties:
customer_group:
description: Customer group details.
$ref: "#/components/schemas/CustomerGroup"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
| `customer_group` | [`CustomerGroup`](../classes/internal-3.CustomerGroup.md) |
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:5
packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:15
www/apps/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md
-123
View File
@@ -1,123 +0,0 @@
# Namespace: "/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
[internal](internal-7.md)."/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
## Type Aliases
### ClassConstructor
Ƭ **ClassConstructor**<`T`\>: `Object`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
medusa/dist/types/global.d.ts:27
___
### ConfigModule
Ƭ **ConfigModule**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `featureFlags` | `Record`<`string`, `boolean` \| `string`\> |
| `moduleResolutions?` | `Record`<`string`, [`ModuleResolution`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduleresolution)\> |
| `modules?` | `Record`<`string`, `string`\> |
| `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] |
| `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } |
| `projectConfig.admin_cors?` | `string` |
| `projectConfig.cookie_secret?` | `string` |
| `projectConfig.database_database?` | `string` |
| `projectConfig.database_extra?` | `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } |
| `projectConfig.database_logging` | `LoggerOptions` |
| `projectConfig.database_type` | `string` |
| `projectConfig.database_url?` | `string` |
| `projectConfig.jwt_secret?` | `string` |
| `projectConfig.redis_url?` | `string` |
| `projectConfig.store_cors?` | `string` |
#### Defined in
medusa/dist/types/global.d.ts:50
___
### ExtendedRequest
Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` }
#### Type parameters
| Name |
| :------ |
| `TEntity` |
#### Defined in
medusa/dist/types/global.d.ts:24
___
### Logger
Ƭ **Logger**: `_Logger` & { `info`: (`msg`: `string`) => `void` ; `progress`: (`activityId`: `string`, `msg`: `string`) => `void` ; `warn`: (`msg`: `string`) => `void` }
#### Defined in
medusa/dist/types/global.d.ts:33
___
### MedusaContainer
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
#### Defined in
medusa/dist/types/global.d.ts:30
___
### ModuleDefinition
Ƭ **ModuleDefinition**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `canOverride?` | `boolean` |
| `defaultPackage` | `string` |
| `isRequired?` | `boolean` |
| `key` | `string` |
| `label` | `string` |
| `registrationName` | `string` |
#### Defined in
medusa/dist/types/global.d.ts:42
___
### ModuleResolution
Ƭ **ModuleResolution**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `definition` | [`ModuleDefinition`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduledefinition) |
| `resolutionPath` | `string` |
#### Defined in
medusa/dist/types/global.d.ts:38
www/apps/docs/content/references/js-client/modules/internal-7.md
+64 -62
View File
@@ -1,78 +1,80 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Namespaces
- [&quot;/home/runner/work/medusa/medusa/packages/medusa/dist/types/global&quot;](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
# Module: internal
## Classes
- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.md)
- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md)
- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md)
- [AdminGetDiscountsDiscountRuleParams](../classes/internal-7.AdminGetDiscountsDiscountRuleParams.md)
- [AdminGetDiscountsParams](../classes/internal-7.AdminGetDiscountsParams.md)
- [AdminPostDiscountsDiscountConditions](../classes/internal-7.AdminPostDiscountsDiscountConditions.md)
- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md)
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md)
- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md)
- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md)
- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md)
- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md)
- [AdminPostDiscountsDiscountReq](../classes/internal-7.AdminPostDiscountsDiscountReq.md)
- [AdminPostDiscountsDiscountRule](../classes/internal-7.AdminPostDiscountsDiscountRule.md)
- [AdminPostDiscountsReq](../classes/internal-7.AdminPostDiscountsReq.md)
- [AdminUpdateDiscountRule](../classes/internal-7.AdminUpdateDiscountRule.md)
- [AdminUpsertCondition](../classes/internal-7.AdminUpsertCondition.md)
- [AdminUpsertConditionsReq](../classes/internal-7.AdminUpsertConditionsReq.md)
- [AdminGetCustomersParams](../classes/internal-7.AdminGetCustomersParams.md)
- [AdminListCustomerSelector](../classes/internal-7.AdminListCustomerSelector.md)
- [AdminPostCustomersCustomerReq](../classes/internal-7.AdminPostCustomersCustomerReq.md)
- [AdminPostCustomersReq](../classes/internal-7.AdminPostCustomersReq.md)
- [Group](../classes/internal-7.Group.md)
## Type Aliases
### AdminDiscountConditionsRes
### AdminCustomersListRes
Ƭ **AdminDiscountConditionsRes**: `Object`
Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal-3.Customer.md)[] }
**`Schema`**
AdminCustomersListRes
type: object
required:
- customers
- count
- offset
- limit
properties:
customers:
type: array
description: "An array of customer details."
items:
$ref: "#/components/schemas/Customer"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of customers skipped when retrieving the customers.
limit:
type: integer
description: The number of items per page
#### Defined in
packages/medusa/dist/api/routes/admin/customers/index.d.ts:47
___
### AdminCustomersRes
Ƭ **AdminCustomersRes**: `Object`
**`Schema`**
AdminCustomersRes
type: object
x-expanded-relations:
field: customer
relations:
- orders
- shipping_addresses
required:
- customer
properties:
customer:
description: "Customer details."
$ref: "#/components/schemas/Customer"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) |
| `customer` | [`Customer`](../classes/internal-3.Customer.md) |
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:14
___
### AdminDiscountsListRes
Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] }
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:18
___
### AdminDiscountsRes
Ƭ **AdminDiscountsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `discount` | [`Discount`](../classes/internal.Discount.md) |
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:11
## Variables
### AdminGetDiscountsParams\_base
• `Const` **AdminGetDiscountsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:87
packages/medusa/dist/api/routes/admin/customers/index.d.ts:20
www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md
+17
View File
@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: EventEmitter
[internal](internal-8.md).EventEmitter
## Interfaces
- [Abortable](../interfaces/internal-8.EventEmitter.Abortable.md)
## References
### EventEmitter
Re-exports [EventEmitter](../classes/internal-8.EventEmitter-1.md)
www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md
+643
View File
@@ -0,0 +1,643 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
[internal](internal-8.md).internal
## References
### Address
Re-exports [Address](../classes/internal-3.Address.md)
___
### AllocationType
Re-exports [AllocationType](../enums/internal-3.AllocationType.md)
___
### AnalyticsConfig
Re-exports [AnalyticsConfig](../classes/internal-8.internal.AnalyticsConfig.md)
___
### BatchJob
Re-exports [BatchJob](../classes/internal-2.BatchJob.md)
___
### Cart
Re-exports [Cart](../classes/internal-3.Cart.md)
___
### CartType
Re-exports [CartType](../enums/internal-3.CartType.md)
___
### ClaimFulfillmentStatus
Re-exports [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md)
___
### ClaimImage
Re-exports [ClaimImage](../classes/internal-3.ClaimImage.md)
___
### ClaimItem
Re-exports [ClaimItem](../classes/internal-3.ClaimItem.md)
___
### ClaimOrder
Re-exports [ClaimOrder](../classes/internal-3.ClaimOrder.md)
___
### ClaimPaymentStatus
Re-exports [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md)
___
### ClaimReason
Re-exports [ClaimReason](../enums/internal-3.ClaimReason.md)
___
### ClaimTag
Re-exports [ClaimTag](../classes/internal-3.ClaimTag.md)
___
### ClaimType
Re-exports [ClaimType](../enums/internal-3.ClaimType.md)
___
### Country
Re-exports [Country](../classes/internal-3.Country.md)
___
### Currency
Re-exports [Currency](../classes/internal-3.Currency.md)
___
### CustomShippingOption
Re-exports [CustomShippingOption](../classes/internal-8.internal.CustomShippingOption.md)
___
### Customer
Re-exports [Customer](../classes/internal-3.Customer.md)
___
### CustomerGroup
Re-exports [CustomerGroup](../classes/internal-3.CustomerGroup.md)
___
### Discount
Re-exports [Discount](../classes/internal-3.Discount.md)
___
### DiscountCondition
Re-exports [DiscountCondition](../classes/internal-3.DiscountCondition.md)
___
### DiscountConditionCustomerGroup
Re-exports [DiscountConditionCustomerGroup](../classes/internal-8.internal.DiscountConditionCustomerGroup.md)
___
### DiscountConditionOperator
Re-exports [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md)
___
### DiscountConditionProduct
Re-exports [DiscountConditionProduct](../classes/internal-8.internal.DiscountConditionProduct.md)
___
### DiscountConditionProductCollection
Re-exports [DiscountConditionProductCollection](../classes/internal-8.internal.DiscountConditionProductCollection.md)
___
### DiscountConditionProductTag
Re-exports [DiscountConditionProductTag](../classes/internal-8.internal.DiscountConditionProductTag.md)
___
### DiscountConditionProductType
Re-exports [DiscountConditionProductType](../classes/internal-8.internal.DiscountConditionProductType.md)
___
### DiscountConditionType
Re-exports [DiscountConditionType](../enums/internal-3.DiscountConditionType.md)
___
### DiscountRule
Re-exports [DiscountRule](../classes/internal-3.DiscountRule.md)
___
### DiscountRuleType
Re-exports [DiscountRuleType](../enums/internal-3.DiscountRuleType.md)
___
### DraftOrder
Re-exports [DraftOrder](../classes/internal-3.DraftOrder.md)
___
### DraftOrderStatus
Re-exports [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md)
___
### Fulfillment
Re-exports [Fulfillment](../classes/internal-3.Fulfillment.md)
___
### FulfillmentItem
Re-exports [FulfillmentItem](../classes/internal-3.FulfillmentItem.md)
___
### FulfillmentProvider
Re-exports [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md)
___
### FulfillmentStatus
Re-exports [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md)
___
### GiftCard
Re-exports [GiftCard](../classes/internal-3.GiftCard.md)
___
### GiftCardTransaction
Re-exports [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md)
___
### IdempotencyKey
Re-exports [IdempotencyKey](../classes/internal-8.internal.IdempotencyKey.md)
___
### Image
Re-exports [Image](../classes/internal-3.Image.md)
___
### Invite
Re-exports [Invite](../classes/internal-8.internal.Invite.md)
___
### LineItem
Re-exports [LineItem](../classes/internal-3.LineItem.md)
___
### LineItemAdjustment
Re-exports [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md)
___
### LineItemTaxLine
Re-exports [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md)
___
### MoneyAmount
Re-exports [MoneyAmount](../classes/internal-3.MoneyAmount.md)
___
### Note
Re-exports [Note](../classes/internal-8.internal.Note.md)
___
### Notification
Re-exports [Notification](../classes/internal-8.internal.Notification.md)
___
### Oauth
Re-exports [Oauth](../classes/internal-8.internal.Oauth.md)
___
### Order
Re-exports [Order](../classes/internal-3.Order.md)
___
### OrderEdit
Re-exports [OrderEdit](../classes/internal-3.OrderEdit.md)
___
### OrderEditItemChangeType
Re-exports [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md)
___
### OrderEditStatus
Re-exports [OrderEditStatus](../enums/internal-3.OrderEditStatus.md)
___
### OrderItemChange
Re-exports [OrderItemChange](../classes/internal-3.OrderItemChange.md)
___
### OrderStatus
Re-exports [OrderStatus](../enums/internal-3.OrderStatus.md)
___
### Payment
Re-exports [Payment](../classes/internal-3.Payment.md)
___
### PaymentCollection
Re-exports [PaymentCollection](../classes/internal-3.PaymentCollection.md)
___
### PaymentCollectionStatus
Re-exports [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md)
___
### PaymentCollectionType
Re-exports [PaymentCollectionType](../enums/internal-8.internal.PaymentCollectionType.md)
___
### PaymentProvider
Re-exports [PaymentProvider](../classes/internal-3.PaymentProvider.md)
___
### PaymentSession
Re-exports [PaymentSession](../classes/internal-3.PaymentSession.md)
___
### PaymentSessionStatus
Re-exports [PaymentSessionStatus](../enums/internal-8.internal.PaymentSessionStatus.md)
___
### PaymentStatus
Re-exports [PaymentStatus](../enums/internal-3.PaymentStatus.md)
___
### PriceList
Re-exports [PriceList](../classes/internal-3.PriceList.md)
___
### Product
Re-exports [Product](../classes/internal-3.Product.md)
___
### ProductCategory
Re-exports [ProductCategory](../classes/internal-3.ProductCategory.md)
___
### ProductCollection
Re-exports [ProductCollection](../classes/internal-3.ProductCollection.md)
___
### ProductOption
Re-exports [ProductOption](../classes/internal-3.ProductOption.md)
___
### ProductOptionValue
Re-exports [ProductOptionValue](../classes/internal-3.ProductOptionValue.md)
___
### ProductStatus
Re-exports [ProductStatus](../enums/internal-3.ProductStatus.md)
___
### ProductTag
Re-exports [ProductTag](../classes/internal-3.ProductTag.md)
___
### ProductTaxRate
Re-exports [ProductTaxRate](../classes/internal-8.internal.ProductTaxRate.md)
___
### ProductType
Re-exports [ProductType](../classes/internal-3.ProductType.md)
___
### ProductTypeTaxRate
Re-exports [ProductTypeTaxRate](../classes/internal-8.internal.ProductTypeTaxRate.md)
___
### ProductVariant
Re-exports [ProductVariant](../classes/internal-3.ProductVariant.md)
___
### ProductVariantInventoryItem
Re-exports [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md)
___
### ProductVariantMoneyAmount
Re-exports [ProductVariantMoneyAmount](../classes/internal-8.internal.ProductVariantMoneyAmount.md)
___
### PublishableApiKey
Re-exports [PublishableApiKey](../classes/internal-8.internal.PublishableApiKey.md)
___
### PublishableApiKeySalesChannel
Re-exports [PublishableApiKeySalesChannel](../classes/internal-8.internal.PublishableApiKeySalesChannel.md)
___
### Refund
Re-exports [Refund](../classes/internal-3.Refund.md)
___
### RefundReason
Re-exports [RefundReason](../enums/internal-8.internal.RefundReason.md)
___
### Region
Re-exports [Region](../classes/internal-3.Region.md)
___
### RequirementType
Re-exports [RequirementType](../enums/internal-3.RequirementType.md)
___
### Return
Re-exports [Return](../classes/internal-3.Return.md)
___
### ReturnItem
Re-exports [ReturnItem](../classes/internal-3.ReturnItem.md)
___
### ReturnReason
Re-exports [ReturnReason](../classes/internal-3.ReturnReason.md)
___
### ReturnStatus
Re-exports [ReturnStatus](../enums/internal-3.ReturnStatus.md)
___
### SalesChannel
Re-exports [SalesChannel](../classes/internal-3.SalesChannel.md)
___
### SalesChannelLocation
Re-exports [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md)
___
### ShippingMethod
Re-exports [ShippingMethod](../classes/internal-3.ShippingMethod.md)
___
### ShippingMethodTaxLine
Re-exports [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md)
___
### ShippingOption
Re-exports [ShippingOption](../classes/internal-3.ShippingOption.md)
___
### ShippingOptionPriceType
Re-exports [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md)
___
### ShippingOptionRequirement
Re-exports [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md)
___
### ShippingProfile
Re-exports [ShippingProfile](../classes/internal-3.ShippingProfile.md)
___
### ShippingProfileType
Re-exports [ShippingProfileType](../enums/internal-3.ShippingProfileType.md)
___
### ShippingTaxRate
Re-exports [ShippingTaxRate](../classes/internal-8.internal.ShippingTaxRate.md)
___
### StagedJob
Re-exports [StagedJob](../classes/internal-8.internal.StagedJob.md)
___
### Store
Re-exports [Store](../classes/internal-8.internal.Store.md)
___
### Swap
Re-exports [Swap](../classes/internal-3.Swap.md)
___
### SwapFulfillmentStatus
Re-exports [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md)
___
### SwapPaymentStatus
Re-exports [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md)
___
### TaxProvider
Re-exports [TaxProvider](../classes/internal-3.TaxProvider.md)
___
### TaxRate
Re-exports [TaxRate](../classes/internal-3.TaxRate.md)
___
### TrackingLink
Re-exports [TrackingLink](../classes/internal-3.TrackingLink.md)
___
### User
Re-exports [User](../classes/internal-1.User.md)
___
### UserRoles
Re-exports [UserRoles](../enums/internal-1.UserRoles.md)
www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md
+28
View File
@@ -0,0 +1,28 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: finished
[internal](internal-8.md).[internal](internal-8.internal-2.md).finished
## Functions
### \_\_promisify\_\_
▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `options?` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1230
www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md
+835
View File
@@ -0,0 +1,835 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
[internal](internal-8.md).internal
## Namespaces
- [finished](internal-8.internal-2.finished.md)
- [pipeline](internal-8.internal-2.pipeline.md)
## Classes
- [Writable](../classes/internal-8.internal-2.Writable.md)
## Interfaces
- [FinishedOptions](../interfaces/internal-8.internal-2.FinishedOptions.md)
- [Pipe](../interfaces/internal-8.internal-2.Pipe.md)
- [PipelineOptions](../interfaces/internal-8.internal-2.PipelineOptions.md)
- [ReadableOptions](../interfaces/internal-8.internal-2.ReadableOptions.md)
- [StreamOptions](../interfaces/internal-8.internal-2.StreamOptions.md)
- [WritableOptions](../interfaces/internal-8.internal-2.WritableOptions.md)
## References
### Duplex
Re-exports [Duplex](../classes/internal-8.Duplex.md)
___
### DuplexOptions
Re-exports [DuplexOptions](../interfaces/internal-8.DuplexOptions.md)
___
### PassThrough
Re-exports [PassThrough](../classes/internal-8.PassThrough.md)
___
### Readable
Re-exports [Readable](../classes/internal-8.Readable.md)
___
### Stream
Re-exports [Stream](../classes/internal-8.Stream.md)
___
### Transform
Re-exports [Transform](../classes/internal-8.Transform.md)
___
### TransformCallback
Re-exports [TransformCallback](internal-8.md#transformcallback)
___
### TransformOptions
Re-exports [TransformOptions](../interfaces/internal-8.TransformOptions.md)
## Type Aliases
### PipelineCallback
Ƭ **PipelineCallback**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, infer P\> ? (`err`: [`ErrnoException`](../interfaces/internal-8.ErrnoException.md) \| ``null``, `value`: `P`) => `void` : (`err`: [`ErrnoException`](../interfaces/internal-8.ErrnoException.md) \| ``null``) => `void`
#### Type parameters
| Name | Type |
| :------ | :------ |
| `S` | extends [`PipelineDestination`](internal-8.internal-2.md#pipelinedestination)<`any`, `any`\> |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1243
___
### PipelineDestination
Ƭ **PipelineDestination**<`S`, `P`\>: `S` extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource)<infer ST\> ? [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`ST`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`ST`, `P`\> : `never`
#### Type parameters
| Name | Type |
| :------ | :------ |
| `S` | extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource)<`any`\> |
| `P` | `P` |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1240
___
### PipelineDestinationIterableFunction
Ƭ **PipelineDestinationIterableFunction**<`T`\>: (`source`: [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>) => [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Type declaration
▸ (`source`): [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `source` | [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> |
##### Returns
[`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1238
___
### PipelineDestinationPromiseFunction
Ƭ **PipelineDestinationPromiseFunction**<`T`, `P`\>: (`source`: [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>) => `Promise`<`P`\>
#### Type parameters
| Name |
| :------ |
| `T` |
| `P` |
#### Type declaration
▸ (`source`): `Promise`<`P`\>
##### Parameters
| Name | Type |
| :------ | :------ |
| `source` | [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> |
##### Returns
`Promise`<`P`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1239
___
### PipelinePromise
Ƭ **PipelinePromise**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, infer P\> ? `Promise`<`P`\> : `Promise`<`void`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `S` | extends [`PipelineDestination`](internal-8.internal-2.md#pipelinedestination)<`any`, `any`\> |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1246
___
### PipelineSource
Ƭ **PipelineSource**<`T`\>: [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> \| [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`PipelineSourceFunction`](internal-8.internal-2.md#pipelinesourcefunction)<`T`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1233
___
### PipelineSourceFunction
Ƭ **PipelineSourceFunction**<`T`\>: () => [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Type declaration
▸ (): [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>
##### Returns
[`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1232
___
### PipelineTransform
Ƭ **PipelineTransform**<`S`, `U`\>: [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| (`source`: `S` extends (...`args`: `any`[]) => [`Iterable`](../interfaces/internal-8.Iterable.md)<infer ST\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<infer ST\> ? [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`ST`\> : `S`) => [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`U`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `S` | extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource)<`any`\> |
| `U` | `U` |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1234
___
### PipelineTransformSource
Ƭ **PipelineTransformSource**<`T`\>: [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`T`\> \| [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`any`, `T`\>
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1237
## Variables
### consumers
• `Const` **consumers**: typeof [`internal`](internal-8.internal-4.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1414
___
### promises
• `Const` **promises**: typeof [`internal`](internal-8.internal-3.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1413
## Functions
### addAbortSignal
▸ **addAbortSignal**<`T`\>(`signal`, `stream`): `T`
A stream to attach a signal to.
Attaches an AbortSignal to a readable or writeable stream. This lets code
control stream destruction using an `AbortController`.
Calling `abort` on the `AbortController` corresponding to the passed`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`on the stream, and `controller.error(new
AbortError())` for webstreams.
```js
const fs = require('node:fs');
const controller = new AbortController();
const read = addAbortSignal(
controller.signal,
fs.createReadStream(('object.json')),
);
// Later, abort the operation closing the stream
controller.abort();
```
Or using an `AbortSignal` with a readable stream as an async iterable:
```js
const controller = new AbortController();
setTimeout(() => controller.abort(), 10_000); // set a timeout
const stream = addAbortSignal(
controller.signal,
fs.createReadStream(('object.json')),
);
(async () => {
try {
for await (const chunk of stream) {
await process(chunk);
}
} catch (e) {
if (e.name === 'AbortError') {
// The operation was cancelled
} else {
throw e;
}
}
})();
```
Or using an `AbortSignal` with a ReadableStream:
```js
const controller = new AbortController();
const rs = new ReadableStream({
start(controller) {
controller.enqueue('hello');
controller.enqueue('world');
controller.close();
},
});
addAbortSignal(controller.signal, rs);
finished(rs, (err) => {
if (err) {
if (err.name === 'AbortError') {
// The operation was cancelled
}
}
});
const reader = rs.getReader();
reader.read().then(({ value, done }) => {
console.log(value); // hello
console.log(done); // false
controller.abort();
});
```
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | extends [`Stream`](../classes/internal-8.Stream.md) |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `signal` | `AbortSignal` | A signal representing possible cancellation |
| `stream` | `T` | a stream to attach a signal to |
#### Returns
`T`
**`Since`**
v15.4.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1162
___
### finished
▸ **finished**(`stream`, `options`, `callback`): () => `void`
A readable and/or writable stream/webstream.
A function to get notified when a stream is no longer readable, writable
or has experienced an error or a premature close event.
```js
const { finished } = require('node:stream');
const fs = require('node:fs');
const rs = fs.createReadStream('archive.tar');
finished(rs, (err) => {
if (err) {
console.error('Stream failed.', err);
} else {
console.log('Stream is done reading.');
}
});
rs.resume(); // Drain the stream.
```
Especially useful in error handling scenarios where a stream is destroyed
prematurely (like an aborted HTTP request), and will not emit `'end'`or `'finish'`.
The `finished` API provides `promise version`.
`stream.finished()` leaves dangling event listeners (in particular`'error'`, `'end'`, `'finish'` and `'close'`) after `callback` has been
invoked. The reason for this is so that unexpected `'error'` events (due to
incorrect stream implementations) do not cause unexpected crashes.
If this is unwanted behavior then the returned cleanup function needs to be
invoked in the callback:
```js
const cleanup = finished(rs, (err) => {
cleanup();
// ...
});
```
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | A readable and/or writable stream. |
| `options` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) | - |
| `callback` | (`err?`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` | A callback function that takes an optional error argument. |
#### Returns
`fn`
A cleanup function which removes all registered listeners.
▸ (): `void`
##### Returns
`void`
**`Since`**
v10.0.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1227
▸ **finished**(`stream`, `callback`): () => `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `callback` | (`err?`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` |
#### Returns
`fn`
▸ (): `void`
##### Returns
`void`
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1228
___
### getDefaultHighWaterMark
▸ **getDefaultHighWaterMark**(`objectMode`): `number`
Returns the default highWaterMark used by streams.
Defaults to `16384` (16 KiB), or `16` for `objectMode`.
#### Parameters
| Name | Type |
| :------ | :------ |
| `objectMode` | `boolean` |
#### Returns
`number`
**`Since`**
v19.9.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1169
___
### isErrored
▸ **isErrored**(`stream`): `boolean`
Returns whether the stream has encountered an error.
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`Writable`](../classes/internal-8.internal-2.Writable.md) |
#### Returns
`boolean`
**`Since`**
v17.3.0, v16.14.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1406
___
### isReadable
▸ **isReadable**(`stream`): `boolean`
Returns whether the stream is readable.
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) |
#### Returns
`boolean`
**`Since`**
v17.4.0, v16.14.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1412
___
### pipeline
▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
A module method to pipe between streams and generators forwarding errors and
properly cleaning up and provide a callback when the pipeline is complete.
```js
const { pipeline } = require('node:stream');
const fs = require('node:fs');
const zlib = require('node:zlib');
// Use the pipeline API to easily pipe a series of streams
// together and get notified when the pipeline is fully done.
// A pipeline to gzip a potentially huge tar file efficiently:
pipeline(
fs.createReadStream('archive.tar'),
zlib.createGzip(),
fs.createWriteStream('archive.tar.gz'),
(err) => {
if (err) {
console.error('Pipeline failed.', err);
} else {
console.log('Pipeline succeeded.');
}
},
);
```
The `pipeline` API provides a `promise version`.
`stream.pipeline()` will call `stream.destroy(err)` on all streams except:
* `Readable` streams which have emitted `'end'` or `'close'`.
* `Writable` streams which have emitted `'finish'` or `'close'`.
`stream.pipeline()` leaves dangling event listeners on the streams
after the `callback` has been invoked. In the case of reuse of streams after
failure, this can cause event listener leaks and swallowed errors. If the last
stream is readable, dangling event listeners will be removed so that the last
stream can be consumed later.
`stream.pipeline()` closes all the streams when an error is raised.
The `IncomingRequest` usage with `pipeline` could lead to an unexpected behavior
once it would destroy the socket without sending the expected response.
See the example below:
```js
const fs = require('node:fs');
const http = require('node:http');
const { pipeline } = require('node:stream');
const server = http.createServer((req, res) => {
const fileStream = fs.createReadStream('./fileNotExist.txt');
pipeline(fileStream, res, (err) => {
if (err) {
console.log(err); // No such file
// this message can't be sent once `pipeline` already destroyed the socket
return res.end('error!!!');
}
});
});
```
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `source` | `A` | - |
| `destination` | `B` | - |
| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | Called when the pipeline is fully done. |
#### Returns
`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
**`Since`**
v10.0.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1316
▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `destination` | `B` |
| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> |
#### Returns
`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1321
▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `destination` | `B` |
| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> |
#### Returns
`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1327
▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `destination` | `B` |
| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> |
#### Returns
`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1334
▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `transform4` | `T4` |
| `destination` | `B` |
| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> |
#### Returns
`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1341
▸ **pipeline**(`streams`, `callback?`): [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] |
| `callback?` | (`err`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` |
#### Returns
[`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1349
▸ **pipeline**(`stream1`, `stream2`, `...streams`): [`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) |
| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| (`err`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void`)[] |
#### Returns
[`WritableStream`](../interfaces/internal-8.WritableStream.md)
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1353
___
### setDefaultHighWaterMark
▸ **setDefaultHighWaterMark**(`objectMode`, `value`): `void`
Sets the default highWaterMark used by streams.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `objectMode` | `boolean` | |
| `value` | `number` | highWaterMark value |
#### Returns
`void`
**`Since`**
v19.9.0
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1176
www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md
+191
View File
@@ -0,0 +1,191 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: pipeline
[internal](internal-8.md).[internal](internal-8.internal-2.md).pipeline
## Functions
### \_\_promisify\_\_
▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1359
▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1360
▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1366
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1373
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `transform4` | `T4` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1380
▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1388
▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) |
| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md))[] |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream.d.ts:1389
www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md
+212
View File
@@ -0,0 +1,212 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
[internal](internal-8.md).internal
## Functions
### finished
▸ **finished**(`stream`, `options?`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `options?` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:3
___
### pipeline
▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:4
▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:5
▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:11
▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:18
▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> |
| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> |
| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> |
| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> |
| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> |
| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> |
#### Parameters
| Name | Type |
| :------ | :------ |
| `source` | `A` |
| `transform1` | `T1` |
| `transform2` | `T2` |
| `transform3` | `T3` |
| `transform4` | `T4` |
| `destination` | `B` |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:25
▸ **pipeline**(`streams`, `options?`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] |
| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:33
▸ **pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) |
| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) |
| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md))[] |
#### Returns
`Promise`<`void`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:34
www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md
+107
View File
@@ -0,0 +1,107 @@
---
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
[internal](internal-8.md).internal
## Functions
### arrayBuffer
▸ **arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> |
#### Returns
`Promise`<`ArrayBuffer`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:6
___
### blob
▸ **blob**(`stream`): `Promise`<[`Blob`](../classes/internal-8.Blob.md)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> |
#### Returns
`Promise`<[`Blob`](../classes/internal-8.Blob.md)\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:7
___
### buffer
▸ **buffer**(`stream`): `Promise`<[`Buffer`](internal-8.md#buffer)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> |
#### Returns
`Promise`<[`Buffer`](internal-8.md#buffer)\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:4
___
### json
▸ **json**(`stream`): `Promise`<`unknown`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> |
#### Returns
`Promise`<`unknown`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:8
___
### text
▸ **text**(`stream`): `Promise`<`string`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> |
#### Returns
`Promise`<`string`\>
#### Defined in
packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:5
www/apps/docs/content/references/js-client/modules/internal-8.internal.md
+9655
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/modules/internal-8.md
+7107 -24
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/modules/internal-9.md
+10 -18
View File
@@ -1,33 +1,25 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Classes
- [AdminGetGiftCardsParams](../classes/internal-9.AdminGetGiftCardsParams.md)
- [AdminPostGiftCardsGiftCardReq](../classes/internal-9.AdminPostGiftCardsGiftCardReq.md)
- [AdminPostGiftCardsReq](../classes/internal-9.AdminPostGiftCardsReq.md)
# Module: internal
## Type Aliases
### AdminGiftCardsListRes
### AdminPostInvitesPayload
Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] }
Ƭ **AdminPostInvitesPayload**: [`Omit`](internal-1.md#omit)<[`AdminPostInvitesReq`](../classes/internal-8.internal.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) }
#### Defined in
medusa/dist/api/routes/admin/gift-cards/index.d.ts:14
[packages/medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L47)
___
### AdminGiftCardsRes
### InviteUserRolesEnum
Ƭ **AdminGiftCardsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
#### Defined in
medusa/dist/api/routes/admin/gift-cards/index.d.ts:10
[packages/medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L45)
www/apps/docs/content/references/js-client/modules/internal.md
+7 -206
View File
@@ -2,229 +2,30 @@
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
## Enumerations
- [AllocationType](../enums/internal.AllocationType.md)
- [CartType](../enums/internal.CartType.md)
- [ClaimFulfillmentStatus](../enums/internal.ClaimFulfillmentStatus.md)
- [ClaimPaymentStatus](../enums/internal.ClaimPaymentStatus.md)
- [ClaimReason](../enums/internal.ClaimReason.md)
- [ClaimType](../enums/internal.ClaimType.md)
- [DiscountConditionOperator](../enums/internal.DiscountConditionOperator.md)
- [DiscountConditionType](../enums/internal.DiscountConditionType.md)
- [DiscountRuleType](../enums/internal.DiscountRuleType.md)
- [DraftOrderStatus](../enums/internal.DraftOrderStatus.md)
- [FulfillmentStatus](../enums/internal.FulfillmentStatus.md)
- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal.OrderEditStatus.md)
- [OrderStatus](../enums/internal.OrderStatus.md)
- [PaymentCollectionStatus](../enums/internal.PaymentCollectionStatus.md)
- [PaymentStatus](../enums/internal.PaymentStatus.md)
- [PriceListStatus](../enums/internal.PriceListStatus.md)
- [PriceListType](../enums/internal.PriceListType.md)
- [ProductStatus](../enums/internal.ProductStatus.md)
- [RequirementType](../enums/internal.RequirementType.md)
- [ReturnStatus](../enums/internal.ReturnStatus.md)
- [ShippingOptionPriceType](../enums/internal.ShippingOptionPriceType.md)
- [ShippingProfileType](../enums/internal.ShippingProfileType.md)
- [SwapFulfillmentStatus](../enums/internal.SwapFulfillmentStatus.md)
- [SwapPaymentStatus](../enums/internal.SwapPaymentStatus.md)
# Module: internal
## Classes
- [Address](../classes/internal.Address.md)
- [AddressCreatePayload](../classes/internal.AddressCreatePayload.md)
- [AddressPayload](../classes/internal.AddressPayload.md)
- [Axios](../classes/internal.Axios.md)
- [BaseEntity](../classes/internal.BaseEntity.md)
- [Cart](../classes/internal.Cart.md)
- [ClaimImage](../classes/internal.ClaimImage.md)
- [ClaimItem](../classes/internal.ClaimItem.md)
- [ClaimOrder](../classes/internal.ClaimOrder.md)
- [ClaimTag](../classes/internal.ClaimTag.md)
- [Client](../classes/internal.Client.md)
- [Country](../classes/internal.Country.md)
- [Currency](../classes/internal.Currency.md)
- [Customer](../classes/internal.Customer.md)
- [CustomerGroup](../classes/internal.CustomerGroup.md)
- [Discount](../classes/internal.Discount.md)
- [DiscountCondition](../classes/internal.DiscountCondition.md)
- [DiscountRule](../classes/internal.DiscountRule.md)
- [DraftOrder](../classes/internal.DraftOrder.md)
- [Fulfillment](../classes/internal.Fulfillment.md)
- [FulfillmentItem](../classes/internal.FulfillmentItem.md)
- [FulfillmentProvider](../classes/internal.FulfillmentProvider.md)
- [GiftCard](../classes/internal.GiftCard.md)
- [GiftCardTransaction](../classes/internal.GiftCardTransaction.md)
- [Image](../classes/internal.Image.md)
- [LineItem](../classes/internal.LineItem.md)
- [LineItemAdjustment](../classes/internal.LineItemAdjustment.md)
- [LineItemTaxLine](../classes/internal.LineItemTaxLine.md)
- [MoneyAmount](../classes/internal.MoneyAmount.md)
- [Order](../classes/internal.Order.md)
- [OrderEdit](../classes/internal.OrderEdit.md)
- [OrderItemChange](../classes/internal.OrderItemChange.md)
- [Payment](../classes/internal.Payment.md)
- [PaymentCollection](../classes/internal.PaymentCollection.md)
- [PaymentProvider](../classes/internal.PaymentProvider.md)
- [PaymentSession](../classes/internal.PaymentSession.md)
- [PriceList](../classes/internal.PriceList.md)
- [Product](../classes/internal.Product.md)
- [ProductCollection](../classes/internal.ProductCollection.md)
- [ProductOption](../classes/internal.ProductOption.md)
- [ProductOptionValue](../classes/internal.ProductOptionValue.md)
- [ProductTag](../classes/internal.ProductTag.md)
- [ProductType](../classes/internal.ProductType.md)
- [ProductVariant](../classes/internal.ProductVariant.md)
- [Refund](../classes/internal.Refund.md)
- [Region](../classes/internal.Region.md)
- [Return](../classes/internal.Return.md)
- [ReturnItem](../classes/internal.ReturnItem.md)
- [ReturnReason](../classes/internal.ReturnReason.md)
- [SalesChannel](../classes/internal.SalesChannel.md)
- [ShippingMethod](../classes/internal.ShippingMethod.md)
- [ShippingMethodTaxLine](../classes/internal.ShippingMethodTaxLine.md)
- [ShippingOption](../classes/internal.ShippingOption.md)
- [ShippingOptionRequirement](../classes/internal.ShippingOptionRequirement.md)
- [ShippingProfile](../classes/internal.ShippingProfile.md)
- [SoftDeletableEntity](../classes/internal.SoftDeletableEntity.md)
- [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md)
- [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md)
- [Swap](../classes/internal.Swap.md)
- [TaxLine](../classes/internal.TaxLine.md)
- [TaxProvider](../classes/internal.TaxProvider.md)
- [TaxRate](../classes/internal.TaxRate.md)
- [TrackingLink](../classes/internal.TrackingLink.md)
## Interfaces
- [AxiosAdapter](../interfaces/internal.AxiosAdapter.md)
- [AxiosBasicCredentials](../interfaces/internal.AxiosBasicCredentials.md)
- [AxiosDefaults](../interfaces/internal.AxiosDefaults.md)
- [AxiosError](../interfaces/internal.AxiosError.md)
- [AxiosInstance](../interfaces/internal.AxiosInstance.md)
- [AxiosInterceptorManager](../interfaces/internal.AxiosInterceptorManager.md)
- [AxiosPromise](../interfaces/internal.AxiosPromise.md)
- [AxiosProxyConfig](../interfaces/internal.AxiosProxyConfig.md)
- [AxiosRequestConfig](../interfaces/internal.AxiosRequestConfig.md)
- [AxiosRequestTransformer](../interfaces/internal.AxiosRequestTransformer.md)
- [AxiosResponse](../interfaces/internal.AxiosResponse.md)
- [AxiosResponseTransformer](../interfaces/internal.AxiosResponseTransformer.md)
- [Cancel](../interfaces/internal.Cancel.md)
- [CancelToken](../interfaces/internal.CancelToken.md)
- [Config](../interfaces/internal.Config.md)
- [HTTPResponse](../interfaces/internal.HTTPResponse.md)
- [HeadersDefaults](../interfaces/internal.HeadersDefaults.md)
- [RequestOptions](../interfaces/internal.RequestOptions.md)
- [RetryConfig](../interfaces/internal.RetryConfig.md)
- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md)
## Enumeration Members
### ORDER\_EDIT
• **ORDER\_EDIT**: ``"order_edit"``
#### Defined in
medusa/dist/models/payment-collection.d.ts:11
## Type Aliases
### AxiosRequestHeaders
### Record
Ƭ **AxiosRequestHeaders**: `Record`<`string`, `string`\>
Ƭ **Record**<`K`, `T`\>: { [P in K]: T }
#### Defined in
medusa-js/node_modules/axios/index.d.ts:3
___
### AxiosResponseHeaders
Ƭ **AxiosResponseHeaders**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] }
#### Defined in
medusa-js/node_modules/axios/index.d.ts:5
___
### Method
Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``
#### Defined in
medusa-js/node_modules/axios/index.d.ts:36
___
### RequestMethod
Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"``
#### Defined in
[medusa-js/src/request.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L26)
___
### Response
Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal.HTTPResponse.md) }
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L17)
___
### ResponsePromise
Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal.md#response)<`T`\>\>
Construct a type with a set of properties K of type T
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
| `K` | extends keyof `any` |
| `T` | `T` |
#### Defined in
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L21)
___
### ResponseType
Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"``
#### Defined in
medusa-js/node_modules/axios/index.d.ts:48
___
### StoreCustomersRes
Ƭ **StoreCustomersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | `Omit`<[`Customer`](../classes/internal.Customer.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:9
docs-util/node_modules/typescript/lib/lib.es5.d.ts:1599