@wix/auto_sdk_ecom_shipping-options 1.0.4 → 1.0.6

package/build/{es/src/ecom-v1-shipping-option-shipping-options.universal.d.ts → ecom-v1-shipping-option-shipping-options.universal-BURLQHsn.d.mts}

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface ShippingOption {
+interface ShippingOption {
     /**
      * ShippingOption ID.
      * @format GUID
@@ -57,7 +56,7 @@ export interface ShippingOption {
     /** Data Extensions */
     extendedFields?: ExtendedFields;
 }
-export interface ConditionalRates {
+interface ConditionalRates {
     /**
      * there is an AND logic between all the conditions. Empty conditions means true.
      * For example: weight > 0 and weight <= 10
@@ -72,7 +71,7 @@ export interface ConditionalRates {
     /** When this flag is set to true, multiply the amount by the number of line items passed on the request. */
     multiplyByQuantity?: boolean;
 }
-export interface Condition {
+interface Condition {
     type?: ConditionType;
     /**
      * The value in respective to the condition type
@@ -84,13 +83,13 @@ export interface Condition {
     value?: string;
     operator?: LogicalOperator;
 }
-export declare enum ConditionType {
+declare enum ConditionType {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
     BY_TOTAL_WEIGHT = "BY_TOTAL_WEIGHT",
     BY_TOTAL_PRICE = "BY_TOTAL_PRICE",
     BY_TOTAL_QUANTITY = "BY_TOTAL_QUANTITY"
 }
-export declare enum LogicalOperator {
+declare enum LogicalOperator {
     UNKNOWN_LOGICAL_OPERATOR_TYPE = "UNKNOWN_LOGICAL_OPERATOR_TYPE",
     EQ = "EQ",
     GT = "GT",
@@ -98,7 +97,7 @@ export declare enum LogicalOperator {
     LT = "LT",
     LTE = "LTE"
 }
-export interface ExtendedFields {
+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.
@@ -109,47 +108,47 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface CreateShippingOptionRequest {
+interface CreateShippingOptionRequest {
     /** ShippingOption to be created. */
     shippingOption: ShippingOption;
 }
-export interface CreateShippingOptionResponse {
+interface CreateShippingOptionResponse {
     /** The created ShippingOption. */
     shippingOption?: ShippingOption;
 }
-export interface GetShippingOptionRequest {
+interface GetShippingOptionRequest {
     /**
      * ID of the ShippingOption to retrieve.
      * @format GUID
      */
     shippingOptionId: string;
 }
-export interface GetShippingOptionResponse {
+interface GetShippingOptionResponse {
     /** The requested ShippingOption. */
     shippingOption?: ShippingOption;
 }
-export interface UpdateShippingOptionRequest {
+interface UpdateShippingOptionRequest {
     /** ShippingOption to be updated, may be partial. */
     shippingOption: ShippingOption;
 }
-export interface UpdateShippingOptionResponse {
+interface UpdateShippingOptionResponse {
     /** Updated ShippingOption. */
     shippingOption?: ShippingOption;
 }
-export interface DeleteShippingOptionRequest {
+interface DeleteShippingOptionRequest {
     /**
      * Id of the ShippingOption to delete.
      * @format GUID
      */
     shippingOptionId: string;
 }
-export interface DeleteShippingOptionResponse {
+interface DeleteShippingOptionResponse {
 }
-export interface QueryShippingOptionsRequest {
+interface QueryShippingOptionsRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -169,11 +168,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -182,11 +181,11 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -201,13 +200,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryShippingOptionsResponse {
+interface QueryShippingOptionsResponse {
     /** List of ShippingOptions. */
     shippingOptions?: ShippingOption[];
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -220,7 +219,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -232,7 +231,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface UpdateExtendedFieldsRequest {
+interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
@@ -240,11 +239,11 @@ export 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;
 }
-export interface UpdateExtendedFieldsResponse {
+interface UpdateExtendedFieldsResponse {
     /** Updated ShippingOption. */
     shippingOption?: ShippingOption;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -287,19 +286,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -307,16 +306,16 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -332,7 +331,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -357,7 +356,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -379,76 +378,14 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-type ShippingOptionNonNullablePaths = `deliveryRegionId` | `deliveryRegionIds` | `rates` | `rates.${number}.conditions` | `rates.${number}.conditions.${number}.type` | `rates.${number}.conditions.${number}.value` | `rates.${number}.conditions.${number}.operator` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity`;
-/**
- * Creates a ShippingOption.
- *
- * The request body must include shipping option and delivery region associated to.
- * @param shippingOption - ShippingOption to be created.
- * @public
- * @documentationMaturity preview
- * @requiredField shippingOption
- * @permissionId ECOM.SHIPPING_OPTION_CREATE
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @applicableIdentity APP
- * @returns The created ShippingOption.
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.CreateShippingOption
- */
-export declare function createShippingOption(shippingOption: ShippingOption): Promise<NonNullablePaths<ShippingOption, ShippingOptionNonNullablePaths>>;
-/**
- * Retrieves a ShippingOption.
- * @param shippingOptionId - ID of the ShippingOption to retrieve.
- * @public
- * @documentationMaturity preview
- * @requiredField shippingOptionId
- * @permissionId ECOM.SHIPPING_OPTION_READ
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @applicableIdentity APP
- * @returns The requested ShippingOption.
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.GetShippingOption
- */
-export declare function getShippingOption(shippingOptionId: string): Promise<NonNullablePaths<ShippingOption, ShippingOptionNonNullablePaths>>;
-/**
- * Updates a ShippingOption.
- *
- *
- * Each time the ShippingOption is updated,
- * `revision` increments by 1.
- * The current `revision` must be passed when updating the ShippingOption.
- * This ensures you're working with the latest ShippingOption
- * and prevents unintended overwrites.
- * @param _id - ShippingOption ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField shippingOption
- * @requiredField shippingOption.revision
- * @permissionId ECOM.SHIPPING_OPTION_UPDATE
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @applicableIdentity APP
- * @returns Updated ShippingOption.
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.UpdateShippingOption
- */
-export declare function updateShippingOption(_id: string, shippingOption: NonNullablePaths<UpdateShippingOption, `revision`>): Promise<NonNullablePaths<ShippingOption, ShippingOptionNonNullablePaths>>;
-export interface UpdateShippingOption {
+interface UpdateShippingOption {
     /**
      * ShippingOption ID.
      * @format GUID
@@ -506,44 +443,6 @@ export interface UpdateShippingOption {
     /** Data Extensions */
     extendedFields?: ExtendedFields;
 }
-/**
- * Deletes a ShippingOption.
- * Deleting a ShippingOption permanently removes them from the ShippingOption List.
- * @param shippingOptionId - Id of the ShippingOption to delete.
- * @public
- * @documentationMaturity preview
- * @requiredField shippingOptionId
- * @permissionId ECOM.SHIPPING_OPTION_DELETE
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @applicableIdentity APP
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.DeleteShippingOption
- */
-export declare function deleteShippingOption(shippingOptionId: string): Promise<void>;
-/**
- * Retrieves a list of ShippingOptions, given the provided [paging, filtering, and sorting][1].
- *
- * Up to 1,000 ShippingOptions can be returned per request.
- *
- * To learn how to query ShippingOptions, 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionId ECOM.SHIPPING_OPTION_READ
- * @applicableIdentity APP
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.QueryShippingOptions
- */
-export declare function queryShippingOptions(): ShippingOptionsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -551,13 +450,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface ShippingOptionsQueryResult extends QueryCursorResult {
+interface ShippingOptionsQueryResult extends QueryCursorResult {
     items: ShippingOption[];
     query: ShippingOptionsQueryBuilder;
     next: () => Promise<ShippingOptionsQueryResult>;
     prev: () => Promise<ShippingOptionsQueryResult>;
 }
-export interface ShippingOptionsQueryBuilder {
+interface ShippingOptionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -606,29 +505,9 @@ export interface ShippingOptionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ShippingOptionsQueryResult>;
 }
-/**
- * Updates extended fields of a ShippingOption 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.SHIPPING_OPTION_UPDATE
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @applicableIdentity APP
- * @fqn wix.ecom.delivery.v1.ShippingOptionService.UpdateExtendedFields
- */
-export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
-    [P in ShippingOptionNonNullablePaths]: `shippingOption.${P}`;
-}[ShippingOptionNonNullablePaths]>>;
-export interface UpdateExtendedFieldsOptions {
+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 {};
+
+export { type ActionEvent as A, type IdentificationDataIdOneOf as B, ConditionType as C, type DeleteShippingOptionRequest as D, type ExtendedFields as E, type ShippingOptionsQueryResult as F, type GetShippingOptionRequest as G, type IdentificationData as I, LogicalOperator as L, type MessageEnvelope as M, type QueryShippingOptionsRequest as Q, type RestoreInfo as R, type ShippingOption as S, type UpdateShippingOption as U, WebhookIdentityType as W, type ShippingOptionsQueryBuilder as a, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, SortOrder as d, type ConditionalRates as e, type Condition as f, type CreateShippingOptionRequest as g, type CreateShippingOptionResponse as h, type GetShippingOptionResponse as i, type UpdateShippingOptionRequest as j, type UpdateShippingOptionResponse as k, type DeleteShippingOptionResponse as l, type CursorQuery as m, type CursorQueryPagingMethodOneOf as n, type Sorting as o, type CursorPaging as p, type QueryShippingOptionsResponse as q, type CursorPagingMetadata as r, type Cursors as s, type UpdateExtendedFieldsRequest as t, type DomainEvent as u, type DomainEventBodyOneOf as v, type EntityCreatedEvent as w, type EntityUpdatedEvent as x, type EntityDeletedEvent as y, type Empty as z };