001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Enum representing the different regions that the Vonage API can be accessed from.
023 *
024 * @since 8.11.0
025 */
026public enum ApiRegion {
027    /**
028     * The region for the Vonage API in Europe.
029     */
030    API_EU,
031
032    /**
033     * The region for the Vonage API in the US.
034     */
035    API_US,
036
037    /**
038     * The region for the Vonage API in Asia Pacific.
039     */
040    API_AP;
041
042    @JsonValue
043    @Override
044    public String toString() {
045        return name().toLowerCase().replace("_", "-");
046    }
047
048    /**
049     * Converts a string representation of a region to the corresponding enum value.
050     *
051     * @param region The region as a string.
052     * @return The region enum, or {@code null} if the input is {@code null}.
053     */
054    @JsonCreator
055    public static ApiRegion fromString(String region) {
056        if (region == null) return null;
057        return valueOf(region.toUpperCase().replace("-", "_"));
058    }
059}