com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration 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

/*
 * Numbers | Sinch
 *
 * OpenAPI document version: 1.0.2
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 */

package com.sinch.sdk.domains.numbers.models.v1;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/**
 * The current SMS configuration for this number. Once the servicePlanId is sent, it
 * enters scheduled provisioning. The status of scheduled provisioning will show under a 
 * scheduledProvisioning object if it's still running. Once processed successfully, the
 * servicePlanId sent will appear directly under the smsConfiguration
 * object.
 */
@JsonDeserialize(builder = SmsConfigurationImpl.Builder.class)
public interface SmsConfiguration {

  /**
   * The servicePlanId can be found in the Sinch Customer Dashboard. The service plan
   * ID is what ties this number to the configured SMS service.
   *
   * @return servicePlanId
   */
  String getServicePlanId();

  /**
   * Only for US virtual numbers. This campaign ID relates to 10DLC numbers. So, it
   * is the current campaign ID for this number. The campaignId is found on your TCR
   * platform.
   *
   * @return campaignId
   */
  String getCampaignId();

  /**
   * Get scheduledProvisioning
   *
   * @return scheduledProvisioning
   */
  ScheduledSmsProvisioning getScheduledProvisioning();

  /**
   * Getting builder
   *
   * @return New Builder instance
   */
  static Builder builder() {
    return new SmsConfigurationImpl.Builder();
  }

  /** Dedicated Builder */
  interface Builder {

    /**
     * see getter
     *
     * @param servicePlanId see getter
     * @return Current builder
     * @see #getServicePlanId
     */
    Builder setServicePlanId(String servicePlanId);

    /**
     * see getter
     *
     * @param campaignId see getter
     * @return Current builder
     * @see #getCampaignId
     */
    Builder setCampaignId(String campaignId);

    /**
     * see getter
     *
     * @param scheduledProvisioning see getter
     * @return Current builder
     * @see #getScheduledProvisioning
     */
    Builder setScheduledProvisioning(ScheduledSmsProvisioning scheduledProvisioning);

    /**
     * Create instance
     *
     * @return The instance build with current builder values
     */
    SmsConfiguration build();
  }
}