/*-
 * -\-\-
 * 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.apps.requests;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.spotify.github.GithubStyle;
import java.util.List;
import java.util.Optional;
import org.immutables.value.Value;

/** Request to create an installation access token with repository scoping. */
@Value.Immutable
@GithubStyle
@JsonSerialize(as = ImmutableAccessTokenRequest.class)
@JsonDeserialize(as = ImmutableAccessTokenRequest.class)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public interface AccessTokenRequest {

  /**
   * List of repository names that the token should be scoped to.
   *
   * @return list of repository names
   */
  Optional<List<String>> repositories();

  /**
   * List of repository IDs that the token should be scoped to.
   *
   * @return list of repository IDs
   */
  @JsonProperty("repository_ids")
  Optional<List<Integer>> repositoryIds();
}
