package io.apibuilder.api.v0.models;

import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
import java.lang.Void;
import java.util.Map;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.DELETE;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.PUT;
import retrofit2.http.Path;
import retrofit2.http.Query;

/**
 * Generated by API Builder - https://www.apibuilder.io
 * Service version: 0.16.74
 * User agent: apibuilder app.apibuilder.io/apicollective/apibuilder-api/0.16.74/android_client
 *
 * WARNING: not all features (notably unions) and data types work with android generator yet.  
 * Android generator is designed to be used in an android application, but should work in any java codebase as long as you import jackson and retrofit2 libraries.  
 * If you are considering using this library, would like to request/discuss features, or would like to share how you're using it, please contact android-feedback@gilt.com 
 *
 */
public interface VersionsClient {
  /**
   * Search all versions of this application. Results are always paginated.
   */
  @GET("{orgKey}/{applicationKey}")
  Call<Version[]> getOrgKeyApplicationKey(@Path("orgKey") String orgKey,
      @Path("applicationKey") String applicationKey, @Query("limit") Long limit,
      @Query("offset") Long offset);

  /**
   * Retrieve a specific version of an application.
   */
  @GET("{orgKey}/{applicationKey}/{version}")
  Call<Version> getOrgKeyApplicationKeyVersion(@Path("orgKey") String orgKey,
      @Path("applicationKey") String applicationKey, @Path("version") String version);

  /**
   * Create a new version for an application
   */
  @POST("{orgKey}/{version}")
  Call<Version> postOrgKeyVersion(@Body VersionForm versionForm, @Path("orgKey") String orgKey,
      @Path("version") String version);

  /**
   * Upsert a version of an application
   */
  @PUT("{orgKey}/{applicationKey}/{version}")
  Call<Version> putOrgKeyApplicationKeyVersion(@Body VersionForm versionForm,
      @Path("orgKey") String orgKey, @Path("applicationKey") String applicationKey,
      @Path("version") String version);

  /**
   * Deletes a specific version.
   */
  @DELETE("{orgKey}/{applicationKey}/{version}")
  Call<Void> deleteOrgKeyApplicationKeyVersion(@Path("orgKey") String orgKey,
      @Path("applicationKey") String applicationKey, @Path("version") String version);

  /**
   * Generates an example JSON document of the type with the specified name.
   */
  @GET("{orgKey}/{applicationKey}/{version}/example/{type_name}")
  Call<Map> getOrgKeyApplicationKeyVersionExampleTypeName(@Path("orgKey") String orgKey,
      @Path("applicationKey") String applicationKey, @Path("version") String version,
      @Path("type_name") String typeName, @Query("sub_type_name") String subTypeName,
      @Query("optional_fields") Boolean optionalFields);
}