/*-
 * -\-\-
 * github-api
 * --
 * Copyright (C) 2016 - 2020 Spotify AB
 * --
 * 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.
 * -/-/-
 */

package com.spotify.github.v3;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.spotify.github.CloseTracking;
import com.spotify.github.GitHubInstant;
import com.spotify.github.GithubStyle;
import java.net.URI;
import java.util.Optional;
import javax.annotation.Nullable;
import org.immutables.value.Value;

/** Milestone resource */
@Value.Immutable
@GithubStyle
@JsonSerialize(as = ImmutableMilestone.class)
@JsonDeserialize(as = ImmutableMilestone.class)
public interface Milestone extends CloseTracking {

  /** URL */
  @Nullable
  URI url();

  /** HTML URL */
  @Nullable
  URI htmlUrl();

  /** Labels URL */
  @Nullable
  URI labelsUrl();

  /** ID */
  @Nullable
  Integer id();

  /** Number */
  @Nullable
  Integer number();

  /** The state of the milestone. Either open, closed, or all. */
  @Nullable
  String state();

  /** Title */
  @Nullable
  String title();

  /** Description */
  Optional<String> description();

  /** Creator user */
  @Nullable
  User creator();

  /** Number of open issues */
  @Nullable
  Integer openIssues();

  /** Number of closed issues */
  @Nullable
  Integer closedIssues();

  /** Due date */
  Optional<GitHubInstant> dueOn();
}
