@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/specification.proto

@@ -0,0 +1,91 @@
+syntax = "proto3";
+
+package wix.coupons.api.v2;
+
+import "google/protobuf/wrappers.proto";
+import "wix/coupons/api/v2/scope.proto";
+import "wix/api/validations.proto";
+
+option java_package = "com.wix.coupons.api.v2";
+
+// Coupon information
+message Specification {
+
+    // Name of coupon.
+    google.protobuf.StringValue name = 2;
+    /*
+    Coupon code. Must be unique for all coupons on your site.  
+
+    Max: 20 characters
+    */
+    google.protobuf.StringValue code = 3;
+    // Coupon valid from this date and time.
+    google.protobuf.Int64Value start_time = 4 [(.wix.api.min) = 1000000000000];
+    // Coupon expires at this date and time.
+    google.protobuf.Int64Value expiration_time = 5 [(.wix.api.min) = 1000000000000];
+    /* Maximum number of times the coupon can be used.
+
+    >**Note:** Multiple purchases by the same customer or purchases by different customers are both counted toward `usageLimit`.
+    */
+    google.protobuf.Int32Value usage_limit = 6; 
+    // Maximum number of times the coupon can be used per customer.
+    google.protobuf.Int32Value limit_per_customer = 20; 
+    /* Whether the coupon is limited to one item.  
+
+    If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item. 
+    Coupons with a `bookings` `scope.namespace` are always limited to one item.
+    */
+    google.protobuf.BoolValue limited_to_one_item = 18; 
+    // Whether the coupon applies to subscription products.
+    google.protobuf.BoolValue applies_to_subscriptions = 21; 
+    /* 
+    Specifies the amount of discounted cycles for a subscription item.  
+    
+    Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`. 
+    If `discountedCycleCount` is empty, the coupon applies to all available cycles.  
+
+    Min: `1`  
+    Max: `999`
+    */
+    google.protobuf.Int32Value discounted_cycle_count = 22;
+    /*
+    Whether the coupon is currently [active](https://support.wix.com/en/article/wix-stores-activating-and-deactivating-coupons).  
+
+    Default: `true`
+    */
+    google.protobuf.BoolValue active = 8;
+    oneof ScopeOrMinSubtotal {
+        Scope scope = 16; // Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).
+        google.protobuf.DoubleValue minimum_subtotal = 17; // Limit the coupon to carts with a subtotal above this number.
+    }
+
+    // Coupon type.
+    message BuyXGetY { 
+        // Number of purchased items required to receive free items.
+        int32 x = 1; 
+        // Number of items received for free if required number of items were purchased.
+        int32 y = 2; 
+    }
+    oneof Behavior {
+        double money_off_amount = 11; // Discount as a fixed amount.
+        double percent_off_rate = 12; // Discount as a percentage.
+        /*
+        Free shipping.  
+        
+        If `true`, the coupon applies to all items in all `namespaces`.
+        */
+        bool free_shipping = 13;
+        double fixed_price_amount = 14; // Fixed sale price.
+        /*
+        Receive free products when making a purchase.  
+
+        For example, purchase `x` number of products and receive `y` number of products for free.
+        */
+        BuyXGetY buy_x_get_y = 15;
+    }
+
+    string type = 19; // Coupon type. Read-only.
+}
+
+
+

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

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package wix.fedinfra.exportservice.v1;
+option java_package = "com.wixpress.fedinfra.exportservice.v1";
+import "wix/common/paging.proto";
+
+import "wix/catalog/api/v1/product.proto";
+import "wix/catalog/api/v1/variant.proto";
+
+message QueryVariantsExportSpiResponse {
+  repeated ProductOrVariant items = 1;
+  .wix.common.PagingMetadataV2 paging_metadata = 2;
+}
+
+message ProductOrVariant {
+  string kind = 1;
+  .wix.catalog.api.v1.Product product = 2;
+  .wix.catalog.api.v1.StoreVariant variant = 3;
+}
+
+message QueryProductsExportSpiResponse {
+  repeated ProductOrVariantV2 items = 1;
+  .wix.common.PagingMetadataV2 paging_metadata = 2;
+}
+
+message ProductOrVariantV2 {
+  string kind = 1;
+  .wix.catalog.api.v1.Product product = 2;
+  .wix.catalog.api.v1.Variant variant = 3;
+}

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

@@ -0,0 +1,96 @@
+syntax = "proto3";
+
+package wix.fedinfra.exportservice.v1;
+option java_package = "com.wixpress.fedinfra.exportservice.v1";
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/infra/asyncjobs/v1/AsyncJob.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/common/query.proto";
+import "wix/common/paging.proto";
+import "wix/api/api_errors.proto";
+import "wix/api/errors.proto";
+import "wix/fedinfra/exportservicespi/v1/export_query_v2.proto";
+
+message ExportAsyncJob {
+  option (wix.api.entity) = {
+    fqdn: "wix.fedinfra.exportservice.v1.export_async_job"
+    segment: USERS
+  };
+
+  string id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  ExportAsyncJobData data = 3;
+
+  .wix.infra.asyncjobs.v1.AsyncJob.Status status = 4;
+
+  google.protobuf.Timestamp create_date = 6 [(wix.api.readOnly) = true];
+  google.protobuf.Timestamp update_date = 7 [(wix.api.readOnly) = true];
+}
+
+enum ArrayFieldDelimiter {
+  SEMICOLON = 0;
+  SEMICOLON_AND_SPACE = 1;
+}
+
+message ExportAsyncJobData {
+  // original request data for the export
+  .wix.fedinfra.exportservicespi.v1.ExportQueryV2 query = 1; // WQL expression
+  repeated FieldDescriptor fields = 2; // translated CSV headers
+  ArrayFieldDelimiter array_field_delimiter = 18;
+  MethodMetadata method_metadata = 3; // The target method to query data from
+  MethodSpec method_spec = 4; // Custom spec for the target method's request/response
+
+  string user_id = 14;
+  .google.protobuf.StringValue sub_dir = 15;
+
+  string format = 6;
+  string upload_id = 7;
+  .google.protobuf.StringValue save_as = 13 [(.wix.api.maxLength) = 255];
+
+  // the progress of fetching all data update during the process multiple times
+  .wix.common.PagingMetadataV2 paging_metadata = 8;
+  int32 iterations_count = 9;
+  int32 processed_items_count = 16;
+  .google.protobuf.StringValue completion_step = 17;
+  int32 reset_count = 10;
+
+  // at final step update the signed_url to download the result from
+  string signed_url = 11;
+  // when failed during the process update the error details
+  .wix.api.Details error = 12;
+
+  .google.protobuf.Struct test_params = 20;
+}
+
+message FieldDescriptor {
+  string id = 1; // the path to the field out of the query response items
+  string header = 2; // how to present the filed in the CSV headers (translated)
+}
+
+message MethodMetadata {
+  string artifact = 1;
+  string service = 2;
+  string method = 3;
+}
+
+message MethodSpec {
+  QueryFieldNumber request_query_field_number = 1;
+  .google.protobuf.StringValue response_repeated_field_name = 2;
+  .google.protobuf.StringValue response_paging_metadata_field_name = 3;
+
+  enum QueryFieldNumber {
+    DEFAULT = 0; // message QuerySomethingRequest { .wix.common.QueryV2 query = 1; }
+    FIELD_2 = 2;
+    FIELD_3 = 3;
+    FIELD_4 = 4;
+    FIELD_5 = 5;
+    FIELD_6 = 6;
+    FIELD_7 = 7;
+    FIELD_8 = 8; // message QuerySomethingRequest { .wix.common.QueryV2 query = 8; }
+    FIELD_9 = 9;
+  }
+}

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

@@ -0,0 +1,145 @@
+syntax = "proto3";
+
+package wix.fedinfra.exportservice.v1;
+option java_package = "com.wixpress.fedinfra.exportservice.v1";
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/field_mask.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/common/query.proto";
+import "wix/fedinfra/exportservicespi/v1/export_service_spi.proto";
+import "wix/fedinfra/exportservicespi/v1/export_query_v2.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/callback.proto";
+import "wix/http/field_mask.proto";
+import "wix/fedinfra/exportservice/v1/export.proto";
+import "wix/fedinfra/exportservice/v1/catalog.proto";
+import "wix/common/paging.proto";
+import "wix/api/api_errors.proto";
+
+/**
+  Manages Exports
+ */
+service ExportService {
+  option (.wix.api.service_maturity) = ALPHA;
+  option (.wix.api.service_exposure) = PRIVATE;
+  option (.wix.api.service_entity).message = "wix.fedinfra.exportservice.v1.ExportAsyncJob";
+
+  /**
+    Creates a new Export
+   */
+  rpc CreateExportAsyncJob (CreateExportAsyncJobRequest) returns (CreateExportAsyncJobResponse) {
+    option (google.api.http).post = "/v1/export-async-job";
+    //    option (.wix.api.permission).name = "FAKE_DOMAIN_CHANGE_ME.EXPORT_READ";
+    option (.wix.api.required) = "CreateExportAsyncJobRequest.method_metadata";
+    option (.wix.api.required) = "CreateExportAsyncJobRequest.fields";
+    option (.wix.api.required) = "CreateExportAsyncJobRequest.query";
+    option (.wix.api.required) = "CreateExportAsyncJobRequest.query.pagingMethod";
+
+    option (wix.api.error) = {
+      http_code: NOT_FOUND
+      application_code: "method_endpoint_not_found"
+    };
+  }
+
+  /**
+    Get a Export by id
+   */
+  rpc GetExportAsyncJob (GetExportAsyncJobRequest) returns (GetExportAsyncJobResponse) {
+    option (google.api.http).get = "/v1/export-async-job/{job_id}";
+    //    option (.wix.api.permission).name = "FAKE_DOMAIN_CHANGE_ME.EXPORT_READ";
+    option (.wix.api.required) = "GetExportAsyncJobRequest.job_id";
+
+    option (wix.api.error) = {
+      http_code: NOT_FOUND
+      application_code: "job_not_found"
+    };
+
+    option (wix.api.error) = {
+      http_code: INTERNAL
+      application_code: "get_async_job_internal"
+    };
+
+    option (wix.api.error) = {
+      http_code: PERMISSION_DENIED
+      application_code: "method_endpoint_permission_denied"
+    };
+  }
+
+  rpc CancelExportAsyncJob (CancelExportAsyncJobRequest) returns (CancelExportAsyncJobResponse) {
+    option (google.api.http).put = "/v1/export-async-job/{job_id}/cancel";
+    option (.wix.api.required) = "CancelExportAsyncJobRequest.job_id";
+  }
+
+  rpc GenerateExportAsyncJobDownloadUrl (GenerateExportAsyncJobDownloadUrlRequest) returns (GenerateExportAsyncJobDownloadUrlResponse) {
+    option (google.api.http).put = "/v1/export-async-job/{job_id}/generate-download-url";
+    option (.wix.api.required) = "GenerateExportAsyncJobDownloadUrlRequest.job_id";
+  }
+
+  rpc QueryVariantsExportSpi (.wix.fedinfra.exportservicespi.v1.QueryRequestLoose) returns (QueryVariantsExportSpiResponse) {
+    option (.wix.api.required) = "QueryRequestLoose.query.pagingMethod.cursorPaging";
+  }
+
+  rpc QueryProductsExportSpi (.wix.fedinfra.exportservicespi.v1.QueryRequestLoose) returns (QueryProductsExportSpiResponse) {
+    option (wix.api.error) = {
+      http_code: NOT_FOUND
+      application_code: "query_products_test_not_found"
+    };
+
+    option (wix.api.error) = {
+      http_code: INTERNAL
+      application_code: "query_products_test_internal"
+    };
+  }
+}
+
+message CreateExportAsyncJobRequest {
+  .wix.fedinfra.exportservicespi.v1.ExportQueryV2 query = 1; // WQL expression
+  repeated FieldDescriptor fields = 2; // translated CSV headers
+  ArrayFieldDelimiter array_field_delimiter = 6;
+  MethodMetadata method_metadata = 3; // The target method to query data from
+  MethodSpec method_spec = 4; // The target method to query data from
+  .google.protobuf.StringValue save_as = 5 [(.wix.api.maxLength) = 255];
+  .google.protobuf.Struct test_params = 10; // Test params
+}
+
+message CreateExportAsyncJobRequestCompat {
+  .wix.common.QueryV2 query = 1; // WQL expression
+  repeated FieldDescriptor fields = 2; // translated CSV headers
+  MethodMetadata method_metadata = 3; // The target method to query data from
+  MethodSpec method_spec = 4; // The target method to query data from
+  .google.protobuf.StringValue save_as = 5 [(.wix.api.maxLength) = 255];
+  .google.protobuf.Struct test_params = 10; // Test params
+}
+
+message CreateExportAsyncJobResponse {
+  ExportAsyncJob job = 1; // The retrieved Exports
+}
+
+message GetExportAsyncJobRequest {
+  string job_id = 1 [(.wix.api.format) = GUID]; // Id of the Export to retrieve
+}
+
+message GetExportAsyncJobResponse {
+  ExportAsyncJob job = 1; // The retrieved ExportAsyncJob
+}
+
+message CancelExportAsyncJobRequest {
+  string job_id = 1 [(.wix.api.format) = GUID]; // Id of the Export to retrieve
+}
+
+message CancelExportAsyncJobResponse {
+  ExportAsyncJob job = 1; // The retrieved ExportAsyncJob
+}
+
+message GenerateExportAsyncJobDownloadUrlRequest {
+  string job_id = 1 [(.wix.api.format) = GUID]; // Id of the Export to retrieve
+}
+
+message GenerateExportAsyncJobDownloadUrlResponse {
+  ExportAsyncJob job = 1; // The retrieved ExportAsyncJob
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservicespi/v1/export_query_v2.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/paging.proto";
+import "wix/common/sorting.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+package wix.fedinfra.exportservicespi.v1;
+
+message ExportQueryV2 {
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "filter"
+    field: "sort"
+    field: "paging"
+  };
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "filter"
+    field: "sort"
+    field: "cursorPaging"
+  };
+  //Filter object in the following format:
+  //`"filter" : {
+  //              "fieldName1": "value1",
+  //              "fieldName2":{"$operator":"value2"}
+  //  }`
+  //Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+  google.protobuf.Struct filter = 1;
+  //Sort object in the following format:
+  //`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+  repeated .wix.common.Sorting sort = 2;
+  //Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+  repeated string fields = 4;
+  //Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+  repeated string fieldsets = 5;
+  oneof pagingMethod {
+    //Paging options to limit and skip the number of items.
+    .wix.common.Paging paging = 3;
+    //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`.
+    ExportCursorPaging cursorPaging = 6;
+  }
+}
+
+message ExportCursorPaging {
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "limit"
+    field: "cursor"
+  };
+
+  google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0, (.wix.api.max) = 10000];
+  google.protobuf.StringValue cursor = 2;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservicespi/v1/export_service_spi.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+import "wix/common/query.proto";
+import "wix/common/paging.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/fedinfra/exportservicespi/v1/export_query_v2.proto";
+
+package wix.fedinfra.exportservicespi.v1;
+
+message QueryRequestLoose {
+  ExportQueryV2 query = 1; // WQL expression
+}
+
+message QueryRequestLoose2 {
+  ExportQueryV2 query = 2;
+}
+
+message QueryRequestLoose3 {
+  ExportQueryV2 query = 3;
+}
+
+message QueryRequestLoose4 {
+  ExportQueryV2 query = 4;
+}
+
+message QueryRequestLoose5 {
+  ExportQueryV2 query = 5;
+}
+
+message QueryRequestLoose6 {
+  ExportQueryV2 query = 6;
+}
+
+message QueryRequestLoose7 {
+  ExportQueryV2 query = 7;
+}
+
+message QueryRequestLoose8 {
+  ExportQueryV2 query = 8;
+}
+
+message QueryRequestLoose9 {
+  ExportQueryV2 query = 9;
+}
+
+//message QueryResponse {
+//  repeated Message items = 1;
+//  .wix.common.PagingMetadataV2 paging_metadata = 2;
+//}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/graphql/definitions.proto

@@ -0,0 +1,13 @@
+syntax = "proto2";
+
+package wix.graphql;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "GraphqlProto";
+option java_package = "com.wix.graphql";
+
+extend google.protobuf.FileOptions {
+  optional string namespace = 66000;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/http/field_mask.proto

@@ -0,0 +1,46 @@
+syntax = "proto2";
+
+package wix.http;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "FieldmaskProto";
+option java_package = "com.wix.http";
+
+/*
+When (most commonly) update endpoint accepts FieldMask object, from REST client perspective it is redundant and 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. E.g.
+```
+import "wix/http/field_mask.proto";
+
+rpc UpdateProduct (UpdateProductRequest) returns (UpdateProductResponse) {
+  option (google.api.http) = {
+    PATCH: "/v1/products/{product.id}
+  };
+  option (wix.http.infer_fieldmask) = {
+    from: "product"
+    fieldmask: "mask"
+  };
+}
+
+message UpdateProductRequest {
+  Product product = 1;
+  google.protobuf.FieldMask mask = 2;
+}
+```
+*/
+extend google.protobuf.FieldOptions {
+  optional string infer_fieldmask_from = 50901 [deprecated=true];
+}
+
+extend google.protobuf.MethodOptions {
+  optional InferFieldmask infer_fieldmask = 50902;
+}
+
+message InferFieldmask {
+  required string from = 1; // ref to field on which we want to infer
+  required string fieldmask = 2; // ref to actual fieldmask member
+  optional bool snake_case_comma_separated_mask = 3; // recase comma-separated field mask to snake_case (legacy behavior)
+}

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

@@ -0,0 +1,79 @@
+//flynt-disable missing-permission, missing-service-entity, missing-field-comments, missing-method-comments, request-response, missing-rest-mapping, missing-main-entity-fqdn
+syntax = "proto3";
+
+package wix.infra.asyncjobs.v1;
+option java_package = "com.wixpress.infra.asyncinfra.asyncjobservice.v1";
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+
+
+message AsyncJob {
+    option (wix.api.entity) = {
+        fqdn: "wix.infra.asyncjobs.v1.async_job",
+        segment: USERS
+    };
+
+    // Unique identifier of the job
+    string id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+    // Optional job metadata, used to store any parameters used during job execution, user-define statuses, etc.
+    google.protobuf.Struct metadata = 2;
+
+    // The current stage of job execution.
+    Status status = 3;
+
+    // The current counters.
+    Counters counters = 5;
+
+    google.protobuf.Timestamp created_date = 6 [(wix.api.readOnly) = true];
+
+    google.protobuf.Timestamp updated_date = 7 [(wix.api.readOnly) = true];
+
+    Owner owner = 8 [(wix.api.readOnly) = true];
+
+    enum Status {
+        UNKNOWN = 0;
+        // Job was created, but not started yet.
+        INITIALIZED = 1;
+        // Job has started and is in progress.
+        PROCESSING = 2;
+        // Job is finished.
+        FINISHED = 3;
+        // Job is failed
+        FAILED = 4;
+    }
+
+    message Counters {
+        // Optional count of the dataset size, specified during job creation. Can be used for progress bars, etc.
+        google.protobuf.Int32Value items_to_process = 1;
+
+        // Amount of items that were successfully processed.
+        int32 items_succeeded = 2;
+
+        // Amount of items whose processing failed.
+        int32 items_failed = 3;
+
+        // A mapping between an error code and the number of failures associated with it
+        map<string, int32> error_count_by_code = 4;
+    }
+
+    message Owner {
+        oneof id {
+            // ID of a site visitor that has not logged in to the site.
+            string anonymous_visitor_id = 2 [(.wix.api.format) = GUID];
+            // ID of a site visitor that has logged in to the site.
+            string member_id = 3 [(.wix.api.format) = GUID, (.wix.api.referenced_entity) = "wix.members.v1.member"];
+            // ID of a Wix user (site owner, contributor, etc.).
+            string wix_user_id = 4 [(.wix.api.format) = GUID];
+            // ID of an app.
+            string app_id = 5 [(.wix.api.format) = GUID];
+        }
+    }
+
+}

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

@@ -0,0 +1,34 @@
+//flynt-disable missing-permission, missing-service-entity, missing-field-comments, missing-method-comments, request-response, missing-rest-mapping, missing-main-entity-fqdn
+syntax = "proto3";
+
+package wix.infra.asyncjobs.v1;
+option java_package = "com.wixpress.infra.asyncinfra.asyncjobservice.v1";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+
+import "wix/api/validations.proto";
+import "wix/api/errors.proto";
+import "wix/api/entity.proto";
+
+
+message AsyncJobItem {
+    option (wix.api.entity) = {
+        fqdn: "wix.infra.asyncjobs.v1.async_job_item",
+        segment: USERS
+    };
+
+    string id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+    // Used to optionally return result of the job (e.g., S3 link to the generated CSV file).
+    google.protobuf.Struct data = 2;
+
+    // The optional id of the job entity id being processed.
+    google.protobuf.StringValue entity_id = 3 [(wix.api.minLength) = 1, (wix.api.maxLength) = 32, (wix.api.immutable) = true];
+
+    // Convenience property, signifies absence of errors.
+    bool success = 4 [(wix.api.readOnly) = true];
+
+    // Error which prevented item from being processed.
+    wix.api.ApplicationError error = 5 [(wix.api.immutable) = true];
+}