com.okta.sdk.resource.api.ApplicationLogosApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation
The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.
There is a newer version: 21.0.0
Show newest version
/*
 * Okta Admin Management
 * Allows customers to easily access the Okta Management APIs
 *
 * The version of the OpenAPI document: 2024.08.3
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package com.okta.sdk.resource.api;

import com.fasterxml.jackson.core.type.TypeReference;

import com.okta.sdk.resource.client.ApiException;
import com.okta.sdk.resource.client.ApiClient;
import com.okta.sdk.resource.client.Configuration;
import com.okta.sdk.resource.model.*;
import com.okta.sdk.resource.client.Pair;

import com.okta.sdk.resource.model.Error;
import java.io.File;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.DeserializationFeature;

import org.openapitools.jackson.nullable.JsonNullableModule;

@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-11-15T08:48:47.130589-06:00[America/Chicago]", comments = "Generator version: 7.8.0")
public class ApplicationLogosApi {

    private ApiClient apiClient;

    public ApplicationLogosApi() {
        this(Configuration.getDefaultApiClient());
    }

    public ApplicationLogosApi(ApiClient apiClient) {
        this.apiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return apiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.apiClient = apiClient;
    }

    /**
     * Upload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation
     * replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you
     * have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for
     * your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for
     * each app link. > You can't use the API to add logos for multiple app links.
     *
     * @param appId
     *            Application ID (required)
     * @param _file
     *            The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than
     *            one MB in size. For best results, use an image with a transparent background and a square dimension of
     *            200 x 200 pixels to prevent upscaling. (required)
     *
     * @throws ApiException
     *             if fails to make API call
     */
    public void uploadApplicationLogo(String appId, File _file) throws ApiException {
        this.uploadApplicationLogo(appId, _file, Collections.emptyMap());
    }

    /**
     * Upload an application Logo Uploads a logo for the app instance. If the app already has a logo, this operation
     * replaces the previous logo. The logo is visible in the Admin Console as an icon for your app instance. If you
     * have one `appLink` object configured, this logo also appears in the End-User Dashboard as an icon for
     * your app. > **Note:** If you have multiple `appLink` objects, use the Admin Console to add logos for
     * each app link. > You can't use the API to add logos for multiple app links.
     *
     * @param appId
     *            Application ID (required)
     * @param _file
     *            The image file containing the logo. The file must be in PNG, JPG, SVG, or GIF format, and less than
     *            one MB in size. For best results, use an image with a transparent background and a square dimension of
     *            200 x 200 pixels to prevent upscaling. (required)
     * @param additionalHeaders
     *            additionalHeaders for this call
     *
     * @throws ApiException
     *             if fails to make API call
     */
    public void uploadApplicationLogo(String appId, File _file, Map additionalHeaders)
            throws ApiException {
        Object localVarPostBody = null;

        // verify the required parameter 'appId' is set
        if (appId == null) {
            throw new ApiException(400, "Missing the required parameter 'appId' when calling uploadApplicationLogo");
        }

        // verify the required parameter '_file' is set
        if (_file == null) {
            throw new ApiException(400, "Missing the required parameter '_file' when calling uploadApplicationLogo");
        }

        // create path and map variables
        String localVarPath = "/api/v1/apps/{appId}/logo".replaceAll("\\{" + "appId" + "\\}",
                apiClient.escapeString(appId.toString()));

        StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
        String localVarQueryParameterBaseName;
        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        localVarHeaderParams.putAll(additionalHeaders);

        if (_file != null)
            localVarFormParams.put("file", _file);

        final String[] localVarAccepts = { "application/json" };
        final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

        final String[] localVarContentTypes = { "multipart/form-data" };
        final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

        String[] localVarAuthNames = new String[] { "apiToken", "oauth2" };

        apiClient.invokeAPI(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams,
                localVarQueryStringJoiner.toString(), localVarPostBody, localVarHeaderParams, localVarCookieParams,
                localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, null);
    }

    protected static ObjectMapper getObjectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.registerModule(new JavaTimeModule());
        objectMapper.registerModule(new JsonNullableModule());
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        objectMapper.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, true);
        return objectMapper;
    }

}