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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +55 -0
  2. package/dist/{client.d.ts → 2026-01/client.d.ts} +19 -8
  3. package/dist/2026-01/index.d.ts +3 -0
  4. package/dist/2026-01/index.js +7 -0
  5. package/dist/{openapi → 2026-01/openapi}/client/index.d.ts +2 -1
  6. package/dist/{openapi → 2026-01/openapi}/client/types.gen.d.ts +2 -9
  7. package/dist/{openapi → 2026-01/openapi}/client/utils.gen.d.ts +1 -1
  8. package/dist/{openapi → 2026-01/openapi}/core/bodySerializer.gen.d.ts +12 -4
  9. package/dist/{openapi → 2026-01/openapi}/core/params.gen.d.ts +10 -0
  10. package/dist/2026-01/openapi/core/queryKeySerializer.gen.d.ts +18 -0
  11. package/dist/2026-01/openapi/index.d.ts +2 -0
  12. package/dist/{openapi → 2026-01/openapi}/sdk.gen.d.ts +14 -4
  13. package/dist/{openapi → 2026-01/openapi}/types.gen.d.ts +775 -20
  14. package/dist/{types.d.ts → 2026-01/types.d.ts} +1 -2
  15. package/dist/2026-04/client.d.ts +143 -0
  16. package/dist/2026-04/index.d.ts +3 -0
  17. package/dist/2026-04/index.js +7 -0
  18. package/dist/2026-04/openapi/client/client.gen.d.ts +2 -0
  19. package/dist/2026-04/openapi/client/index.d.ts +8 -0
  20. package/dist/2026-04/openapi/client/types.gen.d.ts +117 -0
  21. package/dist/2026-04/openapi/client/utils.gen.d.ts +33 -0
  22. package/dist/2026-04/openapi/client.gen.d.ts +12 -0
  23. package/dist/2026-04/openapi/core/auth.gen.d.ts +18 -0
  24. package/dist/2026-04/openapi/core/bodySerializer.gen.d.ts +25 -0
  25. package/dist/2026-04/openapi/core/params.gen.d.ts +43 -0
  26. package/dist/2026-04/openapi/core/pathSerializer.gen.d.ts +33 -0
  27. package/dist/2026-04/openapi/core/queryKeySerializer.gen.d.ts +18 -0
  28. package/dist/2026-04/openapi/core/serverSentEvents.gen.d.ts +71 -0
  29. package/dist/2026-04/openapi/core/types.gen.d.ts +78 -0
  30. package/dist/2026-04/openapi/core/utils.gen.d.ts +19 -0
  31. package/dist/2026-04/openapi/index.d.ts +2 -0
  32. package/dist/2026-04/openapi/sdk.gen.d.ts +279 -0
  33. package/dist/2026-04/openapi/types.gen.d.ts +4502 -0
  34. package/dist/2026-04/types.d.ts +57 -0
  35. package/dist/index.d.ts +1 -3
  36. package/dist/index.js +6 -4
  37. package/dist/unstable/client.d.ts +143 -0
  38. package/dist/unstable/index.d.ts +3 -0
  39. package/dist/unstable/index.js +7 -0
  40. package/dist/unstable/openapi/client/client.gen.d.ts +2 -0
  41. package/dist/unstable/openapi/client/index.d.ts +8 -0
  42. package/dist/unstable/openapi/client/types.gen.d.ts +117 -0
  43. package/dist/unstable/openapi/client/utils.gen.d.ts +33 -0
  44. package/dist/unstable/openapi/client.gen.d.ts +12 -0
  45. package/dist/unstable/openapi/core/auth.gen.d.ts +18 -0
  46. package/dist/unstable/openapi/core/bodySerializer.gen.d.ts +25 -0
  47. package/dist/unstable/openapi/core/params.gen.d.ts +43 -0
  48. package/dist/unstable/openapi/core/pathSerializer.gen.d.ts +33 -0
  49. package/dist/unstable/openapi/core/queryKeySerializer.gen.d.ts +18 -0
  50. package/dist/unstable/openapi/core/serverSentEvents.gen.d.ts +71 -0
  51. package/dist/unstable/openapi/core/types.gen.d.ts +78 -0
  52. package/dist/unstable/openapi/core/utils.gen.d.ts +19 -0
  53. package/dist/unstable/openapi/index.d.ts +2 -0
  54. package/dist/unstable/openapi/sdk.gen.d.ts +279 -0
  55. package/dist/unstable/openapi/types.gen.d.ts +4502 -0
  56. package/dist/unstable/types.d.ts +57 -0
  57. package/package.json +52 -22
  58. package/dist/openapi/index.d.ts +0 -2
  59. /package/dist/{openapi → 2026-01/openapi}/client/client.gen.d.ts +0 -0
  60. /package/dist/{openapi → 2026-01/openapi}/client.gen.d.ts +0 -0
  61. /package/dist/{openapi → 2026-01/openapi}/core/auth.gen.d.ts +0 -0
  62. /package/dist/{openapi → 2026-01/openapi}/core/pathSerializer.gen.d.ts +0 -0
  63. /package/dist/{openapi → 2026-01/openapi}/core/serverSentEvents.gen.d.ts +0 -0
  64. /package/dist/{openapi → 2026-01/openapi}/core/types.gen.d.ts +0 -0
  65. /package/dist/{openapi → 2026-01/openapi}/core/utils.gen.d.ts +0 -0
@@ -0,0 +1,78 @@
1
+ import type { Auth, AuthToken } from './auth.gen';
2
+ import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen';
3
+ export type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
4
+ export type Client<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
5
+ /**
6
+ * Returns the final request URL.
7
+ */
8
+ buildUrl: BuildUrlFn;
9
+ getConfig: () => Config;
10
+ request: RequestFn;
11
+ setConfig: (config: Config) => Config;
12
+ } & {
13
+ [K in HttpMethod]: MethodFn;
14
+ } & ([SseFn] extends [never] ? {
15
+ sse?: never;
16
+ } : {
17
+ sse: {
18
+ [K in HttpMethod]: SseFn;
19
+ };
20
+ });
21
+ export interface Config {
22
+ /**
23
+ * Auth token or a function returning auth token. The resolved value will be
24
+ * added to the request payload as defined by its `security` array.
25
+ */
26
+ auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
27
+ /**
28
+ * A function for serializing request body parameter. By default,
29
+ * {@link JSON.stringify()} will be used.
30
+ */
31
+ bodySerializer?: BodySerializer | null;
32
+ /**
33
+ * An object containing any HTTP headers that you want to pre-populate your
34
+ * `Headers` object with.
35
+ *
36
+ * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
37
+ */
38
+ headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
39
+ /**
40
+ * The request method.
41
+ *
42
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
43
+ */
44
+ method?: Uppercase<HttpMethod>;
45
+ /**
46
+ * A function for serializing request query parameters. By default, arrays
47
+ * will be exploded in form style, objects will be exploded in deepObject
48
+ * style, and reserved characters are percent-encoded.
49
+ *
50
+ * This method will have no effect if the native `paramsSerializer()` Axios
51
+ * API function is used.
52
+ *
53
+ * {@link https://swagger.io/docs/specification/serialization/#query View examples}
54
+ */
55
+ querySerializer?: QuerySerializer | QuerySerializerOptions;
56
+ /**
57
+ * A function validating request data. This is useful if you want to ensure
58
+ * the request conforms to the desired shape, so it can be safely sent to
59
+ * the server.
60
+ */
61
+ requestValidator?: (data: unknown) => Promise<unknown>;
62
+ /**
63
+ * A function transforming response data before it's returned. This is useful
64
+ * for post-processing data, e.g. converting ISO strings into Date objects.
65
+ */
66
+ responseTransformer?: (data: unknown) => Promise<unknown>;
67
+ /**
68
+ * A function validating response data. This is useful if you want to ensure
69
+ * the response conforms to the desired shape, so it can be safely passed to
70
+ * the transformers and returned to the user.
71
+ */
72
+ responseValidator?: (data: unknown) => Promise<unknown>;
73
+ }
74
+ type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] ? true : [T] extends [never | undefined] ? [undefined] extends [T] ? false : true : false;
75
+ export type OmitNever<T extends Record<string, unknown>> = {
76
+ [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K];
77
+ };
78
+ export {};
@@ -0,0 +1,19 @@
1
+ import type { BodySerializer, QuerySerializer } from './bodySerializer.gen';
2
+ export interface PathSerializer {
3
+ path: Record<string, unknown>;
4
+ url: string;
5
+ }
6
+ export declare const PATH_PARAM_RE: RegExp;
7
+ export declare const defaultPathSerializer: ({ path, url: _url }: PathSerializer) => string;
8
+ export declare const getUrl: ({ baseUrl, path, query, querySerializer, url: _url, }: {
9
+ baseUrl?: string;
10
+ path?: Record<string, unknown>;
11
+ query?: Record<string, unknown>;
12
+ querySerializer: QuerySerializer;
13
+ url: string;
14
+ }) => string;
15
+ export declare function getValidRequestBody(options: {
16
+ body?: unknown;
17
+ bodySerializer?: BodySerializer | null;
18
+ serializedBody?: unknown;
19
+ }): unknown;
@@ -0,0 +1,2 @@
1
+ export { analyticsControllerLoadNewLists, analyticsControllerLoadSavedItems, analyticsControllerLoadSessions, itemControllerCount, itemControllerCreate, itemControllerDelete, itemControllerDeleteById, itemControllerFind, itemControllerFindById, itemControllerSetListsById, itemControllerUpdateById, listControllerAddItemsToList, listControllerCreate, listControllerDeleteById, listControllerFind, listControllerFindById, listControllerRemoveItemFromList, listControllerSetListItemsOrder, listControllerUpdateById, notificationsControllerDeleteById, notificationsControllerFind, notificationsControllerGetUnreadCount, notificationsControllerMarkAllAsRead, notificationsControllerMarkAsRead, type Options, ordersControllerFind, ordersControllerFindOne, profileControllerCreateToken, profileControllerGetProfile, profileControllerIdentify, profileControllerUpdateProfile, sharedListsControllerDeleteById, sharedListsControllerFindAll, sharedListsControllerFindById, sharedListsControllerFindItems, sharedListsControllerSave, smartListsControllerFindAll, smartListsControllerFindById, smartListsControllerFindItems, subscriptionsControllerCreate, subscriptionsControllerDelete, subscriptionsControllerFind, subscriptionsControllerFindById, subscriptionsControllerUpdate, trackingControllerCollect } from './sdk.gen';
2
+ export type { AddItemsToList, Analytics, AnalyticsControllerLoadNewListsData, AnalyticsControllerLoadNewListsError, AnalyticsControllerLoadNewListsErrors, AnalyticsControllerLoadNewListsResponse, AnalyticsControllerLoadNewListsResponses, AnalyticsControllerLoadSavedItemsData, AnalyticsControllerLoadSavedItemsError, AnalyticsControllerLoadSavedItemsErrors, AnalyticsControllerLoadSavedItemsResponse, AnalyticsControllerLoadSavedItemsResponses, AnalyticsControllerLoadSessionsData, AnalyticsControllerLoadSessionsError, AnalyticsControllerLoadSessionsErrors, AnalyticsControllerLoadSessionsResponse, AnalyticsControllerLoadSessionsResponses, ClientOptions, CreateItem, CreateList, CreateProfileToken, CreateProfileTokenResult, CreateSubscription, DeleteItems, Error, ErrorResponse, Fulfillment, IdentifyProfile, Image, Item, ItemControllerCountData, ItemControllerCountError, ItemControllerCountErrors, ItemControllerCountResponse, ItemControllerCountResponses, ItemControllerCreateData, ItemControllerCreateError, ItemControllerCreateErrors, ItemControllerCreateResponse, ItemControllerCreateResponses, ItemControllerDeleteByIdData, ItemControllerDeleteByIdError, ItemControllerDeleteByIdErrors, ItemControllerDeleteByIdResponse, ItemControllerDeleteByIdResponses, ItemControllerDeleteData, ItemControllerDeleteError, ItemControllerDeleteErrors, ItemControllerDeleteResponse, ItemControllerDeleteResponses, ItemControllerFindByIdData, ItemControllerFindByIdError, ItemControllerFindByIdErrors, ItemControllerFindByIdResponse, ItemControllerFindByIdResponses, ItemControllerFindData, ItemControllerFindError, ItemControllerFindErrors, ItemControllerFindResponse, ItemControllerFindResponses, ItemControllerSetListsByIdData, ItemControllerSetListsByIdError, ItemControllerSetListsByIdErrors, ItemControllerSetListsByIdResponse, ItemControllerSetListsByIdResponses, ItemControllerUpdateByIdData, ItemControllerUpdateByIdError, ItemControllerUpdateByIdErrors, ItemControllerUpdateByIdResponse, ItemControllerUpdateByIdResponses, ItemCount, ItemDetail, ItemReference, List, ListControllerAddItemsToListData, ListControllerAddItemsToListError, ListControllerAddItemsToListErrors, ListControllerAddItemsToListResponse, ListControllerAddItemsToListResponses, ListControllerCreateData, ListControllerCreateError, ListControllerCreateErrors, ListControllerCreateResponse, ListControllerCreateResponses, ListControllerDeleteByIdData, ListControllerDeleteByIdError, ListControllerDeleteByIdErrors, ListControllerDeleteByIdResponse, ListControllerDeleteByIdResponses, ListControllerFindByIdData, ListControllerFindByIdError, ListControllerFindByIdErrors, ListControllerFindByIdResponse, ListControllerFindByIdResponses, ListControllerFindData, ListControllerFindError, ListControllerFindErrors, ListControllerFindResponse, ListControllerFindResponses, ListControllerRemoveItemFromListData, ListControllerRemoveItemFromListError, ListControllerRemoveItemFromListErrors, ListControllerRemoveItemFromListResponse, ListControllerRemoveItemFromListResponses, ListControllerSetListItemsOrderData, ListControllerSetListItemsOrderError, ListControllerSetListItemsOrderErrors, ListControllerSetListItemsOrderResponse, ListControllerSetListItemsOrderResponses, ListControllerUpdateByIdData, ListControllerUpdateByIdError, ListControllerUpdateByIdErrors, ListControllerUpdateByIdResponse, ListControllerUpdateByIdResponses, ListDetail, MarkAsRead, MarketingConsent, Money, Notification, NotificationContext, NotificationMoney, NotificationProduct, NotificationsControllerDeleteByIdData, NotificationsControllerDeleteByIdError, NotificationsControllerDeleteByIdErrors, NotificationsControllerDeleteByIdResponse, NotificationsControllerDeleteByIdResponses, NotificationsControllerFindData, NotificationsControllerFindError, NotificationsControllerFindErrors, NotificationsControllerFindResponse, NotificationsControllerFindResponses, NotificationsControllerGetUnreadCountData, NotificationsControllerGetUnreadCountError, NotificationsControllerGetUnreadCountErrors, NotificationsControllerGetUnreadCountResponse, NotificationsControllerGetUnreadCountResponses, NotificationsControllerMarkAllAsReadData, NotificationsControllerMarkAllAsReadError, NotificationsControllerMarkAllAsReadErrors, NotificationsControllerMarkAllAsReadResponse, NotificationsControllerMarkAllAsReadResponses, NotificationsControllerMarkAsReadData, NotificationsControllerMarkAsReadError, NotificationsControllerMarkAsReadErrors, NotificationsControllerMarkAsReadResponse, NotificationsControllerMarkAsReadResponses, NotificationSettings, NotificationUnreadCount, NotificationVariant, Order, OrderDetail, OrderLineItem, OrderProduct, OrderProductVariant, OrdersControllerFindData, OrdersControllerFindError, OrdersControllerFindErrors, OrdersControllerFindOneData, OrdersControllerFindOneError, OrdersControllerFindOneErrors, OrdersControllerFindOneResponse, OrdersControllerFindOneResponses, OrdersControllerFindResponse, OrdersControllerFindResponses, PageInfo, PaginatedResponse, PreviewImage, ProductCategory, ProductOption, ProductPriceRange, ProductVariantsCount, Profile, ProfileControllerCreateTokenData, ProfileControllerCreateTokenError, ProfileControllerCreateTokenErrors, ProfileControllerCreateTokenResponse, ProfileControllerCreateTokenResponses, ProfileControllerGetProfileData, ProfileControllerGetProfileError, ProfileControllerGetProfileErrors, ProfileControllerGetProfileResponse, ProfileControllerGetProfileResponses, ProfileControllerIdentifyData, ProfileControllerIdentifyError, ProfileControllerIdentifyErrors, ProfileControllerIdentifyResponses, ProfileControllerUpdateProfileData, ProfileControllerUpdateProfileError, ProfileControllerUpdateProfileErrors, ProfileControllerUpdateProfileResponse, ProfileControllerUpdateProfileResponses, Response, SaveSharedList, SetItemLists, SetListItemsOrder, SharedListsControllerDeleteByIdData, SharedListsControllerDeleteByIdError, SharedListsControllerDeleteByIdErrors, SharedListsControllerDeleteByIdResponse, SharedListsControllerDeleteByIdResponses, SharedListsControllerFindAllData, SharedListsControllerFindAllError, SharedListsControllerFindAllErrors, SharedListsControllerFindAllResponse, SharedListsControllerFindAllResponses, SharedListsControllerFindByIdData, SharedListsControllerFindByIdError, SharedListsControllerFindByIdErrors, SharedListsControllerFindByIdResponse, SharedListsControllerFindByIdResponses, SharedListsControllerFindItemsData, SharedListsControllerFindItemsError, SharedListsControllerFindItemsErrors, SharedListsControllerFindItemsResponse, SharedListsControllerFindItemsResponses, SharedListsControllerSaveData, SharedListsControllerSaveError, SharedListsControllerSaveErrors, SharedListsControllerSaveResponse, SharedListsControllerSaveResponses, SmartListsControllerFindAllData, SmartListsControllerFindAllError, SmartListsControllerFindAllErrors, SmartListsControllerFindAllResponse, SmartListsControllerFindAllResponses, SmartListsControllerFindByIdData, SmartListsControllerFindByIdError, SmartListsControllerFindByIdErrors, SmartListsControllerFindByIdResponse, SmartListsControllerFindByIdResponses, SmartListsControllerFindItemsData, SmartListsControllerFindItemsError, SmartListsControllerFindItemsErrors, SmartListsControllerFindItemsResponse, SmartListsControllerFindItemsResponses, Subscription, SubscriptionQuery, SubscriptionsControllerCreateData, SubscriptionsControllerCreateError, SubscriptionsControllerCreateErrors, SubscriptionsControllerCreateResponse, SubscriptionsControllerCreateResponses, SubscriptionsControllerDeleteData, SubscriptionsControllerDeleteError, SubscriptionsControllerDeleteErrors, SubscriptionsControllerDeleteResponse, SubscriptionsControllerDeleteResponses, SubscriptionsControllerFindByIdData, SubscriptionsControllerFindByIdError, SubscriptionsControllerFindByIdErrors, SubscriptionsControllerFindByIdResponse, SubscriptionsControllerFindByIdResponses, SubscriptionsControllerFindData, SubscriptionsControllerFindError, SubscriptionsControllerFindErrors, SubscriptionsControllerFindResponse, SubscriptionsControllerFindResponses, SubscriptionsControllerUpdateData, SubscriptionsControllerUpdateError, SubscriptionsControllerUpdateErrors, SubscriptionsControllerUpdateResponse, SubscriptionsControllerUpdateResponses, TrackingControllerCollectData, TrackingControllerCollectError, TrackingControllerCollectErrors, TrackingControllerCollectResponse, TrackingControllerCollectResponses, TrackingEventItem, TrackingEventRequest, TrackingInfo, UpdateItem, UpdateList, UpdateProfile, UpdateSubscription } from './types.gen';
@@ -0,0 +1,279 @@
1
+ import type { Client, Options as Options2, TDataShape } from './client';
2
+ import type { AnalyticsControllerLoadNewListsData, AnalyticsControllerLoadNewListsErrors, AnalyticsControllerLoadNewListsResponses, AnalyticsControllerLoadSavedItemsData, AnalyticsControllerLoadSavedItemsErrors, AnalyticsControllerLoadSavedItemsResponses, AnalyticsControllerLoadSessionsData, AnalyticsControllerLoadSessionsErrors, AnalyticsControllerLoadSessionsResponses, ItemControllerCountData, ItemControllerCountErrors, ItemControllerCountResponses, ItemControllerCreateData, ItemControllerCreateErrors, ItemControllerCreateResponses, ItemControllerDeleteByIdData, ItemControllerDeleteByIdErrors, ItemControllerDeleteByIdResponses, ItemControllerDeleteData, ItemControllerDeleteErrors, ItemControllerDeleteResponses, ItemControllerFindByIdData, ItemControllerFindByIdErrors, ItemControllerFindByIdResponses, ItemControllerFindData, ItemControllerFindErrors, ItemControllerFindResponses, ItemControllerSetListsByIdData, ItemControllerSetListsByIdErrors, ItemControllerSetListsByIdResponses, ItemControllerUpdateByIdData, ItemControllerUpdateByIdErrors, ItemControllerUpdateByIdResponses, ListControllerAddItemsToListData, ListControllerAddItemsToListErrors, ListControllerAddItemsToListResponses, ListControllerCreateData, ListControllerCreateErrors, ListControllerCreateResponses, ListControllerDeleteByIdData, ListControllerDeleteByIdErrors, ListControllerDeleteByIdResponses, ListControllerFindByIdData, ListControllerFindByIdErrors, ListControllerFindByIdResponses, ListControllerFindData, ListControllerFindErrors, ListControllerFindResponses, ListControllerRemoveItemFromListData, ListControllerRemoveItemFromListErrors, ListControllerRemoveItemFromListResponses, ListControllerSetListItemsOrderData, ListControllerSetListItemsOrderErrors, ListControllerSetListItemsOrderResponses, ListControllerUpdateByIdData, ListControllerUpdateByIdErrors, ListControllerUpdateByIdResponses, NotificationsControllerDeleteByIdData, NotificationsControllerDeleteByIdErrors, NotificationsControllerDeleteByIdResponses, NotificationsControllerFindData, NotificationsControllerFindErrors, NotificationsControllerFindResponses, NotificationsControllerGetUnreadCountData, NotificationsControllerGetUnreadCountErrors, NotificationsControllerGetUnreadCountResponses, NotificationsControllerMarkAllAsReadData, NotificationsControllerMarkAllAsReadErrors, NotificationsControllerMarkAllAsReadResponses, NotificationsControllerMarkAsReadData, NotificationsControllerMarkAsReadErrors, NotificationsControllerMarkAsReadResponses, OrdersControllerFindData, OrdersControllerFindErrors, OrdersControllerFindOneData, OrdersControllerFindOneErrors, OrdersControllerFindOneResponses, OrdersControllerFindResponses, ProfileControllerCreateTokenData, ProfileControllerCreateTokenErrors, ProfileControllerCreateTokenResponses, ProfileControllerGetProfileData, ProfileControllerGetProfileErrors, ProfileControllerGetProfileResponses, ProfileControllerIdentifyData, ProfileControllerIdentifyErrors, ProfileControllerIdentifyResponses, ProfileControllerUpdateProfileData, ProfileControllerUpdateProfileErrors, ProfileControllerUpdateProfileResponses, SharedListsControllerDeleteByIdData, SharedListsControllerDeleteByIdErrors, SharedListsControllerDeleteByIdResponses, SharedListsControllerFindAllData, SharedListsControllerFindAllErrors, SharedListsControllerFindAllResponses, SharedListsControllerFindByIdData, SharedListsControllerFindByIdErrors, SharedListsControllerFindByIdResponses, SharedListsControllerFindItemsData, SharedListsControllerFindItemsErrors, SharedListsControllerFindItemsResponses, SharedListsControllerSaveData, SharedListsControllerSaveErrors, SharedListsControllerSaveResponses, SmartListsControllerFindAllData, SmartListsControllerFindAllErrors, SmartListsControllerFindAllResponses, SmartListsControllerFindByIdData, SmartListsControllerFindByIdErrors, SmartListsControllerFindByIdResponses, SmartListsControllerFindItemsData, SmartListsControllerFindItemsErrors, SmartListsControllerFindItemsResponses, SubscriptionsControllerCreateData, SubscriptionsControllerCreateErrors, SubscriptionsControllerCreateResponses, SubscriptionsControllerDeleteData, SubscriptionsControllerDeleteErrors, SubscriptionsControllerDeleteResponses, SubscriptionsControllerFindByIdData, SubscriptionsControllerFindByIdErrors, SubscriptionsControllerFindByIdResponses, SubscriptionsControllerFindData, SubscriptionsControllerFindErrors, SubscriptionsControllerFindResponses, SubscriptionsControllerUpdateData, SubscriptionsControllerUpdateErrors, SubscriptionsControllerUpdateResponses, TrackingControllerCollectData, TrackingControllerCollectErrors, TrackingControllerCollectResponses } from './types.gen';
3
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
+ /**
5
+ * You can provide a client instance returned by `createClient()` instead of
6
+ * individual options. This might be also useful if you want to implement a
7
+ * custom client.
8
+ */
9
+ client?: Client;
10
+ /**
11
+ * You can pass arbitrary values through the `meta` object. This can be
12
+ * used to access values that aren't defined as part of the SDK function.
13
+ */
14
+ meta?: Record<string, unknown>;
15
+ };
16
+ /**
17
+ * List all lists
18
+ *
19
+ * Returns all lists as a paginated response with optional sorting
20
+ */
21
+ export declare const listControllerFind: <ThrowOnError extends boolean = false>(options?: Options<ListControllerFindData, ThrowOnError>) => import("./client").RequestResult<ListControllerFindResponses, ListControllerFindErrors, ThrowOnError, "fields">;
22
+ /**
23
+ * Create a list
24
+ *
25
+ * Creates a new list, optionally with items
26
+ */
27
+ export declare const listControllerCreate: <ThrowOnError extends boolean = false>(options: Options<ListControllerCreateData, ThrowOnError>) => import("./client").RequestResult<ListControllerCreateResponses, ListControllerCreateErrors, ThrowOnError, "fields">;
28
+ /**
29
+ * Delete a list
30
+ *
31
+ * Deletes a list by its ID
32
+ */
33
+ export declare const listControllerDeleteById: <ThrowOnError extends boolean = false>(options: Options<ListControllerDeleteByIdData, ThrowOnError>) => import("./client").RequestResult<ListControllerDeleteByIdResponses, ListControllerDeleteByIdErrors, ThrowOnError, "fields">;
34
+ /**
35
+ * Get a list by ID
36
+ *
37
+ * Returns the list with its details
38
+ */
39
+ export declare const listControllerFindById: <ThrowOnError extends boolean = false>(options: Options<ListControllerFindByIdData, ThrowOnError>) => import("./client").RequestResult<ListControllerFindByIdResponses, ListControllerFindByIdErrors, ThrowOnError, "fields">;
40
+ /**
41
+ * Update a list
42
+ *
43
+ * Updates a list's name or access level
44
+ */
45
+ export declare const listControllerUpdateById: <ThrowOnError extends boolean = false>(options: Options<ListControllerUpdateByIdData, ThrowOnError>) => import("./client").RequestResult<ListControllerUpdateByIdResponses, ListControllerUpdateByIdErrors, ThrowOnError, "fields">;
46
+ /**
47
+ * Reorder list items
48
+ *
49
+ * Sets the order of items within a list
50
+ */
51
+ export declare const listControllerSetListItemsOrder: <ThrowOnError extends boolean = false>(options: Options<ListControllerSetListItemsOrderData, ThrowOnError>) => import("./client").RequestResult<ListControllerSetListItemsOrderResponses, ListControllerSetListItemsOrderErrors, ThrowOnError, "fields">;
52
+ /**
53
+ * Add items to a list
54
+ *
55
+ * Adds existing items to a list by their IDs
56
+ */
57
+ export declare const listControllerAddItemsToList: <ThrowOnError extends boolean = false>(options: Options<ListControllerAddItemsToListData, ThrowOnError>) => import("./client").RequestResult<ListControllerAddItemsToListResponses, ListControllerAddItemsToListErrors, ThrowOnError, "fields">;
58
+ /**
59
+ * Remove an item from a list
60
+ *
61
+ * Removes a specific item from a list without deleting the item itself
62
+ */
63
+ export declare const listControllerRemoveItemFromList: <ThrowOnError extends boolean = false>(options: Options<ListControllerRemoveItemFromListData, ThrowOnError>) => import("./client").RequestResult<ListControllerRemoveItemFromListResponses, ListControllerRemoveItemFromListErrors, ThrowOnError, "fields">;
64
+ /**
65
+ * Delete multiple items
66
+ *
67
+ * Deletes multiple items by their IDs
68
+ */
69
+ export declare const itemControllerDelete: <ThrowOnError extends boolean = false>(options: Options<ItemControllerDeleteData, ThrowOnError>) => import("./client").RequestResult<ItemControllerDeleteResponses, ItemControllerDeleteErrors, ThrowOnError, "fields">;
70
+ /**
71
+ * List all items
72
+ *
73
+ * Returns all items as a paginated response with optional filtering and sorting
74
+ */
75
+ export declare const itemControllerFind: <ThrowOnError extends boolean = false>(options?: Options<ItemControllerFindData, ThrowOnError>) => import("./client").RequestResult<ItemControllerFindResponses, ItemControllerFindErrors, ThrowOnError, "fields">;
76
+ /**
77
+ * Create an item
78
+ *
79
+ * Creates a new item (product save) for the authenticated profile
80
+ */
81
+ export declare const itemControllerCreate: <ThrowOnError extends boolean = false>(options: Options<ItemControllerCreateData, ThrowOnError>) => import("./client").RequestResult<ItemControllerCreateResponses, ItemControllerCreateErrors, ThrowOnError, "fields">;
82
+ /**
83
+ * Get item count
84
+ *
85
+ * Returns the total count of items for the authenticated profile
86
+ */
87
+ export declare const itemControllerCount: <ThrowOnError extends boolean = false>(options?: Options<ItemControllerCountData, ThrowOnError>) => import("./client").RequestResult<ItemControllerCountResponses, ItemControllerCountErrors, ThrowOnError, "fields">;
88
+ /**
89
+ * Delete an item
90
+ *
91
+ * Deletes a single item by its ID
92
+ */
93
+ export declare const itemControllerDeleteById: <ThrowOnError extends boolean = false>(options: Options<ItemControllerDeleteByIdData, ThrowOnError>) => import("./client").RequestResult<ItemControllerDeleteByIdResponses, ItemControllerDeleteByIdErrors, ThrowOnError, "fields">;
94
+ /**
95
+ * Get an item by ID
96
+ *
97
+ * Returns a single item with its list associations
98
+ */
99
+ export declare const itemControllerFindById: <ThrowOnError extends boolean = false>(options: Options<ItemControllerFindByIdData, ThrowOnError>) => import("./client").RequestResult<ItemControllerFindByIdResponses, ItemControllerFindByIdErrors, ThrowOnError, "fields">;
100
+ /**
101
+ * Update an item
102
+ *
103
+ * Updates an item by its ID
104
+ */
105
+ export declare const itemControllerUpdateById: <ThrowOnError extends boolean = false>(options: Options<ItemControllerUpdateByIdData, ThrowOnError>) => import("./client").RequestResult<ItemControllerUpdateByIdResponses, ItemControllerUpdateByIdErrors, ThrowOnError, "fields">;
106
+ /**
107
+ * Set item lists
108
+ *
109
+ * Sets which lists an item belongs to, replacing any previous list assignments
110
+ */
111
+ export declare const itemControllerSetListsById: <ThrowOnError extends boolean = false>(options: Options<ItemControllerSetListsByIdData, ThrowOnError>) => import("./client").RequestResult<ItemControllerSetListsByIdResponses, ItemControllerSetListsByIdErrors, ThrowOnError, "fields">;
112
+ /**
113
+ * Identify a profile
114
+ *
115
+ * Identifies a profile by email or phone number
116
+ */
117
+ export declare const profileControllerIdentify: <ThrowOnError extends boolean = false>(options: Options<ProfileControllerIdentifyData, ThrowOnError>) => import("./client").RequestResult<ProfileControllerIdentifyResponses, ProfileControllerIdentifyErrors, ThrowOnError, "fields">;
118
+ /**
119
+ * Create a profile token
120
+ *
121
+ * Creates a JWT token for a customer or session profile
122
+ */
123
+ export declare const profileControllerCreateToken: <ThrowOnError extends boolean = false>(options: Options<ProfileControllerCreateTokenData, ThrowOnError>) => import("./client").RequestResult<ProfileControllerCreateTokenResponses, ProfileControllerCreateTokenErrors, ThrowOnError, "fields">;
124
+ /**
125
+ * Get the current profile
126
+ *
127
+ * Returns the profile for the authenticated user
128
+ */
129
+ export declare const profileControllerGetProfile: <ThrowOnError extends boolean = false>(options?: Options<ProfileControllerGetProfileData, ThrowOnError>) => import("./client").RequestResult<ProfileControllerGetProfileResponses, ProfileControllerGetProfileErrors, ThrowOnError, "fields">;
130
+ /**
131
+ * Update the current profile
132
+ *
133
+ * Updates profile fields such as about text, notification preferences, and marketing consent
134
+ */
135
+ export declare const profileControllerUpdateProfile: <ThrowOnError extends boolean = false>(options: Options<ProfileControllerUpdateProfileData, ThrowOnError>) => import("./client").RequestResult<ProfileControllerUpdateProfileResponses, ProfileControllerUpdateProfileErrors, ThrowOnError, "fields">;
136
+ /**
137
+ * Get saved items analytics
138
+ *
139
+ * Returns analytics data for saved items over a time range
140
+ */
141
+ export declare const analyticsControllerLoadSavedItems: <ThrowOnError extends boolean = false>(options: Options<AnalyticsControllerLoadSavedItemsData, ThrowOnError>) => import("./client").RequestResult<AnalyticsControllerLoadSavedItemsResponses, AnalyticsControllerLoadSavedItemsErrors, ThrowOnError, "fields">;
142
+ /**
143
+ * Get sessions analytics
144
+ *
145
+ * Returns analytics data for sessions over a time range
146
+ */
147
+ export declare const analyticsControllerLoadSessions: <ThrowOnError extends boolean = false>(options: Options<AnalyticsControllerLoadSessionsData, ThrowOnError>) => import("./client").RequestResult<AnalyticsControllerLoadSessionsResponses, AnalyticsControllerLoadSessionsErrors, ThrowOnError, "fields">;
148
+ /**
149
+ * Get new lists analytics
150
+ *
151
+ * Returns analytics data for new lists created over a time range
152
+ */
153
+ export declare const analyticsControllerLoadNewLists: <ThrowOnError extends boolean = false>(options: Options<AnalyticsControllerLoadNewListsData, ThrowOnError>) => import("./client").RequestResult<AnalyticsControllerLoadNewListsResponses, AnalyticsControllerLoadNewListsErrors, ThrowOnError, "fields">;
154
+ /**
155
+ * Collect user behavior events
156
+ *
157
+ * Endpoint for collecting user behavior events.
158
+ */
159
+ export declare const trackingControllerCollect: <ThrowOnError extends boolean = false>(options: Options<TrackingControllerCollectData, ThrowOnError>) => import("./client").RequestResult<TrackingControllerCollectResponses, TrackingControllerCollectErrors, ThrowOnError, "fields">;
160
+ /**
161
+ * List all orders
162
+ *
163
+ * Returns all orders as a paginated response
164
+ */
165
+ export declare const ordersControllerFind: <ThrowOnError extends boolean = false>(options?: Options<OrdersControllerFindData, ThrowOnError>) => import("./client").RequestResult<OrdersControllerFindResponses, OrdersControllerFindErrors, ThrowOnError, "fields">;
166
+ /**
167
+ * Get an order by ID
168
+ *
169
+ * Returns order detail with line items and tracking information
170
+ */
171
+ export declare const ordersControllerFindOne: <ThrowOnError extends boolean = false>(options: Options<OrdersControllerFindOneData, ThrowOnError>) => import("./client").RequestResult<OrdersControllerFindOneResponses, OrdersControllerFindOneErrors, ThrowOnError, "fields">;
172
+ /**
173
+ * List all shared lists
174
+ *
175
+ * Returns all shared lists as a paginated response
176
+ */
177
+ export declare const sharedListsControllerFindAll: <ThrowOnError extends boolean = false>(options?: Options<SharedListsControllerFindAllData, ThrowOnError>) => import("./client").RequestResult<SharedListsControllerFindAllResponses, SharedListsControllerFindAllErrors, ThrowOnError, "fields">;
178
+ /**
179
+ * Save a shared list
180
+ *
181
+ * Saves a public list as a shared list for the authenticated profile
182
+ */
183
+ export declare const sharedListsControllerSave: <ThrowOnError extends boolean = false>(options: Options<SharedListsControllerSaveData, ThrowOnError>) => import("./client").RequestResult<SharedListsControllerSaveResponses, SharedListsControllerSaveErrors, ThrowOnError, "fields">;
184
+ /**
185
+ * Delete a shared list
186
+ *
187
+ * Removes a shared list entry without affecting the original list
188
+ */
189
+ export declare const sharedListsControllerDeleteById: <ThrowOnError extends boolean = false>(options: Options<SharedListsControllerDeleteByIdData, ThrowOnError>) => import("./client").RequestResult<SharedListsControllerDeleteByIdResponses, SharedListsControllerDeleteByIdErrors, ThrowOnError, "fields">;
190
+ /**
191
+ * Get a shared list by ID
192
+ *
193
+ * Returns the shared list with its details
194
+ */
195
+ export declare const sharedListsControllerFindById: <ThrowOnError extends boolean = false>(options: Options<SharedListsControllerFindByIdData, ThrowOnError>) => import("./client").RequestResult<SharedListsControllerFindByIdResponses, SharedListsControllerFindByIdErrors, ThrowOnError, "fields">;
196
+ /**
197
+ * Get shared list items
198
+ *
199
+ * Retrieves all items from a shared list as a paginated response.
200
+ */
201
+ export declare const sharedListsControllerFindItems: <ThrowOnError extends boolean = false>(options: Options<SharedListsControllerFindItemsData, ThrowOnError>) => import("./client").RequestResult<SharedListsControllerFindItemsResponses, SharedListsControllerFindItemsErrors, ThrowOnError, "fields">;
202
+ /**
203
+ * List notifications
204
+ *
205
+ * Returns notifications as a paginated response with optional filtering
206
+ */
207
+ export declare const notificationsControllerFind: <ThrowOnError extends boolean = false>(options?: Options<NotificationsControllerFindData, ThrowOnError>) => import("./client").RequestResult<NotificationsControllerFindResponses, NotificationsControllerFindErrors, ThrowOnError, "fields">;
208
+ /**
209
+ * Get unread notification count
210
+ *
211
+ * Returns the total count of unread notifications for the authenticated profile
212
+ */
213
+ export declare const notificationsControllerGetUnreadCount: <ThrowOnError extends boolean = false>(options?: Options<NotificationsControllerGetUnreadCountData, ThrowOnError>) => import("./client").RequestResult<NotificationsControllerGetUnreadCountResponses, NotificationsControllerGetUnreadCountErrors, ThrowOnError, "fields">;
214
+ /**
215
+ * Mark notifications as read
216
+ *
217
+ * Marks specified notifications as read by their IDs
218
+ */
219
+ export declare const notificationsControllerMarkAsRead: <ThrowOnError extends boolean = false>(options: Options<NotificationsControllerMarkAsReadData, ThrowOnError>) => import("./client").RequestResult<NotificationsControllerMarkAsReadResponses, NotificationsControllerMarkAsReadErrors, ThrowOnError, "fields">;
220
+ /**
221
+ * Mark all notifications as read
222
+ *
223
+ * Marks all notifications as read for the authenticated profile
224
+ */
225
+ export declare const notificationsControllerMarkAllAsRead: <ThrowOnError extends boolean = false>(options?: Options<NotificationsControllerMarkAllAsReadData, ThrowOnError>) => import("./client").RequestResult<NotificationsControllerMarkAllAsReadResponses, NotificationsControllerMarkAllAsReadErrors, ThrowOnError, "fields">;
226
+ /**
227
+ * Delete a notification
228
+ *
229
+ * Deletes a notification by its ID
230
+ */
231
+ export declare const notificationsControllerDeleteById: <ThrowOnError extends boolean = false>(options: Options<NotificationsControllerDeleteByIdData, ThrowOnError>) => import("./client").RequestResult<NotificationsControllerDeleteByIdResponses, NotificationsControllerDeleteByIdErrors, ThrowOnError, "fields">;
232
+ /**
233
+ * List all subscriptions
234
+ *
235
+ * Returns all subscriptions as a paginated response with optional filtering
236
+ */
237
+ export declare const subscriptionsControllerFind: <ThrowOnError extends boolean = false>(options?: Options<SubscriptionsControllerFindData, ThrowOnError>) => import("./client").RequestResult<SubscriptionsControllerFindResponses, SubscriptionsControllerFindErrors, ThrowOnError, "fields">;
238
+ /**
239
+ * Create a subscription
240
+ *
241
+ * Creates a new product subscription
242
+ */
243
+ export declare const subscriptionsControllerCreate: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsControllerCreateData, ThrowOnError>) => import("./client").RequestResult<SubscriptionsControllerCreateResponses, SubscriptionsControllerCreateErrors, ThrowOnError, "fields">;
244
+ /**
245
+ * Delete a subscription
246
+ *
247
+ * Deletes a subscription by its ID
248
+ */
249
+ export declare const subscriptionsControllerDelete: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsControllerDeleteData, ThrowOnError>) => import("./client").RequestResult<SubscriptionsControllerDeleteResponses, SubscriptionsControllerDeleteErrors, ThrowOnError, "fields">;
250
+ /**
251
+ * Get a subscription by ID
252
+ *
253
+ * Returns a single subscription by its ID
254
+ */
255
+ export declare const subscriptionsControllerFindById: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsControllerFindByIdData, ThrowOnError>) => import("./client").RequestResult<SubscriptionsControllerFindByIdResponses, SubscriptionsControllerFindByIdErrors, ThrowOnError, "fields">;
256
+ /**
257
+ * Update a subscription
258
+ *
259
+ * Updates a subscription's status or variant
260
+ */
261
+ export declare const subscriptionsControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<SubscriptionsControllerUpdateData, ThrowOnError>) => import("./client").RequestResult<SubscriptionsControllerUpdateResponses, SubscriptionsControllerUpdateErrors, ThrowOnError, "fields">;
262
+ /**
263
+ * Get all smart lists
264
+ *
265
+ * Returns all available smart lists with their details.
266
+ */
267
+ export declare const smartListsControllerFindAll: <ThrowOnError extends boolean = false>(options?: Options<SmartListsControllerFindAllData, ThrowOnError>) => import("./client").RequestResult<SmartListsControllerFindAllResponses, SmartListsControllerFindAllErrors, ThrowOnError, "fields">;
268
+ /**
269
+ * Get smart list by ID
270
+ *
271
+ * Returns a specific smart list with its details.
272
+ */
273
+ export declare const smartListsControllerFindById: <ThrowOnError extends boolean = false>(options: Options<SmartListsControllerFindByIdData, ThrowOnError>) => import("./client").RequestResult<SmartListsControllerFindByIdResponses, SmartListsControllerFindByIdErrors, ThrowOnError, "fields">;
274
+ /**
275
+ * Get smart list items
276
+ *
277
+ * Returns items for a specific smart list as a paginated response.
278
+ */
279
+ export declare const smartListsControllerFindItems: <ThrowOnError extends boolean = false>(options: Options<SmartListsControllerFindItemsData, ThrowOnError>) => import("./client").RequestResult<SmartListsControllerFindItemsResponses, SmartListsControllerFindItemsErrors, ThrowOnError, "fields">;