// Copyright 2019 Make.TV Inc.
//
// 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 tv.make.api;

import "transfertarget/transfertarget.proto";

import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";

option go_package = "git.ltnglobal.com/make.tv/genproto/api;api";

service TransferTargetService {
  // Lists transfer targets.
  rpc ListTransferTargets (ListTransferTargetsRequest) returns (ListTransferTargetsResponse) {
    option (google.api.http) = { get: "/v1/teams/{team_id}/transfertargets" };
  }

  // Gets a transfer target.
  rpc GetTransferTarget (GetTransferTargetRequest) returns (TransferTarget) {
    option (google.api.http) = { get: "/v1/teams/{team_id}/transfertargets/{transfer_target_id}" };
  }

  // Creates a transfer target.
  rpc CreateTransferTarget (CreateTransferTargetRequest) returns (TransferTarget) {
    option (google.api.http) = {
      post: "/v1/teams/{team_id}/transfertargets"
      body: "transfer_target"
    };
  }

  // Updates a transfer target.
  rpc UpdateTransferTarget (UpdateTransferTargetRequest) returns (TransferTarget) {
    option (google.api.http) = {
      patch: "/v1/teams/{transfer_target.team_id}/transfertargets/{transfer_target.id}"
      body: "transfer_target"
    };
  }

  // Deletes a transfer target.
  rpc DeleteTransferTarget (DeleteTransferTargetRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = { delete: "/v1/teams/{team_id}/transfertargets/{transfer_target_id}" };
  }
}

// Request message for [ListTransferTargets][tv.make.api.TransferTargetService.ListTransferTargets].
message ListTransferTargetsRequest {
  // The unique identifier of the team owning the transfer target.
  string team_id = 1;

  // The maximum number of items to return.
  int32 page_size = 2;

  // The next_page_token value returned from a previous List request, if any.
  string page_token = 3;

  // Specifies the result ordering for List requests.
  string order_by = 4;
}

// Response message for [ListTransferTargets][tv.make.api.TransferTargetService.ListTransferTargets].
message ListTransferTargetsResponse {
  // The list of transfer targets.
  repeated TransferTarget transfer_targets = 1;

  // Token to retrieve the next page of results, or empty if there are no
  // more results in the list.
  string next_page_token = 2;
}

// Request message for [GetTransferTarget][tv.make.api.TransferTargetService.GetTransferTarget].
message GetTransferTargetRequest {
  // The unique identifier of the transfer target.
  string transfer_target_id = 1;

  // The unique identifier of the team owning the transfer target.
  string team_id = 2;
}

// Request message for [CreateTransferTarget][tv.make.api.TransferTargetService.CreateTransferTarget].
message CreateTransferTargetRequest {
  // The unique identifier of the team owning the transfer target.
  string team_id = 1;

  // The transfer target to create.
  TransferTarget transfer_target = 2;
}

// Request message for [UpdateTransferTarget][tv.make.api.TransferTargetService.UpdateTransferTarget].
message UpdateTransferTargetRequest {
  // The transfer target resource which replaces the resource on the server.
  TransferTarget transfer_target = 1;

  // The update mask applies to the resource. For the `FieldMask` definition,
  // see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  google.protobuf.FieldMask update_mask = 2;
}

// Request message for [DeleteTransferTarget][tv.make.api.TransferTargetService.DeleteTransferTarget].
message DeleteTransferTargetRequest {
  // The unique identifier of the transfer_target.
  string transfer_target_id = 1;

  // The unique identifier of the team owning the transfer target.
  string team_id = 2;
}