@wix/atlas 1.0.17 → 1.0.19

package/type-bundles/context.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 Place {
     /** The given place id */
     placeId?: string;
@@ -36,52 +514,80 @@ interface StreetAddress$1 {
     /** Street name. */
     name?: string;
 }
+interface AddressLocation$2 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision$1 {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType$1 {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+interface GetPlaceRequest {
+    searchId: string;
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
 interface GetPlaceResponse {
     place?: Place;
 }
+interface StreetAddressNonNullableFields$1 {
+    number: string;
+    name: string;
+    apt: string;
+}
+interface AddressNonNullableFields$1 {
+    streetAddress?: StreetAddressNonNullableFields$1;
+}
+interface PlaceNonNullableFields {
+    placeId: string;
+    address?: AddressNonNullableFields$1;
+    types: string[];
+}
 interface GetPlaceResponseNonNullableFields {
-    place?: {
-        placeId: string;
-        types: string[];
-    };
+    place?: PlaceNonNullableFields;
 }
 interface GetPlaceOptions {
     /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
     sessionToken?: string | null;
 }
 
-type RESTFunctionDescriptor$2<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$2) => T;
-interface HttpClient$2 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$2<TResponse, TData>): Promise<HttpResponse$2<TResponse>>;
+declare function getPlace$1(httpClient: HttpClient): GetPlaceSignature;
+interface GetPlaceSignature {
+    /**
+     * Once you have a search_id from a autocomplete Search, you can request more details about a particular establishment or point of interest by initiating a get place request.
+     */
+    (searchId: string, options?: GetPlaceOptions | undefined): Promise<GetPlaceResponse & GetPlaceResponseNonNullableFields>;
 }
-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;
-};
-type BuildRESTFunction$2<T extends RESTFunctionDescriptor$2> = T extends RESTFunctionDescriptor$2<infer U> ? U : never;
-
-declare function getPlace$1(httpClient: HttpClient$2): (searchId: string, options?: GetPlaceOptions) => Promise<GetPlaceResponse & GetPlaceResponseNonNullableFields>;
 
-declare const getPlace: BuildRESTFunction$2<typeof getPlace$1>;
+declare const getPlace: MaybeContext<BuildRESTFunction<typeof getPlace$1> & typeof getPlace$1>;
 
+type context$2_GetPlaceOptions = GetPlaceOptions;
+type context$2_GetPlaceRequest = GetPlaceRequest;
+type context$2_GetPlaceResponse = GetPlaceResponse;
+type context$2_GetPlaceResponseNonNullableFields = GetPlaceResponseNonNullableFields;
+type context$2_Place = Place;
 declare const context$2_getPlace: typeof getPlace;
 declare namespace context$2 {
-  export { context$2_getPlace as getPlace };
+  export { type Address$1 as Address, type AddressLocation$2 as AddressLocation, type AddressStreetOneOf$1 as AddressStreetOneOf, type context$2_GetPlaceOptions as GetPlaceOptions, type context$2_GetPlaceRequest as GetPlaceRequest, type context$2_GetPlaceResponse as GetPlaceResponse, type context$2_GetPlaceResponseNonNullableFields as GetPlaceResponseNonNullableFields, type context$2_Place as Place, type StreetAddress$1 as StreetAddress, type Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, context$2_getPlace as getPlace };
 }
 
 interface Prediction {
@@ -108,38 +614,79 @@ interface TextStructure {
     /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */
     mainTextMatchedSubstrings?: MatchedSubstrings[];
 }
-interface AddressLocation {
+interface ListPredictionsRequest {
+    /** The text the predictions will be based on. */
+    input?: string;
+    /** The origin point from which to calculate straight-line distance to the destination */
+    origin?: AddressLocation$1;
+    /** The point around which you wish to retrieve place information */
+    location?: AddressLocation$1;
+    /** The acceptable distance from that location (in meters) */
+    radius?: string | null;
+    /** Filters the user can add in order to get more accurate results */
+    filterBy?: FilterBy$1[];
+}
+interface AddressLocation$1 {
     /** Address latitude. */
     latitude?: number | null;
     /** Address longitude. */
     longitude?: number | null;
 }
+interface FilterBy$1 {
+    /** One of the filter types enum */
+    filterType?: FilterType$1;
+    /** Free text like "us" */
+    filterValue?: string;
+}
+declare enum FilterType$1 {
+    /** Filter by zip code */
+    zip_code = "zip_code",
+    /** Filter by 2-letters or 3-letters country code */
+    country_code = "country_code"
+}
+interface ListPredictionsResponse {
+    predictions?: Prediction[];
+}
+interface PredictRequest {
+    /** The text the predictions will be based on. */
+    input: string;
+    /** The origin point from which to calculate straight-line distance to the destination */
+    origin?: AddressLocation$1;
+    /** The point around which you wish to retrieve place information */
+    location?: AddressLocation$1;
+    /** The acceptable distance from that location (in meters) */
+    radius?: string | null;
+    /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */
+    countryCodes?: string[];
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
 interface PredictResponse {
     predictions?: Prediction[];
 }
+interface MatchedSubstringsNonNullableFields {
+    length: number;
+    offset: number;
+}
+interface TextStructureNonNullableFields {
+    mainText: string;
+    secondaryText: string;
+    mainTextMatchedSubstrings: MatchedSubstringsNonNullableFields[];
+}
+interface PredictionNonNullableFields {
+    description: string;
+    searchId: string;
+    matchedSubstrings: MatchedSubstringsNonNullableFields[];
+    textStructure?: TextStructureNonNullableFields;
+}
 interface PredictResponseNonNullableFields {
-    predictions: {
-        description: string;
-        searchId: string;
-        matchedSubstrings: {
-            length: number;
-            offset: number;
-        }[];
-        textStructure?: {
-            mainText: string;
-            secondaryText: string;
-            mainTextMatchedSubstrings: {
-                length: number;
-                offset: number;
-            }[];
-        };
-    }[];
+    predictions: PredictionNonNullableFields[];
 }
 interface PredictOptions {
     /** The origin point from which to calculate straight-line distance to the destination */
-    origin?: AddressLocation;
+    origin?: AddressLocation$1;
     /** The point around which you wish to retrieve place information */
-    location?: AddressLocation;
+    location?: AddressLocation$1;
     /** The acceptable distance from that location (in meters) */
     radius?: string | null;
     /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */
@@ -148,38 +695,29 @@ interface PredictOptions {
     sessionToken?: string | null;
 }
 
-type RESTFunctionDescriptor$1<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$1) => T;
-interface HttpClient$1 {
-    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
+declare function predict$1(httpClient: HttpClient): PredictSignature;
+interface PredictSignature {
+    /**
+     * A Predict end-point take an input and returns an list of Prediction object.
+     * @param - The text the predictions will be based on.
+     */
+    (input: string, options?: PredictOptions | undefined): Promise<PredictResponse & PredictResponseNonNullableFields>;
 }
-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;
-};
-type BuildRESTFunction$1<T extends RESTFunctionDescriptor$1> = T extends RESTFunctionDescriptor$1<infer U> ? U : never;
 
-declare function predict$1(httpClient: HttpClient$1): (input: string, options?: PredictOptions) => Promise<PredictResponse & PredictResponseNonNullableFields>;
-
-declare const predict: BuildRESTFunction$1<typeof predict$1>;
+declare const predict: MaybeContext<BuildRESTFunction<typeof predict$1> & typeof predict$1>;
 
+type context$1_ListPredictionsRequest = ListPredictionsRequest;
+type context$1_ListPredictionsResponse = ListPredictionsResponse;
+type context$1_MatchedSubstrings = MatchedSubstrings;
+type context$1_PredictOptions = PredictOptions;
+type context$1_PredictRequest = PredictRequest;
+type context$1_PredictResponse = PredictResponse;
+type context$1_PredictResponseNonNullableFields = PredictResponseNonNullableFields;
+type context$1_Prediction = Prediction;
+type context$1_TextStructure = TextStructure;
 declare const context$1_predict: typeof predict;
 declare namespace context$1 {
-  export { context$1_predict as predict };
+  export { type AddressLocation$1 as AddressLocation, type FilterBy$1 as FilterBy, FilterType$1 as FilterType, type context$1_ListPredictionsRequest as ListPredictionsRequest, type context$1_ListPredictionsResponse as ListPredictionsResponse, type context$1_MatchedSubstrings as MatchedSubstrings, type context$1_PredictOptions as PredictOptions, type context$1_PredictRequest as PredictRequest, type context$1_PredictResponse as PredictResponse, type context$1_PredictResponseNonNullableFields as PredictResponseNonNullableFields, type context$1_Prediction as Prediction, type context$1_TextStructure as TextStructure, context$1_predict as predict };
 }
 
 interface SearchResult {
@@ -218,6 +756,33 @@ interface StreetAddress {
     /** Street name. */
     name?: string;
 }
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
 declare enum Proximity {
     UNKNOWN_PROXIMITY = "UNKNOWN_PROXIMITY",
     /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
@@ -227,6 +792,20 @@ declare enum Proximity {
     /** indicates that the returned result is around an area */
     GENERAL_AREA = "GENERAL_AREA"
 }
+/** User must provide query or filter by parameters */
+interface SearchRequest {
+    /** Free text */
+    query?: string | null;
+    /**
+     * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
+     * @deprecated
+     */
+    filterBy?: FilterBy[];
+    /** Zip code filter the user can add in order to get more accurate results */
+    zipCode?: string | null;
+    /** Country codes filter the user can add in order to get more accurate results */
+    countryCodes?: string[];
+}
 interface FilterBy {
     /** One of the filter types enum */
     filterType?: FilterType;
@@ -243,10 +822,27 @@ interface SearchResponse {
     /** List of 'Address' objects */
     searchResults?: SearchResult[];
 }
+interface ReverseGeocodingRequest {
+    /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */
+    addressLocation?: AddressLocation;
+}
+interface ReverseGeocodingResponse {
+    searchResults?: SearchResult[];
+}
+interface StreetAddressNonNullableFields {
+    number: string;
+    name: string;
+    apt: string;
+}
+interface AddressNonNullableFields {
+    streetAddress?: StreetAddressNonNullableFields;
+}
+interface SearchResultNonNullableFields {
+    address?: AddressNonNullableFields;
+    proximity: Proximity;
+}
 interface SearchResponseNonNullableFields {
-    searchResults: {
-        proximity: Proximity;
-    }[];
+    searchResults: SearchResultNonNullableFields[];
 }
 interface SearchOptions {
     /** Free text */
@@ -262,38 +858,38 @@ interface SearchOptions {
     countryCodes?: 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>>;
+declare function search$1(httpClient: HttpClient): SearchSignature;
+interface SearchSignature {
+    /**
+     * A Search request takes a free text as an input and returns a list of 'Address' objects.
+     */
+    (options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
 }
-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;
-
-declare function search$1(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
 
-declare const search: BuildRESTFunction<typeof search$1>;
+declare const search: MaybeContext<BuildRESTFunction<typeof search$1> & typeof search$1>;
 
+type context_Address = Address;
+type context_AddressLocation = AddressLocation;
+type context_AddressStreetOneOf = AddressStreetOneOf;
+type context_FilterBy = FilterBy;
+type context_FilterType = FilterType;
+declare const context_FilterType: typeof FilterType;
+type context_Proximity = Proximity;
+declare const context_Proximity: typeof Proximity;
+type context_ReverseGeocodingRequest = ReverseGeocodingRequest;
+type context_ReverseGeocodingResponse = ReverseGeocodingResponse;
+type context_SearchOptions = SearchOptions;
+type context_SearchRequest = SearchRequest;
+type context_SearchResponse = SearchResponse;
+type context_SearchResponseNonNullableFields = SearchResponseNonNullableFields;
+type context_SearchResult = SearchResult;
+type context_StreetAddress = StreetAddress;
+type context_Subdivision = Subdivision;
+type context_SubdivisionType = SubdivisionType;
+declare const context_SubdivisionType: typeof SubdivisionType;
 declare const context_search: typeof search;
 declare namespace context {
-  export { context_search as search };
+  export { type context_Address as Address, type context_AddressLocation as AddressLocation, type context_AddressStreetOneOf as AddressStreetOneOf, type context_FilterBy as FilterBy, context_FilterType as FilterType, context_Proximity as Proximity, type context_ReverseGeocodingRequest as ReverseGeocodingRequest, type context_ReverseGeocodingResponse as ReverseGeocodingResponse, type context_SearchOptions as SearchOptions, type context_SearchRequest as SearchRequest, type context_SearchResponse as SearchResponse, type context_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type context_SearchResult as SearchResult, type context_StreetAddress as StreetAddress, type context_Subdivision as Subdivision, context_SubdivisionType as SubdivisionType, context_search as search };
 }
 
 export { context$1 as autocomplete, context as location, context$2 as places };