diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 83058c6..4f31399 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,6 +17,7 @@ jobs: release: name: Update documentation runs-on: ubuntu-latest + timeout-minutes: 5 steps: - uses: actions/checkout@v3 - uses: spenserblack/actions-wiki@v0.3.0 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 97323c7..e3bb098 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,6 +11,7 @@ jobs: release: name: Release runs-on: ubuntu-latest + timeout-minutes: 10 steps: - name: Checkout uses: actions/checkout@v3 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index fb42b71..8fa34ba 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,12 +1,5 @@ name: Test on: - push: - branches: - - main - - next - paths-ignore: - - "docs/**" - - "**/*.md" pull_request: paths-ignore: - "docs/**" @@ -16,6 +9,7 @@ jobs: test: name: Test runs-on: ubuntu-latest + timeout-minutes: 5 steps: - name: Checkout uses: actions/checkout@v3 diff --git a/docs/Batch.md b/docs/Batch.md new file mode 100644 index 0000000..c91d313 --- /dev/null +++ b/docs/Batch.md @@ -0,0 +1,223 @@ +Contains all information about a given Batch + +# Fields + +| Name | Type | Description | +| ---------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | The ID of the batch. | +| `companyId` | `string` | The ID of the company the batch belongs to. | +| `Name` | `string` | The name of the batch. | +| `billingId` | `string` \| `undefined` | The ID assigned to the batch by the customer. | +| `finish` | `string` | The finish of the batch. Can be `GLOSSY` or `MATT`. | +| `isBillable` | `boolean` | Whether the batch is billable. True when an live API key is used, false when a test API key is used. | +| `templateId` | `string` | The ID of the template the batch is based on. | +| `estimatedPrice` | `number` | The estimated price of the batch. | +| `status` | `string` | The status of the batch. Can be `batch_created`, `batch_needs_approval`, `batch_user_ready`, `batch_ready_to_schedule`, `batch_scheduling`, `batch_scheduled` or `batch_sent` | +| `orders` | `object` | An object containing the orders of the batch. With keys 'processing', 'success', 'failed' and 'cancelled' | +| `createdAt` | `string` | The date the batch was created. | +| `updatedAt` | `string` | The date the batch was last updated. | + +# Methods + +## `.getTemplate()` + +Get the template the batch is based on. Uses [`PrintOne.getTemplate()`](./PrintOne#gettemplateid). + +**Returns: [`Promise