docs: add cartData to response (#10)

square · Jul 19, 2024 · b9f5859 · b9f5859
1 parent c1efff3
commit b9f5859
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 5 deletions.
diff --git a/src/types/api/cart/index.ts b/src/types/api/cart/index.ts
@@ -428,6 +428,9 @@ export interface CartBaseResponse {
 		 * doing very custom order management.
 		 */
 		cart: string;
+		/** The cart object. See https://square.github.io/custom-sites-docs/resources/cart#cart */
+		// eslint-disable-next-line @typescript-eslint/naming-convention
+		cart_data: unknown;
 		/** Validation for scheduling. Empty if not pickup or delivery fulfillment. */
 		validation: CartValidation;
 	};

diff --git a/src/types/api/cart/private.types.ts b/src/types/api/cart/private.types.ts
@@ -1,4 +1,4 @@
-import { 
+import {
 	CartValidationErrors,
 	CartValidation
 } from '.';
@@ -18,6 +18,7 @@ export interface CartBaseErrorResponse {
 export interface CartFetchResponse extends CartBaseErrorResponse {
 	data?: {
 		cart: string;
+		cart_data: unknown;
 		validation: CartValidation;
 	};
 }

diff --git a/src/types/api/resources/index.ts b/src/types/api/resources/index.ts
@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 /** ResourcesRequest can take up to 5 keys (each representing a resource). */
 export interface ResourcesRequest {
     [key: string]: ResourceInput;
@@ -8,7 +6,7 @@ export interface ResourcesRequest {
 /** `key` is the same key we used in the request object, and the value is the resource being returned. */
 export interface ResourcesResponse {
     [key: string]: {
-        data?: any;
+        data?: unknown;
         errors: string[];
     };
 }

diff --git a/typedocs/interfaces/types_api_cart.CartBaseResponse.md b/typedocs/interfaces/types_api_cart.CartBaseResponse.md
@@ -27,4 +27,5 @@
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `cart` | `string` | The `orderId` for the order. Only needed if you're doing very custom order management. |
+| `cart_data` | `unknown` | The cart object. See https://square.github.io/custom-sites-docs/resources/cart#cart |
 | `validation` | [`CartValidation`](types_api_cart.CartValidation.md) | Validation for scheduling. Empty if not pickup or delivery fulfillment. |
diff --git a/typedocs/interfaces/types_api_cart.CartResponse.md b/typedocs/interfaces/types_api_cart.CartResponse.md
@@ -28,6 +28,7 @@
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `cart` | `string` | The `orderId` for the order. Only needed if you're doing very custom order management. |
+| `cart_data` | `unknown` | The cart object. See https://square.github.io/custom-sites-docs/resources/cart#cart |
 | `validation` | [`CartValidation`](types_api_cart.CartValidation.md) | Validation for scheduling. Empty if not pickup or delivery fulfillment. |
 
 #### Inherited from

diff --git a/typedocs/interfaces/types_api_resources.ResourcesResponse.md b/typedocs/interfaces/types_api_resources.ResourcesResponse.md
@@ -8,4 +8,4 @@
 
 ## Indexable
 
-▪ [key: `string`]: { `data?`: `any` ; `errors`: `string`[]  }
+▪ [key: `string`]: { `data?`: `unknown` ; `errors`: `string`[]  }