/*
 * Created by jonathan.jesperson@pluto.tv on 01/22/2021.
 * Copyright (c) PlutoTV Inc 2021.
 */

syntax = "proto3";

package devicepackage;

option go_package = "github.com/Pluto-tv/service-dal/golang_client";
option java_package = "tv.pluto.ip.dal.device";

service DeviceManager {
  // GetDocumentsUpdatedBetweenDates (Server Stream)
  //
  rpc GetDocumentsUpdatedBetweenDates(GetDocumentsUpdatedBetweenDatesRequest) returns (stream Device) {}

  rpc GetById(GetByIdRequest) returns (GetByIdResponse) {}

  rpc GetAllPaged(GetAllPagedRequest) returns (GetAllPagedResponse) {}

  // Create (Unary)
  //
  rpc Create(CreateRequest) returns (CreateResponse) {}

  // UpdateFields (Unary)
  //
  rpc UpdateFields(UpdateFieldsRequest) returns (UpdateFieldsResponse) {}
}

message GetDocumentsUpdatedBetweenDatesRequest {
  // Expressed as a valid javascript Date, https://en.wikipedia.org/wiki/ISO_8601
  string updated_at_min = 1;
  // Expressed as a valid javascript Date, https://en.wikipedia.org/wiki/ISO_8601
  string updated_at_max = 2;
}

message Device {
  string id = 1;
  string name = 2;
  string manufacturer = 3;
  string platform = 4;
  string slug = 5;
  string created_at = 6;
  string updated_at = 7;
  repeated Partner partners = 8;
  string revplatform = 9;
  bool disabled = 10;
}

message GetByIdRequest {
  string id = 1;
}

message GetByIdResponse {
  Device document = 1;
}

message Metadata {
  int32 current_offset = 1;
  int32 total_items = 2;
}

message Filter {
  string field = 1;
  string value = 2;
  string type = 3;
}

message GetAllPagedSort {
  string field = 1;
  int32 value = 2;
}

message GetAllPagedRequest {
  int32 limit = 1;
  int32 offset = 2;
  repeated GetAllPagedSort sort = 3;
  repeated Filter filters = 4;
  bool disable_total_count = 5;
  // when set to true the `name` value will be sent to MongoDB as regex expression
  // when set to false the `name` value will be sent to MongoDB as a literal string
  bool enable_regex = 6;
}

message GetAllPagedResponse {
  repeated Device documents = 1;
  Metadata metadata = 2;
}

message CreateRequest {
  Device document = 1;
}

message CreateResponse {
  Device document = 1;
}

message UpdateFieldsRequest {
  string id = 1;
  Device document = 2;
  repeated string update_fields = 3;
}

message UpdateFieldsResponse {
  Device document = 1;
}

message Partner {
  string name = 1;
  repeated string regions = 2;
}