From c2765b9b564940ba129ebc5976d79cb7d31ade47 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 7 May 2026 01:57:03 +0000 Subject: [PATCH] [nightly] generate types against bigcommerce/docs@24f580c --- .changeset/nightly-20260507-015656.md | 5 + .last_commit | 2 +- src/generated/checkouts.sf.ts | 20 +- src/generated/infrastructure_hosting.v3.ts | 580 +++++++++++++++++++++ src/generated/price_lists.v3.ts | 59 +++ src/generated/tax_classes.v3.ts | 276 ++++++++++ src/generated/v3.ts | 4 + 7 files changed, 944 insertions(+), 2 deletions(-) create mode 100644 .changeset/nightly-20260507-015656.md create mode 100644 src/generated/infrastructure_hosting.v3.ts create mode 100644 src/generated/tax_classes.v3.ts diff --git a/.changeset/nightly-20260507-015656.md b/.changeset/nightly-20260507-015656.md new file mode 100644 index 0000000..9d9ef92 --- /dev/null +++ b/.changeset/nightly-20260507-015656.md @@ -0,0 +1,5 @@ +--- +'bigrequest': patch +--- + +[bigcommerce/docs@`24f580c`](https://github.com/bigcommerce/docs/commit/24f580ca6d2981728b7ed70a2049e00fc602c335), [bigcommerce/docs@`05974b1`](https://github.com/bigcommerce/docs/commit/05974b1c9b19bd822e466ea45ea1e1b8cac73222), [bigcommerce/docs@`1ef1cb1`](https://github.com/bigcommerce/docs/commit/1ef1cb19be7fe71f34a2693b10c9fe31a3c4098b), [bigcommerce/docs@`e03f09c`](https://github.com/bigcommerce/docs/commit/e03f09c08ff1077d8b5ce003959e907d2b11d3ef), [bigcommerce/docs@`07e2d13`](https://github.com/bigcommerce/docs/commit/07e2d132e1308212867eb6d663b79827aeae3ef9), [bigcommerce/docs@`0b3fd8b`](https://github.com/bigcommerce/docs/commit/0b3fd8b93b5ce8eebcfc2183eee66cb1ca5c562b) diff --git a/.last_commit b/.last_commit index 53d547a..acb0348 100644 --- a/.last_commit +++ b/.last_commit @@ -1 +1 @@ -74ff1cf26bc4b933a215683531fe687a9f5f77a6 +24f580ca6d2981728b7ed70a2049e00fc602c335 diff --git a/src/generated/checkouts.sf.ts b/src/generated/checkouts.sf.ts index e207580..33ece4e 100644 --- a/src/generated/checkouts.sf.ts +++ b/src/generated/checkouts.sf.ts @@ -441,8 +441,16 @@ export interface components { /** @description Text displayed on the storefront for the promotion. */ text?: string; })[]; - /** @description The shipping cost before discounts are applied. */ + /** + * Format: float + * @description Total shipping cost for the checkout before discounts are applied. + */ shippingCostBeforeDiscount?: number; + /** + * Format: float + * @description Total shipping cost for the checkout after automatic promotions are applied. + */ + comparisonShippingCost?: number; /** * Format: float * @description Shipping cost before any discounts are applied. @@ -694,6 +702,16 @@ export interface components { * @description The shipping cost for this consignment. */ shippingCost?: number; + /** + * Format: double + * @description This consignment's shipping cost before discounts are applied. + */ + shippingCostBeforeDiscount?: number; + /** + * Format: double + * @description This consignment's shipping cost after automatic promotions are applied. + */ + comparisonShippingCost?: number; lineItemIds?: string[]; }; /** consignmentAvailableShippingOptions */ diff --git a/src/generated/infrastructure_hosting.v3.ts b/src/generated/infrastructure_hosting.v3.ts new file mode 100644 index 0000000..5704e2b --- /dev/null +++ b/src/generated/infrastructure_hosting.v3.ts @@ -0,0 +1,580 @@ +// @ts-nocheck +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + + +export interface paths { + "/infrastructure/projects": { + /** + * List Projects + * @description Returns a list of infrastructure hosting projects for the store. Supports cursor-based pagination and filtering. + */ + get: operations["listProjects"]; + /** + * Create a Project + * @description Creates a new infrastructure hosting project. + */ + post: operations["createProject"]; + /** + * Delete Projects + * @description Deletes one or more infrastructure hosting projects by UUID. The `project_uuid:in` query parameter is required. + */ + delete: operations["deleteProjects"]; + }; + "/infrastructure/projects/{project_uuid}": { + /** + * Delete a Project + * @description Deletes a single infrastructure hosting project by UUID. + */ + delete: operations["deleteProject"]; + }; + "/infrastructure/deployments": { + /** + * Create a Deployment + * @description Creates a new deployment for an infrastructure hosting project. You must first generate an upload signature and upload your deployment artifact before creating a deployment. + * + * Only one deployment can be in progress per project at a time. If a deployment is already in progress, the API returns a `409 Conflict` response. + */ + post: operations["createDeployment"]; + }; + "/infrastructure/deployments/uploads": { + /** + * Generate Upload Signature + * @description Generates a pre-signed upload URL for uploading deployment artifacts. Use the returned `upload_url` to upload your deployment package, then pass the `upload_uuid` when creating a deployment. + */ + post: operations["generateUploadSignature"]; + }; + "/infrastructure/deployments/{deployment_uuid}/events": { + /** + * Get Deployment Event Stream + * @description Opens a server-sent events (SSE) stream that delivers real-time deployment progress updates. The stream remains open until the deployment completes, fails, or the connection times out (30 seconds). + * + * Each event is a JSON object delivered as an SSE `data` field. + */ + get: operations["getDeploymentEventStream"]; + }; + "/infrastructure/logs/{project_uuid}/tail": { + /** + * Tail Worker Logs + * @description Opens a server-sent events (SSE) stream that delivers real-time worker logs for a project. The stream includes log messages, request data, and exception information. A keep-alive is sent every 15 seconds. The stream times out after 60 seconds. + * + * Each event is a JSON object delivered as an SSE `data` field. + * + * > **Note**: This endpoint is served from the streaming API server, not the main API gateway. + */ + get: operations["tailWorkerLogs"]; + }; +} + +export type webhooks = Record; + +export interface components { + schemas: { + /** @description An infrastructure hosting project. */ + Project: { + /** + * Format: uuid + * @description The unique identifier for the project. + * @example 019500e2-933d-7057-8e81-090dd7240795 + */ + uuid?: string; + /** + * @description The name of the project. + * @example my-storefront + */ + name?: string; + /** + * Format: date-time + * @description The date the project was created, in RFC 3339 format. + * @example 2024-06-15T10:30:00Z + */ + date_created?: string; + /** + * Format: date-time + * @description The date the project was last modified, in RFC 3339 format. + * @example 2024-06-16T14:22:00Z + */ + date_modified?: string; + }; + CreateProjectRequest: { + /** + * @description The name for the new project. + * @example my-storefront + */ + name: string; + }; + CreateDeploymentRequest: { + /** + * @description The UUID of the uploaded deployment artifact, obtained from the Generate Upload Signature endpoint. + * @example 0194fd2b-2ac6-72de-b73f-d83f2d626a74 + */ + upload_uuid: string; + /** + * Format: uuid + * @description The UUID of the project to deploy to. + * @example 01956ca2-72dd-7968-9484-469ce291d38f + */ + project_uuid: string; + /** @description Optional environment variables to set for this deployment. */ + environment_variables?: components["schemas"]["EnvironmentVariable"][] | null; + }; + EnvironmentVariable: { + /** + * @description The type of environment variable. + * - `plain_text`: A regular environment variable visible in responses. + * - `secret`: A sensitive environment variable that is encrypted and not returned in responses. + * @enum {string} + */ + type: "plain_text" | "secret"; + /** + * @description The name of the environment variable. + * @example API_URL + */ + key: string; + /** + * @description The value of the environment variable. + * @example https://api.example.com + */ + value: string; + }; + CreateDeploymentResponse: { + /** + * Format: uuid + * @description The unique identifier of the newly created deployment. + * @example 019500e2-933d-7057-8e81-090dd7240795 + */ + deployment_uuid?: string; + }; + UploadSignatureResponse: { + /** + * Format: uri + * @description The pre-signed URL to upload the deployment artifact to. + * @example https://storage.googleapis.com/bigcommerce-production-ignition-gcs-bucket-platform/0000000000/0194fd2b-2ac6-72de-b73f-d83f2d626a74/bundle.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=example%40bigcommerce-production.iam.gserviceaccount.com%2F20240615%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240615T103000Z&X-Goog-Expires=59&X-Goog-Signature=example-signature&X-Goog-SignedHeaders=content-type%3Bhost + */ + upload_url?: string; + /** + * @description The UUID identifying this upload. Pass this value when creating a deployment. + * @example 0194fd2b-2ac6-72de-b73f-d83f2d626a74 + */ + upload_uuid?: string; + }; + /** @description A deployment event delivered via server-sent events. */ + DeploymentEvent: { + /** + * Format: uuid + * @description The UUID of the deployment. + * @example 019500e2-933d-7057-8e81-090dd7240795 + */ + deployment_uuid?: string; + /** + * @description The current status of the deployment. + * @enum {string} + */ + deployment_status?: "queued" | "in_progress" | "failed" | "completed"; + /** @description Details about the current deployment step and progress. Null when no step information is available. */ + event?: ({ + /** + * @description The current step in the deployment process. + * @enum {string} + */ + step?: "initializing" | "downloading" | "unzipping" | "processing" | "deploying" | "finalizing" | "complete"; + /** + * @description The progress percentage of the deployment. + * @example 25 + */ + progress?: number; + }) | null; + /** @description Error information if the deployment failed. Null when the deployment has not failed. */ + error?: { + /** + * @description An error code identifying the failure reason. + * @example 20 + */ + code?: number; + } | null; + /** + * @description The URL where the deployed application is accessible. Null until the deployment is finalizing or complete. + * @example catalyst.catalyst-sandbox.store + */ + deployment_url?: string | null; + }; + /** @description A worker log event delivered via server-sent events. */ + WorkerLogEvent: { + /** + * Format: uuid + * @description The unique identifier for this log event. + * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890 + */ + uuid?: string; + /** + * Format: uuid + * @description The UUID of the project this log belongs to. + * @example 019500e2-933d-7057-8e81-090dd7240795 + */ + project_uuid?: string; + /** @description HTTP request information associated with this log entry, if applicable. */ + request?: { + /** + * @description The HTTP method. + * @example GET + */ + method?: string; + /** + * @description The request URL. + * @example /products + */ + url?: string; + /** + * @description The HTTP response status code. + * @example 200 + */ + status_code?: number; + } | null; + /** @description Log messages associated with this event. */ + logs?: ({ + /** + * Format: date-time + * @description The timestamp of the log message. + * @example 2024-06-15T10:30:00Z + */ + timestamp?: string | null; + /** + * @description The severity level of the log message. + * @enum {string} + */ + level?: "debug" | "info" | "warn" | "error"; + /** @description The log message content. */ + messages?: string[]; + })[]; + /** @description Exceptions that occurred during request processing. */ + exceptions?: ({ + /** + * Format: date-time + * @description The timestamp of the exception. + * @example 2024-06-15T10:30:01Z + */ + timestamp?: string | null; + /** + * @description The name or type of the exception. + * @example TypeError + */ + name?: string; + /** + * @description The exception message. + * @example Cannot read property of undefined + */ + message?: string; + })[]; + /** + * Format: date-time + * @description The timestamp of the overall log event. + * @example 2024-06-15T10:30:00Z + */ + timestamp?: string | null; + }; + /** @description Meta information including cursor-based pagination. */ + CursorPaginationMeta: { + cursor_pagination?: { + /** + * @description The number of items in the current page. + * @example 1 + */ + count?: number; + /** + * @description The number of items per page. + * @example 50 + */ + per_page?: number; + /** + * @description The cursor marking the start of the current page. + * @example abc123 + */ + start_cursor?: string; + /** + * @description The cursor marking the end of the current page. + * @example def456 + */ + end_cursor?: string; + links?: { + /** + * @description The relative URL for the previous page. + * @example ?before=abc123 + */ + previous?: string; + /** + * @description The relative URL for the next page. + * @example ?after=def456 + */ + next?: string; + }; + }; + }; + /** @description Empty meta object. */ + EmptyMeta: Record; + /** @description Error payload for the BigCommerce API. */ + ErrorResponse: { + /** @description The HTTP status code. */ + status?: number; + /** @description A description of the error. */ + title?: string; + /** @description A URL identifying the error type. */ + type?: string; + /** @description Additional error details. */ + errors?: { + [key: string]: string; + }; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} + +export type $defs = Record; + +export type external = Record; + +export interface operations { + + /** + * List Projects + * @description Returns a list of infrastructure hosting projects for the store. Supports cursor-based pagination and filtering. + */ + listProjects: { + parameters: { + query?: { + /** @description The number of results to return per page. Defaults to 50. */ + limit?: number; + /** @description Cursor for forward pagination. Returns results after this cursor. */ + after?: string; + /** @description Cursor for backward pagination. Returns results before this cursor. */ + before?: string; + /** @description A comma-separated list of project UUIDs by which to filter. For example, `?uuid:in=uuid1,uuid2`. */ + "uuid:in"?: string; + /** @description Filter projects by name using a partial match. */ + "name:like"?: string; + /** @description Filter for projects created after this date. RFC 3339 format, for example `2024-01-01T00:00:00Z`. */ + "date_created:min"?: string; + /** @description Filter for projects created before this date. RFC 3339 format, for example `2024-12-31T23:59:59Z`. */ + "date_created:max"?: string; + /** @description Filter for projects modified after this date. RFC 3339 format. */ + "date_modified:min"?: string; + /** @description Filter for projects modified before this date. RFC 3339 format. */ + "date_modified:max"?: string; + }; + }; + responses: { + /** @description The request completed successfully. */ + 200: { + content: { + "application/json": { + data?: components["schemas"]["Project"][]; + meta?: components["schemas"]["CursorPaginationMeta"]; + }; + }; + }; + }; + }; + /** + * Create a Project + * @description Creates a new infrastructure hosting project. + */ + createProject: { + requestBody: { + content: { + /** + * @example { + * "name": "my-storefront" + * } + */ + "application/json": components["schemas"]["CreateProjectRequest"]; + }; + }; + responses: { + /** @description The project was created successfully. */ + 200: { + content: { + "application/json": { + data?: components["schemas"]["Project"]; + meta?: components["schemas"]["EmptyMeta"]; + }; + }; + }; + }; + }; + /** + * Delete Projects + * @description Deletes one or more infrastructure hosting projects by UUID. The `project_uuid:in` query parameter is required. + */ + deleteProjects: { + parameters: { + query: { + /** @description A comma-separated list of project UUIDs to delete. For example, `?project_uuid:in=uuid1,uuid2`. */ + "project_uuid:in": string; + }; + }; + responses: { + /** @description The projects were deleted successfully. No content is returned. */ + 204: { + content: never; + }; + /** @description The request could not be processed. */ + 422: { + content: { + "application/json": components["schemas"]["ErrorResponse"]; + }; + }; + }; + }; + /** + * Delete a Project + * @description Deletes a single infrastructure hosting project by UUID. + */ + deleteProject: { + parameters: { + path: { + /** @description The UUID of the project to delete. */ + project_uuid: string; + }; + }; + responses: { + /** @description The project was deleted successfully. No content is returned. */ + 204: { + content: never; + }; + }; + }; + /** + * Create a Deployment + * @description Creates a new deployment for an infrastructure hosting project. You must first generate an upload signature and upload your deployment artifact before creating a deployment. + * + * Only one deployment can be in progress per project at a time. If a deployment is already in progress, the API returns a `409 Conflict` response. + */ + createDeployment: { + requestBody: { + content: { + /** + * @example { + * "upload_uuid": "0194fd2b-2ac6-72de-b73f-d83f2d626a74", + * "project_uuid": "01956ca2-72dd-7968-9484-469ce291d38f", + * "environment_variables": [ + * { + * "type": "plain_text", + * "key": "API_URL", + * "value": "https://api.example.com" + * }, + * { + * "type": "secret", + * "key": "API_SECRET", + * "value": "s3cret" + * } + * ] + * } + */ + "application/json": components["schemas"]["CreateDeploymentRequest"]; + }; + }; + responses: { + /** @description The deployment was created successfully. */ + 200: { + content: { + "application/json": { + data?: components["schemas"]["CreateDeploymentResponse"]; + meta?: components["schemas"]["EmptyMeta"]; + }; + }; + }; + /** @description A deployment is already in progress for this project. */ + 409: { + content: { + "application/json": components["schemas"]["ErrorResponse"]; + }; + }; + }; + }; + /** + * Generate Upload Signature + * @description Generates a pre-signed upload URL for uploading deployment artifacts. Use the returned `upload_url` to upload your deployment package, then pass the `upload_uuid` when creating a deployment. + */ + generateUploadSignature: { + requestBody: { + content: { + /** @example {} */ + "application/json": components["schemas"]["EmptyMeta"]; + }; + }; + responses: { + /** @description The upload signature was generated successfully. */ + 200: { + content: { + "application/json": { + data?: components["schemas"]["UploadSignatureResponse"]; + meta?: components["schemas"]["EmptyMeta"]; + }; + }; + }; + }; + }; + /** + * Get Deployment Event Stream + * @description Opens a server-sent events (SSE) stream that delivers real-time deployment progress updates. The stream remains open until the deployment completes, fails, or the connection times out (30 seconds). + * + * Each event is a JSON object delivered as an SSE `data` field. + */ + getDeploymentEventStream: { + parameters: { + path: { + /** @description The UUID of the deployment to stream events for. */ + deployment_uuid: string; + }; + }; + responses: { + /** @description A stream of server-sent events with deployment progress updates. The `data` attribute is stringified JSON. */ + 200: { + content: { + "text/event-stream": string; + }; + }; + /** @description The deployment UUID is not a valid UUID. */ + 400: { + content: { + "application/json": components["schemas"]["ErrorResponse"]; + }; + }; + }; + }; + /** + * Tail Worker Logs + * @description Opens a server-sent events (SSE) stream that delivers real-time worker logs for a project. The stream includes log messages, request data, and exception information. A keep-alive is sent every 15 seconds. The stream times out after 60 seconds. + * + * Each event is a JSON object delivered as an SSE `data` field. + * + * > **Note**: This endpoint is served from the streaming API server, not the main API gateway. + */ + tailWorkerLogs: { + parameters: { + path: { + /** @description The UUID of the project to tail logs for. */ + project_uuid: string; + }; + }; + responses: { + /** @description A stream of server-sent events with real-time worker log entries. The `data` attribute is stringified JSON. */ + 200: { + content: { + "text/event-stream": string; + }; + }; + /** @description The project UUID is not a valid UUID. */ + 400: { + content: { + "application/json": components["schemas"]["ErrorResponse"]; + }; + }; + }; + }; +} diff --git a/src/generated/price_lists.v3.ts b/src/generated/price_lists.v3.ts index 83695e8..1bb94e3 100644 --- a/src/generated/price_lists.v3.ts +++ b/src/generated/price_lists.v3.ts @@ -504,6 +504,41 @@ export interface components { Meta: { [key: string]: unknown; }; + /** + * Service Unavailable Error + * @description Returned when the service is temporarily unavailable. + */ + ServiceUnavailableError: { + /** @description Top-level error wrapper. */ + error?: { + /** + * @description Error code identifying the type of failure. + * @example SERVICE_DEGRADED + */ + code?: string; + /** + * @description Human-readable summary of the error. + * @example Service temporarily unavailable + */ + message?: string; + /** + * @description Additional information about the error. + * @example We're unable to process your request right now, please retry later + */ + details?: string; + /** + * @description Number of seconds to wait before retrying the request. + * @example 30 + */ + retry_after_seconds?: number; + /** + * Format: date-time + * @description ISO 8601 timestamp of when the error occurred. + * @example 2024-01-01T00:00:00.000Z + */ + timestamp?: string; + }; + }; /** Error Response */ ErrorResponse: { /** @description The HTTP status code. */ @@ -832,6 +867,12 @@ export interface operations { } | null; }; }; + /** @description Service temporarily unavailable. */ + 503: { + content: { + "application/json": components["schemas"]["ServiceUnavailableError"]; + }; + }; }; }; /** @@ -1040,6 +1081,12 @@ export interface operations { 204: { content: never; }; + /** @description Service temporarily unavailable. */ + 503: { + content: { + "application/json": components["schemas"]["ServiceUnavailableError"]; + }; + }; }; }; /** @@ -1741,6 +1788,12 @@ export interface operations { }; }; }; + /** @description Service temporarily unavailable. */ + 503: { + content: { + "application/json": components["schemas"]["ServiceUnavailableError"]; + }; + }; }; }; /** @@ -2401,6 +2454,12 @@ export interface operations { content: { }; }; + /** @description Service temporarily unavailable. */ + 503: { + content: { + "application/json": components["schemas"]["ServiceUnavailableError"]; + }; + }; }; }; /** diff --git a/src/generated/tax_classes.v3.ts b/src/generated/tax_classes.v3.ts new file mode 100644 index 0000000..9a6a2d9 --- /dev/null +++ b/src/generated/tax_classes.v3.ts @@ -0,0 +1,276 @@ +// @ts-nocheck +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + + +export interface paths { + "/tax/classes": { + /** + * Update tax classes + * @description Updates multiple tax classes in a single request. Max **50** items per request. + */ + put: operations["taxClassBatchPut"]; + /** + * Create tax classes + * @description Creates multiple tax classes in a single request. Max **50** items per request. + */ + post: operations["taxClassBatchPost"]; + /** + * Delete tax classes + * @description Deletes multiple tax classes in a single request. Max **50** items per request. + */ + delete: operations["taxClassBatchDelete"]; + }; +} + +export type webhooks = Record; + +export interface components { + schemas: { + TaxClassCreateBatch: ({ + /** @description Tax class name. Must be 1–100 characters and cannot contain < > { } ` ( ) ; |. Must be unique case-insensitively across the store (both existing classes and the incoming batch). Conflicting names produce a 409. */ + name: string; + })[]; + TaxClassUpdateBatch: { + id: number; + name: string; + }[]; + TaxClassResource: { + id: number; + name: string; + /** + * Format: date-time + * @description ISO-8601 timestamp. + */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + TaxClassCollectionEnvelope: { + data: components["schemas"]["TaxClassResource"][]; + /** @description Response metadata (may be an empty object). */ + meta: Record; + }; + /** @description RFC 7807-style problem object (optional fields omitted when empty). */ + Problem: { + title?: string; + status?: number; + /** Format: uri */ + type?: string; + detail?: string; + code?: number; + errors?: { + [key: string]: unknown; + }; + }; + ProblemResponseEnvelope: { + errors?: components["schemas"]["Problem"][]; + meta?: Record; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} + +export type $defs = Record; + +export type external = Record; + +export interface operations { + + /** + * Update tax classes + * @description Updates multiple tax classes in a single request. Max **50** items per request. + */ + taxClassBatchPut: { + requestBody: { + content: { + /** + * @example [ + * { + * "id": 1, + * "name": "Renamed One" + * }, + * { + * "id": 2, + * "name": "Renamed Two" + * } + * ] + */ + "application/json": components["schemas"]["TaxClassUpdateBatch"]; + }; + }; + responses: { + /** @description Updated classes returned. */ + 200: { + content: { + "application/json": components["schemas"]["TaxClassCollectionEnvelope"]; + }; + }; + /** @description One or more classes not found (update). */ + 400: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Authentication or permission denied. */ + 403: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Duplicate tax class names. */ + 409: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Batch exceeds 50 ids/items. */ + 413: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Validation error (format, duplicate `id` in batch, invalid ID values, ID-only update payload, etc.). */ + 422: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Server error. */ + 500: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + }; + }; + /** + * Create tax classes + * @description Creates multiple tax classes in a single request. Max **50** items per request. + */ + taxClassBatchPost: { + requestBody: { + content: { + /** + * @example [ + * { + * "name": "Class One" + * }, + * { + * "name": "Class Two" + * } + * ] + */ + "application/json": components["schemas"]["TaxClassCreateBatch"]; + }; + }; + responses: { + /** @description Created classes returned as a collection. */ + 200: { + content: { + "application/json": components["schemas"]["TaxClassCollectionEnvelope"]; + }; + }; + /** @description Bad request (e.g., invalid input). */ + 400: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Authentication or `Manage_Tax` denied. */ + 403: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Duplicate tax class names (conflict). */ + 409: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Batch exceeds limit (50 items). */ + 413: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Unprocessable entity — empty body, non-array batch shape, or duplicate `name` or `id` within the batch. */ + 422: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Unexpected server error. */ + 500: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + }; + }; + /** + * Delete tax classes + * @description Deletes multiple tax classes in a single request. Max **50** items per request. + */ + taxClassBatchDelete: { + parameters: { + query: { + /** + * @description Comma-separated list of tax class IDs to delete (e.g., `1,2,3`). + * + * @example 101,102,103 + */ + "id:in": string; + }; + }; + responses: { + /** @description All listed classes deleted successfully. */ + 204: { + content: never; + }; + /** @description Delete failed (e.g., class not found). */ + 400: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Authentication or permission denied. */ + 403: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Missing or empty `id:in` filter. */ + 404: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description More than 50 IDs. */ + 413: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Invalid ID values in filter. */ + 422: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + /** @description Server error. */ + 500: { + content: { + "application/problem+json": components["schemas"]["ProblemResponseEnvelope"]; + }; + }; + }; + }; +} diff --git a/src/generated/v3.ts b/src/generated/v3.ts index cb08006..573abfb 100644 --- a/src/generated/v3.ts +++ b/src/generated/v3.ts @@ -15,6 +15,7 @@ import * as checkouts_v3 from './checkouts.v3'; import * as custom_template_associations_v3 from './custom-template-associations.v3'; import * as customers_v3 from './customers.v3'; import * as email_templates_v3 from './email_templates.v3'; +import * as infrastructure_hosting_v3 from './infrastructure_hosting.v3'; import * as inventory_v3 from './inventory.v3'; import * as locations_v3 from './locations.v3'; import * as orders_v3 from './orders.v3'; @@ -40,6 +41,7 @@ import * as store_logs_v3 from './store_logs.v3'; import * as storefront_tokens_v3 from './storefront_tokens.v3'; import * as subscribers_v3 from './subscribers.v3'; import * as tax_v3 from './tax.v3'; +import * as tax_classes_v3 from './tax_classes.v3'; import * as tax_customers_v3 from './tax_customers.v3'; import * as tax_properties_v3 from './tax_properties.v3'; import * as tax_rates_zones_v3 from './tax_rates_zones.v3'; @@ -66,6 +68,7 @@ checkouts_v3.paths & custom_template_associations_v3.paths & customers_v3.paths & email_templates_v3.paths & +infrastructure_hosting_v3.paths & inventory_v3.paths & locations_v3.paths & orders_v3.paths & @@ -91,6 +94,7 @@ store_logs_v3.paths & storefront_tokens_v3.paths & subscribers_v3.paths & tax_v3.paths & +tax_classes_v3.paths & tax_customers_v3.paths & tax_properties_v3.paths & tax_rates_zones_v3.paths &