@swishapp/api-client 0.41.0 → 0.43.0-unstable.20260305130147

package/dist/{openapi → 2026-01/openapi}/types.gen.d.ts

@@ -97,7 +97,7 @@ export type List = {
      */
     access: 'private' | 'public';
 };
-export type _Error = {
+export type Error = {
     /**
      * The error message
      */
@@ -119,7 +119,7 @@ export type ErrorResponse = {
     /**
      * Error details
      */
-    error: _Error;
+    error: Error;
 };
 export type PageInfo = {
     /**
@@ -436,6 +436,14 @@ export type OrderLineItem = {
      * The original total price for this order item
      */
     originalTotalPrice: Money;
+    /**
+     * Whether the line item requires shipping
+     */
+    requiresShipping: boolean;
+    /**
+     * The unfulfilled quantity of the line item
+     */
+    unfulfilledQuantity: number;
 };
 export type TrackingInfo = {
     /**
@@ -511,9 +519,9 @@ export type OrderDetailDto = {
      */
     processedAt: string;
     /**
-     * The total number of items in the order
+     * The total quantity of items in the order
      */
-    itemCount: number;
+    totalQuantity: number;
     /**
      * The total price of the order
      */
@@ -525,11 +533,11 @@ export type OrderDetailDto = {
     /**
      * Array of fulfillments
      */
-    fulfillments: Fulfillment;
+    fulfillments: Array<Fulfillment>;
     /**
      * Array of unfulfilled line items
      */
-    unfulfilledLineItems: OrderLineItem;
+    unfulfilledLineItems: Array<OrderLineItem>;
 };
 export type OrderDto = {
     /**
@@ -549,9 +557,9 @@ export type OrderDto = {
      */
     displayStatus: 'FULFILLED' | 'IN_PROGRESS' | 'PARTIALLY_FULFILLED' | 'UNFULFILLED';
     /**
-     * The number of line items in the order
+     * The total quantity of items in the order
      */
-    itemCount: number;
+    totalQuantity: number;
     /**
      * The total price of the order
      */
@@ -591,6 +599,192 @@ export type SharedList = {
      */
     updatedAt: string;
 };
+export type NotificationUnreadCount = {
+    /**
+     * The total number of unread notifications
+     */
+    count: number;
+};
+export type MarkReadDto = {
+    /**
+     * Array of notification IDs to mark as read
+     */
+    notificationIds: Array<string>;
+};
+export type Notification = {
+    /**
+     * The ID of the notification
+     */
+    id: string;
+    /**
+     * The type of notification. Use this to look up localized title and message on the client.
+     */
+    type: 'price_drop' | 'back_in_stock' | 'low_in_stock';
+    /**
+     * The Shopify product ID
+     */
+    productId?: string;
+    /**
+     * The Shopify variant ID
+     */
+    variantId?: string;
+    /**
+     * Whether the notification has been read
+     */
+    read: boolean;
+    /**
+     * The date and time the notification was created
+     */
+    createdAt: string;
+    /**
+     * The date and time the notification was last updated
+     */
+    updatedAt: string;
+};
+export type SubscriptionQueryDto = {
+    /**
+     * Filter subscriptions by type
+     */
+    type?: 'back_in_stock';
+    /**
+     * Filter subscriptions by status
+     */
+    status?: 'active' | 'cancelled' | 'fulfilled';
+    /**
+     * Filter subscriptions by product ID
+     */
+    productId?: string;
+    /**
+     * Number of subscriptions to return
+     */
+    limit?: number;
+    /**
+     * The page cursor for pagination
+     */
+    page?: string;
+};
+export type UpdateSubscriptionInput = {
+    /**
+     * The status of the subscription
+     */
+    status?: 'active' | 'cancelled' | 'fulfilled';
+    /**
+     * The Shopify variant ID
+     */
+    variantId?: {
+        [key: string]: unknown;
+    } | null;
+};
+export type CreateSubscriptionInput = {
+    /**
+     * The contact information for the subscription (phone or email)
+     */
+    contact: string;
+    /**
+     * The Shopify product ID
+     */
+    productId: string;
+    /**
+     * The Shopify variant ID
+     */
+    variantId?: string;
+    /**
+     * The type of subscription
+     */
+    type: 'back_in_stock';
+    /**
+     * The channel for the subscription
+     */
+    channel: 'email' | 'sms' | 'whatsapp';
+    /**
+     * The market for the subscription
+     */
+    market?: string;
+    /**
+     * The country for the subscription
+     */
+    country?: string;
+    /**
+     * The language for the subscription
+     */
+    language?: string;
+};
+export type Subscription = {
+    /**
+     * The ID of the subscription
+     */
+    id: string;
+    /**
+     * The contact information for the subscription (phone or email)
+     */
+    contact: string;
+    /**
+     * The Shopify product ID
+     */
+    productId: string;
+    /**
+     * The Shopify variant ID
+     */
+    variantId?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The type of subscription
+     */
+    type: 'back_in_stock';
+    /**
+     * The channel for the subscription
+     */
+    channel: 'email' | 'sms' | 'whatsapp';
+    /**
+     * The status of the subscription
+     */
+    status: 'active' | 'cancelled' | 'fulfilled';
+    /**
+     * The date and time the subscription was created
+     */
+    createdAt: string;
+    /**
+     * The date and time the subscription was last updated
+     */
+    updatedAt: string;
+    /**
+     * The date and time the subscription was cancelled
+     */
+    cancelledAt?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The date and time the subscription was fulfilled
+     */
+    fulfilledAt?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The date and time the last notification was sent
+     */
+    lastNotificationAt?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The market for the subscription
+     */
+    market?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The country for the subscription
+     */
+    country?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The language for the subscription
+     */
+    language?: {
+        [key: string]: unknown;
+    } | null;
+};
 export type ListControllerFindData = {
     body?: never;
     path?: never;
@@ -766,7 +960,9 @@ export type ListControllerDeleteByIdResponses = {
     /**
      * The list has been successfully deleted.
      */
-    204: void;
+    200: Response & {
+        data?: List;
+    };
 };
 export type ListControllerDeleteByIdResponse = ListControllerDeleteByIdResponses[keyof ListControllerDeleteByIdResponses];
 export type ListControllerFindByIdData = {
@@ -1112,7 +1308,9 @@ export type ItemControllerDeleteResponses = {
     /**
      * The items have been successfully deleted.
      */
-    204: void;
+    200: Response & {
+        data?: Array<Item>;
+    };
 };
 export type ItemControllerDeleteResponse = ItemControllerDeleteResponses[keyof ItemControllerDeleteResponses];
 export type ItemControllerFindData = {
@@ -1366,7 +1564,9 @@ export type ItemControllerDeleteByIdResponses = {
     /**
      * The item has been successfully deleted.
      */
-    204: void;
+    200: Response & {
+        data?: Item;
+    };
 };
 export type ItemControllerDeleteByIdResponse = ItemControllerDeleteByIdResponses[keyof ItemControllerDeleteByIdResponses];
 export type ItemControllerFindByIdData = {
@@ -1973,16 +2173,13 @@ export type AnalyticsControllerLoadNewListsResponses = {
     };
 };
 export type AnalyticsControllerLoadNewListsResponse = AnalyticsControllerLoadNewListsResponses[keyof AnalyticsControllerLoadNewListsResponses];
-export type TrackingControllerTrackData = {
+export type TrackingControllerCollectData = {
     body: TrackingEventRequestDto;
-    headers: {
-        referer: string;
-    };
     path?: never;
     query?: never;
-    url: '/tracking';
+    url: '/collect';
 };
-export type TrackingControllerTrackErrors = {
+export type TrackingControllerCollectErrors = {
     /**
      * Bad Request
      */
@@ -2011,14 +2208,14 @@ export type TrackingControllerTrackErrors = {
         };
     };
 };
-export type TrackingControllerTrackError = TrackingControllerTrackErrors[keyof TrackingControllerTrackErrors];
-export type TrackingControllerTrackResponses = {
+export type TrackingControllerCollectError = TrackingControllerCollectErrors[keyof TrackingControllerCollectErrors];
+export type TrackingControllerCollectResponses = {
     /**
      * Event tracked successfully
      */
     204: void;
 };
-export type TrackingControllerTrackResponse = TrackingControllerTrackResponses[keyof TrackingControllerTrackResponses];
+export type TrackingControllerCollectResponse = TrackingControllerCollectResponses[keyof TrackingControllerCollectResponses];
 export type OrdersControllerFindData = {
     body?: never;
     path?: never;
@@ -2379,3 +2576,561 @@ export type SharedListsControllerFindAllResponses = {
     };
 };
 export type SharedListsControllerFindAllResponse = SharedListsControllerFindAllResponses[keyof SharedListsControllerFindAllResponses];
+export type NotificationsControllerFindData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Filter notifications by read status. Use read=false for unread notifications.
+         */
+        read?: boolean;
+        /**
+         * Filter notifications by type
+         */
+        type?: 'price_drop' | 'back_in_stock' | 'low_in_stock';
+        /**
+         * Number of notifications to return
+         */
+        limit?: number;
+        /**
+         * The page cursor for pagination
+         */
+        page?: string;
+    };
+    url: '/notifications';
+};
+export type NotificationsControllerFindErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type NotificationsControllerFindError = NotificationsControllerFindErrors[keyof NotificationsControllerFindErrors];
+export type NotificationsControllerFindResponses = {
+    /**
+     * Returns all notifications as paginated response
+     */
+    200: PaginatedResponse & {
+        data?: Array<Notification>;
+    };
+};
+export type NotificationsControllerFindResponse = NotificationsControllerFindResponses[keyof NotificationsControllerFindResponses];
+export type NotificationsControllerGetUnreadCountData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/notifications/unread/count';
+};
+export type NotificationsControllerGetUnreadCountErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type NotificationsControllerGetUnreadCountError = NotificationsControllerGetUnreadCountErrors[keyof NotificationsControllerGetUnreadCountErrors];
+export type NotificationsControllerGetUnreadCountResponses = {
+    /**
+     * Returns the total count of unread notifications
+     */
+    200: Response & {
+        data?: NotificationUnreadCount;
+    };
+};
+export type NotificationsControllerGetUnreadCountResponse = NotificationsControllerGetUnreadCountResponses[keyof NotificationsControllerGetUnreadCountResponses];
+export type NotificationsControllerMarkAsReadData = {
+    body: MarkReadDto;
+    path?: never;
+    query?: never;
+    url: '/notifications/read';
+};
+export type NotificationsControllerMarkAsReadErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type NotificationsControllerMarkAsReadError = NotificationsControllerMarkAsReadErrors[keyof NotificationsControllerMarkAsReadErrors];
+export type NotificationsControllerMarkAsReadResponses = {
+    /**
+     * Notifications marked as read successfully
+     */
+    200: Response & {
+        data?: Array<Notification>;
+    };
+};
+export type NotificationsControllerMarkAsReadResponse = NotificationsControllerMarkAsReadResponses[keyof NotificationsControllerMarkAsReadResponses];
+export type NotificationsControllerDeleteByIdData = {
+    body?: never;
+    path: {
+        /**
+         * The ID of the notification
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/notifications/{id}';
+};
+export type NotificationsControllerDeleteByIdErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type NotificationsControllerDeleteByIdError = NotificationsControllerDeleteByIdErrors[keyof NotificationsControllerDeleteByIdErrors];
+export type NotificationsControllerDeleteByIdResponses = {
+    /**
+     * The notification has been successfully deleted.
+     */
+    200: Response & {
+        data?: Notification;
+    };
+};
+export type NotificationsControllerDeleteByIdResponse = NotificationsControllerDeleteByIdResponses[keyof NotificationsControllerDeleteByIdResponses];
+export type SubscriptionsControllerFindData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Filter subscriptions by type
+         */
+        type?: 'back_in_stock';
+        /**
+         * Filter subscriptions by status
+         */
+        status?: 'active' | 'cancelled' | 'fulfilled';
+        /**
+         * Filter subscriptions by product ID
+         */
+        productId?: string;
+        /**
+         * Number of subscriptions to return
+         */
+        limit?: number;
+        /**
+         * The page cursor for pagination
+         */
+        page?: string;
+    };
+    url: '/subscriptions';
+};
+export type SubscriptionsControllerFindErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type SubscriptionsControllerFindError = SubscriptionsControllerFindErrors[keyof SubscriptionsControllerFindErrors];
+export type SubscriptionsControllerFindResponses = {
+    /**
+     * Returns all subscriptions as paginated response
+     */
+    200: PaginatedResponse & {
+        data?: Array<Subscription>;
+    };
+};
+export type SubscriptionsControllerFindResponse = SubscriptionsControllerFindResponses[keyof SubscriptionsControllerFindResponses];
+export type SubscriptionsControllerCreateData = {
+    body: CreateSubscriptionInput;
+    headers?: {
+        /**
+         * The language for the user (e.g., 'en', 'de', 'fr')
+         */
+        language?: string;
+        /**
+         * The country for the user (e.g., 'US', 'DE', 'FR')
+         */
+        country?: string;
+        /**
+         * The market for the user (e.g. 1234567)
+         */
+        market?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/subscriptions';
+};
+export type SubscriptionsControllerCreateErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type SubscriptionsControllerCreateError = SubscriptionsControllerCreateErrors[keyof SubscriptionsControllerCreateErrors];
+export type SubscriptionsControllerCreateResponses = {
+    /**
+     * The subscription has been successfully created.
+     */
+    201: Response & {
+        data?: Subscription;
+    };
+};
+export type SubscriptionsControllerCreateResponse = SubscriptionsControllerCreateResponses[keyof SubscriptionsControllerCreateResponses];
+export type SubscriptionsControllerDeleteData = {
+    body?: never;
+    path: {
+        /**
+         * The ID of the subscription to delete
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/subscriptions/{id}';
+};
+export type SubscriptionsControllerDeleteErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type SubscriptionsControllerDeleteError = SubscriptionsControllerDeleteErrors[keyof SubscriptionsControllerDeleteErrors];
+export type SubscriptionsControllerDeleteResponses = {
+    /**
+     * The subscription has been successfully deleted.
+     */
+    200: Response & {
+        data?: Subscription;
+    };
+};
+export type SubscriptionsControllerDeleteResponse = SubscriptionsControllerDeleteResponses[keyof SubscriptionsControllerDeleteResponses];
+export type SubscriptionsControllerFindByIdData = {
+    body?: never;
+    path: {
+        /**
+         * The ID of the subscription
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/subscriptions/{id}';
+};
+export type SubscriptionsControllerFindByIdErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type SubscriptionsControllerFindByIdError = SubscriptionsControllerFindByIdErrors[keyof SubscriptionsControllerFindByIdErrors];
+export type SubscriptionsControllerFindByIdResponses = {
+    /**
+     * The subscription has been successfully retrieved.
+     */
+    200: Response & {
+        data?: Subscription;
+    };
+};
+export type SubscriptionsControllerFindByIdResponse = SubscriptionsControllerFindByIdResponses[keyof SubscriptionsControllerFindByIdResponses];
+export type SubscriptionsControllerUpdateData = {
+    body: UpdateSubscriptionInput;
+    path: {
+        /**
+         * The ID of the subscription to update
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/subscriptions/{id}';
+};
+export type SubscriptionsControllerUpdateErrors = {
+    /**
+     * Bad Request
+     */
+    400: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+    /**
+     * Not Found
+     */
+    404: ErrorResponse & {
+        error?: {
+            statusCode?: number;
+            error?: string;
+        };
+    };
+};
+export type SubscriptionsControllerUpdateError = SubscriptionsControllerUpdateErrors[keyof SubscriptionsControllerUpdateErrors];
+export type SubscriptionsControllerUpdateResponses = {
+    /**
+     * The subscription has been successfully updated.
+     */
+    200: Response & {
+        data?: Subscription;
+    };
+};
+export type SubscriptionsControllerUpdateResponse = SubscriptionsControllerUpdateResponses[keyof SubscriptionsControllerUpdateResponses];