syntax = "proto3";

package fincleartech.ibroker;

option java_package = "io.fincleartech.protobuf.ibroker.corpact";
option java_multiple_files = true;

import "google/protobuf/wrappers.proto";
import "fincleartech/ibroker/common.proto";

message ParticipantInitiatedBidElectionRequest {
    // Correlation request identifier
    google.protobuf.StringValue request_id = 1;

    // The Participant identifies the Participant delivering/receiving units.
    google.protobuf.StringValue participant = 18;

    // The Account (HIN) is the Account (HIN) from which units are being delivered/received.
    google.protobuf.StringValue settlement_account = 19;

    // Identifies the security in which units are being transferred.
    google.protobuf.StringValue security_code = 14;

    // The Unit Quantity of the Security Code which is being transferred. This must be a positive whole number
    // greater than 0, with no decimal places.
    // The Delivering Account (HIN) must have sufficient available units greater than or equal to the Unit Quantity
    // for the specified security.
    fincleartech.ibroker.NumberValue units = 16;

    // The unique numeric identifier of the Corporate Action that the Bid Offer pertains to.
    google.protobuf.StringValue corporate_action_id = 2;

    // Identifies whether the number of securities covered by the Bid Election relate to a distinct portion of a security holding, either:
    //      'true', where the securities covered by the acceptance relate to a distinct portion of a security holding; or
    //      'false', where the securities covered by the acceptance do not relate to a distinct portion of a security holding.
    google.protobuf.BoolValue distinct_portion_indicator = 3;

    // Identifies the Option Number of the Corporate Action ID that the Controlling Participant is
    // accepting on behalf of the Account Holder.
    google.protobuf.StringValue option_number = 4;

    // The corporate action event type
    //
    // # Valid Values:
    //
    // - BIDS buyback
    // - TEND takeover
    // - OTHR other
    google.protobuf.StringValue event_type = 5;

    // The corporate action event type
    //
    // # Valid Values:
    //
    // - CASE Identifies that the Bid Offer consideration is paid in Cash and Securities (CASE).
    // - CASH Identifies that the Bid Offer consideration is paid in Cash (CASH).
    // - SECU Identifies that the Bid Offer consideration is paid in Securities (SECU).
    google.protobuf.StringValue option_type = 6;

}

message ParticipantInitiatedBidElectionResponse {
    fincleartech.ibroker.ResponseStatus status = 1;
}

message CorporateActionElectionStatusAdvice {
    enum CorporateActionElectionStatus {
        CORPORATE_ACTION_ELECTION_STATUS_NOT_SET = 0;
        CORPORATE_ACTION_ELECTION_STATUS_ACCEPTED = 1;
        CORPORATE_ACTION_ELECTION_STATUS_REJECTED = 2;
    }

    // Correlation request identifier
    google.protobuf.StringValue request_id = 1;

    // The Participant identifies the Participant delivering/receiving units.
    google.protobuf.StringValue participant = 18;

    // The Account (HIN) is the Account (HIN) from which units are being delivered/received.
    google.protobuf.StringValue settlement_account = 19;

    // The unique numeric identifier of the Corporate Action that the Bid Offer pertains to.
    google.protobuf.StringValue corporate_action_id = 2;

    // Identifies the security in which units are being transferred.
    google.protobuf.StringValue security_code = 14;

    // The Unit Quantity of the Security Code which is being transferred.
    fincleartech.ibroker.NumberValue units = 16;

    // Identifies whether the number of securities covered by the Bid Election relate to a distinct portion of a security holding, either:
    //      'true', where the securities covered by the acceptance relate to a distinct portion of a security holding; or
    //      'false', where the securities covered by the acceptance do not relate to a distinct portion of a security holding.
    google.protobuf.BoolValue distinct_portion_indicator = 3;

    // Identifies the Option Number of the Corporate Action ID that the Controlling Participant is
    // accepting on behalf of the Account Holder.
    google.protobuf.StringValue option_number = 4;

    // The corporate action event type
    //
    // # Valid Values:
    //
    // - BIDS buyback
    // - TEND takeover
    // - OTHR other
    google.protobuf.StringValue event_type = 5;

    // The corporate action event type
    //
    // # Valid Values:
    //
    // - CASE Identifies that the Bid Offer consideration is paid in Cash and Securities (CASE).
    // - CASH Identifies that the Bid Offer consideration is paid in Cash (CASH).
    // - SECU Identifies that the Bid Offer consideration is paid in Securities (SECU).
    google.protobuf.StringValue option_type = 6;

    // status of election
    CorporateActionElectionStatus status = 7;
}

service IBrokerCorporateActionService {
    // Acceptance of a corporate action election (takeover/buyback)
    rpc ParticipantInitiatedBidElection(ParticipantInitiatedBidElectionRequest) returns (ParticipantInitiatedBidElectionResponse);
}