com.sinch.sdk.models.SMSRegion Maven / Gradle / Ivy

Go to download

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

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.models;

import com.sinch.sdk.core.utils.EnumDynamic;
import com.sinch.sdk.core.utils.EnumSupportDynamic;
import java.util.Arrays;
import java.util.stream.Stream;

/**
 * SMS Region
 *
 * Available SMS region Regions are tied to a specific SMS API URL
 *
 * @see https://developers.sinch.com/docs/sms/api-reference/#base-url/
 * @since 1.0
 */
public class SMSRegion extends EnumDynamic {

  /** United States */
  public static final SMSRegion US = new SMSRegion("us");

  /** European Union */
  public static final SMSRegion EU = new SMSRegion("eu");

  /** Australia */
  public static final SMSRegion AU = new SMSRegion("au");

  /** Brazil */
  public static final SMSRegion BR = new SMSRegion("br");

  /** Canada */
  public static final SMSRegion CA = new SMSRegion("ca");

  private static final EnumSupportDynamic ENUM_SUPPORT =
      new EnumSupportDynamic<>(SMSRegion.class, SMSRegion::new, Arrays.asList(US, EU, AU, BR, CA));

  private SMSRegion(String value) {
    super(value);
  }

  /**
   * Get list of regions
   *
   * @return List of known SMS region
   */
  public static Stream values() {
    return ENUM_SUPPORT.values();
  }

  /**
   * Get SMS region from a String
   *
   * @param value String region identifier. Create an SMS Region instance if not known at
   *     compilation
   * @return SMSRegion identified by the string
   */
  public static SMSRegion from(String value) {
    return ENUM_SUPPORT.from(value);
  }

  /**
   * Get SMS region string identifier
   *
   * @param value region identifier
   * @return String value identifier for region
   */
  public static String valueOf(SMSRegion value) {
    return ENUM_SUPPORT.valueOf(value);
  }
}