api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,249 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: BatchJob
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`BatchJob`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new BatchJob**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### completed\_at
|
||||
|
||||
• `Optional` **completed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### confirmed\_at
|
||||
|
||||
• `Optional` **confirmed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### context
|
||||
|
||||
• **context**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### created\_by
|
||||
|
||||
• **created\_by**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### created\_by\_user
|
||||
|
||||
• **created\_by\_user**: [`User`](User.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• **deleted\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.deleted\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### dry\_run
|
||||
|
||||
• **dry\_run**: `boolean` = `false`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### failed\_at
|
||||
|
||||
• `Optional` **failed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### pre\_processed\_at
|
||||
|
||||
• `Optional` **pre\_processed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### processing\_at
|
||||
|
||||
• `Optional` **processing\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### result
|
||||
|
||||
• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: `BatchJobResultError`[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `BatchJobStatus`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
### loadStatus
|
||||
|
||||
▸ **loadStatus**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### toJSON
|
||||
|
||||
▸ **toJSON**(): [`BatchJob`](BatchJob.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`BatchJob`](BatchJob.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/batch-job.ts#L99)
|
||||
Reference in New Issue
Block a user