@wix/auto_sdk_ecom_delivery-profile 1.0.49 → 1.0.51

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
 import { DeliveryProfile, CreateDeliveryProfileApplicationErrors, CreateDeliveryProfileValidationErrors, UpdateDeliveryProfile, UpdateDeliveryProfileApplicationErrors, DeliveryProfilesQueryBuilder, DeliveryRegion, AddDeliveryRegionOptions, AddDeliveryRegionResponse, AddDeliveryRegionApplicationErrors, AddDeliveryRegionValidationErrors, UpdateDeliveryRegionIdentifiers, UpdateDeliveryRegion, UpdateDeliveryRegionOptions, UpdateDeliveryRegionResponse, UpdateDeliveryRegionApplicationErrors, UpdateDeliveryRegionValidationErrors, GetDeliveryProfileByDeliveryRegionIdResponse, GetDeliveryProfileByDeliveryRegionIdApplicationErrors, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, RemoveDeliveryRegionApplicationErrors, AddDeliveryCarrierOptions, AddDeliveryCarrierResponse, AddDeliveryCarrierApplicationErrors, AddDeliveryCarrierValidationErrors, RemoveDeliveryCarrierOptions, RemoveDeliveryCarrierResponse, RemoveDeliveryCarrierApplicationErrors, UpdateDeliveryCarrierOptions, UpdateDeliveryCarrierResponse, UpdateDeliveryCarrierApplicationErrors, ListDeliveryCarrierDetailsResponse, ListInstalledDeliveryCarriersResponse, ListDeliveryCarriersOptions, ListDeliveryCarriersResponse, ListDeliveryCarriersApplicationErrors, UpdateCarrierSettingsOptions, UpdateCarrierSettingsApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse } from './index.typings.js';
 export { ActionEvent, AddDeliveryCarrierRequest, AddDeliveryRegionRequest, AdditionalCharge, ApplicationError, Asset, BackupRate, BulkActionMetadata, ChargeType, Column, CreateDeliveryProfileRequest, CreateDeliveryProfileResponse, CreatedBy, CreatedByIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DashboardTable, DeleteContext, DeleteDefaultDeliveryProfileRequest, DeleteDefaultDeliveryProfileResponse, DeleteDeliveryProfileRequest, DeleteDeliveryProfileResponse, DeleteStatus, DeliveryCarrier, DeliveryCarrierDetails, DeliveryCarrierRegionalSettings, DeliveryProfilesQueryResult, DeliveryRegionAdded, DeliveryRegionRemoved, DeliveryRegionUpdated, Destination, DestinationScope, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetDeliveryProfileByDeliveryRegionIdRequest, GetDeliveryProfileRequest, GetDeliveryProfileResponse, IdentificationData, IdentificationDataIdOneOf, InstalledDeliveryCarrier, ItemMetadata, ListDeliveryCarrierDetailsRequest, ListDeliveryCarriersRequest, ListDeliveryCarriersResult, ListDeliveryDestinationsRequest, ListDeliveryDestinationsResponse, ListInstalledDeliveryCarriersRequest, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, QueryDeliveryProfilesRequest, QueryDeliveryProfilesResponse, RemoveDeliveryCarrierRequest, RemoveDeliveryRegionRequest, RequiredZipcodeRequest, RequiredZipcodeResponse, RestoreInfo, Row, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, Sorting, State, StudioAssigned, StudioUnassigned, UpdateCarrierSettingsRequest, UpdateCarrierSettingsResponse, UpdateDeliveryCarrierRequest, UpdateDeliveryProfileRequest, UpdateDeliveryProfileResponse, UpdateDeliveryRegionRequest, UpdateExtendedFieldsRequest, WebhookIdentityType } from './index.typings.js';
 
+type DeliveryProfileNonNullablePaths = `deliveryRegions`;
 declare function createDeliveryProfile$1(httpClient: HttpClient): CreateDeliveryProfileSignature;
 interface CreateDeliveryProfileSignature {
     /**
@@ -11,9 +12,9 @@ interface CreateDeliveryProfileSignature {
      * @param - DeliveryProfile to be created.
      * @returns The created DeliveryProfile.
      */
-    (deliveryProfile: DeliveryProfile): Promise<DeliveryProfile & {
-        __applicationErrorsType?: CreateDeliveryProfileApplicationErrors | undefined;
-        __validationErrorsType?: CreateDeliveryProfileValidationErrors | undefined;
+    (deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations` | `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths> & {
+        __applicationErrorsType?: CreateDeliveryProfileApplicationErrors;
+        __validationErrorsType?: CreateDeliveryProfileValidationErrors;
     }>;
 }
 declare function getDeliveryProfile$1(httpClient: HttpClient): GetDeliveryProfileSignature;
@@ -23,7 +24,7 @@ interface GetDeliveryProfileSignature {
      * @param - ID of the DeliveryProfile to retrieve.
      * @returns The requested DeliveryProfile.
      */
-    (deliveryProfileId: string): Promise<DeliveryProfile>;
+    (deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths>>;
 }
 declare function updateDeliveryProfile$1(httpClient: HttpClient): UpdateDeliveryProfileSignature;
 interface UpdateDeliveryProfileSignature {
@@ -42,8 +43,8 @@ interface UpdateDeliveryProfileSignature {
      * @param - DeliveryProfile ID.
      * @returns Updated DeliveryProfile.
      */
-    (_id: string, deliveryProfile: UpdateDeliveryProfile): Promise<DeliveryProfile & {
-        __applicationErrorsType?: UpdateDeliveryProfileApplicationErrors | undefined;
+    (_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths> & {
+        __applicationErrorsType?: UpdateDeliveryProfileApplicationErrors;
     }>;
 }
 declare function deleteDeliveryProfile$1(httpClient: HttpClient): DeleteDeliveryProfileSignature;
@@ -77,9 +78,11 @@ interface AddDeliveryRegionSignature {
      * @param - delivery profile id to associated with the DeliveryRegion
      * @param - DeliveryRegion to be created
      */
-    (deliveryProfileId: string, deliveryRegion: DeliveryRegion, options?: AddDeliveryRegionOptions | undefined): Promise<AddDeliveryRegionResponse & {
-        __applicationErrorsType?: AddDeliveryRegionApplicationErrors | undefined;
-        __validationErrorsType?: AddDeliveryRegionValidationErrors | undefined;
+    (deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: AddDeliveryRegionApplicationErrors;
+        __validationErrorsType?: AddDeliveryRegionValidationErrors;
     }>;
 }
 declare function updateDeliveryRegion$1(httpClient: HttpClient): UpdateDeliveryRegionSignature;
@@ -91,9 +94,11 @@ interface UpdateDeliveryRegionSignature {
      * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
      * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.
      */
-    (identifiers: UpdateDeliveryRegionIdentifiers, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions | undefined): Promise<UpdateDeliveryRegionResponse & {
-        __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors | undefined;
-        __validationErrorsType?: UpdateDeliveryRegionValidationErrors | undefined;
+    (identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors;
+        __validationErrorsType?: UpdateDeliveryRegionValidationErrors;
     }>;
 }
 declare function getDeliveryProfileByDeliveryRegionId$1(httpClient: HttpClient): GetDeliveryProfileByDeliveryRegionIdSignature;
@@ -102,8 +107,10 @@ interface GetDeliveryProfileByDeliveryRegionIdSignature {
      * Retrieves a DeliveryProfile by delivery region ID.
      * @param - ID of the DeliveryRegion to retrieve the profile for.
      */
-    (deliveryRegionId: string): Promise<GetDeliveryProfileByDeliveryRegionIdResponse & {
-        __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors | undefined;
+    (deliveryRegionId: string): Promise<NonNullablePaths<GetDeliveryProfileByDeliveryRegionIdResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors;
     }>;
 }
 declare function removeDeliveryRegion$1(httpClient: HttpClient): RemoveDeliveryRegionSignature;
@@ -111,8 +118,10 @@ interface RemoveDeliveryRegionSignature {
     /**
      * Delete a DeliveryRegion
      */
-    (identifiers: RemoveDeliveryRegionIdentifiers, options?: RemoveDeliveryRegionOptions | undefined): Promise<RemoveDeliveryRegionResponse & {
-        __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors | undefined;
+    (identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors;
     }>;
 }
 declare function addDeliveryCarrier$1(httpClient: HttpClient): AddDeliveryCarrierSignature;
@@ -121,9 +130,11 @@ interface AddDeliveryCarrierSignature {
      * Add a delivery_carrier to a delivery region
      * @param - delivery_region id to associated with the delivery_carrier.
      */
-    (deliveryRegionId: string, options: AddDeliveryCarrierOptions): Promise<AddDeliveryCarrierResponse & {
-        __applicationErrorsType?: AddDeliveryCarrierApplicationErrors | undefined;
-        __validationErrorsType?: AddDeliveryCarrierValidationErrors | undefined;
+    (deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier`>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: AddDeliveryCarrierApplicationErrors;
+        __validationErrorsType?: AddDeliveryCarrierValidationErrors;
     }>;
 }
 declare function removeDeliveryCarrier$1(httpClient: HttpClient): RemoveDeliveryCarrierSignature;
@@ -132,8 +143,10 @@ interface RemoveDeliveryCarrierSignature {
      * Remove a delivery_carrier from a delivery region
      * @param - Id of the DeliveryRegion
      */
-    (deliveryRegionId: string, options: RemoveDeliveryCarrierOptions): Promise<RemoveDeliveryCarrierResponse & {
-        __applicationErrorsType?: RemoveDeliveryCarrierApplicationErrors | undefined;
+    (deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: RemoveDeliveryCarrierApplicationErrors;
     }>;
 }
 declare function updateDeliveryCarrier$1(httpClient: HttpClient): UpdateDeliveryCarrierSignature;
@@ -142,8 +155,10 @@ interface UpdateDeliveryCarrierSignature {
      * Update a delivery carrier in a delivery region
      * @param - DeliveryRegion id
      */
-    (deliveryRegionId: string, options?: UpdateDeliveryCarrierOptions | undefined): Promise<UpdateDeliveryCarrierResponse & {
-        __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors | undefined;
+    (deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]> & {
+        __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors;
     }>;
 }
 declare function listDeliveryCarrierDetails$1(httpClient: HttpClient): ListDeliveryCarrierDetailsSignature;
@@ -152,12 +167,12 @@ interface ListDeliveryCarrierDetailsSignature {
      * List all installed delivery carriers in order to set their ids in delivery rules
      * @deprecated
      */
-    (): Promise<ListDeliveryCarrierDetailsResponse>;
+    (): Promise<NonNullablePaths<ListDeliveryCarrierDetailsResponse, `deliveryCarrierDetails` | `deliveryCarrierDetails.${number}._id` | `deliveryCarrierDetails.${number}.displayName` | `deliveryCarrierDetails.${number}.toggleGetCarrierSettingsEnabled` | `deliveryCarrierDetails.${number}.toggleUpdateCarrierActiveStatusEnabled`>>;
 }
 declare function listInstalledDeliveryCarriers$1(httpClient: HttpClient): ListInstalledDeliveryCarriersSignature;
 interface ListInstalledDeliveryCarriersSignature {
     /** */
-    (): Promise<ListInstalledDeliveryCarriersResponse>;
+    (): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`>>;
 }
 declare function listDeliveryCarriers$1(httpClient: HttpClient): ListDeliveryCarriersSignature;
 interface ListDeliveryCarriersSignature {
@@ -166,8 +181,8 @@ interface ListDeliveryCarriersSignature {
      * These are returned in a table format for the dashboard.
      * @param - Delivery profile id.
      */
-    (deliveryProfileId: string, options?: ListDeliveryCarriersOptions | undefined): Promise<ListDeliveryCarriersResponse & {
-        __applicationErrorsType?: ListDeliveryCarriersApplicationErrors | undefined;
+    (deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise<NonNullablePaths<ListDeliveryCarriersResponse, `results` | `results.${number}.deliveryCarrierMetadata.success` | `results.${number}.deliveryCarrierMetadata.error.code` | `results.${number}.deliveryCarrierMetadata.error.description` | `results.${number}.deliveryCarrierDetails._id` | `results.${number}.deliveryCarrierDetails.displayName` | `results.${number}.deliveryCarrierDetails.toggleGetCarrierSettingsEnabled` | `results.${number}.deliveryCarrierDetails.toggleUpdateCarrierActiveStatusEnabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+        __applicationErrorsType?: ListDeliveryCarriersApplicationErrors;
     }>;
 }
 declare function updateCarrierSettings$1(httpClient: HttpClient): UpdateCarrierSettingsSignature;
@@ -176,8 +191,8 @@ interface UpdateCarrierSettingsSignature {
      * Update carrier's external active settings
      * @param - Carrier id.
      */
-    (carrierId: string, options: UpdateCarrierSettingsOptions): Promise<void & {
-        __applicationErrorsType?: UpdateCarrierSettingsApplicationErrors | undefined;
+    (carrierId: string, options: NonNullablePaths<UpdateCarrierSettingsOptions, `active` | `rowId`>): Promise<void & {
+        __applicationErrorsType?: UpdateCarrierSettingsApplicationErrors;
     }>;
 }
 declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
@@ -187,7 +202,9 @@ interface UpdateExtendedFieldsSignature {
      * @param - ID of the entity to update.
      * @param - Identifier for the app whose extended fields are being updated.
      */
-    (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+    (_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+        [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
+    }[DeliveryProfileNonNullablePaths]>>;
 }
 
 declare const createDeliveryProfile: MaybeContext<BuildRESTFunction<typeof createDeliveryProfile$1> & typeof createDeliveryProfile$1>;