@wix/motion 1.0.39 → 1.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/motion",
-  "version": "1.0.39",
+  "version": "1.0.41",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/motion_alarms": "1.0.8",
+    "@wix/motion_alarms": "1.0.9",
     "@wix/motion_metroinspector": "1.0.5",
     "@wix/motion_products": "1.0.8"
   },
@@ -45,5 +45,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "618c0372961d899242c8295b4f95a23c77914c34c8283af99e1684d9"
+  "falconPackageHash": "ecc873ee56f9e003eb4cd2e076abaf81dce97d3c187d84bccaf28ab0"
 }

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

@@ -118,52 +118,104 @@ interface UpdateAlarm {
     seconds?: number;
 }
 
-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>>;
+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>>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
+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<_TResponse = any, Data = any> = {
+type RequestOptions$2<_TResponse = any, Data = any> = {
     method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
     url: string;
     data?: Data;
     params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
+} & APIMetadata$2;
+type APIMetadata$2 = {
     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 BuildRESTFunction$2<T extends RESTFunctionDescriptor$2> = T extends RESTFunctionDescriptor$2<infer U> ? U : never;
+type EventDefinition$1<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
     transformations?: unknown;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: 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;
+declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
+type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
 
-declare function alarm$1(httpClient: HttpClient): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
-declare function updateAlarm$1(httpClient: HttpClient): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
-declare const onAlarmTriggered$1: EventDefinition<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
-declare const onAlarmSnoozed$1: EventDefinition<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;
-declare const onAlarmDeleted$1: EventDefinition<AlarmDeletedEnvelope, "wix.alarm.v1.alarm_alarm_deleted">;
+/**
+ * Creates a booking.
+ *
+ *
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
+ *
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
+ * You can use Query Availability to check the availability beforehand.
+ *
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
+ * Then, any specified slot details are calculated.
+ *
+ * If you create a booking for a new session, we recommend to call Query Availability first.
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
+ *
+ * Bookings are created with a status of `CREATED`.
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
+ *
+ * To create a booking with a given status, pass a booking with the wanted status.
+ * This is only permitted for site Owners.
+ *
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
+ *
+ * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
+ *
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
+ *
+ * When creating a booking, you can pass `selectedPaymentOption`.
+ * This specifies which payment method the customer plans to use.
+ * But it's possible for them to later use another supported payment method.
+ *
+ * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
+ * @param booking - The booking to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField booking
+ * @requiredField booking.additionalFields._id
+ * @requiredField booking.bookedEntity
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
+declare function alarm$1(httpClient: HttpClient$2): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
+/**
+ * Another thing
+ */
+declare function updateAlarm$1(httpClient: HttpClient$2): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
+declare const onAlarmTriggered$1: EventDefinition$1<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
+declare const onAlarmSnoozed$1: EventDefinition$1<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;
+declare const onAlarmDeleted$1: EventDefinition$1<AlarmDeletedEnvelope, "wix.alarm.v1.alarm_alarm_deleted">;
 
-declare const alarm: BuildRESTFunction<typeof alarm$1>;
-declare const updateAlarm: BuildRESTFunction<typeof updateAlarm$1>;
-declare const onAlarmTriggered: BuildEventDefinition<typeof onAlarmTriggered$1>;
-declare const onAlarmSnoozed: BuildEventDefinition<typeof onAlarmSnoozed$1>;
-declare const onAlarmDeleted: BuildEventDefinition<typeof onAlarmDeleted$1>;
+declare const alarm: BuildRESTFunction$2<typeof alarm$1>;
+declare const updateAlarm: BuildRESTFunction$2<typeof updateAlarm$1>;
+declare const onAlarmTriggered: BuildEventDefinition$1<typeof onAlarmTriggered$1>;
+declare const onAlarmSnoozed: BuildEventDefinition$1<typeof onAlarmSnoozed$1>;
+declare const onAlarmDeleted: BuildEventDefinition$1<typeof onAlarmDeleted$1>;
 
 declare const context$2_alarm: typeof alarm;
 declare const context$2_onAlarmDeleted: typeof onAlarmDeleted;
@@ -174,6 +226,41 @@ declare namespace context$2 {
   export { context$2_alarm as alarm, context$2_onAlarmDeleted as onAlarmDeleted, context$2_onAlarmSnoozed as onAlarmSnoozed, context$2_onAlarmTriggered as onAlarmTriggered, context$2_updateAlarm as updateAlarm };
 }
 
+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>>;
+}
+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;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: 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;
+
 interface Dispatched {
     /** the message someone says */
     echo?: EchoMessage;
@@ -271,10 +358,10 @@ interface EchoOptions {
     someDate?: Date;
 }
 
-declare function echo$1(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
+declare function echo$1(httpClient: HttpClient$1): (arg1: string, options?: EchoOptions) => Promise<string>;
 declare const onEchoDispatched$1: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
 
-declare const echo: BuildRESTFunction<typeof echo$1>;
+declare const echo: BuildRESTFunction$1<typeof echo$1>;
 declare const onEchoDispatched: BuildEventDefinition<typeof onEchoDispatched$1>;
 
 declare const context$1_echo: typeof echo;
@@ -651,6 +738,31 @@ interface BulkUpdateProductsOptions {
     returnEntity?: boolean;
 }
 
+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>>;
+}
+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 createProduct$1(httpClient: HttpClient): (options?: CreateProductOptions & CreateProductOptionsRequiredFields) => Promise<Product & {
     _id: string;
     collectionId: string;

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

@@ -212,45 +212,97 @@ interface UpdateAlarm {
     seconds?: number;
 }
 
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+interface HttpClient$2 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$2<TResponse, TData>): Promise<HttpResponse$2<TResponse>>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
+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<_TResponse = any, Data = any> = {
+type RequestOptions$2<_TResponse = any, Data = any> = {
     method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
     url: string;
     data?: Data;
     params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
+} & APIMetadata$2;
+type APIMetadata$2 = {
     methodFqn?: string;
     entityFqdn?: string;
     packageName?: string;
 };
-type EventDefinition<Payload = unknown, Type extends string = string> = {
+type EventDefinition$1<Payload = unknown, Type extends string = string> = {
     __type: 'event-definition';
     type: Type;
     isDomainEvent?: boolean;
     transformations?: unknown;
     __payload: Payload;
 };
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
 
 declare const __metadata$2: {
     PACKAGE_NAME: string;
 };
-declare function alarm(httpClient: HttpClient): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
-declare function updateAlarm(httpClient: HttpClient): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
-declare const onAlarmTriggered: EventDefinition<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
-declare const onAlarmSnoozed: EventDefinition<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;
-declare const onAlarmDeleted: EventDefinition<AlarmDeletedEnvelope, "wix.alarm.v1.alarm_alarm_deleted">;
+/**
+ * Creates a booking.
+ *
+ *
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
+ *
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
+ * You can use Query Availability to check the availability beforehand.
+ *
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
+ * Then, any specified slot details are calculated.
+ *
+ * If you create a booking for a new session, we recommend to call Query Availability first.
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
+ *
+ * Bookings are created with a status of `CREATED`.
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
+ *
+ * To create a booking with a given status, pass a booking with the wanted status.
+ * This is only permitted for site Owners.
+ *
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
+ *
+ * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
+ *
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
+ *
+ * When creating a booking, you can pass `selectedPaymentOption`.
+ * This specifies which payment method the customer plans to use.
+ * But it's possible for them to later use another supported payment method.
+ *
+ * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
+ * @param booking - The booking to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField booking
+ * @requiredField booking.additionalFields._id
+ * @requiredField booking.bookedEntity
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
+declare function alarm(httpClient: HttpClient$2): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
+/**
+ * Another thing
+ */
+declare function updateAlarm(httpClient: HttpClient$2): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
+declare const onAlarmTriggered: EventDefinition$1<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
+declare const onAlarmSnoozed: EventDefinition$1<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;
+declare const onAlarmDeleted: EventDefinition$1<AlarmDeletedEnvelope, "wix.alarm.v1.alarm_alarm_deleted">;
 
 type index_d$2_AlarmDeleted = AlarmDeleted;
 type index_d$2_AlarmDeletedEnvelope = AlarmDeletedEnvelope;
@@ -277,6 +329,37 @@ declare namespace index_d$2 {
   export { type ActionEvent$2 as ActionEvent, type index_d$2_AlarmDeleted as AlarmDeleted, type index_d$2_AlarmDeletedEnvelope as AlarmDeletedEnvelope, type index_d$2_AlarmMessage as AlarmMessage, type index_d$2_AlarmOptions as AlarmOptions, type index_d$2_AlarmRequest as AlarmRequest, type index_d$2_AlarmRequestRequiredFields as AlarmRequestRequiredFields, type index_d$2_AlarmResponse as AlarmResponse, type index_d$2_AlarmSnoozed as AlarmSnoozed, type index_d$2_AlarmSnoozedEnvelope as AlarmSnoozedEnvelope, type index_d$2_AlarmTriggered as AlarmTriggered, type index_d$2_AlarmTriggeredEnvelope as AlarmTriggeredEnvelope, type BaseEventMetadata$1 as BaseEventMetadata, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type MessageEnvelope$2 as MessageEnvelope, type index_d$2_UpdateAlarm as UpdateAlarm, type index_d$2_UpdateAlarmRequest as UpdateAlarmRequest, type index_d$2_UpdateAlarmRequestRequiredFields as UpdateAlarmRequestRequiredFields, type index_d$2_UpdateAlarmResponse as UpdateAlarmResponse, type index_d$2_UpdateAlarmResponseNonNullableFields as UpdateAlarmResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, __metadata$2 as __metadata, index_d$2_alarm as alarm, index_d$2_onAlarmDeleted as onAlarmDeleted, index_d$2_onAlarmSnoozed as onAlarmSnoozed, index_d$2_onAlarmTriggered as onAlarmTriggered, index_d$2_updateAlarm as updateAlarm };
 }
 
+interface HttpClient$1 {
+    request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
+}
+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 EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+
 interface MessageItem {
     /** inner_message comment from EchoMessage proto def */
     innerMessage?: string;
@@ -487,7 +570,7 @@ interface EchoOptions {
 declare const __metadata$1: {
     PACKAGE_NAME: string;
 };
-declare function echo(httpClient: HttpClient): (arg1: string, options?: EchoOptions) => Promise<string>;
+declare function echo(httpClient: HttpClient$1): (arg1: string, options?: EchoOptions) => Promise<string>;
 declare const onEchoDispatched: EventDefinition<EchoDispatchedEnvelope, "wix.metroinspector.v1.echo_dispatched">;
 
 type index_d$1_BaseEventMetadata = BaseEventMetadata;
@@ -1281,6 +1364,29 @@ interface BulkUpdateProductsOptions {
     returnEntity?: boolean;
 }
 
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+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 const __metadata: {
     PACKAGE_NAME: string;
 };