@wix/auto_sdk_ecom_shippo-configurations 1.0.24 → 1.0.25

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { S as ShippoConfiguration, C as CreateShippoConfigurationOptions, U as UpdateShippoConfiguration, a as ShippoConfigurationsQueryBuilder, b as UpdateExtendedFieldsOptions, c as UpdateExtendedFieldsResponse, A as AddDeliveryRegionOptions, d as AddDeliveryRegionResponse, R as RemoveDeliveryRegionIdentifiers, e as RemoveDeliveryRegionOptions, f as RemoveDeliveryRegionResponse, g as ShippoConfigurationCreatedEnvelope, h as ShippoConfigurationDeletedEnvelope, i as ShippoConfigurationUpdatedEnvelope } from './ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.js';
-export { $ as ActionEvent, a1 as AddDeliveryRegionRequest, q as Address, s as AddressLocation, a6 as BaseEventMetadata, j as CalculationType, t as CreateShippoConfigurationRequest, u as CreateShippoConfigurationResponse, K as CursorPaging, M as CursorPagingMetadata, B as CursorQuery, F as CursorQueryPagingMethodOneOf, N as Cursors, y as DeleteShippoConfigurationRequest, z as DeleteShippoConfigurationResponse, T as DomainEvent, V as DomainEventBodyOneOf, D as DomesticService, l as DomesticServiceSettings, a0 as Empty, X as EntityCreatedEvent, _ as EntityDeletedEvent, Z as EntityUpdatedEvent, a7 as EventMetadata, E as ExtendedFields, G as GetShippoConfigurationRequest, v as GetShippoConfigurationResponse, H as HandlingFee, a4 as IdentificationData, a5 as IdentificationDataIdOneOf, I as InternationalService, n as InternationalServiceSettings, a3 as MessageEnvelope, o as PackageDetails, p as PackageDimensions, P as PackageType, Q as QueryShippoConfigurationsRequest, L as QueryShippoConfigurationsResponse, a2 as RemoveDeliveryRegionRequest, Y as RestoreInfo, m as ServiceSettings, a8 as ShippoConfigurationsQueryResult, k as SortOrder, J as Sorting, r as StreetAddress, O as UpdateExtendedFieldsRequest, w as UpdateShippoConfigurationRequest, x as UpdateShippoConfigurationResponse, W as WebhookIdentityType } from './ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.js';
+import { ShippoConfiguration, CreateShippoConfigurationOptions, UpdateShippoConfiguration, ShippoConfigurationsQueryBuilder, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, AddDeliveryRegionOptions, AddDeliveryRegionResponse, RemoveDeliveryRegionIdentifiers, RemoveDeliveryRegionOptions, RemoveDeliveryRegionResponse, ShippoConfigurationCreatedEnvelope, ShippoConfigurationDeletedEnvelope, ShippoConfigurationUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, AddDeliveryRegionRequest, Address, AddressLocation, BaseEventMetadata, CalculationType, CreateShippoConfigurationRequest, CreateShippoConfigurationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteShippoConfigurationRequest, DeleteShippoConfigurationResponse, DomainEvent, DomainEventBodyOneOf, DomesticService, DomesticServiceSettings, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetShippoConfigurationRequest, GetShippoConfigurationResponse, HandlingFee, IdentificationData, IdentificationDataIdOneOf, InternationalService, InternationalServiceSettings, MessageEnvelope, PackageDetails, PackageDimensions, PackageType, QueryShippoConfigurationsRequest, QueryShippoConfigurationsResponse, RemoveDeliveryRegionRequest, RestoreInfo, ServiceSettings, ShippoConfigurationsQueryResult, SortOrder, Sorting, StreetAddress, UpdateExtendedFieldsRequest, UpdateShippoConfigurationRequest, UpdateShippoConfigurationResponse, WebhookIdentityType } from './index.typings.js';
 
 declare function createShippoConfiguration$1(httpClient: HttpClient): CreateShippoConfigurationSignature;
 interface CreateShippoConfigurationSignature {

package/build/cjs/{ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface ShippoConfiguration {
     /**
      * ShippoConfiguration ID.
@@ -612,18 +614,97 @@ interface ShippoConfigurationCreatedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a shipping option is created.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
 interface ShippoConfigurationDeletedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a shipping option is deleted.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
 interface ShippoConfigurationUpdatedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a shipping option is updated.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onShippoConfigurationUpdated(handler: (event: ShippoConfigurationUpdatedEnvelope) => void | Promise<void>): void;
+type ShippoConfigurationNonNullablePaths = `domesticServices` | `domesticServices.${number}.service` | `domesticServices.${number}.serviceSettings.handlingFee.value` | `domesticServices.${number}.serviceSettings.handlingFee.calculationType` | `internationalServices` | `internationalServices.${number}.service` | `internationalServices.${number}.serviceSettings.handlingFee.value` | `internationalServices.${number}.serviceSettings.handlingFee.calculationType` | `packageType` | `packageDetails.dimensions.length` | `packageDetails.dimensions.width` | `packageDetails.dimensions.height` | `shipFromAddress.streetAddress.number` | `shipFromAddress.streetAddress.name` | `deliveryRegionIds`;
+/**
+ * Creates a ShippoConfiguration.
+ * @param shippoConfiguration - ShippoConfiguration to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField shippoConfiguration
+ * @requiredField shippoConfiguration.deliveryRegionId
+ * @requiredField shippoConfiguration.osLocationId
+ * @requiredField shippoConfiguration.packageDetails
+ * @requiredField shippoConfiguration.packageDetails.dimensions.height
+ * @requiredField shippoConfiguration.packageDetails.dimensions.length
+ * @requiredField shippoConfiguration.packageDetails.dimensions.width
+ * @requiredField shippoConfiguration.packageType
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE
+ * @applicableIdentity APP
+ * @returns The created ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
+ */
+declare function createShippoConfiguration(shippoConfiguration: NonNullablePaths<ShippoConfiguration, `deliveryRegionId` | `osLocationId` | `packageDetails` | `packageDetails.dimensions.height` | `packageDetails.dimensions.length` | `packageDetails.dimensions.width` | `packageType`>, options?: CreateShippoConfigurationOptions): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
 interface CreateShippoConfigurationOptions {
     /** @decimalValue options { gte:0, maxScale:6 } */
     backupRate?: string | null;
 }
+/**
+ * Retrieves a ShippoConfiguration.
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField shippoConfigurationId
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @applicableIdentity APP
+ * @returns The requested ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
+ */
+declare function getShippoConfiguration(shippoConfigurationId: string): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
+/**
+ * Updates a ShippoConfiguration.
+ * @param _id - ShippoConfiguration ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField shippoConfiguration
+ * @requiredField shippoConfiguration.revision
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
+ */
+declare function updateShippoConfiguration(_id: string, shippoConfiguration: NonNullablePaths<UpdateShippoConfiguration, `revision`>): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
 interface UpdateShippoConfiguration {
     /**
      * ShippoConfiguration ID.
@@ -691,6 +772,33 @@ interface UpdateShippoConfiguration {
     /** Data extensions. */
     extendedFields?: ExtendedFields;
 }
+/**
+ * Deletes a ShippoConfiguration.
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField shippoConfigurationId
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
+ */
+declare function deleteShippoConfiguration(shippoConfigurationId: string): Promise<void>;
+/**
+ * Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
+ *
+ * Up to 1,000 ShippoConfigurations can be returned per request.
+ *
+ * To learn how to query ShippoConfigurations, see [API Query Language][2].
+ *
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @applicableIdentity APP
+ * @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
+ */
+declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -768,14 +876,61 @@ interface ShippoConfigurationsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ShippoConfigurationsQueryResult>;
 }
+/**
+ * Updates extended fields of a ShippoConfiguration without incrementing revision
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
+ */
+declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+    [P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
+}[ShippoConfigurationNonNullablePaths]>>;
 interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
 }
+/**
+ * Adds a delivery region to a Shippo configuration.
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to add the delivery region to.
+ * @param deliveryRegionId - ID of the delivery region to add.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField deliveryRegionId
+ * @requiredField shippoConfigurationId
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.delivery.v1.ShippoService.AddDeliveryRegion
+ */
+declare function addDeliveryRegion(shippoConfigurationId: string, deliveryRegionId: string, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
+    [P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
+}[ShippoConfigurationNonNullablePaths]>>;
 interface AddDeliveryRegionOptions {
     /** Revision of the ShippoConfiguration. */
     revision?: string | null;
 }
+/**
+ * Removes a delivery region from a Shippo configuration.
+ * When passing the ID of the only existing delivery region, removing it will delete the Shippo configuration.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.deliveryRegionId
+ * @requiredField identifiers.shippoConfigurationId
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.delivery.v1.ShippoService.RemoveDeliveryRegion
+ */
+declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryRegionId` | `shippoConfigurationId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
+    [P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
+}[ShippoConfigurationNonNullablePaths]>>;
 interface RemoveDeliveryRegionIdentifiers {
     /**
      * ID of the ShippoConfiguration to remove the delivery region from.
@@ -793,4 +948,4 @@ interface RemoveDeliveryRegionOptions {
     revision?: string | null;
 }
 
-export { type ActionEvent as $, type AddDeliveryRegionOptions as A, type CursorQuery as B, type CreateShippoConfigurationOptions as C, DomesticService as D, type ExtendedFields as E, type CursorQueryPagingMethodOneOf as F, type GetShippoConfigurationRequest as G, type HandlingFee as H, InternationalService as I, type Sorting as J, type CursorPaging as K, type QueryShippoConfigurationsResponse as L, type CursorPagingMetadata as M, type Cursors as N, type UpdateExtendedFieldsRequest as O, PackageType as P, type QueryShippoConfigurationsRequest as Q, type RemoveDeliveryRegionIdentifiers as R, type ShippoConfiguration as S, type DomainEvent as T, type UpdateShippoConfiguration as U, type DomainEventBodyOneOf as V, WebhookIdentityType as W, type EntityCreatedEvent as X, type RestoreInfo as Y, type EntityUpdatedEvent as Z, type EntityDeletedEvent as _, type ShippoConfigurationsQueryBuilder as a, type Empty as a0, type AddDeliveryRegionRequest as a1, type RemoveDeliveryRegionRequest as a2, type MessageEnvelope as a3, type IdentificationData as a4, type IdentificationDataIdOneOf as a5, type BaseEventMetadata as a6, type EventMetadata as a7, type ShippoConfigurationsQueryResult as a8, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, type AddDeliveryRegionResponse as d, type RemoveDeliveryRegionOptions as e, type RemoveDeliveryRegionResponse as f, type ShippoConfigurationCreatedEnvelope as g, type ShippoConfigurationDeletedEnvelope as h, type ShippoConfigurationUpdatedEnvelope as i, CalculationType as j, SortOrder as k, type DomesticServiceSettings as l, type ServiceSettings as m, type InternationalServiceSettings as n, type PackageDetails as o, type PackageDimensions as p, type Address as q, type StreetAddress as r, type AddressLocation as s, type CreateShippoConfigurationRequest as t, type CreateShippoConfigurationResponse as u, type GetShippoConfigurationResponse as v, type UpdateShippoConfigurationRequest as w, type UpdateShippoConfigurationResponse as x, type DeleteShippoConfigurationRequest as y, type DeleteShippoConfigurationResponse as z };
+export { type ActionEvent, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type Address, type AddressLocation, type BaseEventMetadata, CalculationType, type CalculationTypeWithLiterals, type CreateShippoConfigurationOptions, type CreateShippoConfigurationRequest, type CreateShippoConfigurationResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteShippoConfigurationRequest, type DeleteShippoConfigurationResponse, type DomainEvent, type DomainEventBodyOneOf, DomesticService, type DomesticServiceSettings, type DomesticServiceWithLiterals, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetShippoConfigurationRequest, type GetShippoConfigurationResponse, type HandlingFee, type IdentificationData, type IdentificationDataIdOneOf, InternationalService, type InternationalServiceSettings, type InternationalServiceWithLiterals, type MessageEnvelope, type PackageDetails, type PackageDimensions, PackageType, type PackageTypeWithLiterals, type QueryShippoConfigurationsRequest, type QueryShippoConfigurationsResponse, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RestoreInfo, type ServiceSettings, type ShippoConfiguration, type ShippoConfigurationCreatedEnvelope, type ShippoConfigurationDeletedEnvelope, type ShippoConfigurationUpdatedEnvelope, type ShippoConfigurationsQueryBuilder, type ShippoConfigurationsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, type StreetAddress, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateShippoConfiguration, type UpdateShippoConfigurationRequest, type UpdateShippoConfigurationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addDeliveryRegion, createShippoConfiguration, deleteShippoConfiguration, getShippoConfiguration, onShippoConfigurationCreated, onShippoConfigurationDeleted, onShippoConfigurationUpdated, queryShippoConfigurations, removeDeliveryRegion, updateExtendedFields, updateShippoConfiguration };