com.cardpay.sdk.api.AuthenticationApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation

Cardpay APIv3 JAVA SDK

There is a newer version: 3.82.1

package com.cardpay.sdk.api;

import com.cardpay.sdk.client.CollectionFormats.*;
import com.cardpay.sdk.model.AuthenticationCreateResponse;
import com.cardpay.sdk.model.AuthenticationDataRequest;
import com.cardpay.sdk.model.AuthenticationDataResponse;
import com.cardpay.sdk.model.AuthenticationPatchRequest;
import com.cardpay.sdk.model.AuthenticationUpdateResponse;
import retrofit2.Call;
import retrofit2.http.*;

public interface AuthenticationApi {
  /**
   * Create authentication
   * 
   * @param authenticationDataRequest authenticationDataRequest (required)
   * @return Call<AuthenticationCreateResponse>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @POST("api/authentication")
  Call createAuthentication(
    @retrofit2.http.Body AuthenticationDataRequest authenticationDataRequest
  );

  /**
   * Get authentication information
   * 
   * @param authId Authentication ID (required)
   * @return Call<AuthenticationDataResponse>
   */
  @GET("api/authentication/{authId}")
  Call getAuthentication(
    @retrofit2.http.Path("authId") String authId
  );

  /**
   * Update authentication
   * 
   * @param authenticationId Authentication ID (required)
   * @param authenticationPatchRequest authenticationPatchRequest (required)
   * @return Call<AuthenticationUpdateResponse>
   */
  @Headers({
    "Content-Type:application/json"
  })
  @PATCH("api/authentication/{authenticationId}")
  Call updateAuthentication(
    @retrofit2.http.Path("authenticationId") String authenticationId, @retrofit2.http.Body AuthenticationPatchRequest authenticationPatchRequest
  );

}