|
| 1 | +syntax = "proto3"; |
| 2 | +package decentraland.social_service.v1; |
| 3 | + |
| 4 | +// This message is a response that is sent from the server to the client |
| 5 | +message FriendshipEventResponse { |
| 6 | + oneof body { |
| 7 | + RequestResponse request = 1; |
| 8 | + AcceptResponse accept = 2; |
| 9 | + RejectResponse reject = 4; |
| 10 | + DeleteResponse delete = 5; |
| 11 | + CancelResponse cancel = 6; |
| 12 | + } |
| 13 | +} |
| 14 | + |
| 15 | +message FriendshipEventResponses { |
| 16 | + repeated FriendshipEventResponse responses = 1; |
| 17 | +} |
| 18 | + |
| 19 | +message FriendshipEventPayload { |
| 20 | + oneof body { |
| 21 | + RequestPayload request = 1; |
| 22 | + AcceptPayload accept = 2; |
| 23 | + RejectPayload reject = 4; |
| 24 | + DeletePayload delete = 5; |
| 25 | + CancelPayload cancel = 6; |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +message User { string address = 1; } |
| 30 | + |
| 31 | +message Users { repeated User users = 1; } |
| 32 | + |
| 33 | +message RequestResponse { |
| 34 | + User user = 1; |
| 35 | + int64 created_at = 2; |
| 36 | + optional string message = 3; |
| 37 | +} |
| 38 | + |
| 39 | +message RequestPayload { |
| 40 | + User user = 1; |
| 41 | + optional string message = 3; |
| 42 | +} |
| 43 | + |
| 44 | +message Requests { |
| 45 | + int64 total = 1; // Total amount of friendship requests |
| 46 | + repeated RequestResponse items = 2; |
| 47 | +} |
| 48 | + |
| 49 | +message RequestEvents { |
| 50 | + Requests outgoing = 1; // Requests the authed user have sent to users |
| 51 | + Requests incoming = 2; // Requests the authed user have received from users |
| 52 | +} |
| 53 | + |
| 54 | +message AcceptResponse { User user = 1; } |
| 55 | + |
| 56 | +message AcceptPayload { User user = 1; } |
| 57 | + |
| 58 | +message RejectResponse { User user = 1; } |
| 59 | + |
| 60 | +message RejectPayload { User user = 1; } |
| 61 | + |
| 62 | +message DeleteResponse { User user = 1; } |
| 63 | + |
| 64 | +message DeletePayload { User user = 1; } |
| 65 | + |
| 66 | +message CancelResponse { User user = 1; } |
| 67 | + |
| 68 | +message CancelPayload { User user = 1; } |
| 69 | + |
| 70 | +message UpdateFriendshipPayload { |
| 71 | + FriendshipEventPayload event = 1; |
| 72 | + // For internal use only, subject to change. |
| 73 | + optional Payload auth_token = 2; |
| 74 | +} |
| 75 | + |
| 76 | +message MutualFriendsPayload { |
| 77 | + User user = 1; |
| 78 | + // For internal use only, subject to change. |
| 79 | + optional Payload auth_token = 2; |
| 80 | +} |
| 81 | + |
| 82 | +message Payload { |
| 83 | + // For internal use only, subject to change. |
| 84 | + optional string synapse_token = 1; |
| 85 | +} |
| 86 | + |
| 87 | +message BadRequestError { |
| 88 | + string message = 1; |
| 89 | +} |
| 90 | +message UnauthorizedError { |
| 91 | + string message = 1; |
| 92 | +} |
| 93 | +message ForbiddenError { |
| 94 | + string message = 1; |
| 95 | +} |
| 96 | +message TooManyRequestsError { |
| 97 | + string message = 1; |
| 98 | +} |
| 99 | +message InternalServerError { |
| 100 | + string message = 1; |
| 101 | +} |
| 102 | + |
| 103 | +message UsersResponse { |
| 104 | + oneof response { |
| 105 | + Users users = 1; |
| 106 | + InternalServerError internal_server_error = 2; |
| 107 | + UnauthorizedError unauthorized_error = 3; |
| 108 | + ForbiddenError forbidden_error = 4; |
| 109 | + TooManyRequestsError too_many_requests_error = 5; |
| 110 | + BadRequestError bad_request_error = 6; |
| 111 | + } |
| 112 | +} |
| 113 | + |
| 114 | +message RequestEventsResponse { |
| 115 | + oneof response { |
| 116 | + RequestEvents events = 1; |
| 117 | + InternalServerError internal_server_error = 2; |
| 118 | + UnauthorizedError unauthorized_error = 3; |
| 119 | + ForbiddenError forbidden_error = 4; |
| 120 | + TooManyRequestsError too_many_requests_error = 5; |
| 121 | + } |
| 122 | +} |
| 123 | + |
| 124 | +message UpdateFriendshipResponse { |
| 125 | + oneof response { |
| 126 | + FriendshipEventResponse event = 1; |
| 127 | + InternalServerError internal_server_error = 2; |
| 128 | + UnauthorizedError unauthorized_error = 3; |
| 129 | + ForbiddenError forbidden_error = 4; |
| 130 | + TooManyRequestsError too_many_requests_error = 5; |
| 131 | + BadRequestError bad_request_error = 6; |
| 132 | + } |
| 133 | +} |
| 134 | + |
| 135 | +message SubscribeFriendshipEventsUpdatesResponse { |
| 136 | + oneof response { |
| 137 | + FriendshipEventResponses events = 1; |
| 138 | + InternalServerError internal_server_error = 2; |
| 139 | + UnauthorizedError unauthorized_error = 3; |
| 140 | + ForbiddenError forbidden_error = 4; |
| 141 | + TooManyRequestsError too_many_requests_error = 5; |
| 142 | + } |
| 143 | +} |
| 144 | + |
| 145 | +// @deprecated, only available for old explorer compatibility |
| 146 | +service FriendshipsService { |
| 147 | + // Get the list of friends for the authenticated user |
| 148 | + rpc GetFriends(Payload) returns (stream UsersResponse) {} |
| 149 | + |
| 150 | + // Get the list of mutual friends between the authenticated user and the one in the parameter |
| 151 | + rpc GetMutualFriends(MutualFriendsPayload) returns (stream UsersResponse) {} |
| 152 | + |
| 153 | + // Get the list of request events for the authenticated user |
| 154 | + rpc GetRequestEvents(Payload) returns (RequestEventsResponse) {} |
| 155 | + |
| 156 | + // Update friendship status: REQUEST, ACCEPT, REJECT, CANCEL, DELETE |
| 157 | + rpc UpdateFriendshipEvent(UpdateFriendshipPayload) |
| 158 | + returns (UpdateFriendshipResponse) {} |
| 159 | + |
| 160 | + // Subscribe to updates of friendship status: REQUEST, ACCEPT, REJECT, CANCEL, DELETE |
| 161 | + rpc SubscribeFriendshipEventsUpdates(Payload) |
| 162 | + returns (stream SubscribeFriendshipEventsUpdatesResponse) {} |
| 163 | +} |
0 commit comments