@wix/workflows 1.0.31 → 1.0.32

package/type-bundles/index.bundle.d.ts

@@ -1,3 +1,481 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> =
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]-?:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
+	// Discard this key since the condition fails.
+		: never;
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base];
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
 interface Card$2 {
     /** Card details. */
     info?: CardInfo$2;
@@ -16,7 +494,7 @@ interface CardInfo$2 {
     /** Details about the contact attached to the card. */
     primaryAttachment?: Attachment$2;
     /** Due date. */
-    dueDate?: Date;
+    dueDate?: Date | null;
     /** Name of the app or service that created the contact. */
     source?: string | null;
     /**
@@ -25,14 +503,14 @@ interface CardInfo$2 {
      * @readonly
      * @deprecated
      */
-    createdAt?: Date;
+    createdAt?: Date | null;
     /**
      * @internal
      * @internal
      * @readonly
      * @deprecated
      */
-    updatedAt?: Date;
+    updatedAt?: Date | null;
     /**
      * ID of the phase that currently holds the card.
      * @readonly
@@ -42,12 +520,12 @@ interface CardInfo$2 {
      * Date and time the card was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date and time the card was updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
 }
 interface Attachment$2 {
     /**
@@ -274,7 +752,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** ID of the entity associated with the event. */
     entityId?: string;
     /** Event timestamp. */
-    eventTime?: Date;
+    eventTime?: Date | null;
     /**
      * Whether the event was triggered as a result of a privacy regulation application
      * (for example, GDPR).
@@ -357,34 +835,30 @@ declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+interface AttachmentNonNullableFields$2 {
+    attachmentId: string;
+    value: string;
+    attachmentType: AttachmentType$2;
+    contactId: string;
+}
+interface CardInfoNonNullableFields$2 {
+    primaryAttachment?: AttachmentNonNullableFields$2;
+}
+interface CardNonNullableFields$2 {
+    info?: CardInfoNonNullableFields$2;
+}
+interface PaginationResponseNonNullableFields$2 {
+    offset: number;
+    limit: number;
+    total: number;
+    count: number;
+}
 interface ListCardsResponseNonNullableFields {
-    cards: {
-        info?: {
-            primaryAttachment?: {
-                attachmentId: string;
-                value: string;
-                attachmentType: AttachmentType$2;
-                contactId: string;
-            };
-        };
-    }[];
-    pagination?: {
-        offset: number;
-        total: number;
-        count: number;
-    };
+    cards: CardNonNullableFields$2[];
+    pagination?: PaginationResponseNonNullableFields$2;
 }
 interface GetCardResponseNonNullableFields {
-    card?: {
-        info?: {
-            primaryAttachment?: {
-                attachmentId: string;
-                value: string;
-                attachmentType: AttachmentType$2;
-                contactId: string;
-            };
-        };
-    };
+    card?: CardNonNullableFields$2;
 }
 interface ListCardsOptions {
     /** Filters for cards in the specified phase. */
@@ -457,57 +931,167 @@ interface RestoreCardOptions {
     newPosition?: number | null;
 }
 
-interface HttpClient$2 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$2<TResponse, TData>): Promise<HttpResponse$2<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+declare function listCards$1(httpClient: HttpClient): ListCardsSignature;
+interface ListCardsSignature {
+    /**
+     * Retrieves a list of a workflow's cards.
+     *
+     *
+     * The `listCards()` function returns a Promise that resolves to a list of the specified workflow's cards.
+     *
+     *
+     * Use the `options` parameter to specify which cards to retrieve and in which order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`.
+     *
+     *
+     * Cards can be sorted based on their `"id"`, `"name"`, `"phaseId"`, `"createdDate"`, `"updatedDate"`, `"source"`, and `"position"`.
+     *
+     *
+     * If no `limit` parameter is passed, the first 50 cards are returned.
+     *
+     *
+     * Sort order defaults to by `"phaseId"` and then by `"position"` ascending.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the workflow whose cards will be listed.
+     * @param - Options to use when retrieving the list of cards.
+     */
+    (workflowId: string, options?: ListCardsOptions | undefined): Promise<ListCardsResponse & ListCardsResponseNonNullableFields>;
 }
-type RequestOptionsFactory$2<TResponse = any, TData = any> = (context: any) => RequestOptions$2<TResponse, TData>;
-type HttpResponse$2<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions$2<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata$2;
-type APIMetadata$2 = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getCard$1(httpClient: HttpClient): GetCardSignature;
+interface GetCardSignature {
+    /**
+     * Retrieves a workflow card by ID.
+     *
+     *
+     * The `getCard()` function returns a Promise that resolves to the card with the specified ID.
+     *
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the card to retrieve.
+     * @returns Requested card.
+     */
+    (_id: string): Promise<Card$2 & CardNonNullableFields$2>;
+}
+declare function updateCard$1(httpClient: HttpClient): UpdateCardSignature;
+interface UpdateCardSignature {
+    /**
+     * Updates an existing workflow card.
+     *
+     *
+     * The `updateCard()` function returns a Promise that resolves when the card has been updated with the specified values.
+     *
+     *
+     * `contactId` is not a required field, but if the parameter is not passed, the field will default to empty and the card will not be associated with any contact.
+     *
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the card to update.
+     * @param - Card details.
+     * @param - Options to use when updating a card.
+     */
+    (_id: string, cardInfo: CardInfo$2): Promise<void>;
+}
+declare function createCard$1(httpClient: HttpClient): CreateCardSignature;
+interface CreateCardSignature {
+    /**
+     * Creates a new workflow card.
+     *
+     *
+     * The `createCard()` function returns a Promise that resolves to the created card's ID when the card is created in the specified workflow phase.
+     *
+     * Pass a value for the `position` parameter to specify the newly created card's position within the specified phase. Positions are zero-based, meaning the first position is `0`.
+     *
+     * When omitted, the newly created card is added to the specified phase as the top card within the phase.
+     *
+     *
+     * This function requires you to specify the ID of a workflow and phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     *
+     *  > **Note:**
+     *  > Each workflow is limited to 5,000 cards.
+     *  > If this limit is reached, `createCard()` throws an error.
+     *  > [Archive cards](#archivecard) when they're no longer needed
+     *  > to reduce card count and avoid hitting the limit.
+     * @param - Card details.
+     * @param - Options to use when creating a card.
+     */
+    (identifiers: CreateCardIdentifiers, card: CardInfo$2, options?: CreateCardOptions | undefined): Promise<CreateCardResponse>;
+}
+declare function deleteCard$1(httpClient: HttpClient): DeleteCardSignature;
+interface DeleteCardSignature {
+    /**
+     * Deletes a workflow card by ID.
+     *
+     *
+     * The `deleteCard()` function returns a Promise when the specified card has been deleted.
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the card to delete.
+     */
+    (_id: string): Promise<void>;
+}
+declare function moveCard$1(httpClient: HttpClient): MoveCardSignature;
+interface MoveCardSignature {
+    /**
+     * Moves a card to a new position within a workflow.
+     *
+     *
+     * The `moveCard()` function returns a Promise when the specified card has been moved to the new position.
+     *
+     * Use the `options` parameter to specify the phase and position within that phase to move the card to. Positions are zero-based, meaning the first position is `0`.
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the card to move.
+     * @param - Information about where to move the card.
+     */
+    (_id: string, options?: MoveCardOptions | undefined): Promise<void>;
+}
+declare function restoreCard$1(httpClient: HttpClient): RestoreCardSignature;
+interface RestoreCardSignature {
+    /**
+     * Restores an archived workflow card.
+     *
+     *
+     * The `restoreCard()` function returns a Promise that resolves when the archived card has been restored.
+     *
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     *
+     *
+     * > **Note:**
+     * > Each workflow is limited to 5,000 cards.
+     * > If this limit is reached, `createCard()` throws an error.
+     * > [Archive cards](#archivecard) when they're no longer needed
+     * > to reduce card count and avoid hitting the limit.
+     * @param - ID of the card to restore.
+     * @param - ID of the phase to restore the card to.
+     * @param - Options to use when restoring a card.
+     */
+    (_id: string, newPhaseId: string, options?: RestoreCardOptions | undefined): Promise<void>;
+}
+declare function archiveCard$1(httpClient: HttpClient): ArchiveCardSignature;
+interface ArchiveCardSignature {
+    /**
+     * Archives a workflow card.
+     *
+     *
+     * The `archiveCard()` function returns a Promise that resolves when the card has been archived.
+     *
+     *
+     * This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the card to archive.
+     */
+    (_id: string): Promise<void>;
 }
 
-declare const __metadata$2: {
-    PACKAGE_NAME: string;
-};
-declare function listCards(httpClient: HttpClient$2): (workflowId: string, options?: ListCardsOptions) => Promise<ListCardsResponse & ListCardsResponseNonNullableFields>;
-declare function getCard(httpClient: HttpClient$2): (_id: string) => Promise<Card$2 & {
-    info?: {
-        primaryAttachment?: {
-            attachmentId: string;
-            value: string;
-            attachmentType: AttachmentType$2;
-            contactId: string;
-        } | undefined;
-    } | undefined;
-}>;
-declare function updateCard(httpClient: HttpClient$2): (_id: string, cardInfo: CardInfo$2) => Promise<void>;
-declare function createCard(httpClient: HttpClient$2): (identifiers: CreateCardIdentifiers, card: CardInfo$2, options?: CreateCardOptions) => Promise<CreateCardResponse>;
-declare function deleteCard(httpClient: HttpClient$2): (_id: string) => Promise<void>;
-declare function moveCard(httpClient: HttpClient$2): (_id: string, options?: MoveCardOptions) => Promise<void>;
-declare function restoreCard(httpClient: HttpClient$2): (_id: string, newPhaseId: string, options?: RestoreCardOptions) => Promise<void>;
-declare function archiveCard(httpClient: HttpClient$2): (_id: string) => Promise<void>;
+declare const listCards: MaybeContext<BuildRESTFunction<typeof listCards$1> & typeof listCards$1>;
+declare const getCard: MaybeContext<BuildRESTFunction<typeof getCard$1> & typeof getCard$1>;
+declare const updateCard: MaybeContext<BuildRESTFunction<typeof updateCard$1> & typeof updateCard$1>;
+declare const createCard: MaybeContext<BuildRESTFunction<typeof createCard$1> & typeof createCard$1>;
+declare const deleteCard: MaybeContext<BuildRESTFunction<typeof deleteCard$1> & typeof deleteCard$1>;
+declare const moveCard: MaybeContext<BuildRESTFunction<typeof moveCard$1> & typeof moveCard$1>;
+declare const restoreCard: MaybeContext<BuildRESTFunction<typeof restoreCard$1> & typeof restoreCard$1>;
+declare const archiveCard: MaybeContext<BuildRESTFunction<typeof archiveCard$1> & typeof archiveCard$1>;
 
 type index_d$2_ActionEvent = ActionEvent;
 type index_d$2_ArchiveCardRequest = ArchiveCardRequest;
@@ -554,7 +1138,7 @@ declare const index_d$2_moveCard: typeof moveCard;
 declare const index_d$2_restoreCard: typeof restoreCard;
 declare const index_d$2_updateCard: typeof updateCard;
 declare namespace index_d$2 {
-  export { type index_d$2_ActionEvent as ActionEvent, type index_d$2_ArchiveCardRequest as ArchiveCardRequest, type index_d$2_ArchiveCardResponse as ArchiveCardResponse, type Attachment$2 as Attachment, AttachmentType$2 as AttachmentType, type Card$2 as Card, type CardInfo$2 as CardInfo, type index_d$2_CreateCardIdentifiers as CreateCardIdentifiers, type index_d$2_CreateCardOptions as CreateCardOptions, type index_d$2_CreateCardRequest as CreateCardRequest, type index_d$2_CreateCardResponse as CreateCardResponse, type index_d$2_DeleteCardRequest as DeleteCardRequest, type index_d$2_DeleteCardResponse as DeleteCardResponse, type index_d$2_DomainEvent as DomainEvent, type index_d$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d$2_EntityCreatedEvent as EntityCreatedEvent, type index_d$2_EntityDeletedEvent as EntityDeletedEvent, type index_d$2_EntityUpdatedEvent as EntityUpdatedEvent, type index_d$2_GetCardRequest as GetCardRequest, type index_d$2_GetCardResponse as GetCardResponse, type index_d$2_GetCardResponseNonNullableFields as GetCardResponseNonNullableFields, type index_d$2_IdentificationData as IdentificationData, type index_d$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d$2_ListCardsOptions as ListCardsOptions, type index_d$2_ListCardsRequest as ListCardsRequest, type index_d$2_ListCardsResponse as ListCardsResponse, type index_d$2_ListCardsResponseNonNullableFields as ListCardsResponseNonNullableFields, type index_d$2_MessageEnvelope as MessageEnvelope, type index_d$2_MoveCardOptions as MoveCardOptions, type index_d$2_MoveCardRequest as MoveCardRequest, type index_d$2_MoveCardResponse as MoveCardResponse, type PaginationResponse$2 as PaginationResponse, type Paging$2 as Paging, type Query$2 as Query, type index_d$2_QueryCardsRequest as QueryCardsRequest, type index_d$2_QueryCardsResponse as QueryCardsResponse, type index_d$2_RestoreCardOptions as RestoreCardOptions, type index_d$2_RestoreCardRequest as RestoreCardRequest, type index_d$2_RestoreCardResponse as RestoreCardResponse, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$2_UpdateCardRequest as UpdateCardRequest, type index_d$2_UpdateCardResponse as UpdateCardResponse, index_d$2_WebhookIdentityType as WebhookIdentityType, __metadata$2 as __metadata, index_d$2_archiveCard as archiveCard, index_d$2_createCard as createCard, index_d$2_deleteCard as deleteCard, index_d$2_getCard as getCard, index_d$2_listCards as listCards, index_d$2_moveCard as moveCard, index_d$2_restoreCard as restoreCard, index_d$2_updateCard as updateCard };
+  export { type index_d$2_ActionEvent as ActionEvent, type index_d$2_ArchiveCardRequest as ArchiveCardRequest, type index_d$2_ArchiveCardResponse as ArchiveCardResponse, type Attachment$2 as Attachment, AttachmentType$2 as AttachmentType, type Card$2 as Card, type CardInfo$2 as CardInfo, type CardNonNullableFields$2 as CardNonNullableFields, type index_d$2_CreateCardIdentifiers as CreateCardIdentifiers, type index_d$2_CreateCardOptions as CreateCardOptions, type index_d$2_CreateCardRequest as CreateCardRequest, type index_d$2_CreateCardResponse as CreateCardResponse, type index_d$2_DeleteCardRequest as DeleteCardRequest, type index_d$2_DeleteCardResponse as DeleteCardResponse, type index_d$2_DomainEvent as DomainEvent, type index_d$2_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d$2_EntityCreatedEvent as EntityCreatedEvent, type index_d$2_EntityDeletedEvent as EntityDeletedEvent, type index_d$2_EntityUpdatedEvent as EntityUpdatedEvent, type index_d$2_GetCardRequest as GetCardRequest, type index_d$2_GetCardResponse as GetCardResponse, type index_d$2_GetCardResponseNonNullableFields as GetCardResponseNonNullableFields, type index_d$2_IdentificationData as IdentificationData, type index_d$2_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d$2_ListCardsOptions as ListCardsOptions, type index_d$2_ListCardsRequest as ListCardsRequest, type index_d$2_ListCardsResponse as ListCardsResponse, type index_d$2_ListCardsResponseNonNullableFields as ListCardsResponseNonNullableFields, type index_d$2_MessageEnvelope as MessageEnvelope, type index_d$2_MoveCardOptions as MoveCardOptions, type index_d$2_MoveCardRequest as MoveCardRequest, type index_d$2_MoveCardResponse as MoveCardResponse, type PaginationResponse$2 as PaginationResponse, type Paging$2 as Paging, type Query$2 as Query, type index_d$2_QueryCardsRequest as QueryCardsRequest, type index_d$2_QueryCardsResponse as QueryCardsResponse, type index_d$2_RestoreCardOptions as RestoreCardOptions, type index_d$2_RestoreCardRequest as RestoreCardRequest, type index_d$2_RestoreCardResponse as RestoreCardResponse, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$2_UpdateCardRequest as UpdateCardRequest, type index_d$2_UpdateCardResponse as UpdateCardResponse, index_d$2_WebhookIdentityType as WebhookIdentityType, index_d$2_archiveCard as archiveCard, index_d$2_createCard as createCard, index_d$2_deleteCard as deleteCard, index_d$2_getCard as getCard, index_d$2_listCards as listCards, index_d$2_moveCard as moveCard, index_d$2_restoreCard as restoreCard, index_d$2_updateCard as updateCard };
 }
 
 interface Phase$1 {
@@ -600,7 +1184,7 @@ interface CardInfo$1 {
     /** Details about the contact attached to the card. */
     primaryAttachment?: Attachment$1;
     /** Due date. */
-    dueDate?: Date;
+    dueDate?: Date | null;
     /** Name of the app or service that created the contact. */
     source?: string | null;
     /**
@@ -609,14 +1193,14 @@ interface CardInfo$1 {
      * @readonly
      * @deprecated
      */
-    createdAt?: Date;
+    createdAt?: Date | null;
     /**
      * @internal
      * @internal
      * @readonly
      * @deprecated
      */
-    updatedAt?: Date;
+    updatedAt?: Date | null;
     /**
      * ID of the phase that currently holds the card.
      * @readonly
@@ -626,12 +1210,12 @@ interface CardInfo$1 {
      * Date and time the card was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date and time the card was updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
 }
 interface Attachment$1 {
     /**
@@ -803,44 +1387,37 @@ interface MovePhaseRequest {
 }
 interface MovePhaseResponse {
 }
+interface AttachmentNonNullableFields$1 {
+    attachmentId: string;
+    value: string;
+    attachmentType: AttachmentType$1;
+    contactId: string;
+}
+interface CardInfoNonNullableFields$1 {
+    primaryAttachment?: AttachmentNonNullableFields$1;
+}
+interface CardNonNullableFields$1 {
+    info?: CardInfoNonNullableFields$1;
+}
+interface CardsListNonNullableFields$1 {
+    total: number;
+    cards: CardNonNullableFields$1[];
+}
+interface PhaseNonNullableFields$1 {
+    cardsList?: CardsListNonNullableFields$1;
+}
+interface PaginationResponseNonNullableFields$1 {
+    offset: number;
+    limit: number;
+    total: number;
+    count: number;
+}
 interface ListPhasesResponseNonNullableFields {
-    phases: {
-        cardsList?: {
-            total: number;
-            cards: {
-                info?: {
-                    primaryAttachment?: {
-                        attachmentId: string;
-                        value: string;
-                        attachmentType: AttachmentType$1;
-                        contactId: string;
-                    };
-                };
-            }[];
-        };
-    }[];
-    pagination?: {
-        offset: number;
-        total: number;
-        count: number;
-    };
+    phases: PhaseNonNullableFields$1[];
+    pagination?: PaginationResponseNonNullableFields$1;
 }
 interface GetPhaseResponseNonNullableFields {
-    phase?: {
-        cardsList?: {
-            total: number;
-            cards: {
-                info?: {
-                    primaryAttachment?: {
-                        attachmentId: string;
-                        value: string;
-                        attachmentType: AttachmentType$1;
-                        contactId: string;
-                    };
-                };
-            }[];
-        };
-    };
+    phase?: PhaseNonNullableFields$1;
 }
 interface ListPhasesOptions {
     /** Number of items to return. */
@@ -884,60 +1461,121 @@ interface MovePhaseIdentifiers {
     _id: string;
 }
 
-interface HttpClient$1 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+declare function listPhases$1(httpClient: HttpClient): ListPhasesSignature;
+interface ListPhasesSignature {
+    /**
+     * Retrieves a list of a workflow's phases.
+     *
+     *
+     * The `listPhases()` function returns a Promise that resolves to a list containing information about the specified workflow's phases.
+     *
+     *
+     * Use the `options` parameter to specify which phases to retrieve and in which order to retrieve them. Phases can be sorted based on their `"id"`, `"name"`, and `"position"`. If no `limit` parameter is passed, the first 50 cards are returned. Sort order defaults to by `"position"` ascending.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the workflow whose phases will be listed.
+     * @param - Options to use when retrieving the list of workflow phases.
+     */
+    (workflowId: string, options?: ListPhasesOptions | undefined): Promise<ListPhasesResponse & ListPhasesResponseNonNullableFields>;
 }
-type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
-type HttpResponse$1<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions$1<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata$1;
-type APIMetadata$1 = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getPhase$1(httpClient: HttpClient): GetPhaseSignature;
+interface GetPhaseSignature {
+    /**
+     * Retrieves a phase by ID.
+     *
+     *
+     * The `getPhase()` function returns a Promise that resolves to the phase with the specified ID.
+     *
+     * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the phase to retrieve.
+     * @returns Requested phase.
+     */
+    (_id: string): Promise<Phase$1 & PhaseNonNullableFields$1>;
+}
+declare function updatePhase$1(httpClient: HttpClient): UpdatePhaseSignature;
+interface UpdatePhaseSignature {
+    /**
+     * Updates an existing workflow phase.
+     *
+     *
+     * The `updatePhase()` function returns a Promise that resolves when the phase has been updated with the specified values.
+     *
+     *
+     * Only the properties passed in the `phase` object will be updated. All other properties will remain the same.
+     *
+     *
+     * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the phase to update.
+     * @param - Phase details to update.
+     * @param - Phase information to update.
+     */
+    (_id: string, phase: PhaseInfo$1): Promise<void>;
+}
+declare function createPhase$1(httpClient: HttpClient): CreatePhaseSignature;
+interface CreatePhaseSignature {
+    /**
+     * Creates a new workflow phase.
+     *
+     *
+     * The `createPhase()` function returns a Promise that resolves to the created phase ID when the phase is created in the specified workflow.
+     *
+     *
+     * Pass a value for the `position` parameter to specify the newly created phase's position within the specified workflow. Positions are zero-based, meaning the first position is `0`.
+     *
+     *
+     * When omitted, the newly created phase is added as the last non-win phase.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the workflow to create the phase in.
+     * @param - Phase details.
+     * @param - Options to use when creating workflow phases.
+     */
+    (workflowId: string, phase: PhaseInfo$1, options?: CreatePhaseOptions | undefined): Promise<CreatePhaseResponse>;
+}
+declare function deletePhase$1(httpClient: HttpClient): DeletePhaseSignature;
+interface DeletePhaseSignature {
+    /**
+     * Deletes a workflow phase.
+     *
+     *
+     * The `deletePhase()` function returns a Promise when the specified phase has been deleted.
+     *
+     *
+     * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the phase to delete.
+     */
+    (_id: string): Promise<void>;
+}
+declare function movePhase$1(httpClient: HttpClient): MovePhaseSignature;
+interface MovePhaseSignature {
+    /**
+     * Moves a phase to a new position with a workflow.
+     *
+     *
+     * The `movePhase()` function returns a Promise when the specified phase has been moved to the new position.
+     *
+     *
+     * Use the `newPosition` parameter to specify the new phase position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot be moved. Positions are zero-based, meaning the first position is `0`.
+     *
+     *
+     * This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - New phase position, where the first phase is `0`.
+     *
+     * If a phase already occupies the specified position,
+     * that phase and any subsequent phases
+     * are shifted to the right by 1.
+     */
+    (identifiers: MovePhaseIdentifiers, newPosition: number | null): Promise<void>;
 }
 
-declare const __metadata$1: {
-    PACKAGE_NAME: string;
-};
-declare function listPhases(httpClient: HttpClient$1): (workflowId: string, options?: ListPhasesOptions) => Promise<ListPhasesResponse & ListPhasesResponseNonNullableFields>;
-declare function getPhase(httpClient: HttpClient$1): (_id: string) => Promise<Phase$1 & {
-    cardsList?: {
-        total: number;
-        cards: {
-            info?: {
-                primaryAttachment?: {
-                    attachmentId: string;
-                    value: string;
-                    attachmentType: AttachmentType$1;
-                    contactId: string;
-                } | undefined;
-            } | undefined;
-        }[];
-    } | undefined;
-}>;
-declare function updatePhase(httpClient: HttpClient$1): (_id: string, phase: PhaseInfo$1) => Promise<void>;
-declare function createPhase(httpClient: HttpClient$1): (workflowId: string, phase: PhaseInfo$1, options?: CreatePhaseOptions) => Promise<CreatePhaseResponse>;
-declare function deletePhase(httpClient: HttpClient$1): (_id: string) => Promise<void>;
-declare function movePhase(httpClient: HttpClient$1): (identifiers: MovePhaseIdentifiers, newPosition: number | null) => Promise<void>;
+declare const listPhases: MaybeContext<BuildRESTFunction<typeof listPhases$1> & typeof listPhases$1>;
+declare const getPhase: MaybeContext<BuildRESTFunction<typeof getPhase$1> & typeof getPhase$1>;
+declare const updatePhase: MaybeContext<BuildRESTFunction<typeof updatePhase$1> & typeof updatePhase$1>;
+declare const createPhase: MaybeContext<BuildRESTFunction<typeof createPhase$1> & typeof createPhase$1>;
+declare const deletePhase: MaybeContext<BuildRESTFunction<typeof deletePhase$1> & typeof deletePhase$1>;
+declare const movePhase: MaybeContext<BuildRESTFunction<typeof movePhase$1> & typeof movePhase$1>;
 
 type index_d$1_CreatePhaseOptions = CreatePhaseOptions;
 type index_d$1_CreatePhaseRequest = CreatePhaseRequest;
@@ -965,7 +1603,7 @@ declare const index_d$1_listPhases: typeof listPhases;
 declare const index_d$1_movePhase: typeof movePhase;
 declare const index_d$1_updatePhase: typeof updatePhase;
 declare namespace index_d$1 {
-  export { type Attachment$1 as Attachment, AttachmentType$1 as AttachmentType, type Card$1 as Card, type CardInfo$1 as CardInfo, type CardsList$1 as CardsList, type index_d$1_CreatePhaseOptions as CreatePhaseOptions, type index_d$1_CreatePhaseRequest as CreatePhaseRequest, type index_d$1_CreatePhaseResponse as CreatePhaseResponse, type index_d$1_DeletePhaseRequest as DeletePhaseRequest, type index_d$1_DeletePhaseResponse as DeletePhaseResponse, type index_d$1_GetPhaseRequest as GetPhaseRequest, type index_d$1_GetPhaseResponse as GetPhaseResponse, type index_d$1_GetPhaseResponseNonNullableFields as GetPhaseResponseNonNullableFields, type index_d$1_ListPhasesOptions as ListPhasesOptions, type index_d$1_ListPhasesRequest as ListPhasesRequest, type index_d$1_ListPhasesResponse as ListPhasesResponse, type index_d$1_ListPhasesResponseNonNullableFields as ListPhasesResponseNonNullableFields, type index_d$1_MovePhaseIdentifiers as MovePhaseIdentifiers, type index_d$1_MovePhaseRequest as MovePhaseRequest, type index_d$1_MovePhaseResponse as MovePhaseResponse, type PaginationResponse$1 as PaginationResponse, type Paging$1 as Paging, type Phase$1 as Phase, type PhaseInfo$1 as PhaseInfo, type Query$1 as Query, type index_d$1_QueryPhasesRequest as QueryPhasesRequest, type index_d$1_QueryPhasesResponse as QueryPhasesResponse, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, type index_d$1_UpdatePhaseRequest as UpdatePhaseRequest, type index_d$1_UpdatePhaseResponse as UpdatePhaseResponse, __metadata$1 as __metadata, index_d$1_createPhase as createPhase, index_d$1_deletePhase as deletePhase, index_d$1_getPhase as getPhase, index_d$1_listPhases as listPhases, index_d$1_movePhase as movePhase, index_d$1_updatePhase as updatePhase };
+  export { type Attachment$1 as Attachment, AttachmentType$1 as AttachmentType, type Card$1 as Card, type CardInfo$1 as CardInfo, type CardsList$1 as CardsList, type index_d$1_CreatePhaseOptions as CreatePhaseOptions, type index_d$1_CreatePhaseRequest as CreatePhaseRequest, type index_d$1_CreatePhaseResponse as CreatePhaseResponse, type index_d$1_DeletePhaseRequest as DeletePhaseRequest, type index_d$1_DeletePhaseResponse as DeletePhaseResponse, type index_d$1_GetPhaseRequest as GetPhaseRequest, type index_d$1_GetPhaseResponse as GetPhaseResponse, type index_d$1_GetPhaseResponseNonNullableFields as GetPhaseResponseNonNullableFields, type index_d$1_ListPhasesOptions as ListPhasesOptions, type index_d$1_ListPhasesRequest as ListPhasesRequest, type index_d$1_ListPhasesResponse as ListPhasesResponse, type index_d$1_ListPhasesResponseNonNullableFields as ListPhasesResponseNonNullableFields, type index_d$1_MovePhaseIdentifiers as MovePhaseIdentifiers, type index_d$1_MovePhaseRequest as MovePhaseRequest, type index_d$1_MovePhaseResponse as MovePhaseResponse, type PaginationResponse$1 as PaginationResponse, type Paging$1 as Paging, type Phase$1 as Phase, type PhaseInfo$1 as PhaseInfo, type PhaseNonNullableFields$1 as PhaseNonNullableFields, type Query$1 as Query, type index_d$1_QueryPhasesRequest as QueryPhasesRequest, type index_d$1_QueryPhasesResponse as QueryPhasesResponse, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, type index_d$1_UpdatePhaseRequest as UpdatePhaseRequest, type index_d$1_UpdatePhaseResponse as UpdatePhaseResponse, index_d$1_createPhase as createPhase, index_d$1_deletePhase as deletePhase, index_d$1_getPhase as getPhase, index_d$1_listPhases as listPhases, index_d$1_movePhase as movePhase, index_d$1_updatePhase as updatePhase };
 }
 
 interface Workflow {
@@ -1002,7 +1640,7 @@ interface WorkflowInfo {
      * @readonly
      * @deprecated
      */
-    createdAt?: Date;
+    createdAt?: Date | null;
     /**
      * Indicates whether the workflow can be deleted.
      * @readonly
@@ -1013,7 +1651,7 @@ interface WorkflowInfo {
      * Date and time the workflow was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
 }
 interface Phase {
     /** Phase information. */
@@ -1058,7 +1696,7 @@ interface CardInfo {
     /** Details about the contact attached to the card. */
     primaryAttachment?: Attachment;
     /** Due date. */
-    dueDate?: Date;
+    dueDate?: Date | null;
     /** Name of the app or service that created the contact. */
     source?: string | null;
     /**
@@ -1067,14 +1705,14 @@ interface CardInfo {
      * @readonly
      * @deprecated
      */
-    createdAt?: Date;
+    createdAt?: Date | null;
     /**
      * @internal
      * @internal
      * @readonly
      * @deprecated
      */
-    updatedAt?: Date;
+    updatedAt?: Date | null;
     /**
      * ID of the phase that currently holds the card.
      * @readonly
@@ -1084,12 +1722,12 @@ interface CardInfo {
      * Date and time the card was created.
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date and time the card was updated.
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
 }
 interface Attachment {
     /**
@@ -1254,50 +1892,44 @@ interface SetupWorkflowRequest {
 }
 interface SetupWorkflowResponse {
 }
+interface PaginationResponseNonNullableFields {
+    offset: number;
+    limit: number;
+    total: number;
+    count: number;
+}
 interface ListWorkflowsResponseNonNullableFields {
-    workflows: WorkflowInfo[];
-    pagination?: {
-        offset: number;
-        total: number;
-        count: number;
-    };
+    pagination?: PaginationResponseNonNullableFields;
+}
+interface AttachmentNonNullableFields {
+    attachmentId: string;
+    value: string;
+    attachmentType: AttachmentType;
+    contactId: string;
+}
+interface CardInfoNonNullableFields {
+    primaryAttachment?: AttachmentNonNullableFields;
+}
+interface CardNonNullableFields {
+    info?: CardInfoNonNullableFields;
+}
+interface CardsListNonNullableFields {
+    total: number;
+    cards: CardNonNullableFields[];
+}
+interface PhaseNonNullableFields {
+    cardsList?: CardsListNonNullableFields;
+}
+interface PhasesListNonNullableFields {
+    total: number;
+    phases: PhaseNonNullableFields[];
+}
+interface WorkflowNonNullableFields {
+    winPhase?: PhaseNonNullableFields;
+    phasesList?: PhasesListNonNullableFields;
 }
 interface GetWorkflowResponseNonNullableFields {
-    workflow?: {
-        winPhase?: {
-            cardsList?: {
-                total: number;
-                cards: {
-                    info?: {
-                        primaryAttachment?: {
-                            attachmentId: string;
-                            value: string;
-                            attachmentType: AttachmentType;
-                            contactId: string;
-                        };
-                    };
-                }[];
-            };
-        };
-        phasesList?: {
-            total: number;
-            phases: {
-                cardsList?: {
-                    total: number;
-                    cards: {
-                        info?: {
-                            primaryAttachment?: {
-                                attachmentId: string;
-                                value: string;
-                                attachmentType: AttachmentType;
-                                contactId: string;
-                            };
-                        };
-                    }[];
-                };
-            }[];
-        };
-    };
+    workflow?: WorkflowNonNullableFields;
 }
 interface ListWorkflowsOptions {
     /**
@@ -1325,79 +1957,94 @@ interface ListWorkflowsOptions {
     sort?: string[];
 }
 
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
+declare function listWorkflows$1(httpClient: HttpClient): ListWorkflowsSignature;
+interface ListWorkflowsSignature {
+    /**
+     * Retrieves a list of the site's workflows info.
+     *
+     *
+     * The `listWorkflows()` function returns a Promise that resolves to a list containing information about the site's workflows.
+     *
+     *
+     * Use the `options` parameter to specify which workflows to retrieve and in which order to retrieve them. Workflows can be sorted based on their `"name"`.
+     *
+     *
+     * If no `limit` parameter is passed, the first 100 workflows are returned. Sort order defaults to by `"name"` ascending.
+     * @param - Options to use when retrieving a list of workflows.
+     */
+    (options?: ListWorkflowsOptions | undefined): Promise<ListWorkflowsResponse & ListWorkflowsResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getWorkflow$1(httpClient: HttpClient): GetWorkflowSignature;
+interface GetWorkflowSignature {
+    /**
+     * Retrieves a workflow by ID.
+     *
+     *
+     * The `getWorkflow()` function returns a Promise that resolves to the workflow info with the specified ID.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the workflow to retrieve.
+     * @param - Maximum number of cards to return per phase.
+     * To retrieve additional pages of cards, use
+     * [List Cards](../cards/listCards)
+     * (in the Cards API).
+     * @param - Options to use when retrieving a workflow.
+     * @returns Requested workflow.
+     */
+    (_id: string, cardsPerPhase: number | null): Promise<Workflow & WorkflowNonNullableFields>;
+}
+declare function updateWorkflow$1(httpClient: HttpClient): UpdateWorkflowSignature;
+interface UpdateWorkflowSignature {
+    /**
+     * Updates an existing workflow.
+     *
+     *
+     * The `updateWorkflow()` function returns a Promise that resolves when the workflow has been updated with the specified values.
+     *
+     *
+     * Only the properties passed in the `workflow` object will be updated. All other properties will remain the same.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).
+     * @param - ID of the workflow to update.
+     * @param - Workflow info.
+     * @param - Options to use when updating a workflow.
+     */
+    (_id: string, workflow: WorkflowInfo): Promise<void>;
+}
+declare function createWorkflow$1(httpClient: HttpClient): CreateWorkflowSignature;
+interface CreateWorkflowSignature {
+    /**
+     * Creates a new workflow.
+     *
+     *
+     * The `createWorkflow()` function returns a Promise that resolves to the created workflow ID.
+     * @param - Workflow details.
+     * @param - Options to use when creating a workflow.
+     */
+    (workflow: WorkflowInfo): Promise<CreateWorkflowResponse>;
+}
+declare function deleteWorkflow$1(httpClient: HttpClient): DeleteWorkflowSignature;
+interface DeleteWorkflowSignature {
+    /**
+     * Deletes a workflow.
+     *
+     *
+     * The `deleteWorkflow()` function returns a Promise when the specified workflow has been deleted.
+     *
+     *
+     * This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflows APIs, see [Retrieving IDs](wix-workflows-v2/introduction#retrieving-ids).
+     * @param - ID of the workflow to delete.
+     */
+    (_id: string): Promise<void>;
 }
 
-declare const __metadata: {
-    PACKAGE_NAME: string;
-};
-declare function listWorkflows(httpClient: HttpClient): (options?: ListWorkflowsOptions) => Promise<ListWorkflowsResponse & ListWorkflowsResponseNonNullableFields>;
-declare function getWorkflow(httpClient: HttpClient): (_id: string, cardsPerPhase: number | null) => Promise<Workflow & {
-    winPhase?: {
-        cardsList?: {
-            total: number;
-            cards: {
-                info?: {
-                    primaryAttachment?: {
-                        attachmentId: string;
-                        value: string;
-                        attachmentType: AttachmentType;
-                        contactId: string;
-                    } | undefined;
-                } | undefined;
-            }[];
-        } | undefined;
-    } | undefined;
-    phasesList?: {
-        total: number;
-        phases: {
-            cardsList?: {
-                total: number;
-                cards: {
-                    info?: {
-                        primaryAttachment?: {
-                            attachmentId: string;
-                            value: string;
-                            attachmentType: AttachmentType;
-                            contactId: string;
-                        } | undefined;
-                    } | undefined;
-                }[];
-            } | undefined;
-        }[];
-    } | undefined;
-}>;
-declare function updateWorkflow(httpClient: HttpClient): (_id: string, workflow: WorkflowInfo) => Promise<void>;
-declare function createWorkflow(httpClient: HttpClient): (workflow: WorkflowInfo) => Promise<CreateWorkflowResponse>;
-declare function deleteWorkflow(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare const listWorkflows: MaybeContext<BuildRESTFunction<typeof listWorkflows$1> & typeof listWorkflows$1>;
+declare const getWorkflow: MaybeContext<BuildRESTFunction<typeof getWorkflow$1> & typeof getWorkflow$1>;
+declare const updateWorkflow: MaybeContext<BuildRESTFunction<typeof updateWorkflow$1> & typeof updateWorkflow$1>;
+declare const createWorkflow: MaybeContext<BuildRESTFunction<typeof createWorkflow$1> & typeof createWorkflow$1>;
+declare const deleteWorkflow: MaybeContext<BuildRESTFunction<typeof deleteWorkflow$1> & typeof deleteWorkflow$1>;
 
 type index_d_Attachment = Attachment;
 type index_d_AttachmentType = AttachmentType;
@@ -1433,14 +2080,14 @@ type index_d_UpdateWorkflowRequest = UpdateWorkflowRequest;
 type index_d_UpdateWorkflowResponse = UpdateWorkflowResponse;
 type index_d_Workflow = Workflow;
 type index_d_WorkflowInfo = WorkflowInfo;
-declare const index_d___metadata: typeof __metadata;
+type index_d_WorkflowNonNullableFields = WorkflowNonNullableFields;
 declare const index_d_createWorkflow: typeof createWorkflow;
 declare const index_d_deleteWorkflow: typeof deleteWorkflow;
 declare const index_d_getWorkflow: typeof getWorkflow;
 declare const index_d_listWorkflows: typeof listWorkflows;
 declare const index_d_updateWorkflow: typeof updateWorkflow;
 declare namespace index_d {
-  export { type index_d_Attachment as Attachment, index_d_AttachmentType as AttachmentType, type index_d_Card as Card, type index_d_CardInfo as CardInfo, type index_d_CardsList as CardsList, type index_d_CreateWorkflowRequest as CreateWorkflowRequest, type index_d_CreateWorkflowResponse as CreateWorkflowResponse, type index_d_DeleteWorkflowRequest as DeleteWorkflowRequest, type index_d_DeleteWorkflowResponse as DeleteWorkflowResponse, type index_d_GetWorkflowRequest as GetWorkflowRequest, type index_d_GetWorkflowResponse as GetWorkflowResponse, type index_d_GetWorkflowResponseNonNullableFields as GetWorkflowResponseNonNullableFields, type index_d_ListWorkflowsOptions as ListWorkflowsOptions, type index_d_ListWorkflowsRequest as ListWorkflowsRequest, type index_d_ListWorkflowsResponse as ListWorkflowsResponse, type index_d_ListWorkflowsResponseNonNullableFields as ListWorkflowsResponseNonNullableFields, type index_d_PaginationResponse as PaginationResponse, type index_d_Paging as Paging, type index_d_Phase as Phase, type index_d_PhaseInfo as PhaseInfo, type index_d_PhasesList as PhasesList, type index_d_Query as Query, type index_d_QueryWorkflowsRequest as QueryWorkflowsRequest, type index_d_QueryWorkflowsResponse as QueryWorkflowsResponse, type index_d_SetupWorkflowRequest as SetupWorkflowRequest, type index_d_SetupWorkflowResponse as SetupWorkflowResponse, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_UpdateWorkflowRequest as UpdateWorkflowRequest, type index_d_UpdateWorkflowResponse as UpdateWorkflowResponse, type index_d_Workflow as Workflow, type index_d_WorkflowInfo as WorkflowInfo, index_d___metadata as __metadata, index_d_createWorkflow as createWorkflow, index_d_deleteWorkflow as deleteWorkflow, index_d_getWorkflow as getWorkflow, index_d_listWorkflows as listWorkflows, index_d_updateWorkflow as updateWorkflow };
+  export { type index_d_Attachment as Attachment, index_d_AttachmentType as AttachmentType, type index_d_Card as Card, type index_d_CardInfo as CardInfo, type index_d_CardsList as CardsList, type index_d_CreateWorkflowRequest as CreateWorkflowRequest, type index_d_CreateWorkflowResponse as CreateWorkflowResponse, type index_d_DeleteWorkflowRequest as DeleteWorkflowRequest, type index_d_DeleteWorkflowResponse as DeleteWorkflowResponse, type index_d_GetWorkflowRequest as GetWorkflowRequest, type index_d_GetWorkflowResponse as GetWorkflowResponse, type index_d_GetWorkflowResponseNonNullableFields as GetWorkflowResponseNonNullableFields, type index_d_ListWorkflowsOptions as ListWorkflowsOptions, type index_d_ListWorkflowsRequest as ListWorkflowsRequest, type index_d_ListWorkflowsResponse as ListWorkflowsResponse, type index_d_ListWorkflowsResponseNonNullableFields as ListWorkflowsResponseNonNullableFields, type index_d_PaginationResponse as PaginationResponse, type index_d_Paging as Paging, type index_d_Phase as Phase, type index_d_PhaseInfo as PhaseInfo, type index_d_PhasesList as PhasesList, type index_d_Query as Query, type index_d_QueryWorkflowsRequest as QueryWorkflowsRequest, type index_d_QueryWorkflowsResponse as QueryWorkflowsResponse, type index_d_SetupWorkflowRequest as SetupWorkflowRequest, type index_d_SetupWorkflowResponse as SetupWorkflowResponse, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_UpdateWorkflowRequest as UpdateWorkflowRequest, type index_d_UpdateWorkflowResponse as UpdateWorkflowResponse, type index_d_Workflow as Workflow, type index_d_WorkflowInfo as WorkflowInfo, type index_d_WorkflowNonNullableFields as WorkflowNonNullableFields, index_d_createWorkflow as createWorkflow, index_d_deleteWorkflow as deleteWorkflow, index_d_getWorkflow as getWorkflow, index_d_listWorkflows as listWorkflows, index_d_updateWorkflow as updateWorkflow };
 }
 
 export { index_d$2 as cards, index_d$1 as phases, index_d as workflows };