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

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/classes/AddressesResource.mdx
+9 -9
View File
@@ -197,7 +197,7 @@ medusa.customers.addresses
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -214,7 +214,7 @@ medusa.customers.addresses
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -232,7 +232,7 @@ medusa.customers.addresses
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -407,7 +407,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -424,7 +424,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -442,7 +442,7 @@ medusa.customers.addresses.deleteAddress(addressId).then(({ customer }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -730,7 +730,7 @@ medusa.customers.addresses
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\">",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -747,7 +747,7 @@ medusa.customers.addresses
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -765,7 +765,7 @@ medusa.customers.addresses
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminAuthResource.mdx
+4 -4
View File
@@ -99,7 +99,7 @@ medusa.admin.AdminAuthResource.createSession({
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ medusa.admin.AdminAuthResource.createSession({
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -299,7 +299,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -325,7 +325,7 @@ medusa.admin.auth.getSession().then(({ user }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx
+21 -21
View File
@@ -131,7 +131,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -149,7 +149,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ medusa.admin.batchJobs.cancel(batchJobId).then(({ batch_job }) => {
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -359,7 +359,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -377,7 +377,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ medusa.admin.batchJobs.confirm(batchJobId).then(({ batch_job }) => {
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -620,7 +620,7 @@ medusa.admin.batchJobs.create({
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -638,7 +638,7 @@ medusa.admin.batchJobs.create({
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -692,7 +692,7 @@ medusa.admin.batchJobs.create({
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -798,7 +798,7 @@ medusa.admin.batchJobs
"children": [
{
"name": "canceled_at",
"type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the batch jobs' `canceled_at` date.",
"optional": true,
"defaultValue": "",
@@ -807,7 +807,7 @@ medusa.admin.batchJobs
},
{
"name": "completed_at",
"type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the batch jobs' `completed_at` date.",
"optional": true,
"defaultValue": "",
@@ -816,7 +816,7 @@ medusa.admin.batchJobs
},
{
"name": "confirmed_at",
"type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the batch jobs' `confirmed_at` date.",
"optional": true,
"defaultValue": "",
@@ -880,7 +880,7 @@ medusa.admin.batchJobs
},
{
"name": "failed_at",
"type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the batch jobs' `failed_at` date.",
"optional": true,
"defaultValue": "",
@@ -934,7 +934,7 @@ medusa.admin.batchJobs
},
{
"name": "pre_processed_at",
"type": "``null`` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"type": "`null` \\| [DateComparisonOperator](../internal/classes/internal.DateComparisonOperator.mdx)",
"description": "Date filters to apply on the batch jobs' `pre_processed_at` date.",
"optional": true,
"defaultValue": "",
@@ -1022,7 +1022,7 @@ medusa.admin.batchJobs
"children": [
{
"name": "AdminBatchJobListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; batch_jobs: [BatchJob](../internal/classes/internal.BatchJob.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ batch_jobs: [BatchJob](../internal/classes/internal.BatchJob.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1110,7 +1110,7 @@ medusa.admin.batchJobs
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -1128,7 +1128,7 @@ medusa.admin.batchJobs
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1182,7 +1182,7 @@ medusa.admin.batchJobs
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -1338,7 +1338,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => {
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -1356,7 +1356,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1410,7 +1410,7 @@ medusa.admin.batchJobs.retrieve(batchJobId).then(({ batch_job }) => {
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../internal/types/internal.internal.BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../internal/types/internal.internal.BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.mdx
+6 -6
View File
@@ -115,7 +115,7 @@ medusa.admin.collections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -294,7 +294,7 @@ medusa.admin.collections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -713,7 +713,7 @@ medusa.admin.collections
"children": [
{
"name": "AdminCollectionsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -765,7 +765,7 @@ medusa.admin.collections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1027,7 +1027,7 @@ medusa.admin.collections.retrieve(collectionId).then(({ collection }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1215,7 +1215,7 @@ medusa.admin.collections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.mdx
+1 -1
View File
@@ -135,7 +135,7 @@ medusa.admin.currencies
"children": [
{
"name": "AdminCurrenciesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; currencies: [Currency](../internal/classes/internal.Currency.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ currencies: [Currency](../internal/classes/internal.Currency.mdx)[] }``",
"description": "List of currencies with pagination fields.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.mdx
+10 -10
View File
@@ -122,7 +122,7 @@ Add a list of customers to a customer group.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ medusa.admin.customerGroups
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -690,7 +690,7 @@ medusa.admin.customerGroups
"children": [
{
"name": "AdminCustomerGroupsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; customer_groups: [CustomerGroup](../internal/classes/internal.CustomerGroup.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customer_groups: [CustomerGroup](../internal/classes/internal.CustomerGroup.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -751,7 +751,7 @@ medusa.admin.customerGroups
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -930,7 +930,7 @@ medusa.admin.customerGroups
"children": [
{
"name": "AdminCustomersListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; customers: [Customer](../internal/classes/internal.Customer.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }``",
"description": "The list of customers with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -982,7 +982,7 @@ medusa.admin.customerGroups
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -1000,7 +1000,7 @@ medusa.admin.customerGroups
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1238,7 +1238,7 @@ medusa.admin.customerGroups
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1415,7 +1415,7 @@ medusa.admin.customerGroups
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1579,7 +1579,7 @@ Update a customer group's details.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminCustomersResource.mdx
+9 -9
View File
@@ -156,7 +156,7 @@ medusa.admin.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ medusa.admin.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -430,7 +430,7 @@ medusa.admin.customers
"children": [
{
"name": "AdminCustomersListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; customers: [Customer](../internal/classes/internal.Customer.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ customers: [Customer](../internal/classes/internal.Customer.mdx)[] }``",
"description": "The list of customers with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ medusa.admin.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ medusa.admin.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -692,7 +692,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -710,7 +710,7 @@ medusa.admin.customers.retrieve(customerId).then(({ customer }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -989,7 +989,7 @@ medusa.admin.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -1007,7 +1007,7 @@ medusa.admin.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.mdx
+73 -73
View File
@@ -94,7 +94,7 @@ medusa.admin.discounts
"children": [
{
"name": "resources",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The resources to be added to the discount condition",
"optional": false,
"defaultValue": "",
@@ -199,7 +199,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -208,7 +208,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -325,7 +325,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -334,7 +334,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -445,7 +445,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -454,7 +454,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -571,7 +571,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -580,7 +580,7 @@ medusa.admin.discounts.addRegion(discountId, regionId).then(({ discount }) => {
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ medusa.admin.discounts
"children": [
{
"name": "ITEM",
"type": "``\"item\"``",
"type": "`\"item\"`",
"description": "The discount should be applied to applicable items in the cart.",
"optional": true,
"defaultValue": "",
@@ -717,7 +717,7 @@ medusa.admin.discounts
},
{
"name": "TOTAL",
"type": "``\"total\"``",
"type": "`\"total\"`",
"description": "The discount should be applied to the checkout total.",
"optional": true,
"defaultValue": "",
@@ -809,7 +809,7 @@ medusa.admin.discounts
"children": [
{
"name": "FIXED",
"type": "``\"fixed\"``",
"type": "`\"fixed\"`",
"description": "Discounts that reduce the price by a fixed amount.",
"optional": true,
"defaultValue": "",
@@ -818,7 +818,7 @@ medusa.admin.discounts
},
{
"name": "FREE_SHIPPING",
"type": "``\"free_shipping\"``",
"type": "`\"free_shipping\"`",
"description": "Discounts that sets the shipping price to `0`.",
"optional": true,
"defaultValue": "",
@@ -827,7 +827,7 @@ medusa.admin.discounts
},
{
"name": "PERCENTAGE",
"type": "``\"percentage\"``",
"type": "`\"percentage\"`",
"description": "Discounts that reduce the price by a percentage reduction.",
"optional": true,
"defaultValue": "",
@@ -934,7 +934,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -943,7 +943,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -1060,7 +1060,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1069,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -1172,7 +1172,7 @@ medusa.admin.discounts
"children": [
{
"name": "IN",
"type": "``\"in\"``",
"type": "`\"in\"`",
"description": "The discountable resources are within the specified resources.",
"optional": true,
"defaultValue": "",
@@ -1181,7 +1181,7 @@ medusa.admin.discounts
},
{
"name": "NOT_IN",
"type": "``\"not_in\"``",
"type": "`\"not_in\"`",
"description": "The discountable resources are everything but the specified resources.",
"optional": true,
"defaultValue": "",
@@ -1314,7 +1314,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1323,7 +1323,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -1440,7 +1440,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -1449,7 +1449,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -1593,7 +1593,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1602,7 +1602,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -1719,7 +1719,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -1728,7 +1728,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -1970,7 +1970,7 @@ medusa.admin.discounts
"children": [
{
"name": "resources",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "The resources to be removed from the discount condition",
"optional": false,
"defaultValue": "",
@@ -2047,7 +2047,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2056,7 +2056,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -2173,7 +2173,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -2182,7 +2182,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -2295,7 +2295,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2304,7 +2304,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -2421,7 +2421,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -2430,7 +2430,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -2588,7 +2588,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2845,7 +2845,7 @@ medusa.admin.discounts
"children": [
{
"name": "ITEM",
"type": "``\"item\"``",
"type": "`\"item\"`",
"description": "The discount should be applied to applicable items in the cart.",
"optional": true,
"defaultValue": "",
@@ -2854,7 +2854,7 @@ medusa.admin.discounts
},
{
"name": "TOTAL",
"type": "``\"total\"``",
"type": "`\"total\"`",
"description": "The discount should be applied to the checkout total.",
"optional": true,
"defaultValue": "",
@@ -2873,7 +2873,7 @@ medusa.admin.discounts
"children": [
{
"name": "FIXED",
"type": "``\"fixed\"``",
"type": "`\"fixed\"`",
"description": "Discounts that reduce the price by a fixed amount.",
"optional": true,
"defaultValue": "",
@@ -2882,7 +2882,7 @@ medusa.admin.discounts
},
{
"name": "FREE_SHIPPING",
"type": "``\"free_shipping\"``",
"type": "`\"free_shipping\"`",
"description": "Discounts that sets the shipping price to `0`.",
"optional": true,
"defaultValue": "",
@@ -2891,7 +2891,7 @@ medusa.admin.discounts
},
{
"name": "PERCENTAGE",
"type": "``\"percentage\"``",
"type": "`\"percentage\"`",
"description": "Discounts that reduce the price by a percentage reduction.",
"optional": true,
"defaultValue": "",
@@ -2928,7 +2928,7 @@ medusa.admin.discounts
"children": [
{
"name": "AdminDiscountsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; discounts: [Discount](../internal/classes/internal.Discount-1.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ discounts: [Discount](../internal/classes/internal.Discount-1.mdx)[] }``",
"description": "The list of discounts with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -2989,7 +2989,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2998,7 +2998,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -3115,7 +3115,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -3124,7 +3124,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -3237,7 +3237,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3246,7 +3246,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -3363,7 +3363,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -3372,7 +3372,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -3474,7 +3474,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3483,7 +3483,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -3600,7 +3600,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -3609,7 +3609,7 @@ medusa.admin.discounts.retrieve(discountId).then(({ discount }) => {
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -3711,7 +3711,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3720,7 +3720,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -3837,7 +3837,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -3846,7 +3846,7 @@ medusa.admin.discounts.retrieveByCode(code).then(({ discount }) => {
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -3913,7 +3913,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date and time at which the discount should no longer be available.",
"optional": true,
"defaultValue": "",
@@ -3965,7 +3965,7 @@ medusa.admin.discounts
"children": [
{
"name": "ITEM",
"type": "``\"item\"``",
"type": "`\"item\"`",
"description": "The discount should be applied to applicable items in the cart.",
"optional": true,
"defaultValue": "",
@@ -3974,7 +3974,7 @@ medusa.admin.discounts
},
{
"name": "TOTAL",
"type": "``\"total\"``",
"type": "`\"total\"`",
"description": "The discount should be applied to the checkout total.",
"optional": true,
"defaultValue": "",
@@ -4096,7 +4096,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Maximum number of times the discount can be used",
"optional": true,
"defaultValue": "",
@@ -4105,7 +4105,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The duration the discount runs between",
"optional": true,
"defaultValue": "",
@@ -4172,7 +4172,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -4181,7 +4181,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -4298,7 +4298,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -4307,7 +4307,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -4530,7 +4530,7 @@ medusa.admin.discounts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -4539,7 +4539,7 @@ medusa.admin.discounts
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -4656,7 +4656,7 @@ medusa.admin.discounts
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -4665,7 +4665,7 @@ medusa.admin.discounts
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.mdx
+7 -7
View File
@@ -861,7 +861,7 @@ medusa.admin.draftOrders
"children": [
{
"name": "AdminDraftOrdersListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ draft_orders: [DraftOrder](../internal/classes/internal.DraftOrder.mdx)[] }``",
"description": "The list of draft orders with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1268,7 +1268,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -1349,7 +1349,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -1493,7 +1493,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1529,7 +1529,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1574,7 +1574,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1583,7 +1583,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId).then(({ order }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.mdx
+10 -10
View File
@@ -163,7 +163,7 @@ medusa.admin.giftCards
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -244,7 +244,7 @@ medusa.admin.giftCards
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
@@ -458,7 +458,7 @@ medusa.admin.giftCards
"children": [
{
"name": "AdminGiftCardsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; gift_cards: [GiftCard](../internal/classes/internal.GiftCard-1.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ gift_cards: [GiftCard](../internal/classes/internal.GiftCard-1.mdx)[] }``",
"description": "The list of gift cards with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ medusa.admin.giftCards
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -609,7 +609,7 @@ medusa.admin.giftCards
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
@@ -738,7 +738,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -819,7 +819,7 @@ medusa.admin.giftCards.retrieve(giftCardId).then(({ gift_card }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
@@ -904,7 +904,7 @@ medusa.admin.giftCards
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date and time at which the Gift Card should no longer be available.",
"optional": true,
"defaultValue": "",
@@ -1007,7 +1007,7 @@ medusa.admin.giftCards
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1088,7 +1088,7 @@ medusa.admin.giftCards
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.mdx
+99 -99
View File
@@ -254,7 +254,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -263,7 +263,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -272,7 +272,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -281,7 +281,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -299,7 +299,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -308,7 +308,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -317,7 +317,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -326,7 +326,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -335,7 +335,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -353,7 +353,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -362,7 +362,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -371,7 +371,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -389,7 +389,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -398,7 +398,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -561,7 +561,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -570,7 +570,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -579,7 +579,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -588,7 +588,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -606,7 +606,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -615,7 +615,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -624,7 +624,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -633,7 +633,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -642,7 +642,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -660,7 +660,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -669,7 +669,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -678,7 +678,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -696,7 +696,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -705,7 +705,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1056,7 +1056,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1065,7 +1065,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -1074,7 +1074,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1083,7 +1083,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1101,7 +1101,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1110,7 +1110,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1119,7 +1119,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -1128,7 +1128,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1137,7 +1137,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1155,7 +1155,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -1164,7 +1164,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -1173,7 +1173,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -1191,7 +1191,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1200,7 +1200,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1425,7 +1425,7 @@ medusa.admin.inventoryItems
"children": [
{
"name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; inventory_items: [DecoratedInventoryItemDTO](../internal/types/internal.DecoratedInventoryItemDTO.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ inventory_items: [DecoratedInventoryItemDTO](../internal/types/internal.DecoratedInventoryItemDTO.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1477,7 +1477,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1486,7 +1486,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -1495,7 +1495,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1504,7 +1504,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1522,7 +1522,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1531,7 +1531,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1540,7 +1540,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -1549,7 +1549,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1558,7 +1558,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1576,7 +1576,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -1585,7 +1585,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -1594,7 +1594,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -1612,7 +1612,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1621,7 +1621,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1912,7 +1912,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1921,7 +1921,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -1930,7 +1930,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1939,7 +1939,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1957,7 +1957,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -1966,7 +1966,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1975,7 +1975,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -1984,7 +1984,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -1993,7 +1993,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2011,7 +2011,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -2020,7 +2020,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -2029,7 +2029,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -2047,7 +2047,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2056,7 +2056,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2308,7 +2308,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2317,7 +2317,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -2326,7 +2326,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2335,7 +2335,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2353,7 +2353,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2362,7 +2362,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2371,7 +2371,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -2380,7 +2380,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2389,7 +2389,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2407,7 +2407,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -2416,7 +2416,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -2425,7 +2425,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -2443,7 +2443,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2452,7 +2452,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2614,7 +2614,7 @@ medusa.admin.inventoryItems
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2623,7 +2623,7 @@ medusa.admin.inventoryItems
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the inventory item",
"optional": true,
"defaultValue": "",
@@ -2632,7 +2632,7 @@ medusa.admin.inventoryItems
},
{
"name": "height",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2641,7 +2641,7 @@ medusa.admin.inventoryItems
},
{
"name": "hs_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2659,7 +2659,7 @@ medusa.admin.inventoryItems
},
{
"name": "length",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2668,7 +2668,7 @@ medusa.admin.inventoryItems
},
{
"name": "material",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2677,7 +2677,7 @@ medusa.admin.inventoryItems
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": true,
"defaultValue": "",
@@ -2686,7 +2686,7 @@ medusa.admin.inventoryItems
},
{
"name": "mid_code",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2695,7 +2695,7 @@ medusa.admin.inventoryItems
},
{
"name": "origin_country",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": true,
"defaultValue": "",
@@ -2713,7 +2713,7 @@ medusa.admin.inventoryItems
},
{
"name": "sku",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"optional": true,
"defaultValue": "",
@@ -2722,7 +2722,7 @@ medusa.admin.inventoryItems
},
{
"name": "thumbnail",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Thumbnail for the inventory item",
"optional": true,
"defaultValue": "",
@@ -2731,7 +2731,7 @@ medusa.admin.inventoryItems
},
{
"name": "title",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Title of the inventory item",
"optional": true,
"defaultValue": "",
@@ -2749,7 +2749,7 @@ medusa.admin.inventoryItems
},
{
"name": "weight",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
@@ -2758,7 +2758,7 @@ medusa.admin.inventoryItems
},
{
"name": "width",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminInvitesResource.mdx
+1 -1
View File
@@ -372,7 +372,7 @@ medusa.admin.invites.list().then(({ invites }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx
+5 -5
View File
@@ -144,7 +144,7 @@ medusa.admin.notes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ medusa.admin.notes
"children": [
{
"name": "AdminNotesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; notes: [Note](../internal/classes/internal.Note.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ notes: [Note](../internal/classes/internal.Note.mdx)[] }``",
"description": "The list of notes with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ medusa.admin.notes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -629,7 +629,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -817,7 +817,7 @@ medusa.admin.notes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.mdx
+3 -3
View File
@@ -185,7 +185,7 @@ medusa.admin.notifications
"children": [
{
"name": "AdminNotificationsListRes",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `&#123; notifications: [Notification](../internal/classes/internal.Notification.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ notifications: [Notification](../internal/classes/internal.Notification.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ medusa.admin.notifications
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ medusa.admin.notifications.resend(notificationId).then(({ notification }) => {
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.mdx
+12 -12
View File
@@ -362,7 +362,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ medusa.admin.orderEdits.cancel(orderEditId).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1034,7 +1034,7 @@ medusa.admin.orderEdits.confirm(orderEditId).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1398,7 +1398,7 @@ medusa.admin.orderEdits.create({ orderId }).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1603,7 +1603,7 @@ medusa.admin.orderEdits
},
{
"name": "object",
"type": "``\"item_change\"``",
"type": "`\"item_change\"`",
"description": "The type of the object that was deleted.",
"optional": false,
"defaultValue": "item_change",
@@ -1758,7 +1758,7 @@ medusa.admin.orderEdits
"children": [
{
"name": "AdminOrderEditsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; order_edits: [OrderEdit](../internal/classes/internal.OrderEdit.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ order_edits: [OrderEdit](../internal/classes/internal.OrderEdit.mdx)[] }``",
"description": "The list of order edits with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -2035,7 +2035,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -2383,7 +2383,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -2721,7 +2721,7 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId)
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -3102,7 +3102,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -3461,7 +3461,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -3830,7 +3830,7 @@ medusa.admin.orderEdits
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminOrdersResource.mdx
+2 -2
View File
@@ -900,7 +900,7 @@ medusa.admin.orders
},
{
"name": "type",
"type": "``\"refund\"`` \\| ``\"replace\"``",
"type": "`\"refund\"` \\| `\"replace\"`",
"description": "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.",
"optional": false,
"defaultValue": "",
@@ -2040,7 +2040,7 @@ medusa.admin.orders
"children": [
{
"name": "AdminOrdersListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; orders: [Order](../internal/classes/internal.Order.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ orders: [Order](../internal/classes/internal.Order.mdx)[] }``",
"description": "The list of orders with pagination fields.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.mdx
+10 -10
View File
@@ -95,7 +95,7 @@ medusa.admin.paymentCollections
},
{
"name": "object",
"type": "``\"payment_collection\"``",
"type": "`\"payment_collection\"`",
"description": "The type of the object that was deleted.",
"optional": false,
"defaultValue": "payment_collection",
@@ -188,7 +188,7 @@ medusa.admin.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -233,7 +233,7 @@ medusa.admin.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -242,7 +242,7 @@ medusa.admin.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -463,7 +463,7 @@ medusa.admin.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -508,7 +508,7 @@ medusa.admin.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -517,7 +517,7 @@ medusa.admin.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -723,7 +723,7 @@ medusa.admin.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -768,7 +768,7 @@ medusa.admin.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -777,7 +777,7 @@ medusa.admin.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.mdx
+5 -5
View File
@@ -331,7 +331,7 @@ medusa.admin.payments
"children": [
{
"name": "CLAIM",
"type": "``\"claim\"``",
"type": "`\"claim\"`",
"description": "The refund is applied because of a created claim.",
"optional": true,
"defaultValue": "",
@@ -340,7 +340,7 @@ medusa.admin.payments
},
{
"name": "DISCOUNT",
"type": "``\"discount\"``",
"type": "`\"discount\"`",
"description": "The refund is applied as a discount.",
"optional": true,
"defaultValue": "",
@@ -349,7 +349,7 @@ medusa.admin.payments
},
{
"name": "OTHER",
"type": "``\"other\"``",
"type": "`\"other\"`",
"description": "The refund is created for a custom reason.",
"optional": true,
"defaultValue": "",
@@ -358,7 +358,7 @@ medusa.admin.payments
},
{
"name": "RETURN",
"type": "``\"return\"``",
"type": "`\"return\"`",
"description": "The refund is applied because of a created return.",
"optional": true,
"defaultValue": "",
@@ -367,7 +367,7 @@ medusa.admin.payments
},
{
"name": "SWAP",
"type": "``\"swap\"``",
"type": "`\"swap\"`",
"description": "The refund is applied because of a created swap.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminPriceListResource.mdx
+62 -62
View File
@@ -205,7 +205,7 @@ medusa.admin.priceLists
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -223,7 +223,7 @@ medusa.admin.priceLists
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -269,7 +269,7 @@ medusa.admin.priceLists
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
@@ -488,8 +488,8 @@ medusa.admin.priceLists
"children": [
{
"name": "ACTIVE",
"type": "``\"active\"``",
"description": "The price list is active, meaning its prices are applied to customers.",
"type": "`\"active\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -497,8 +497,8 @@ medusa.admin.priceLists
},
{
"name": "DRAFT",
"type": "``\"draft\"``",
"description": "The price list is a draft, meaning its not yet applied to customers.",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -516,8 +516,8 @@ medusa.admin.priceLists
"children": [
{
"name": "OVERRIDE",
"type": "``\"override\"``",
"description": "The price list is used to override original prices for specific conditions.",
"type": "`\"override\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -525,8 +525,8 @@ medusa.admin.priceLists
},
{
"name": "SALE",
"type": "``\"sale\"``",
"description": "The price list is used for a sale.",
"type": "`\"sale\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -594,7 +594,7 @@ medusa.admin.priceLists
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -612,7 +612,7 @@ medusa.admin.priceLists
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -658,7 +658,7 @@ medusa.admin.priceLists
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
@@ -1455,7 +1455,7 @@ medusa.admin.priceLists
},
{
"name": "status",
"type": "[PriceListStatus](../internal/enums/internal.PriceListStatus.mdx)[]",
"type": "[PriceListStatus](../internal/enums/internal.PriceListStatus-1.mdx)[]",
"description": "Statuses to filter price lists by.",
"optional": true,
"defaultValue": "",
@@ -1463,7 +1463,7 @@ medusa.admin.priceLists
"children": [
{
"name": "ACTIVE",
"type": "``\"active\"``",
"type": "`\"active\"`",
"description": "The price list is active, meaning its prices are applied to customers.",
"optional": true,
"defaultValue": "",
@@ -1472,7 +1472,7 @@ medusa.admin.priceLists
},
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "The price list is a draft, meaning its not yet applied to customers.",
"optional": true,
"defaultValue": "",
@@ -1483,7 +1483,7 @@ medusa.admin.priceLists
},
{
"name": "type",
"type": "[PriceListType](../internal/enums/internal.PriceListType.mdx)[]",
"type": "[PriceListType](../internal/enums/internal.PriceListType-1.mdx)[]",
"description": "Types to filter price lists by.",
"optional": true,
"defaultValue": "",
@@ -1491,7 +1491,7 @@ medusa.admin.priceLists
"children": [
{
"name": "OVERRIDE",
"type": "``\"override\"``",
"type": "`\"override\"`",
"description": "The price list is used to override original prices for specific conditions.",
"optional": true,
"defaultValue": "",
@@ -1500,7 +1500,7 @@ medusa.admin.priceLists
},
{
"name": "SALE",
"type": "``\"sale\"``",
"type": "`\"sale\"`",
"description": "The price list is used for a sale.",
"optional": true,
"defaultValue": "",
@@ -1581,7 +1581,7 @@ medusa.admin.priceLists
"children": [
{
"name": "AdminPriceListsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; price_lists: [PriceList](../internal/classes/internal.PriceList.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ price_lists: [PriceList](../internal/classes/internal.PriceList.mdx)[] }``",
"description": "The list of price lists with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1642,7 +1642,7 @@ medusa.admin.priceLists
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1660,7 +1660,7 @@ medusa.admin.priceLists
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -1706,7 +1706,7 @@ medusa.admin.priceLists
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
@@ -2022,7 +2022,7 @@ medusa.admin.priceLists
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "The product is a draft. It's not viewable by customers.",
"optional": true,
"defaultValue": "",
@@ -2031,7 +2031,7 @@ medusa.admin.priceLists
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "The product is proposed, but not yet published.",
"optional": true,
"defaultValue": "",
@@ -2040,7 +2040,7 @@ medusa.admin.priceLists
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "The product is published.",
"optional": true,
"defaultValue": "",
@@ -2049,7 +2049,7 @@ medusa.admin.priceLists
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "The product is rejected. It's not viewable by customers.",
"optional": true,
"defaultValue": "",
@@ -2157,7 +2157,7 @@ medusa.admin.priceLists
"children": [
{
"name": "AdminPriceListsProductsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; products: [Product](../internal/classes/internal.Product.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ products: [Product](../internal/classes/internal.Product.mdx)[] }``",
"description": "The list of products with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -2219,7 +2219,7 @@ medusa.admin.priceLists
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -2237,7 +2237,7 @@ medusa.admin.priceLists
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2246,7 +2246,7 @@ medusa.admin.priceLists
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -2264,7 +2264,7 @@ medusa.admin.priceLists
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -2273,7 +2273,7 @@ medusa.admin.priceLists
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -2282,7 +2282,7 @@ medusa.admin.priceLists
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -2291,7 +2291,7 @@ medusa.admin.priceLists
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -2327,7 +2327,7 @@ medusa.admin.priceLists
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -2336,7 +2336,7 @@ medusa.admin.priceLists
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -2345,7 +2345,7 @@ medusa.admin.priceLists
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -2354,7 +2354,7 @@ medusa.admin.priceLists
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -2372,7 +2372,7 @@ medusa.admin.priceLists
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -2426,7 +2426,7 @@ medusa.admin.priceLists
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -2444,7 +2444,7 @@ medusa.admin.priceLists
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -2471,7 +2471,7 @@ medusa.admin.priceLists
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -2498,7 +2498,7 @@ medusa.admin.priceLists
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -2507,7 +2507,7 @@ medusa.admin.priceLists
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -2609,7 +2609,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2627,7 +2627,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -2673,7 +2673,7 @@ medusa.admin.priceLists.retrieve(priceListId).then(({ price_list }) => {
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
@@ -2786,7 +2786,7 @@ medusa.admin.priceLists
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List ends being valid.",
"optional": true,
"defaultValue": "",
@@ -2887,7 +2887,7 @@ medusa.admin.priceLists
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": true,
"defaultValue": "",
@@ -2904,8 +2904,8 @@ medusa.admin.priceLists
"children": [
{
"name": "ACTIVE",
"type": "``\"active\"``",
"description": "The price list is active, meaning its prices are applied to customers.",
"type": "`\"active\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -2913,8 +2913,8 @@ medusa.admin.priceLists
},
{
"name": "DRAFT",
"type": "``\"draft\"``",
"description": "The price list is a draft, meaning its not yet applied to customers.",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -2932,8 +2932,8 @@ medusa.admin.priceLists
"children": [
{
"name": "OVERRIDE",
"type": "``\"override\"``",
"description": "The price list is used to override original prices for specific conditions.",
"type": "`\"override\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -2941,8 +2941,8 @@ medusa.admin.priceLists
},
{
"name": "SALE",
"type": "``\"sale\"``",
"description": "The price list is used for a sale.",
"type": "`\"sale\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -3010,7 +3010,7 @@ medusa.admin.priceLists
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3028,7 +3028,7 @@ medusa.admin.priceLists
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -3074,7 +3074,7 @@ medusa.admin.priceLists
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.mdx
+16 -16
View File
@@ -200,7 +200,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -209,7 +209,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -330,7 +330,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category",
"optional": true,
"defaultValue": "",
@@ -451,7 +451,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -460,7 +460,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -725,7 +725,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Filter product categories by their associated parent ID.",
"optional": true,
"defaultValue": "",
@@ -767,7 +767,7 @@ medusa.admin.productCategories
"children": [
{
"name": "AdminProductCategoriesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }``",
"description": "The list of product categories with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -882,7 +882,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -891,7 +891,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -1111,7 +1111,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -1120,7 +1120,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -1350,7 +1350,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -1359,7 +1359,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -1489,7 +1489,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent product category",
"optional": true,
"defaultValue": "",
@@ -1619,7 +1619,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -1628,7 +1628,7 @@ medusa.admin.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.mdx
+2 -2
View File
@@ -233,7 +233,7 @@ medusa.admin.productTags
"children": [
{
"name": "AdminProductTagsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }``",
"description": "The list of product tags with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -285,7 +285,7 @@ medusa.admin.productTags
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.mdx
+2 -2
View File
@@ -243,7 +243,7 @@ medusa.admin.productTypes
"children": [
{
"name": "AdminProductTypesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }``",
"description": "The list of product types with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -295,7 +295,7 @@ medusa.admin.productTypes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminProductsResource.mdx
+189 -189
View File
File diff suppressed because it is too large Load Diff
www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.mdx
+18 -18
View File
@@ -134,7 +134,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -161,7 +161,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -286,7 +286,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -313,7 +313,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -724,7 +724,7 @@ medusa.admin.publishableApiKeys
"children": [
{
"name": "AdminPublishableApiKeysListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; publishable_api_keys: [PublishableApiKey](../internal/classes/internal.PublishableApiKey.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ publishable_api_keys: [PublishableApiKey](../internal/classes/internal.PublishableApiKey.mdx)[] }``",
"description": "The list of publishable API keys with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -776,7 +776,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -803,7 +803,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -971,7 +971,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -980,7 +980,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1016,7 +1016,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1138,7 +1138,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -1165,7 +1165,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -1278,7 +1278,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -1305,7 +1305,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
@@ -1439,7 +1439,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -1466,7 +1466,7 @@ medusa.admin.publishableApiKeys
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminRegionsResource.mdx
+32 -32
View File
@@ -154,7 +154,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -245,7 +245,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -263,7 +263,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -424,7 +424,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -515,7 +515,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -533,7 +533,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -694,7 +694,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -785,7 +785,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -803,7 +803,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -1033,7 +1033,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1124,7 +1124,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -1142,7 +1142,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -1371,7 +1371,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1462,7 +1462,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -1480,7 +1480,7 @@ medusa.admin.regions.deleteCountry(regionId, "dk").then(({ region }) => {
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -1629,7 +1629,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1720,7 +1720,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -1738,7 +1738,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -1887,7 +1887,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1978,7 +1978,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -1996,7 +1996,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -2248,7 +2248,7 @@ medusa.admin.regions
"children": [
{
"name": "AdminRegionsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; regions: [Region](../internal/classes/internal.Region.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ regions: [Region](../internal/classes/internal.Region.mdx)[] }``",
"description": "The list of regions with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -2336,7 +2336,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2427,7 +2427,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -2445,7 +2445,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -2583,7 +2583,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2674,7 +2674,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -2692,7 +2692,7 @@ medusa.admin.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -2916,7 +2916,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider to use. If none provided, the system tax provider is used.",
"optional": true,
"defaultValue": "",
@@ -3019,7 +3019,7 @@ medusa.admin.regions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3110,7 +3110,7 @@ medusa.admin.regions
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -3128,7 +3128,7 @@ medusa.admin.regions
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminReservationsResource.mdx
+21 -21
View File
@@ -158,7 +158,7 @@ medusa.admin.reservations
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -167,7 +167,7 @@ medusa.admin.reservations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ medusa.admin.reservations
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -203,7 +203,7 @@ medusa.admin.reservations
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -221,7 +221,7 @@ medusa.admin.reservations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,7 @@ medusa.admin.reservations
"children": [
{
"name": "AdminReservationsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; reservations: [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ reservations: [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx)[] }``",
"description": "The list of reservations with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ medusa.admin.reservations
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -662,7 +662,7 @@ medusa.admin.reservations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -671,7 +671,7 @@ medusa.admin.reservations
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -698,7 +698,7 @@ medusa.admin.reservations
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -716,7 +716,7 @@ medusa.admin.reservations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -827,7 +827,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -836,7 +836,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -845,7 +845,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -872,7 +872,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -890,7 +890,7 @@ medusa.admin.reservations.retrieve(reservationId).then(({ reservation }) => {
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1051,7 +1051,7 @@ medusa.admin.reservations
},
{
"name": "created_by",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "UserId of user who created the reservation item",
"optional": true,
"defaultValue": "",
@@ -1060,7 +1060,7 @@ medusa.admin.reservations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1069,7 +1069,7 @@ medusa.admin.reservations
},
{
"name": "description",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Description of the reservation item",
"optional": true,
"defaultValue": "",
@@ -1096,7 +1096,7 @@ medusa.admin.reservations
},
{
"name": "line_item_id",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1114,7 +1114,7 @@ medusa.admin.reservations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.mdx
+12 -12
View File
@@ -146,7 +146,7 @@ medusa.admin.returnReasons
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -191,7 +191,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -200,7 +200,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -395,7 +395,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -440,7 +440,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -449,7 +449,7 @@ medusa.admin.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -571,7 +571,7 @@ medusa.admin.returnReasons
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -616,7 +616,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -625,7 +625,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -795,7 +795,7 @@ medusa.admin.returnReasons
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -840,7 +840,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -849,7 +849,7 @@ medusa.admin.returnReasons
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminReturnsResource.mdx
+21 -21
View File
@@ -248,7 +248,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -554,7 +554,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ medusa.admin.returns.cancel(returnId).then(({ order }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -686,7 +686,7 @@ medusa.admin.returns
"children": [
{
"name": "AdminReturnsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; returns: [Return](../internal/classes/internal.Return.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ returns: [Return](../internal/classes/internal.Return.mdx)[] }``",
"description": "The list of returns with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -738,7 +738,7 @@ medusa.admin.returns
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -765,7 +765,7 @@ medusa.admin.returns
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -783,7 +783,7 @@ medusa.admin.returns
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -792,7 +792,7 @@ medusa.admin.returns
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -801,7 +801,7 @@ medusa.admin.returns
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -819,7 +819,7 @@ medusa.admin.returns
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -882,7 +882,7 @@ medusa.admin.returns
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1049,7 +1049,7 @@ medusa.admin.returns
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1076,7 +1076,7 @@ medusa.admin.returns
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -1094,7 +1094,7 @@ medusa.admin.returns
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -1103,7 +1103,7 @@ medusa.admin.returns
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1112,7 +1112,7 @@ medusa.admin.returns
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -1130,7 +1130,7 @@ medusa.admin.returns
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -1193,7 +1193,7 @@ medusa.admin.returns
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.mdx
+25 -25
View File
@@ -118,7 +118,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -127,7 +127,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -163,7 +163,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -500,7 +500,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -971,7 +971,7 @@ medusa.admin.salesChannels
"children": [
{
"name": "AdminSalesChannelsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ sales_channels: [SalesChannel](../internal/classes/internal.SalesChannel.mdx)[] }``",
"description": "The list of sales channels with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1032,7 +1032,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1068,7 +1068,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1202,7 +1202,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1211,7 +1211,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1247,7 +1247,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1395,7 +1395,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1404,7 +1404,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1440,7 +1440,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1553,7 +1553,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1562,7 +1562,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1598,7 +1598,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1750,7 +1750,7 @@ medusa.admin.salesChannels
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1759,7 +1759,7 @@ medusa.admin.salesChannels
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -1795,7 +1795,7 @@ medusa.admin.salesChannels
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.mdx
+9 -9
View File
@@ -232,7 +232,7 @@ medusa.admin.shippingOptions
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -259,7 +259,7 @@ medusa.admin.shippingOptions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -566,7 +566,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
"children": [
{
"name": "AdminShippingOptionsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; shipping_options: [ShippingOption](../internal/classes/internal.ShippingOption.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ shipping_options: [ShippingOption](../internal/classes/internal.ShippingOption.mdx)[] }``",
"description": "The list of shipping options with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -618,7 +618,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,7 @@ medusa.admin.shippingOptions.list().then(({ shipping_options, count }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -865,7 +865,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -892,7 +892,7 @@ medusa.admin.shippingOptions.retrieve(optionId).then(({ shipping_option }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1216,7 +1216,7 @@ medusa.admin.shippingOptions
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -1243,7 +1243,7 @@ medusa.admin.shippingOptions
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.mdx
+10 -10
View File
@@ -77,7 +77,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "CUSTOM",
"type": "``\"custom\"``",
"type": "`\"custom\"`",
"description": "The profile used to ship custom items.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ medusa.admin.shippingProfiles
},
{
"name": "DEFAULT",
"type": "``\"default\"``",
"type": "`\"default\"`",
"description": "The default profile used to ship item.",
"optional": true,
"defaultValue": "",
@@ -95,7 +95,7 @@ medusa.admin.shippingProfiles
},
{
"name": "GIFT_CARD",
"type": "``\"gift_card\"``",
"type": "`\"gift_card\"`",
"description": "The profile used to ship gift cards.",
"optional": true,
"defaultValue": "",
@@ -155,7 +155,7 @@ medusa.admin.shippingProfiles
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -386,7 +386,7 @@ medusa.admin.shippingProfiles.list().then(({ shipping_profiles }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -544,7 +544,7 @@ medusa.admin.shippingProfiles
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -709,7 +709,7 @@ medusa.admin.shippingProfiles
"children": [
{
"name": "CUSTOM",
"type": "``\"custom\"``",
"type": "`\"custom\"`",
"description": "The profile used to ship custom items.",
"optional": true,
"defaultValue": "",
@@ -718,7 +718,7 @@ medusa.admin.shippingProfiles
},
{
"name": "DEFAULT",
"type": "``\"default\"``",
"type": "`\"default\"`",
"description": "The default profile used to ship item.",
"optional": true,
"defaultValue": "",
@@ -727,7 +727,7 @@ medusa.admin.shippingProfiles
},
{
"name": "GIFT_CARD",
"type": "``\"gift_card\"``",
"type": "`\"gift_card\"`",
"description": "The profile used to ship gift cards.",
"optional": true,
"defaultValue": "",
@@ -787,7 +787,7 @@ medusa.admin.shippingProfiles
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.mdx
+9 -9
View File
@@ -228,7 +228,7 @@ medusa.admin.stockLocations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.stockLocations
"children": [
{
"name": "AdminStockLocationsListRes",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `&#123; stock_locations: [StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ stock_locations: [StockLocationExpandedDTO](../internal/types/internal.StockLocationExpandedDTO.mdx)[] }``",
"description": "The list of stock locations with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -615,7 +615,7 @@ medusa.admin.stockLocations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -633,7 +633,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -773,7 +773,7 @@ medusa.admin.stockLocations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -791,7 +791,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1052,7 +1052,7 @@ medusa.admin.stockLocations
},
{
"name": "deleted_at",
"type": "`string` \\| `Date` \\| ``null``",
"type": "`string` \\| `Date` \\| `null`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1070,7 +1070,7 @@ medusa.admin.stockLocations
},
{
"name": "metadata",
"type": "`Record<string, unknown>` \\| ``null``",
"type": "`Record<string, unknown>` \\| `null`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminStoresResource.mdx
+20 -20
View File
@@ -139,7 +139,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
},
{
"name": "default_sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
},
{
"name": "invite_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Invite links from",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
},
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ medusa.admin.store.addCurrency("eur").then(({ store }) => {
},
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -340,7 +340,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
},
{
"name": "default_sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -358,7 +358,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
},
{
"name": "invite_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Invite links from",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -385,7 +385,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
},
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ medusa.admin.store.deleteCurrency("eur").then(({ store }) => {
},
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -700,7 +700,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
},
{
"name": "default_sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -718,7 +718,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
},
{
"name": "invite_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Invite links from",
"optional": false,
"defaultValue": "",
@@ -727,7 +727,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -745,7 +745,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
},
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -754,7 +754,7 @@ medusa.admin.store.retrieve().then(({ store }) => {
},
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -1005,7 +1005,7 @@ medusa.admin.store
},
{
"name": "default_sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ medusa.admin.store
},
{
"name": "invite_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Invite links from",
"optional": false,
"defaultValue": "",
@@ -1032,7 +1032,7 @@ medusa.admin.store
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1050,7 +1050,7 @@ medusa.admin.store
},
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -1059,7 +1059,7 @@ medusa.admin.store
},
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminSwapsResource.mdx
+3 -3
View File
@@ -107,7 +107,7 @@ medusa.admin.swaps
"children": [
{
"name": "AdminSwapsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; swaps: [Swap](../internal/classes/internal.Swap.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ swaps: [Swap](../internal/classes/internal.Swap.mdx)[] }``",
"description": "The list of swaps with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -213,7 +213,7 @@ medusa.admin.swaps
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -504,7 +504,7 @@ medusa.admin.swaps.retrieve(swapId).then(({ swap }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.mdx
+23 -23
View File
@@ -136,7 +136,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -217,7 +217,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -397,7 +397,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -478,7 +478,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -658,7 +658,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -739,7 +739,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -871,7 +871,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge.",
"optional": true,
"defaultValue": "",
@@ -966,7 +966,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -1047,7 +1047,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -1349,7 +1349,7 @@ medusa.admin.taxRates
"children": [
{
"name": "AdminTaxRatesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; tax_rates: [TaxRate](../internal/classes/internal.TaxRate.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ tax_rates: [TaxRate](../internal/classes/internal.TaxRate.mdx)[] }``",
"description": "The list of tax rates with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1392,7 +1392,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -1473,7 +1473,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -1653,7 +1653,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -1734,7 +1734,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -1914,7 +1914,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -1995,7 +1995,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -2175,7 +2175,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -2256,7 +2256,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -2430,7 +2430,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -2511,7 +2511,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -2650,7 +2650,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge.",
"optional": true,
"defaultValue": "",
@@ -2745,7 +2745,7 @@ medusa.admin.taxRates
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -2826,7 +2826,7 @@ medusa.admin.taxRates
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminUsersResource.mdx
+10 -10
View File
@@ -82,7 +82,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), \"password_hash\"&#62;",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -108,7 +108,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.admin.users.list().then(({ users }) => {
"children": [
{
"name": "users",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), `\"password_hash\"`&#62;[]",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), \"password_hash\"&#62;[]",
"description": "An array of users details.",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ medusa.admin.users.list().then(({ users }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -519,7 +519,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), \"password_hash\"&#62;",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -684,7 +684,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), \"password_hash\"&#62;",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -710,7 +710,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -981,7 +981,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[User](../internal/classes/internal.User.mdx), \"password_hash\"&#62;",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -1007,7 +1007,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.mdx
+52 -52
View File
@@ -104,7 +104,7 @@ medusa.admin.variants.getInventory(variantId).then(({ variant }) => {
},
{
"name": "sales_channel_availability",
"type": "`&#123; available_quantity: number ; channel_id: string ; channel_name: string &#125;`[]",
"type": "``{ available_quantity: number ; channel_id: string ; channel_name: string }``[]",
"description": "Details about the variant's inventory availability in sales channels.",
"optional": false,
"defaultValue": "",
@@ -315,7 +315,7 @@ medusa.admin.variants
"children": [
{
"name": "AdminVariantsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ variants: [PricedVariant](../internal/types/internal.PricedVariant.mdx)[] }``",
"description": "The list of variants with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ medusa.admin.variants
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -385,7 +385,7 @@ medusa.admin.variants
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ medusa.admin.variants
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -403,7 +403,7 @@ medusa.admin.variants
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -412,7 +412,7 @@ medusa.admin.variants
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -448,7 +448,7 @@ medusa.admin.variants
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -466,7 +466,7 @@ medusa.admin.variants
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ medusa.admin.variants
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -502,7 +502,7 @@ medusa.admin.variants
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ medusa.admin.variants
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -565,7 +565,7 @@ medusa.admin.variants
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -583,7 +583,7 @@ medusa.admin.variants
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -592,7 +592,7 @@ medusa.admin.variants
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,7 @@ medusa.admin.variants
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -610,7 +610,7 @@ medusa.admin.variants
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -619,7 +619,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -629,7 +629,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -638,7 +638,7 @@ medusa.admin.variants
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -647,7 +647,7 @@ medusa.admin.variants
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -666,7 +666,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ medusa.admin.variants
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -684,7 +684,7 @@ medusa.admin.variants
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -693,7 +693,7 @@ medusa.admin.variants
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -702,7 +702,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
@@ -840,7 +840,7 @@ medusa.admin.variants
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -858,7 +858,7 @@ medusa.admin.variants
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -867,7 +867,7 @@ medusa.admin.variants
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -876,7 +876,7 @@ medusa.admin.variants
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -885,7 +885,7 @@ medusa.admin.variants
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -921,7 +921,7 @@ medusa.admin.variants
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -939,7 +939,7 @@ medusa.admin.variants
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -948,7 +948,7 @@ medusa.admin.variants
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -957,7 +957,7 @@ medusa.admin.variants
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -975,7 +975,7 @@ medusa.admin.variants
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -1020,7 +1020,7 @@ medusa.admin.variants
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -1038,7 +1038,7 @@ medusa.admin.variants
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1056,7 +1056,7 @@ medusa.admin.variants
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -1065,7 +1065,7 @@ medusa.admin.variants
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1074,7 +1074,7 @@ medusa.admin.variants
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1083,7 +1083,7 @@ medusa.admin.variants
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -1092,7 +1092,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -1102,7 +1102,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -1111,7 +1111,7 @@ medusa.admin.variants
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -1120,7 +1120,7 @@ medusa.admin.variants
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -1139,7 +1139,7 @@ medusa.admin.variants
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -1148,7 +1148,7 @@ medusa.admin.variants
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -1157,7 +1157,7 @@ medusa.admin.variants
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -1166,7 +1166,7 @@ medusa.admin.variants
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -1175,7 +1175,7 @@ medusa.admin.variants
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/AuthResource.mdx
+4 -4
View File
@@ -118,7 +118,7 @@ medusa.auth
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -136,7 +136,7 @@ medusa.auth
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -435,7 +435,7 @@ medusa.auth.getSession().then(({ customer }) => {
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -453,7 +453,7 @@ medusa.auth.getSession().then(({ customer }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/CartsResource.mdx
+81 -81
View File
@@ -121,7 +121,7 @@ medusa.carts
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -192,7 +192,7 @@ medusa.carts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -273,7 +273,7 @@ medusa.carts
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -327,7 +327,7 @@ medusa.carts
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,7 @@ medusa.carts
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -390,7 +390,7 @@ medusa.carts
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -417,7 +417,7 @@ medusa.carts
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -444,7 +444,7 @@ medusa.carts
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -542,7 +542,7 @@ medusa.carts.complete(cartId).then(({ cart }) => {
"children": [
{
"name": "StoreCompleteCartRes",
"type": "`&#123; data: [Cart](../internal/classes/internal.Cart.mdx) ; type: `\"cart\"` &#125;` \\| `&#123; data: [Order](../internal/classes/internal.Order.mdx) ; type: `\"order\"` &#125;` \\| `&#123; data: [Swap](../internal/classes/internal.Swap.mdx) ; type: `\"swap\"` &#125;`",
"type": "``{ data: [Cart](../internal/classes/internal.Cart.mdx) ; type: \"cart\" }`` \\| ``{ data: [Order](../internal/classes/internal.Order.mdx) ; type: \"order\" }`` \\| ``{ data: [Swap](../internal/classes/internal.Swap.mdx) ; type: \"swap\" }``",
"description": "If the cart is completed successfully, this will have the created order or the swap's details, based on the cart's type. Otherwise, it'll be the cart's details.",
"optional": false,
"defaultValue": "",
@@ -680,7 +680,7 @@ medusa.carts.create().then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -751,7 +751,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -832,7 +832,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -886,7 +886,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -940,7 +940,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -949,7 +949,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -976,7 +976,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -1003,7 +1003,7 @@ medusa.carts.create().then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -1106,7 +1106,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -1177,7 +1177,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1258,7 +1258,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -1312,7 +1312,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -1366,7 +1366,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -1375,7 +1375,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -1402,7 +1402,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -1429,7 +1429,7 @@ medusa.carts.createPaymentSessions(cartId).then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -1541,7 +1541,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -1612,7 +1612,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1693,7 +1693,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -1747,7 +1747,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -1801,7 +1801,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -1810,7 +1810,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -1837,7 +1837,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -1864,7 +1864,7 @@ medusa.carts.deleteDiscount(cartId, code).then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -1975,7 +1975,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -2046,7 +2046,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2127,7 +2127,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -2181,7 +2181,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -2235,7 +2235,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -2244,7 +2244,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -2271,7 +2271,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -2298,7 +2298,7 @@ medusa.carts.deletePaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -2409,7 +2409,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -2480,7 +2480,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2561,7 +2561,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -2615,7 +2615,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -2669,7 +2669,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -2678,7 +2678,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -2705,7 +2705,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -2732,7 +2732,7 @@ medusa.carts.refreshPaymentSession(cartId, "manual").then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -2834,7 +2834,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -2905,7 +2905,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2986,7 +2986,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -3040,7 +3040,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -3094,7 +3094,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -3103,7 +3103,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -3130,7 +3130,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -3157,7 +3157,7 @@ medusa.carts.retrieve(cartId).then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -3283,7 +3283,7 @@ medusa.carts
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -3354,7 +3354,7 @@ medusa.carts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3435,7 +3435,7 @@ medusa.carts
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -3489,7 +3489,7 @@ medusa.carts
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -3543,7 +3543,7 @@ medusa.carts
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -3552,7 +3552,7 @@ medusa.carts
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -3579,7 +3579,7 @@ medusa.carts
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -3606,7 +3606,7 @@ medusa.carts
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -3832,7 +3832,7 @@ medusa.carts
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -3903,7 +3903,7 @@ medusa.carts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -3984,7 +3984,7 @@ medusa.carts
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -4038,7 +4038,7 @@ medusa.carts
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -4092,7 +4092,7 @@ medusa.carts
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -4101,7 +4101,7 @@ medusa.carts
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -4128,7 +4128,7 @@ medusa.carts
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -4155,7 +4155,7 @@ medusa.carts
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -4291,7 +4291,7 @@ medusa.carts
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -4362,7 +4362,7 @@ medusa.carts
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -4443,7 +4443,7 @@ medusa.carts
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -4497,7 +4497,7 @@ medusa.carts
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -4551,7 +4551,7 @@ medusa.carts
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -4560,7 +4560,7 @@ medusa.carts
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -4587,7 +4587,7 @@ medusa.carts
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -4614,7 +4614,7 @@ medusa.carts
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/CollectionsResource.mdx
+3 -3
View File
@@ -203,7 +203,7 @@ medusa.collections
"children": [
{
"name": "StoreCollectionsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ collections: [ProductCollection](../internal/classes/internal.ProductCollection.mdx)[] }``",
"description": "The list of product collections with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -255,7 +255,7 @@ medusa.collections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ medusa.collections.retrieve(collectionId).then(({ collection }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/CustomersResource.mdx
+40 -40
View File
@@ -151,7 +151,7 @@ medusa.customers
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\"&#62;",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -168,7 +168,7 @@ medusa.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -186,7 +186,7 @@ medusa.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -556,7 +556,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
"children": [
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "The order's fulfillments are canceled.",
"optional": true,
"defaultValue": "",
@@ -565,7 +565,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "FULFILLED",
"type": "``\"fulfilled\"``",
"type": "`\"fulfilled\"`",
"description": "The order's items are fulfilled.",
"optional": true,
"defaultValue": "",
@@ -574,7 +574,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "NOT_FULFILLED",
"type": "``\"not_fulfilled\"``",
"type": "`\"not_fulfilled\"`",
"description": "The order's items are not fulfilled.",
"optional": true,
"defaultValue": "",
@@ -583,7 +583,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "PARTIALLY_FULFILLED",
"type": "``\"partially_fulfilled\"``",
"type": "`\"partially_fulfilled\"`",
"description": "Some of the order's items, but not all, are fulfilled.",
"optional": true,
"defaultValue": "",
@@ -592,7 +592,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "PARTIALLY_RETURNED",
"type": "``\"partially_returned\"``",
"type": "`\"partially_returned\"`",
"description": "Some of the order's items, but not all, are returned.",
"optional": true,
"defaultValue": "",
@@ -601,7 +601,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "PARTIALLY_SHIPPED",
"type": "``\"partially_shipped\"``",
"type": "`\"partially_shipped\"`",
"description": "Some of the order's items, but not all, are shipped.",
"optional": true,
"defaultValue": "",
@@ -610,7 +610,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "REQUIRES_ACTION",
"type": "``\"requires_action\"``",
"type": "`\"requires_action\"`",
"description": "The order's fulfillment requires action.",
"optional": true,
"defaultValue": "",
@@ -619,7 +619,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "RETURNED",
"type": "``\"returned\"``",
"type": "`\"returned\"`",
"description": "The order's items are returned.",
"optional": true,
"defaultValue": "",
@@ -628,7 +628,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "SHIPPED",
"type": "``\"shipped\"``",
"type": "`\"shipped\"`",
"description": "The order's items are shipped.",
"optional": true,
"defaultValue": "",
@@ -674,7 +674,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
"children": [
{
"name": "AWAITING",
"type": "``\"awaiting\"``",
"type": "`\"awaiting\"`",
"description": "The order's payment is awaiting capturing.",
"optional": true,
"defaultValue": "",
@@ -683,7 +683,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "The order's payment is canceled.",
"optional": true,
"defaultValue": "",
@@ -692,7 +692,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "CAPTURED",
"type": "``\"captured\"``",
"type": "`\"captured\"`",
"description": "The order's payment is captured.",
"optional": true,
"defaultValue": "",
@@ -701,7 +701,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "NOT_PAID",
"type": "``\"not_paid\"``",
"type": "`\"not_paid\"`",
"description": "The order's payment is not paid.",
"optional": true,
"defaultValue": "",
@@ -710,7 +710,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "PARTIALLY_REFUNDED",
"type": "``\"partially_refunded\"``",
"type": "`\"partially_refunded\"`",
"description": "Some of the order's payment amount is refunded.",
"optional": true,
"defaultValue": "",
@@ -719,7 +719,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "REFUNDED",
"type": "``\"refunded\"``",
"type": "`\"refunded\"`",
"description": "The order's payment amount is refunded.",
"optional": true,
"defaultValue": "",
@@ -728,7 +728,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "REQUIRES_ACTION",
"type": "``\"requires_action\"``",
"type": "`\"requires_action\"`",
"description": "The order's payment requires action.",
"optional": true,
"defaultValue": "",
@@ -765,7 +765,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
"children": [
{
"name": "ARCHIVED",
"type": "``\"archived\"``",
"type": "`\"archived\"`",
"description": "The order is archived.",
"optional": true,
"defaultValue": "",
@@ -774,7 +774,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "The order is canceled.",
"optional": true,
"defaultValue": "",
@@ -783,7 +783,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "COMPLETED",
"type": "``\"completed\"``",
"type": "`\"completed\"`",
"description": "The order is completed, meaning that the items have been fulfilled and the payment has been captured.",
"optional": true,
"defaultValue": "",
@@ -792,7 +792,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "PENDING",
"type": "``\"pending\"``",
"type": "`\"pending\"`",
"description": "The order is pending.",
"optional": true,
"defaultValue": "",
@@ -801,7 +801,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "REQUIRES_ACTION",
"type": "``\"requires_action\"``",
"type": "`\"requires_action\"`",
"description": "The order requires action.",
"optional": true,
"defaultValue": "",
@@ -891,7 +891,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
"children": [
{
"name": "StoreCustomersListOrdersRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; orders: [Order](../internal/classes/internal.Order.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ orders: [Order](../internal/classes/internal.Order.mdx)[] }``",
"description": "The list of the customer's orders with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -1096,7 +1096,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -1177,7 +1177,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -1321,7 +1321,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1357,7 +1357,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1402,7 +1402,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1411,7 +1411,7 @@ medusa.customers.listOrders().then(({ orders, limit, offset, count }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1539,7 +1539,7 @@ medusa.customers
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\"&#62;",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -1556,7 +1556,7 @@ medusa.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -1574,7 +1574,7 @@ medusa.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1740,7 +1740,7 @@ medusa.customers.retrieve().then(({ customer }) => {
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\"&#62;",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -1757,7 +1757,7 @@ medusa.customers.retrieve().then(({ customer }) => {
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -1775,7 +1775,7 @@ medusa.customers.retrieve().then(({ customer }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -2018,7 +2018,7 @@ medusa.customers
"children": [
{
"name": "customer",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), `\"password_hash\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Customer](../internal/classes/internal.Customer.mdx), \"password_hash\"&#62;",
"description": "Customer details.",
"optional": false,
"defaultValue": "",
@@ -2035,7 +2035,7 @@ medusa.customers
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -2053,7 +2053,7 @@ medusa.customers
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/GiftCardsResource.mdx
+2 -2
View File
@@ -110,7 +110,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -191,7 +191,7 @@ medusa.giftCards.retrieve(code).then(({ gift_card }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/LineItemsResource.mdx
+24 -24
View File
@@ -112,7 +112,7 @@ medusa.carts.lineItems
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ medusa.carts.lineItems
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ medusa.carts.lineItems
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -318,7 +318,7 @@ medusa.carts.lineItems
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,7 @@ medusa.carts.lineItems
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -381,7 +381,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -408,7 +408,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -435,7 +435,7 @@ medusa.carts.lineItems
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -546,7 +546,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -617,7 +617,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -752,7 +752,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -815,7 +815,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -842,7 +842,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -869,7 +869,7 @@ medusa.carts.lineItems.delete(cartId, lineId).then(({ cart }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -1012,7 +1012,7 @@ medusa.carts.lineItems
"children": [
{
"name": "cart",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), `\"refundable_amount\"` \\| `\"refunded_total\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[Cart](../internal/classes/internal.Cart.mdx), \"refundable_amount\" \\| \"refunded_total\"&#62;",
"description": "Cart details.",
"optional": false,
"defaultValue": "",
@@ -1083,7 +1083,7 @@ medusa.carts.lineItems
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1164,7 +1164,7 @@ medusa.carts.lineItems
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -1218,7 +1218,7 @@ medusa.carts.lineItems
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](../internal/classes/internal.PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -1272,7 +1272,7 @@ medusa.carts.lineItems
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -1281,7 +1281,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](../internal/classes/internal.Address.mdx)",
"type": "`null` \\| [Address](../internal/classes/internal.Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -1308,7 +1308,7 @@ medusa.carts.lineItems
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -1335,7 +1335,7 @@ medusa.carts.lineItems
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/OrderEditsResource.mdx
+6 -6
View File
@@ -75,7 +75,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => {
"children": [
{
"name": "order_edit",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\"&#62;",
"description": "Order edit details.",
"optional": false,
"defaultValue": "",
@@ -281,7 +281,7 @@ medusa.orderEdits.complete(orderEditId).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -393,7 +393,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => {
"children": [
{
"name": "order_edit",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\"&#62;",
"description": "Order edit details.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ medusa.orderEdits.decline(orderEditId).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -692,7 +692,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => {
"children": [
{
"name": "order_edit",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), `\"internal_note\"` \\| `\"created_by\"` \\| `\"confirmed_by\"` \\| `\"canceled_by\"`&#62;",
"type": "[Omit](../internal/types/internal.Omit.mdx)&#60;[OrderEdit](../internal/classes/internal.OrderEdit.mdx), \"internal_note\" \\| \"created_by\" \\| \"confirmed_by\" \\| \"canceled_by\"&#62;",
"description": "Order edit details.",
"optional": false,
"defaultValue": "",
@@ -898,7 +898,7 @@ medusa.orderEdits.retrieve(orderEditId).then(({ order_edit }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/OrdersResource.mdx
+18 -18
View File
@@ -375,7 +375,7 @@ medusa.orders
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,7 @@ medusa.orders
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -600,7 +600,7 @@ medusa.orders
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -636,7 +636,7 @@ medusa.orders
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -681,7 +681,7 @@ medusa.orders
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -690,7 +690,7 @@ medusa.orders
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1026,7 +1026,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -1107,7 +1107,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -1251,7 +1251,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1287,7 +1287,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1332,7 +1332,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1341,7 +1341,7 @@ medusa.orders.retrieve(orderId).then(({ order }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1604,7 +1604,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -1685,7 +1685,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -1829,7 +1829,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1865,7 +1865,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1910,7 +1910,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1919,7 +1919,7 @@ medusa.orders.retrieveByCartId(cartId).then(({ order }) => {
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.mdx
+17 -17
View File
@@ -101,7 +101,7 @@ medusa.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -146,7 +146,7 @@ medusa.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -155,7 +155,7 @@ medusa.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -350,7 +350,7 @@ medusa.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -395,7 +395,7 @@ medusa.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -404,7 +404,7 @@ medusa.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ medusa.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -644,7 +644,7 @@ medusa.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ medusa.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -909,7 +909,7 @@ medusa.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -954,7 +954,7 @@ medusa.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -963,7 +963,7 @@ medusa.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -1156,7 +1156,7 @@ medusa.paymentCollections
},
{
"name": "cart_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -1210,7 +1210,7 @@ medusa.paymentCollections
},
{
"name": "is_selected",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.",
"optional": false,
"defaultValue": "",
@@ -1386,7 +1386,7 @@ medusa.paymentCollections
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -1431,7 +1431,7 @@ medusa.paymentCollections
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1440,7 +1440,7 @@ medusa.paymentCollections
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.mdx
+1 -1
View File
@@ -65,7 +65,7 @@ medusa.customers.paymentMethods.list().then(({ payment_methods }) => {
"children": [
{
"name": "payment_methods",
"type": "`&#123; data: object ; provider_id: string &#125;`[]",
"type": "``{ data: object ; provider_id: string }``[]",
"description": "The details of the saved payment methods.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx
+6 -6
View File
@@ -156,7 +156,7 @@ medusa.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Filter product categories by the ID of their associated parent category.",
"optional": true,
"defaultValue": "",
@@ -198,7 +198,7 @@ medusa.productCategories
"children": [
{
"name": "StoreGetProductCategoriesRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_categories: [ProductCategory](../internal/classes/internal.ProductCategory.mdx)[] }``",
"description": "The list of product categories with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -313,7 +313,7 @@ medusa.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -322,7 +322,7 @@ medusa.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -552,7 +552,7 @@ medusa.productCategories
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](../internal/classes/internal.ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -561,7 +561,7 @@ medusa.productCategories
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
www/apps/docs/content/references/js-client/classes/ProductTagsResource.mdx
+2 -2
View File
@@ -238,7 +238,7 @@ medusa.productTags
"children": [
{
"name": "StoreProductTagsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_tags: [ProductTag](../internal/classes/internal.ProductTag.mdx)[] }``",
"description": "The list of product tags with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -290,7 +290,7 @@ medusa.productTags
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ProductTypesResource.mdx
+2 -2
View File
@@ -240,7 +240,7 @@ medusa.productTypes
"children": [
{
"name": "StoreProductTypesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ product_types: [ProductType](../internal/classes/internal.ProductType.mdx)[] }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ medusa.productTypes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ProductVariantsResource.mdx
+50 -50
View File
@@ -239,7 +239,7 @@ medusa.product.variants
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ medusa.product.variants
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ medusa.product.variants
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -275,7 +275,7 @@ medusa.product.variants
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -284,7 +284,7 @@ medusa.product.variants
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.product.variants
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -338,7 +338,7 @@ medusa.product.variants
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -347,7 +347,7 @@ medusa.product.variants
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ medusa.product.variants
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -374,7 +374,7 @@ medusa.product.variants
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ medusa.product.variants
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ medusa.product.variants
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ medusa.product.variants
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -464,7 +464,7 @@ medusa.product.variants
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ medusa.product.variants
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ medusa.product.variants
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -491,7 +491,7 @@ medusa.product.variants
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -501,7 +501,7 @@ medusa.product.variants
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -510,7 +510,7 @@ medusa.product.variants
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -519,7 +519,7 @@ medusa.product.variants
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -538,7 +538,7 @@ medusa.product.variants
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ medusa.product.variants
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -556,7 +556,7 @@ medusa.product.variants
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -565,7 +565,7 @@ medusa.product.variants
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -574,7 +574,7 @@ medusa.product.variants
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
@@ -671,7 +671,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -689,7 +689,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -707,7 +707,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -716,7 +716,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -770,7 +770,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -788,7 +788,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -806,7 +806,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -851,7 +851,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"optional": false,
"defaultValue": "",
@@ -869,7 +869,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -887,7 +887,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -896,7 +896,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -905,7 +905,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -914,7 +914,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "calculated_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The lowest price among the retrieved prices.",
"optional": false,
"defaultValue": "",
@@ -923,7 +923,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "calculated_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `calculated_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -933,7 +933,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "calculated_price_type",
"type": "`string` \\| ``null``",
"type": "`string` \\| `null`",
"description": "Either `default` if the `calculated_price` is the original price, or the type of the price list applied, if any.",
"optional": true,
"defaultValue": "",
@@ -942,7 +942,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "original_price",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The original price of the variant.",
"optional": false,
"defaultValue": "",
@@ -951,7 +951,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "original_price_includes_tax",
"type": "`boolean` \\| ``null``",
"type": "`boolean` \\| `null`",
"description": "Whether the `original_price` field includes taxes.",
"optional": true,
"defaultValue": "",
@@ -970,7 +970,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "calculated_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the calculated price.",
"optional": false,
"defaultValue": "",
@@ -979,7 +979,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "calculated_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the calculated price.",
"optional": false,
"defaultValue": "",
@@ -988,7 +988,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "original_price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The price after applying the tax amount on the original price.",
"optional": false,
"defaultValue": "",
@@ -997,7 +997,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "original_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "The tax amount applied to the original price.",
"optional": false,
"defaultValue": "",
@@ -1006,7 +1006,7 @@ medusa.product.variants.retrieve(productVariantId).then(({ variant }) => {
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "The list of tax rates.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ProductsResource.mdx
+36 -36
View File
@@ -394,7 +394,7 @@ medusa.products
"children": [
{
"name": "StoreProductsListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; products: [PricedProduct](../internal/types/internal.PricedProduct.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ products: [PricedProduct](../internal/types/internal.PricedProduct.mdx)[] }``",
"description": "The list of products with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -456,7 +456,7 @@ medusa.products
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -474,7 +474,7 @@ medusa.products
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ medusa.products
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ medusa.products
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -510,7 +510,7 @@ medusa.products
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -519,7 +519,7 @@ medusa.products
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ medusa.products
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -564,7 +564,7 @@ medusa.products
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -573,7 +573,7 @@ medusa.products
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -582,7 +582,7 @@ medusa.products
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -591,7 +591,7 @@ medusa.products
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -609,7 +609,7 @@ medusa.products
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -663,7 +663,7 @@ medusa.products
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -681,7 +681,7 @@ medusa.products
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -708,7 +708,7 @@ medusa.products
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -726,7 +726,7 @@ medusa.products
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,7 @@ medusa.products
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -850,7 +850,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -868,7 +868,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -877,7 +877,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -895,7 +895,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -904,7 +904,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -913,7 +913,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -922,7 +922,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -958,7 +958,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -967,7 +967,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -976,7 +976,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -985,7 +985,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -1003,7 +1003,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"optional": false,
"defaultValue": "",
@@ -1057,7 +1057,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -1075,7 +1075,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -1102,7 +1102,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -1120,7 +1120,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1129,7 +1129,7 @@ medusa.products.retrieve(productId).then(({ product }) => {
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1247,7 +1247,7 @@ medusa.products
"children": [
{
"name": "StorePostSearchRes",
"type": "`&#123; hits: unknown[] &#125;` & `Record<string, unknown>`",
"type": "``{ hits: unknown[] }`` & `Record<string, unknown>`",
"description": "The list of search results.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/RegionsResource.mdx
+7 -7
View File
@@ -58,7 +58,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
"children": [
{
"name": "StoreRegionsListRes",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & `&#123; regions: [Region](../internal/classes/internal.Region.mdx)[] &#125;`",
"type": "[PaginatedResponse](../internal/types/internal.PaginatedResponse-1.mdx) & ``{ regions: [Region](../internal/classes/internal.Region.mdx)[] }``",
"description": "The list of regions with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -146,7 +146,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -255,7 +255,7 @@ medusa.regions.list().then(({ regions, count, limit, offset }) => {
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ medusa.regions.retrieve(regionId).then(({ region }) => {
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](../internal/classes/internal.TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.mdx
+6 -6
View File
@@ -80,7 +80,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -134,7 +134,7 @@ medusa.returnReasons.list().then(({ return_reasons }) => {
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -253,7 +253,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -298,7 +298,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => {
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](../internal/classes/internal.ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -307,7 +307,7 @@ medusa.returnReasons.retrieve(reasonId).then(({ return_reason }) => {
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ReturnsResource.mdx
+7 -7
View File
@@ -176,7 +176,7 @@ medusa.returns
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ medusa.returns
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ medusa.returns
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ medusa.returns
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ medusa.returns
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ medusa.returns
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.returns
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.mdx
+8 -8
View File
@@ -119,7 +119,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -146,7 +146,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -282,7 +282,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "Price including taxes",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ medusa.shippingOptions.list().then(({ shipping_options }) => {
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "An array of applied tax rates",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -555,7 +555,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "price_incl_tax",
"type": "`number` \\| ``null``",
"type": "`number` \\| `null`",
"description": "Price including taxes",
"optional": false,
"defaultValue": "",
@@ -573,7 +573,7 @@ medusa.shippingOptions.listCartOptions(cartId).then(({ shipping_options }) => {
},
{
"name": "tax_rates",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| ``null``",
"type": "[TaxServiceRate](../internal/types/internal.TaxServiceRate.mdx)[] \\| `null`",
"description": "An array of applied tax rates",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/classes/SwapsResource.mdx
+2 -2
View File
@@ -260,7 +260,7 @@ medusa.swaps
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -550,7 +550,7 @@ medusa.swaps.retrieveByCartId(cartId).then(({ swap }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",