@swishapp/api-client 0.2.0 → 0.3.0

package/dist/client/types.gen.d.ts

@@ -1,3 +1,31 @@
+export type Item = {
+    /**
+     * The ID of the item
+     */
+    id: string;
+    /**
+     * The Shopify ID of the product
+     */
+    productId: number;
+    /**
+     * The Shopify ID of the variant
+     */
+    variantId: {
+        [key: string]: unknown;
+    };
+    /**
+     * The quantity of the item in the list
+     */
+    quantity: number;
+    /**
+     * The date and time the item was created
+     */
+    createdAt: string;
+    /**
+     * The date and time the item was updated
+     */
+    updatedAt: string;
+};
 export type List = {
     /**
      * The ID of the list
@@ -19,13 +47,35 @@ export type List = {
      * The date and time the list was updated
      */
     updatedAt: string;
+    /**
+     * The items in the list
+     */
+    items: Array<Item>;
 };
-export type ErrorResponseDto = {
+export type ErrorDto = {
+    /**
+     * The error message
+     */
     message: string;
+    /**
+     * The error type
+     */
     error: string;
+    /**
+     * The HTTP status code of the error
+     */
     statusCode: number;
+    /**
+     * The ID of the request that caused the error
+     */
     requestId: string;
 };
+export type ErrorResponseDto = {
+    /**
+     * Error details
+     */
+    error: ErrorDto;
+};
 export type PageInfoDto = {
     /**
      * The cursor for the next page
@@ -58,34 +108,6 @@ export type UpdateListDto = {
      */
     name: string;
 };
-export type Item = {
-    /**
-     * The ID of the item
-     */
-    id: string;
-    /**
-     * The Shopify ID of the product
-     */
-    productId: number;
-    /**
-     * The Shopify ID of the variant
-     */
-    variantId: {
-        [key: string]: unknown;
-    };
-    /**
-     * The quantity of the item in the list
-     */
-    quantity: number;
-    /**
-     * The date and time the item was created
-     */
-    createdAt: string;
-    /**
-     * The date and time the item was updated
-     */
-    updatedAt: string;
-};
 export type CreateItemDto = {
     /**
      * The Shopify ID of the product
@@ -154,9 +176,9 @@ export type ListControllerFindAllData = {
     path?: never;
     query?: {
         /**
-         * The pagination cursor
+         * The page cursor
          */
-        cursor?: string;
+        page?: string;
     };
     url: '/lists';
 };
@@ -165,29 +187,37 @@ export type ListControllerFindAllErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ListControllerFindAllError = ListControllerFindAllErrors[keyof ListControllerFindAllErrors];
@@ -225,29 +255,37 @@ export type ListControllerCreateOneErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ListControllerCreateOneError = ListControllerCreateOneErrors[keyof ListControllerCreateOneErrors];
@@ -290,29 +328,37 @@ export type ListControllerDeleteOneErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ListControllerDeleteOneError = ListControllerDeleteOneErrors[keyof ListControllerDeleteOneErrors];
@@ -353,29 +399,37 @@ export type ListControllerFindOneErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ListControllerFindOneError = ListControllerFindOneErrors[keyof ListControllerFindOneErrors];
@@ -418,29 +472,37 @@ export type ListControllerUpdateOneErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ListControllerUpdateOneError = ListControllerUpdateOneErrors[keyof ListControllerUpdateOneErrors];
@@ -478,29 +540,37 @@ export type ItemControllerDeleteErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ItemControllerDeleteError = ItemControllerDeleteErrors[keyof ItemControllerDeleteErrors];
@@ -530,9 +600,9 @@ export type ItemControllerFindData = {
     path?: never;
     query?: {
         /**
-         * The pagination cursor
+         * The page cursor
          */
-        cursor?: string;
+        page?: string;
     };
     url: '/items';
 };
@@ -541,29 +611,37 @@ export type ItemControllerFindErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ItemControllerFindError = ItemControllerFindErrors[keyof ItemControllerFindErrors];
@@ -601,29 +679,37 @@ export type ItemControllerCreateErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ItemControllerCreateError = ItemControllerCreateErrors[keyof ItemControllerCreateErrors];
@@ -666,29 +752,37 @@ export type ItemControllerDeleteByIdErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ItemControllerDeleteByIdError = ItemControllerDeleteByIdErrors[keyof ItemControllerDeleteByIdErrors];
@@ -729,29 +823,37 @@ export type ItemControllerUpdateByIdErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ItemControllerUpdateByIdError = ItemControllerUpdateByIdErrors[keyof ItemControllerUpdateByIdErrors];
@@ -789,29 +891,37 @@ export type ProfileControllerIdentifyErrors = {
      * Bad Request
      */
     400: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Unauthorized
      */
     401: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Forbidden
      */
     403: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
     /**
      * Not Found
      */
     404: ErrorResponseDto & {
-        statusCode?: number;
-        error?: string;
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
     };
 };
 export type ProfileControllerIdentifyError = ProfileControllerIdentifyErrors[keyof ProfileControllerIdentifyErrors];

package/dist/index.d.ts

@@ -1,19 +1,16 @@
-import { CreateItemDto, CreateListDto, DeleteItemsDto, UpdateItemDto, UpdateListDto } from "./client/types.gen";
+import { CreateItemDto, CreateListDto, DeleteItemsDto, ItemControllerFindData, ListControllerFindAllData, UpdateItemDto, UpdateListDto } from "./client/types.gen";
 export interface SwishClientOptions {
     authToken: string;
     shop: string;
     key: string;
 }
-type CursorQuery = {
-    cursor?: string;
-};
 export declare class SwishClient {
     private readonly authToken;
     private readonly shop;
     private readonly key;
     constructor(options: SwishClientOptions);
     readonly items: {
-        list: (query?: CursorQuery) => Promise<(import("./client").PaginatedResponseDto & {
+        list: (query?: ItemControllerFindData["query"]) => Promise<(import("./client").PaginatedResponseDto & {
             data?: Array<import("./client").Item>;
         }) | undefined>;
         create: (items: CreateItemDto) => Promise<(import("./client").ResponseDto & {
@@ -26,7 +23,7 @@ export declare class SwishClient {
         }) | undefined>;
     };
     readonly lists: {
-        list: (query?: CursorQuery) => Promise<(import("./client").PaginatedResponseDto & {
+        list: (query?: ListControllerFindAllData["query"]) => Promise<(import("./client").PaginatedResponseDto & {
             data?: Array<import("./client").List>;
         }) | undefined>;
         getById: (listId: string) => Promise<(import("./client").ResponseDto & {
@@ -43,4 +40,3 @@ export declare class SwishClient {
     private readonly addHeaders;
     private readonly handleRequest;
 }
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swishapp/api-client",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "API client for the Swish API",
   "website": "https://swish.app",
   "type": "module",