//
// Copyright 2025 HotelEngine, Inc., d/b/a Engine
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

syntax = "proto3";

package engine.common.v1;

option go_package = "engine.com/engine-partner-api/common/v1";
option java_package = "com.engine.common.v1";
option java_multiple_files = true;

import 'protoc-gen-openapiv2/options/annotations.proto';

// Describes the availability of actions on a [BookingDetails].
message AvailableActions {
  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
    json_schema: {
      title: "Common_AvailableActions_v1"
    }
  };

  // Describes the availability of the cancel action.
  .engine.common.v1.ActionAvailability cancel = 1;

  // Describes the availability of the modify action.
  .engine.common.v1.ActionAvailability modify = 2;
}

// Describes the means by which an action may be taken on a [BookingDetails].
enum ActionAvailability {
  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
    title: "Common_ActionAvailability_v1"
  };

  // It is unknown if the action is available. It might be available directly through the vendor.
  ACTION_AVAILABILITY_UNKNOWN = 0;

  // The action is not available through the API. It is unknown whether it can be performed in another context, such as through the vendor or support.
  ACTION_AVAILABILITY_UNAVAILABLE = 1;

  // The action is available through the API.
  ACTION_AVAILABILITY_AVAILABLE = 2;

  // The action is available, but only through the service provider.
  ACTION_AVAILABILITY_AVAILABLE_VIA_VENDOR = 3;

  // The action is available, but only through customer support.
  ACTION_AVAILABILITY_AVAILABLE_VIA_SUPPORT = 4;
}