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

42
www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.mdx
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": "",