@wix/bex-utils 2.15.0 → 2.17.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/infra/asyncjobs/v1/AsyncJobService.proto

@@ -41,7 +41,7 @@ service AsyncJobService {
     payload: "wix.infra.asyncjobs.v1.AsyncJobItemFailedEvent"
   };
 
-  // Create new async job.
+  // Creates an async job.
   rpc CreateAsyncJob (CreateAsyncJobRequest) returns (CreateAsyncJobResponse) {
 
     option (.wix.api.crud) = {
@@ -70,7 +70,7 @@ service AsyncJobService {
     option (wix.api.required) = "CreateAsyncJobRequest.job";
   }
 
-  // Get the job by id.
+  // Retrieves a job.
   rpc GetAsyncJob (GetAsyncJobRequest) returns (GetAsyncJobResponse) {
 
     option (.wix.api.crud) = {
@@ -95,7 +95,7 @@ service AsyncJobService {
     option (wix.api.required) = "GetAsyncJobRequest.job_id";
   }
 
-  // Update the job.
+  // Updates a job.
   rpc UpdateAsyncJob (UpdateAsyncJobRequest) returns (UpdateAsyncJobResponse) {
 
     option (.wix.api.crud) = {
@@ -128,7 +128,7 @@ service AsyncJobService {
     };
   }
 
-  // Delete the job.
+  // Deletes a job.
   rpc DeleteAsyncJob (DeleteAsyncJobRequest) returns (DeleteAsyncJobResponse) {
 
     option (.wix.api.crud) = {
@@ -155,7 +155,7 @@ service AsyncJobService {
     option (wix.api.required) = "DeleteAsyncJobRequest.job_id";
   }
 
-  // Complete the job.
+  // Completes a job.
   rpc CompleteAsyncJob (CompleteAsyncJobRequest) returns (CompleteAsyncJobResponse) {
     option (google.api.http) = {
       put: "/v1/async-jobs/{job_id}/complete"
@@ -171,7 +171,7 @@ service AsyncJobService {
     option (wix.api.required) = "CompleteAsyncJobRequest.job_id";
   }
 
-  // report job progress.
+  // Reports job progress.
   rpc ReportAsyncJobProgress (ReportAsyncJobProgressRequest) returns (ReportAsyncJobProgressResponse) {
     option (google.api.http) = {
       post: "/v1/async-jobs/{job_id}/items/report"
@@ -193,7 +193,7 @@ service AsyncJobService {
     option (wix.api.required) = "ReportAsyncJobProgressRequest.job_id";
   }
 
-  // List the job items.
+  // Retrieves a list of jobs.
   rpc ListAsyncJobItems (ListAsyncJobItemsRequest) returns (ListAsyncJobItemsResponse) {
     option (google.api.http) = {
       get: "/v1/async-jobs/{job_id}/items"
@@ -208,40 +208,40 @@ service AsyncJobService {
 
 }
 message CreateAsyncJobRequest {
-  // the job being created.
+  // Job to create.
   AsyncJob job = 1;
 }
 
 message CreateAsyncJobResponse {
-  // the job created.
+  // Created job.
   AsyncJob job = 1;
 }
 
 message GetAsyncJobRequest {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
 }
 
 message GetAsyncJobResponse {
-  // the job returned.
+  // Returned job.
   AsyncJob job = 1;
 }
 
 
 message UpdateAsyncJobRequest {
-  // the job being updated.
+  // Job to update.
   AsyncJob job = 1;
-  // the mask.
+  // Field mask.
   google.protobuf.FieldMask mask = 2;
 }
 
 message UpdateAsyncJobResponse {
-  // the job updated.
+  // Updated job.
   AsyncJob job = 1;
 }
 
 message DeleteAsyncJobRequest {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
 }
 
@@ -250,46 +250,61 @@ message DeleteAsyncJobResponse {
 
 
 message ReportAsyncJobProgressRequest {
-  // id of the job to report progress on
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
 
-  // the job items being reported.
+  // Job items being reported.
   repeated AsyncJobItem items = 2 [(wix.api.maxSize) = 1000];
 }
 
 message ReportAsyncJobProgressResponse {}
 
 message ListAsyncJobItemsRequest {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
-  // the paging.
+  // Pagination options.
   wix.common.CursorPaging paging = 2;
   /*
-    when true, only failed items will be returned.
+    Whether to return only failed items. 
     when false, only successful items will be returned.
     when not set, all both failed and successful will be returned.
    */
-  google.protobuf.BoolValue has_error = 3;
+  google.protobuf.BoolValue has_error = 3 [(wix.api.field_exposure) = INTERNAL,
+    deprecated = true, (wix.api.field_deprecated) = {
+    replaced_by: "wix.infra.asyncjobs.v1.ListAsyncJobItemsRequest.status_filter"
+    target_removal_date: "2024-12-12",
+  }];
+  // async job item status filter.
+  StatusFilter status_filter = 4;
+
+  enum StatusFilter {
+    // return all items.
+    ALL = 0;
+    // return only failed items.
+    FAILED_ONLY = 1;
+    // return only successful items.
+    SUCCESSFUL_ONLY = 2;
+  }
 }
 
 message ListAsyncJobItemsResponse {
-  // the job items.
+  // Job items.
   repeated AsyncJobItem results = 1;
-  // paging metadata.
+  // Paging metadata.
   wix.infra.asyncjobs.v1.upstream.wix.common.PagingMetadataV2 paging_metadata = 2;
 }
 
 
 message CompleteAsyncJobRequest {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
-  // the job status.
+  // Job status.
   CompleteStatus status = 2;
 
   enum CompleteStatus {
     // Job is finished.
     FINISHED = 0; // default behaviour
-    // Job is failed
+    // Job is failed.
     FAILED = 1;
   }
 }
@@ -298,26 +313,26 @@ message CompleteAsyncJobResponse {}
 
 // Events
 message AsyncJobFinishedEvent {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
 }
 
 message AsyncJobFailedEvent {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
 }
 
 message AsyncJobItemAddedEvent {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
-  // the job items.
+  // Job items.
   AsyncJobItem job_item = 2;
 }
 
 message AsyncJobItemFailedEvent {
-  // the job id.
+  // Job ID.
   string job_id = 1 [(wix.api.format) = GUID];
-  // the job items.
+  // Job items.
   AsyncJobItem job_item = 2;
 }
 

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/inventory/api/v1/locationInventory.proto

@@ -27,6 +27,17 @@ service LocationInventoryReadApi {
     option (.wix.api.permission).name = "WIX_STORES.READ_INVENTORY";
   }
 
+  /**
+   * Returns an inventory item for all locations.
+   * Does not include the online-store non-location.
+   */
+  rpc FetchLocationInventoryItemsForAllLocations (FetchLocationInventoryItemsForAllLocationsRequest) returns (FetchLocationInventoryItemsForAllLocationsResponse) {
+    option (.google.api.http).get = "/v2/location-inventory-items/products";
+    option (.wix.api.maturity) = ALPHA;
+    option (.wix.api.exposure) = INTERNAL;
+    option (.wix.api.permission).name = "WIX_STORES.READ_INVENTORY";
+  }
+
   /**
    * Returns a list of location inventory items, given the provided paging, sorting and filtering.
    * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/inventory/api/v1/locationInventoryMessages.proto

@@ -35,6 +35,24 @@ message FetchLocationInventoryItemResponse {
 
 }
 
+message FetchLocationInventoryItemsForAllLocationsRequest {
+  // The ID of the product which we're retrieving inventory item for
+  repeated string product_ids = 1 [
+    (.wix.api.immutable) = true,
+    (.wix.api.minLength) = 1,
+    (.wix.api.maxLength) = 36,
+    (.wix.api.maxSize) = 100,
+    (.wix.api.referenced_entity) = "wix.stores.catalog.v1.product"
+  ];
+}
+
+message FetchLocationInventoryItemsForAllLocationsResponse {
+
+  // The inventory item at the location
+  repeated LocationInventoryItem location_inventory_items = 1 [(.wix.api.maxSize) = 100];
+
+}
+
 message QueryLocationInventoryRequest {
   /**
    * Query to match inventory records against catalog product records.

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/stores_location.proto

@@ -9,8 +9,10 @@ import "wix/api/annotations.proto";
 import "google/protobuf/wrappers.proto";
 import "google/protobuf/timestamp.proto";
 
+/**
+  A location is a physical or virtual site where products are sold.
+ */
 message StoresLocation {
-
   option (wix.api.entity) = {
     fqdn: "wix.stores.catalog.v3.stores_location"
     app_def_id: "215238eb-22a5-4c36-9e7b-e7c08025e04e"
@@ -29,35 +31,38 @@ message StoresLocation {
     segment: PUBLIC
   };
 
-  // StoresLocation ID.
+  // Stores location ID.
   google.protobuf.StringValue id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
 
   /**
-  Revision number, which increments by 1 each time the StoresLocation is updated.
+  Revision number, which increments by 1 each time the Stores location is updated.
   To prevent conflicting changes,
-  the current revision must be passed when updating the StoresLocation.
+  the current revision must be passed when updating the Stores location.
 
-  Ignored when creating a StoresLocation.
-   */
+  Ignored when creating a Stores location.
+  */
   google.protobuf.Int64Value revision = 2 [(wix.api.readOnly) = true];
 
-  // Date and time the StoresLocation was created.
+  // Date and time the Stores location was created.
   google.protobuf.Timestamp created_date = 3 [(wix.api.readOnly) = true];
 
-  // Date and time the StoresLocation was last updated.
+  // Date and time the Stores location was last updated.
   google.protobuf.Timestamp updated_date = 4 [(wix.api.readOnly) = true];
 
   // Wix location ID.
   // Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
-  google.protobuf.StringValue wix_location_id = 5 [(.wix.api.format) = GUID, (.wix.api.immutable) = true, (.wix.api.referenced_entity) = "com.wixpress.locations.Location"];
+  google.protobuf.StringValue wix_location_id = 5 [(.wix.api.format) = GUID, (.wix.api.immutable) = true, (.wix.api.referenced_entity) = "wix.locations.v1.location"];
 
-  // Indicates if the location is a physical site or virtual online store
+  // Location type.
+  //
+  // + `VIRTUAL`: Online store.
+  // + `PHYSICAL`: Physical location. For example, for POS.
   LocationType location_type = 6 [(.wix.api.readOnly) = true];
 
-  // Materialized display name of the location.
+  // Stores location name.
   string name = 7 [(.wix.api.readOnly) = true, (wix.api.minLength) = 1, (wix.api.maxLength) = 150];
 
-  // Whether the InventoryLocation is the default location.
+  // Whether the location is the site's default location.
   bool default_location = 8;
 
   enum LocationType {

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/stores_location_service.proto

@@ -25,7 +25,7 @@ import "wix/api/api_errors.proto";
   Manages StoresLocations
  */
 service StoresLocationService {
-  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_maturity) = BETA;
   option (wix.api.service_exposure) = PUBLIC;
   option (wix.api.service_entity).message = "wix.stores.catalog.location.v3.StoresLocation";
   option (.wix.api.event) = {
@@ -36,10 +36,7 @@ service StoresLocationService {
   };
 
   /**
-    Creates a StoresLocation.
-
-    The request body must include os_location_id of a corresponding site location:
-     https://bo.wix.com/wix-docs/rest/business-tools/locations/introduction
+    Creates a Stores location.
    */
   rpc CreateStoresLocation (CreateStoresLocationRequest) returns (CreateStoresLocationResponse) {
     option (google.api.http).post = "/v3/locations";
@@ -53,7 +50,7 @@ service StoresLocationService {
         item_field: "stores_location"
       }
     };
-    // Triggered when a stores location is created.
+    // Triggered when a Stores location is created.
     option (wix.api.callback) = {
       event_type: CREATED
       permission: "WIX_STORES.STORES_LOCATION_READ"
@@ -65,7 +62,7 @@ service StoresLocationService {
   }
 
   /**
-    Retrieves a StoresLocation.
+    Retrieves a Stores location.
    */
   rpc GetStoresLocation (GetStoresLocationRequest) returns (GetStoresLocationResponse) {
     option (google.api.http).get = "/v3/locations/{stores_location_id}";
@@ -80,12 +77,11 @@ service StoresLocationService {
   }
 
   /**
-    Updates a StoresLocation.
-    Each time the StoresLocation is updated,
-    `revision` increments by 1.
-    The current `revision` must be passed when updating the StoresLocation.
-    This ensures you're working with the latest StoresLocation
-    and prevents unintended overwrites.
+    Updates a Stores location.
+
+    Each time the Stores location is updated, `revision` increments by 1.
+    The current `revision` must be passed when updating the Stores location.
+    This ensures you're working with the latest Stores location and prevents unintended overwrites.
  */
   rpc UpdateStoresLocation (UpdateStoresLocationRequest) returns (UpdateStoresLocationResponse) {
     option (google.api.http).patch = "/v3/locations/{stores_location.id}";
@@ -94,19 +90,12 @@ service StoresLocationService {
     option (wix.api.required) = "UpdateStoresLocationRequest.stores_location.id";
     option (wix.api.required) = "UpdateStoresLocationRequest.stores_location.revision";
     option (wix.api.exposure) = PRIVATE;
-    // Triggered when a stores location is updated.
+    // Triggered when a Stores location is updated.
     option (wix.api.callback) = {
       event_type: UPDATED
       permission: "WIX_STORES.STORES_LOCATION_READ"
     };
-    /**
-    (explanation)
-    Update endpoint usually accepts FieldMask object. From REST client perspective it is redundant as it can be inferred
-    from the actual JSON payload that was sent. This field annotation will tell the framework to use the JSON body and
-    automatically construct the fieldmask.
-    Refer to [AIP 4006 - Update Endpoints][1] to learn more about update endpoint and why we prefer patch over put.
-    [1]: https://dev.wix.com/docs/rnd-general/articles/p-13-n-guidelines-ai-ps/guidance-ai-ps/standard-methods/4006-update
-     */
+
     option (wix.http.infer_fieldmask) = {
       from: "stores_location"
       fieldmask: "field_mask"
@@ -121,17 +110,14 @@ service StoresLocationService {
   }
 
   /**
-    Deletes a StoresLocation.
-
-
-    Deleting a StoresLocation permanently removes them from the StoresLocation List.
+    Deletes a Stores location.
    */
   rpc DeleteStoresLocation (DeleteStoresLocationRequest) returns (DeleteStoresLocationResponse) {
     option (google.api.http).delete = "/v3/locations/{stores_location_id}";
     option (wix.api.permission).name = "WIX_STORES.STORES_LOCATION_DELETE";
     option (wix.api.required) = "DeleteStoresLocationRequest.stores_location_id";
     option (wix.api.exposure) = PRIVATE;
-    // Triggered when a stores location is deleted.
+    // Triggered when a Stores location is deleted.
     option (wix.api.callback) = {
       event_type: DELETED
       permission: "WIX_STORES.STORES_LOCATION_READ"
@@ -157,6 +143,24 @@ service StoresLocationService {
 
     Notice, not all sits locations will be fetched, only the ones that are assigned as inventory locations
    */
+
+  /**
+  Retrieves a list of up to 100 Stores locations, given the provided filtering, sorting, and cursor paging.
+  Pass supported values to the `fields` array in the request to include those fields in the response.
+
+
+  Query Stores Locations runs with these defaults, which you can override:
+
+  - `createdDate` is sorted in `DESC` order
+  - `cursorPaging.limit` is `100`
+
+  For field support for filters and sorting,
+  see [Stores Locations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/stores-locations-v3/supported-filters-and-sorting).
+
+  To learn about working with _Query_ endpoints, see
+  [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
+  and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+  */
   rpc QueryStoresLocations (QueryStoresLocationsRequest) returns (QueryStoresLocationsResponse) {
     option (google.api.http).post = "/v3/locations/query";
     option (wix.api.permission).name = "WIX_STORES.STORES_LOCATION_READ";
@@ -164,20 +168,6 @@ service StoresLocationService {
       method: QUERY
       query_options: {
         items_field: 'stores_locations'
-        /**
-        (explanation)
-
-        Unlike other CRUD methods, Query allows to declare capabilities spec, e.g. what type of filters and sorting are
-        possible with the API.
-
-        By default, nothing is supported. This means that you have to explicitly spec what is supported by each field
-        (whitelist). The reasoning behind this verbosity is to be future-compatible, e.g., avoid the case when the query
-        language expands and new capabilities are assumed to be supported when in actuality they are not.
-
-        Refer to the [ADR 6: API CRUD Annotations][1] to learn more about WQL annotations.
-
-        [1]: https://bo.wix.com/wix-docs/server-guild/adrs/server-infra-adrs/adr-005-fieldmask-in-method-level#adrs_server-infra-adrs_adr-006-crud-annotations_adr-6-api-crud-annotations
-         */
         wql: {
           pattern: {
             field: "id"
@@ -233,36 +223,27 @@ Retrieves the default inventory location, or creates it if it doesn't exist.
 }
 
 message CreateStoresLocationRequest {
-  // StoresLocation to be created.
+  // Stores location to create.
   StoresLocation stores_location = 1;
 }
 
 message CreateStoresLocationResponse {
-  // The created StoresLocation.
+  // Created Stores location.
   StoresLocation stores_location = 1;
 }
 
 message GetStoresLocationRequest {
-  /**
-  (explanation)
-
-  Each field may contain various validations. Refer to [AIP 3004 - Field Validations][1] to learn about available
-  validations like `maxLength` and `format`.
-
-  [1]: https://dev.wix.com/docs/rnd-general/articles/p-13-n-guidelines-ai-ps/guidance-ai-ps/validations/3004-field-validations
-  */
-
-  // ID of the StoresLocation to retrieve.
+  // Stores location ID.
   string stores_location_id = 1 [(wix.api.format) = GUID];
 }
 
 message GetStoresLocationResponse {
-  // The requested StoresLocation.
+  // Stores location.
   StoresLocation stores_location = 1;
 }
 
 message UpdateStoresLocationRequest {
-  // StoresLocation to be updated, may be partial.
+  // Stores location to update.
   StoresLocation stores_location = 1;
 
   /*
@@ -274,12 +255,12 @@ message UpdateStoresLocationRequest {
 }
 
 message UpdateStoresLocationResponse {
-  // Updated StoresLocation.
+  // Updated Stores location.
   StoresLocation stores_location = 1;
 }
 
 message DeleteStoresLocationRequest {
-  // Id of the StoresLocation to delete.
+  // Stores location ID.
   string stores_location_id = 1 [(wix.api.format) = GUID];
 }
 
@@ -287,15 +268,15 @@ message DeleteStoresLocationResponse {
 }
 
 message QueryStoresLocationsRequest {
-  // WQL expression.
+  // Query options.
   wix.stores.catalog.location.v3.upstream.wix.query.CursorQuery query = 1;
 }
 
 message QueryStoresLocationsResponse {
-  // List of StoresLocations.
+  // List of Stores locations.
   repeated StoresLocation stores_locations = 1 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 100];
 
-  // Paging metadata
+  // Details on the paged set of results returned.
   wix.stores.catalog.location.v3.upstream.wix.common.CursorPagingMetadata paging_metadata = 2;
 }
 
@@ -303,6 +284,6 @@ message GetOrCreateDefaultStoresLocationRequest {
 }
 
 message GetOrCreateDefaultStoresLocationResponse {
-  // The default StoresLocations.
+  // Default Stores location.
   StoresLocation stores_location = 1;
-}
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/location/v3/upstream/wix/common/paging.proto

@@ -53,9 +53,12 @@ message PagingMetadata {
     google.protobuf.Int32Value total = 3;
     // Flag that indicates the server failed to calculate the `total` field.
     google.protobuf.BoolValue too_many_to_count = 4;
-    // Indicates if there are more results after the current page.
-    // If `true`, another page of results can be retrieved.
-    // If `false`, this is the last page.
+    /*
+    Whether there are more pages to retrieve following the current page.
+
+    + `true`: Another page of results can be retrieved.
+    + `false`: This is the last page.
+    */
     google.protobuf.BoolValue has_next = 5 [(.wix.api.field_exposure) = PRIVATE];
 }
 
@@ -79,9 +82,12 @@ message PagingMetadataV2 {
     google.protobuf.BoolValue too_many_to_count = 4;
     // Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.
     Cursors cursors = 5;
-    // Indicates if there are more results after the current page.
-    // If `true`, another page of results can be retrieved.
-    // If `false`, this is the last page.
+    /*
+    Whether there are more pages to retrieve following the current page.
+
+    + `true`: Another page of results can be retrieved.
+    + `false`: This is the last page.
+    */
     google.protobuf.BoolValue has_next = 6 [(.wix.api.field_exposure) = PRIVATE];
 }
 
@@ -94,9 +100,12 @@ message CursorPagingMetadata {
     google.protobuf.Int32Value count = 1;
     // Offset that was requested.
     Cursors cursors = 2;
-    // Indicates if there are more results after the current page.
-    // If `true`, another page of results can be retrieved.
-    // If `false`, this is the last page.
+    /*
+    Whether there are more pages to retrieve following the current page.
+
+    + `true`: Another page of results can be retrieved.
+    + `false`: This is the last page.
+    */
     google.protobuf.BoolValue has_next = 3;
 }
 

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/stores/catalog/provision/v1/provision.proto

@@ -11,12 +11,13 @@ import "wix/api/annotations.proto";
 
 
 /**
-  A Provision is a record that contains the version of the catalog a store was installed on.
+  Provision contains the version of the catalog a store was installed on.
   Only one Provision entity can exist per tenant. Retrieving a provision is managed completely by
   callScope, no api parameters are needed.
 
   Services should only use this service if they are part of the install flow.
  */
+
 message Provision {
   /**
   (explanation)