@wix/bex-utils 2.38.0 → 2.39.0

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

@@ -1,484 +0,0 @@
-//flynt-disable invalid-id-name
-syntax = "proto3";
-
-package com.wixpress.locations;
-
-import "google/protobuf/wrappers.proto";
-import "google/protobuf/empty.proto";
-import "google/api/annotations.proto";
-import "wix/api/annotations.proto";
-import "wix/api/validations.proto";
-import "wix/http/field_mask.proto";
-import "wix/common/query.proto";
-import "wix/common/sorting.proto";
-import "wix/common/paging.proto";
-import "wix/api/callback.proto";
-import "wix/api/action_payload.proto";
-import "wix/api/entity.proto";
-import "com/wixpress/locations/location.proto";
-import "com/wixpress/locations/pagination.proto";
-import "wix/api/subscription.proto";
-import "wix/api/permissions.proto";
-import "wix/api/api_errors.proto";
-
-service LocationsService {
-    option (wix.api.service_entity).message = "com.wixpress.locations.Location";
-    option (.wix.api.service_maturity) = BETA;
-    option (.wix.api.service_exposure) = PUBLIC;
-
-    /*
-    Creates a location.
-    */
-    rpc CreateLocation (CreateLocationRequest) returns (CreateLocationResponse) {
-        option (google.api.http).post = "/v1/locations";
-        option (wix.api.required) = "CreateLocationRequest.location";
-        option (wix.api.required) = "CreateLocationRequest.location.name";
-        option (wix.api.required) = "CreateLocationRequest.location.address";
-        option (wix.api.required) = "CreateLocationRequest.location.time_zone";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: CREATED
-            permission: "LOCATIONS.MANAGE"
-        };
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"
-        };
-        option (.wix.api.crud) = {
-            method: CREATE
-            create_options: {
-                item_field: "location"
-            }
-        };
-    }
-
-    /*
-    Creates locations in bulk.
-    */
-    rpc BulkCreateLocation (BulkCreateLocationRequest) returns (BulkCreateLocationResponse) {
-        option (google.api.http).post = "/v1/locations/bulk-create";
-        option (wix.api.required) = "BulkCreateLocationRequest.locations";
-        option (wix.api.maturity) = ALPHA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: CREATED
-            permission: "LOCATIONS.MANAGE"
-        };
-        option (.wix.api.crud) = {
-            method: BULK_CREATE
-            bulk_create_options: {
-                item_field: "locations"
-            }
-        };
-    }
-
-    /*
-    Retrieves a location.
-    */
-    rpc GetLocation (GetLocationRequest) returns (GetLocationResponse) {
-        option (google.api.http).get = "/v1/locations/{id}";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.required) = "GetLocationRequest.id";
-        option (wix.api.permission).name = "LOCATIONS.READ";
-        option (.wix.api.crud) = {
-            method: GET_ITEM
-            get_options: {
-                id_field: "id"
-                item_field: "location"
-            }
-        };
-    }
-
-    /*
-    Retrieves locations, given the provided filters, sorting, and paging.
-    */
-    rpc ListLocations (ListLocationsRequest) returns (ListLocationsResponse) {
-        option (google.api.http).get = "/v1/locations";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.READ";
-        option (.wix.api.crud) = {
-            method: LIST
-            list_options: {
-                items_field: "locations"
-                paging: {
-                    type: OFFSET
-                    paging_metadata_field: "paging_metadata"
-                }
-            }
-        };
-    }
-
-    /*
-    Replaces a location.
-
-
-    > **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.
-
-    */
-    rpc UpdateLocation (UpdateLocationRequest) returns (UpdateLocationResponse) {
-        option (google.api.http).put = "/v1/locations/{location.id}";
-        option (wix.api.required) = "UpdateLocationRequest.location";
-        option (wix.api.required) = "UpdateLocationRequest.location.id";
-        option (wix.api.required) = "UpdateLocationRequest.location.name";
-        option (wix.api.required) = "UpdateLocationRequest.location.address";
-        option (wix.api.required) = "UpdateLocationRequest.location.time_zone";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: UPDATED
-            permission: "LOCATIONS.MANAGE"
-        };
-
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"
-        };
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_ARCHIVE_DEFAULT"
-        };
-        option (.wix.api.error) = {
-            http_code: NOT_FOUND
-            application_code: "LOCATION_NOT_FOUND"
-        };
-        option (.wix.api.crud) = {
-            method: UPDATE
-            update_options: {
-                item_field: "location"
-            }
-        };
-    }
-
-    /*
-    Replaces locations in bulk.
-
-
-    > **Note:** Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.
-    */
-    rpc BulkUpdateLocation (BulkUpdateLocationRequest) returns (BulkUpdateLocationResponse) {
-        option (google.api.http).put = "/v1/locations/bulk-update";
-        option (wix.api.exposure) = PRIVATE;
-        option (wix.api.required) = "BulkUpdateLocationRequest.locations";
-        option (wix.api.maturity) = ALPHA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: UPDATED
-            permission: "LOCATIONS.MANAGE"
-        };
-        option (.wix.api.crud) = {
-            method: BULK_UPDATE
-            bulk_update_options: {
-                item_field: "locations"
-            }
-        };
-    }
-
-    /*
-    Retrieves locations, given the provided filters, sorting, and paging.
-    */
-    rpc QueryLocations (QueryLocationsRequest) returns (QueryLocationsResponse) {
-        option (google.api.http).post = "/v1/locations/query";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.READ";
-        option (.wix.api.crud) = {
-            method: QUERY
-            query_options: {
-                query_field: "query"
-                items_field: "locations"
-                paging: {
-                    type: OFFSET
-                    paging_metadata_field: "paging_metadata"
-                }
-                wql: {
-                    pattern: {
-                        operator: ALL_APPLICABLE_OPERATORS
-                        field: "id"
-                        field: "name"
-                        field: "description"
-                        field: "default"
-                        field: "status"
-                        field: "location_type"
-                        field: "fax"
-                        field: "time_zone"
-                        field: "email"
-                        field: "phone"
-                        field: "address.country"
-                        field: "address.subdivision"
-                        field: "address.city"
-                        field: "address.postal_code"
-                        field: "address.street_address.number"
-                        field: "address.street_address.name"
-                        field: "address.street_address.apt"
-                        field: "address.formatted_address"
-                        field: "address.hint"
-                        field: "address.geocode.latitude"
-                        field: "address.geocode.longitude"
-                        field: "business_schedule.periods.open_day"
-                        field: "business_schedule.periods.open_time"
-                        field: "business_schedule.periods.close_day"
-                        field: "business_schedule.periods.close_time"
-                        field: "business_schedule.special_hour_period.start_date"
-                        field: "business_schedule.special_hour_period.end_date"
-                        field: "business_schedule.special_hour_period.is_closed"
-                        field: "business_schedule.special_hour_period.comment"
-                        field: "revision"
-                        field: "archived"
-                    }
-                }
-            }
-        };
-    }
-
-    /*
-    Sets a new default location.
-
-
-    > **Notes:**
-    > + There can only be one default location per site.
-    > + The default location can't be archived.
-    */
-    rpc SetDefaultLocation (SetDefaultLocationRequest) returns (SetDefaultLocationResponse) {
-        option (google.api.http).post = "/v1/locations/{id}/set-default";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (.wix.api.required) = "SetDefaultLocationRequest.id";
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: ACTION
-            permission: "LOCATIONS.MANAGE"
-            payload: "com.wixpress.locations.SetDefaultLocation"
-        };
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_PERFORM_ACTION_ON_ARCHIVED_LOCATION"
-        };
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "DEFAULT_NOT_CHANGED"
-        };
-    }
-
-    /*
-    Archives a location.
-
-
-    > **Notes:**
-    > + Changes the `archived` boolean of a location to `true`.
-    > + You can't change a location's `status` using this endpoint.
-    > + Archived locations can't be updated.
-    > + Currently, it isn't possible to unarchive locations.
-    > + The `default` location can't be archived.
-    */
-    rpc ArchiveLocation (ArchiveLocationRequest) returns (ArchiveLocationResponse) {
-        option (google.api.http).post = "/v1/locations/{id}/archive";
-        option (wix.api.exposure) = PUBLIC;
-        option (wix.api.maturity) = BETA;
-        option (.wix.api.required) = "ArchiveLocationRequest.id";
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: ACTION
-            permission: "LOCATIONS.MANAGE"
-            payload: "com.wixpress.locations.ArchiveLocation"
-        };
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_ARCHIVE_DEFAULT"
-        };
-    }
-
-    rpc AddLocationType (AddLocationTypeRequest) returns (AddLocationTypeResponse) {
-        option (google.api.http).patch = "/v1/locations/{id}/add-location-type";
-        option (wix.api.required) = "AddLocationTypeRequest.id";
-        option (wix.api.required) = "AddLocationTypeRequest.location_type";
-        option (wix.api.exposure) = INTERNAL;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: UPDATED
-            permission: "LOCATIONS.MANAGE"
-        };
-
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_UPDATE_LOCATION_TYPES_FOR_LOCATION"
-        };
-    }
-
-    rpc RemoveLocationType (RemoveLocationTypeRequest) returns (RemoveLocationTypeResponse) {
-        option (google.api.http).patch = "/v1/locations/{id}/remove-location-type";
-        option (wix.api.required) = "RemoveLocationTypeRequest.id";
-        option (wix.api.required) = "RemoveLocationTypeRequest.location_type";
-        option (wix.api.exposure) = INTERNAL;
-        option (wix.api.maturity) = BETA;
-        option (wix.api.permission).name = "LOCATIONS.MANAGE";
-        option (wix.api.callback) = {
-            event_type: UPDATED
-            permission: "LOCATIONS.MANAGE"
-        };
-
-        option (.wix.api.error) = {
-            http_code: INVALID_ARGUMENT
-            application_code: "CANNOT_UPDATE_LOCATION_TYPES_FOR_LOCATION"
-        };
-    }
-}
-
-message CreateLocationRequest {
-    // Location to create.
-    Location location = 1;
-}
-
-message CreateLocationResponse {
-    // Created location.
-    Location location = 1;
-}
-
-message BulkCreateLocationRequest {
-    // Locations to create.
-    repeated Location locations = 1 [(wix.api.minSize) = 1, (wix.api.maxSize) = 10];
-}
-
-message BulkCreateLocationResponse {
-    // Locations that were created.
-    repeated Location successful_locations = 1;
-    // Locations that failed.
-    repeated FailedCreateLocation failed_locations = 2;
-}
-
-message FailedCreateLocation {
-    // Location that couldn't be created.
-    Location location = 1;
-    // Error message.
-    string error_message = 2;
-}
-
-message GetLocationRequest {
-    // ID of the location to retrieve.
-    string id = 1 [(wix.api.format) = GUID];
-}
-
-message GetLocationResponse {
-    // Retrieved location.
-    Location location = 1;
-}
-
-message ListLocationsRequest {
-    // Sort order.
-    wix.common.Sorting sort = 1;
-    // Pagination.
-    //
-    // Default values:
-    // `offset`: 0
-    // `limit`: 50 (Max: 1000) 
-    wix.common.Paging paging = 2;
-    // Whether to include `archived` locations in the response. 
-    //
-    //Default: `false`
-    bool include_archived = 3;
-}
-
-message ListLocationsResponse {
-    // Retrieved locations.
-    repeated Location locations = 1;
-    // Paging info.
-    PagingMetadata paging_metadata = 2;
-}
-
-message UpdateLocationRequest {
-    // Location to update.
-    Location location = 1;
-}
-
-message UpdateLocationResponse {
-    // Updated location.
-    Location location = 1;
-}
-
-message BulkUpdateLocationRequest {
-    // Locations to update.
-    repeated Location locations = 1 [(wix.api.minSize) = 1, (wix.api.maxSize) = 10];
-}
-
-message BulkUpdateLocationResponse {
-    // Locations that were updated.
-    repeated Location successful_locations = 1;
-    // Locations that failed.
-    repeated FailedUpdateLocation failed_locations = 2;
-}
-
-message FailedUpdateLocation {
-    // Location that couldn't be updated.
-    string id = 1;
-    // Error message.
-    string error_message = 2;
-}
-
-message QueryLocationsRequest {
-    // Information about the filters, sorting, and paging.
-    wix.common.Query query = 1;
-}
-
-message QueryLocationsResponse {
-    // Retrieved locations.
-    repeated Location locations = 1;
-    // Paging info.
-    PagingMetadata paging_metadata = 2;
-}
-
-message SetDefaultLocationRequest {
-    // ID of the location to set as the default location.
-    string id = 1 [(.wix.api.format) = GUID];
-}
-
-message SetDefaultLocationResponse {
-    // New default location.
-    Location location = 1;
-}
-
-message SetDefaultLocation {
-    option (wix.api.action_payload).custom_slug = "set_default_location";
-
-    // Previous default location id.
-    string prev_default_location_id = 1 [(wix.api.format) = GUID];
-    // Current default location id.
-    string curr_default_location_id = 2 [(wix.api.format) = GUID];
-}
-
-message ArchiveLocationRequest {
-    // ID of the location to archive.
-    string id = 1 [(.wix.api.format) = GUID];
-}
-
-message ArchiveLocationResponse {
-    // Archived location.
-    Location location = 1;
-}
-
-message ArchiveLocation {
-    option (wix.api.action_payload).custom_slug = "archive_status";
-    string id = 1 [(.wix.api.format) = GUID];
-}
-
-message AddLocationTypeRequest {
-    string id = 1 [(.wix.api.format) = GUID]; // Location id to add type
-    LocationType location_type = 2;
-}
-
-message AddLocationTypeResponse {
-    Location location = 1; // Full location with the new type
-}
-
-message RemoveLocationTypeRequest {
-    string id = 1 [(.wix.api.format) = GUID]; // Location id to add type
-    LocationType location_type = 2;
-}
-
-message RemoveLocationTypeResponse {
-    Location location = 1; // Full location with the new type
-}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wixpress/locations/messaging-service.proto

@@ -1,32 +0,0 @@
-syntax = "proto3";
-
-package com.wixpress.locations;
-import "com/wixpress/siteproperties/api/v4/properties.proto";
-import "com/wixpress/siteproperties/api/v4/notifications.proto";
-import "com/wixpress/metasite/event/api/special.proto";
-import "wix/api/subscription.proto";
-import "wix/api/annotations.proto";
-import "google/protobuf/empty.proto";
-import "wix/common/domainevents/domainevents.proto";
-
-service LocationsMessagingService {
-    option (.wix.api.service_exposure) = PRIVATE;
-    /*
-    Consume and handle SiteProperties Notification kafka messages
-    */
-    rpc HandleSitePropertiesNotification (com.wixpress.siteproperties.api.v4.SitePropertiesNotification) returns (google.protobuf.Empty) {
-        option (wix.api.subscription) = {
-            topic: "site-properties.changes.v4"
-        };
-    }
-    /*
-    Consume and handle SitePropertiesV5 domain events
-     */
-    rpc ConsumeSitePropertiesV5DomainEvents (wix.common.domainevents.DomainEvent) returns (google.protobuf.Empty) {
-        option (wix.api.exposure) = PRIVATE;
-        option (wix.api.subscription) = {
-            entity: ".wix.site.properties.v5.Properties"
-        };
-    }
-
-}

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

@@ -1,22 +0,0 @@
-syntax = "proto3";
-
-package com.wixpress.locations;
-
-option java_multiple_files = true;
-option java_package = "com.wixpress.locations";
-
-import "google/protobuf/wrappers.proto";
-import "wix/api/annotations.proto";
-import "wix/api/validations.proto";
-
-message PagingMetadata {
-    option (.wix.api.decomposite_of) = "wix.common.PagingMetadata";
-    // Number of items returned in the response.
-    google.protobuf.Int32Value count = 1;
-    // Offset that was requested.
-    google.protobuf.Int32Value offset = 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.
-    google.protobuf.BoolValue has_next = 5;
-}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wixpress/siteproperties/api/v4/notifications.proto

@@ -1,89 +0,0 @@
-syntax = "proto3";
-
-package com.wixpress.siteproperties.api.v4;
-
-import "com/wixpress/siteproperties/api/v4/properties.proto";
-import "google/protobuf/field_mask.proto";
-import "google/protobuf/wrappers.proto";
-import "wix/api/validations.proto";
-
-// A single mapping from the MetaSite ID to a particular service.
-message Translation {
-    string service_type = 1; // The service type.
-    string app_def_id = 2; // The application definition ID; this only applies to services of type ThirdPartyApps.
-    string instance_id = 3; // The instance ID of the service.
-}
-
-enum NotificationContext {
-    PROPERTIES_UPDATE = 0;
-    SITE_CREATED = 1;
-    SITE_CLONED = 2;
-}
-
-message ChangeContext {
-    oneof payload {
-        PropertiesChange properties_change = 1; // Properties were updated.
-        SiteCreated site_created = 2; // Default properties were created on site creation.
-        SiteCloned site_cloned = 3; // Properties were cloned on site cloning.
-    }
-}
-
-message PropertiesChange {}
-
-message SiteCreated {
-    google.protobuf.StringValue origin_template_id = 1; // Origin template site id.
-}
-
-message SiteCloned {
-    string origin_meta_site_id = 1; // Origin site id.
-}
-
-// Encapsulates all changes when site properties are updated
-message SitePropertiesUpdated {
-    string metasite_id = 1; // ID of the Wix site that has been updated.
-    SitePropertiesEvent event = 2; // Update details.
-}
-
-// Encapsulates all details written to the Greyhound topic when a site's properties are updated.
-message SitePropertiesNotification {
-    string metasite_id = 1; // The site ID for which this update notification applies.
-    SitePropertiesEvent event = 2; // The actual update event.
-    repeated Translation translations = 3 [(.wix.api.maxSize) = 500]; // A convenience set of mappings from the MetaSite ID to its constituent services.
-    ChangeContext change_context = 5; // Context of the notification
-}
-
-// The actual update event for a particular notification.
-message SitePropertiesEvent {
-    uint32 version = 1; // Version of the site's properties represented by this update.
-    google.protobuf.FieldMask fields = 2; // Set of properties that were updated - corresponds to the fields in "properties".
-    Properties properties = 3; // Updated properties.
-}
-
-// Snapshot of latest site properties.
-message SitePropertiesFullNotification {
-    string meta_site_id = 1; // The site ID for which this snapshot applies.
-    uint32 version = 2; // Version of the site's properties current snapshot.
-    Properties properties = 3; // Snapshot properties.
-    ChangeContext change_context = 5; // Context of the notification
-}
-
-/*
-  The set of service types that can be contained within a MetaSite. "Unknown" is a special type used when the service
-  type cannot be resolved (this can happen when a new service type is added, but messages are handled by an
-  older version of the consumer).
-*/
-enum EmbeddedServiceType {
-    UNKNOWN = 0;
-    CONTACTS = 1;
-    LISTS_APP = 2;
-    THIRD_PARTY_APPS = 3;
-    SITE_MEMBERS = 4;
-    ECOMMERCE = 5;
-    APP_BUILDER = 6;
-    PROVIDED_MAILING_SERVICE = 7;
-    MOBILE_SERVICES = 8;
-    CLOUD_SITE_EXTENSION = 9;
-    MOBILE_APP = 10;
-    ONBOARDING = 11;
-    CLUBS = 12;
-}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wixpress/siteproperties/api/v4/properties-sections.proto

@@ -1,23 +0,0 @@
-syntax = "proto3";
-
-package com.wixpress.siteproperties.api.v4;
-
-import "google/protobuf/wrappers.proto";
-import "wix/api/annotations.proto";
-import "wix/api/entity.proto";
-import "wix/api/validations.proto";
-import "com/wixpress/siteproperties/api/v4/properties.proto";
-
-message BusinessProfileData {
-    google.protobuf.StringValue site_display_name = 1; // Site display name.
-    google.protobuf.StringValue business_name = 2; // Business name.
-    google.protobuf.StringValue logo = 3; // Path to the site's logo in Wix Media (without Wix Media base URL).
-    google.protobuf.StringValue description = 4; // Site description.
-}
-
-message BusinessContactData {
-    google.protobuf.StringValue email = 1 [(wix.api.pii) = true]; // Publicly-available business email address.
-    google.protobuf.StringValue phone = 2 [(wix.api.pii) = true]; // Publicly-available business phone number.
-    google.protobuf.StringValue fax = 3 [(wix.api.pii) = true]; // Publicly-available business fax number.
-    Address address = 4; // Publicly-available business address.
-}