io.sphere.sdk.apiclient.ApiClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

package io.sphere.sdk.apiclient;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.annotations.*;
import io.sphere.sdk.client.SphereClientConfig;
import io.sphere.sdk.models.*;

import javax.annotation.Nullable;
import java.time.LocalDate;
import java.time.ZonedDateTime;
import java.util.Date;

@JsonDeserialize(as= ApiClientImpl.class)
@ResourceValue(abstractResourceClass = true)
@ResourceInfo(pluralName = "api-clients", pathElement = "api-clients")
@HasByIdGetEndpoint(javadocSummary = "Retrieves a extension by a known ID.")
@HasQueryEndpoint
@HasCreateCommand(javadocSummary = "Creates an ApiClient")
public interface ApiClient  extends Identifiable, Referenceable {

    @Override
    String getId();

    String getName();

    String getScope();

    @Nullable
    ZonedDateTime getCreatedAt();

    @Nullable
    LocalDate getLastUsedAt();

    @Nullable
    String getSecret();

    @Nullable
    ZonedDateTime getDeleteAt();

    @JsonIgnore
    String getProjectKey();

    static TypeReference typeReference() {
        return new TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }

    @Override
    default Reference toReference() {
        return Reference.of(referenceTypeId(), getId(), this);
    }

    static String resourceTypeId() {
        return "api-client";
    }

    static String referenceTypeId() {
        return "api-client";
    }

    static Reference referenceOfId(final String id) {
        return Reference.of(referenceTypeId(), id);
    }
}