@wix/auto_sdk_ecom_shippo-configurations 1.0.9 → 1.0.11

package/build/{ecom-v1-shippo-configuration-shippo-configurations.universal-nw2-6NKP.d.ts → es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts}

@@ -1,4 +1,5 @@
-interface ShippoConfiguration {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface ShippoConfiguration {
     /**
      * ShippoConfiguration ID.
      * @format GUID
@@ -65,7 +66,7 @@ interface ShippoConfiguration {
     /** Data extensions. */
     extendedFields?: ExtendedFields;
 }
-interface DomesticServiceSettings {
+export interface DomesticServiceSettings {
     /**
      * DomesticServiceSettings ID.
      * @format GUID
@@ -77,13 +78,13 @@ interface DomesticServiceSettings {
     /** Service settings. */
     serviceSettings?: ServiceSettings;
 }
-declare enum DomesticService {
+export declare enum DomesticService {
     UNKNOWN_DOMESTIC_SERVICE = "UNKNOWN_DOMESTIC_SERVICE",
     GROUND_ADVANTAGE = "GROUND_ADVANTAGE",
     PRIORITY_MAIL = "PRIORITY_MAIL",
     PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS"
 }
-interface ServiceSettings {
+export interface ServiceSettings {
     /**
      * Estimated delivery time.
      * @maxLength 500
@@ -97,7 +98,7 @@ interface ServiceSettings {
      */
     freeDeliveryMinimumAmount?: string | null;
 }
-interface HandlingFee {
+export interface HandlingFee {
     /**
      * Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee.
      * @decimalValue options { gte:0, maxScale:4 }
@@ -106,12 +107,12 @@ interface HandlingFee {
     /** How to calculate the fee: fixed amount or by percentage. */
     calculationType?: CalculationType;
 }
-declare enum CalculationType {
+export declare enum CalculationType {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
     FIXED = "FIXED",
     PERCENTAGE = "PERCENTAGE"
 }
-interface InternationalServiceSettings {
+export interface InternationalServiceSettings {
     /**
      * InternationalServiceSettings ID.
      * @format GUID
@@ -123,13 +124,13 @@ interface InternationalServiceSettings {
     /** Service settings. */
     serviceSettings?: ServiceSettings;
 }
-declare enum InternationalService {
+export declare enum InternationalService {
     UNKNOWN_INTERNATIONAL_SERVICE = "UNKNOWN_INTERNATIONAL_SERVICE",
     FIRST_CLASS_PACKAGE_INTERNATIONAL = "FIRST_CLASS_PACKAGE_INTERNATIONAL",
     PRIORITY_MAIL_INTERNATIONAL = "PRIORITY_MAIL_INTERNATIONAL",
     PRIORITY_MAIL_EXPRESS_INTERNATIONAL = "PRIORITY_MAIL_EXPRESS_INTERNATIONAL"
 }
-declare enum PackageType {
+export declare enum PackageType {
     UNKNOWN_PACKAGE_TYPE = "UNKNOWN_PACKAGE_TYPE",
     CUSTOM = "CUSTOM",
     FLAT_RATE_ENVELOPE = "FLAT_RATE_ENVELOPE",
@@ -139,7 +140,7 @@ declare enum PackageType {
     MEDIUM_FLAT_RATE_BOX_2 = "MEDIUM_FLAT_RATE_BOX_2",
     LARGE_FLAT_RATE_BOX = "LARGE_FLAT_RATE_BOX"
 }
-interface PackageDetails {
+export interface PackageDetails {
     /**
      * Package name. Must be set when package type is CUSTOM.
      * For other package types, it is read-only, and an exception will be thrown
@@ -160,7 +161,7 @@ interface PackageDetails {
      */
     maxNumberOfProducts?: string | null;
 }
-interface PackageDimensions {
+export interface PackageDimensions {
     /**
      * Package length.
      * @decimalValue options { gte:0, maxScale:3 }
@@ -178,7 +179,7 @@ interface PackageDimensions {
     height?: string;
 }
 /** Physical address */
-interface Address {
+export interface Address {
     /**
      * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
      * @format COUNTRY
@@ -222,19 +223,19 @@ interface Address {
      */
     subdivisionFullname?: string | null;
 }
-interface StreetAddress {
+export interface StreetAddress {
     /** Street number. */
     number?: string;
     /** Street name. */
     name?: string;
 }
-interface AddressLocation {
+export interface AddressLocation {
     /** Address latitude. */
     latitude?: number | null;
     /** Address longitude. */
     longitude?: number | null;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -245,49 +246,49 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface CreateShippoConfigurationRequest {
+export interface CreateShippoConfigurationRequest {
     /** ShippoConfiguration to be created. */
     shippoConfiguration: ShippoConfiguration;
     /** @decimalValue options { gte:0, maxScale:6 } */
     backupRate?: string | null;
 }
-interface CreateShippoConfigurationResponse {
+export interface CreateShippoConfigurationResponse {
     /** The created ShippoConfiguration. */
     shippoConfiguration?: ShippoConfiguration;
 }
-interface GetShippoConfigurationRequest {
+export interface GetShippoConfigurationRequest {
     /**
      * ID of the ShippoConfiguration to retrieve.
      * @format GUID
      */
     shippoConfigurationId: string;
 }
-interface GetShippoConfigurationResponse {
+export interface GetShippoConfigurationResponse {
     /** The requested ShippoConfiguration. */
     shippoConfiguration?: ShippoConfiguration;
 }
-interface UpdateShippoConfigurationRequest {
+export interface UpdateShippoConfigurationRequest {
     /** ShippoConfiguration to be updated, may be partial. */
     shippoConfiguration: ShippoConfiguration;
 }
-interface UpdateShippoConfigurationResponse {
+export interface UpdateShippoConfigurationResponse {
     /** Updated ShippoConfiguration. */
     shippoConfiguration?: ShippoConfiguration;
 }
-interface DeleteShippoConfigurationRequest {
+export interface DeleteShippoConfigurationRequest {
     /**
      * ID of the ShippoConfiguration to delete.
      * @format GUID
      */
     shippoConfigurationId: string;
 }
-interface DeleteShippoConfigurationResponse {
+export interface DeleteShippoConfigurationResponse {
 }
-interface QueryShippoConfigurationsRequest {
+export interface QueryShippoConfigurationsRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
@@ -307,11 +308,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -320,11 +321,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -339,13 +340,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryShippoConfigurationsResponse {
+export interface QueryShippoConfigurationsResponse {
     /** List of ShippoConfigurations. */
     shippoConfigurations?: ShippoConfiguration[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -358,7 +359,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -370,7 +371,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface UpdateExtendedFieldsRequest {
+export interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
@@ -378,11 +379,11 @@ interface UpdateExtendedFieldsRequest {
     /** 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;
 }
-interface UpdateExtendedFieldsResponse {
+export interface UpdateExtendedFieldsResponse {
     /** Updated ShippoConfiguration. */
     shippoConfiguration?: ShippoConfiguration;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -425,19 +426,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -445,16 +446,16 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface Empty {
+export interface Empty {
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -470,7 +471,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -495,7 +496,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -517,14 +518,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -538,7 +539,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -576,23 +577,87 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface ShippoConfigurationCreatedEnvelope {
+export interface ShippoConfigurationCreatedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
-interface ShippoConfigurationDeletedEnvelope {
+/** @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_created
+ * @serviceIdentifier wix.ecom.delivery.v1.ShippoService
+ * @slug created
+ * @documentationMaturity preview
+ */
+export declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
+export interface ShippoConfigurationDeletedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
-interface ShippoConfigurationUpdatedEnvelope {
+/** @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_deleted
+ * @serviceIdentifier wix.ecom.delivery.v1.ShippoService
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+export declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
+export interface ShippoConfigurationUpdatedEnvelope {
     entity: ShippoConfiguration;
     metadata: EventMetadata;
 }
-interface CreateShippoConfigurationOptions {
+/** @webhook
+ * @eventType wix.ecom.v1.shippo_configuration_updated
+ * @serviceIdentifier wix.ecom.delivery.v1.ShippoService
+ * @slug updated
+ * @documentationMaturity preview
+ */
+export 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
+ * @returns The created ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
+ */
+export 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>>;
+export interface CreateShippoConfigurationOptions {
     /** @decimalValue options { gte:0, maxScale:6 } */
     backupRate?: string | null;
 }
-interface UpdateShippoConfiguration {
+/**
+ * Retrieves a ShippoConfiguration.
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField shippoConfigurationId
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
+ * @returns The requested ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
+ */
+export 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
+ * @returns Updated ShippoConfiguration.
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
+ */
+export declare function updateShippoConfiguration(_id: string, shippoConfiguration: NonNullablePaths<UpdateShippoConfiguration, `revision`>): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
+export interface UpdateShippoConfiguration {
     /**
      * ShippoConfiguration ID.
      * @format GUID
@@ -659,6 +724,31 @@ 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
+ * @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
+ */
+export 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
+ * @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
+ */
+export declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -666,13 +756,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface ShippoConfigurationsQueryResult extends QueryCursorResult {
+export interface ShippoConfigurationsQueryResult extends QueryCursorResult {
     items: ShippoConfiguration[];
     query: ShippoConfigurationsQueryBuilder;
     next: () => Promise<ShippoConfigurationsQueryResult>;
     prev: () => Promise<ShippoConfigurationsQueryResult>;
 }
-interface ShippoConfigurationsQueryBuilder {
+export interface ShippoConfigurationsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -716,9 +806,24 @@ interface ShippoConfigurationsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ShippoConfigurationsQueryResult>;
 }
-interface UpdateExtendedFieldsOptions {
+/**
+ * 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
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
+ */
+export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+    [P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
+}[ShippoConfigurationNonNullablePaths]>>;
+export 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;
 }
-
-export { type ShippoConfigurationDeletedEnvelope as $, type Address as A, type UpdateExtendedFieldsRequest as B, type CreateShippoConfigurationOptions as C, DomesticService as D, type ExtendedFields as E, type DomainEvent as F, type GetShippoConfigurationRequest as G, type HandlingFee as H, InternationalService as I, type DomainEventBodyOneOf as J, type EntityCreatedEvent as K, type EntityUpdatedEvent as L, type EntityDeletedEvent as M, type ActionEvent as N, type Empty as O, PackageType as P, type QueryShippoConfigurationsRequest as Q, type RestoreInfo as R, type ShippoConfiguration as S, type MessageEnvelope as T, type UpdateShippoConfiguration as U, type IdentificationData as V, WebhookIdentityType as W, type IdentificationDataIdOneOf as X, type BaseEventMetadata as Y, type EventMetadata as Z, type ShippoConfigurationCreatedEnvelope as _, type ShippoConfigurationsQueryBuilder as a, type ShippoConfigurationUpdatedEnvelope as a0, type ShippoConfigurationsQueryResult as a1, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, CalculationType as d, SortOrder as e, type DomesticServiceSettings as f, type ServiceSettings as g, type InternationalServiceSettings as h, type PackageDetails as i, type PackageDimensions as j, type StreetAddress as k, type AddressLocation as l, type CreateShippoConfigurationRequest as m, type CreateShippoConfigurationResponse as n, type GetShippoConfigurationResponse as o, type UpdateShippoConfigurationRequest as p, type UpdateShippoConfigurationResponse as q, type DeleteShippoConfigurationRequest as r, type DeleteShippoConfigurationResponse as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type QueryShippoConfigurationsResponse as x, type CursorPagingMetadata as y, type Cursors as z };
+export {};