com.twilio.rest.numbers.v2.regulatorycompliance.SupportingDocumentType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Twilio Java Helper Library
There is a newer version: 10.1.5
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.numbers.v2.regulatorycompliance;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.twilio.base.Resource;
import com.twilio.converter.Converter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import lombok.ToString;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.List;
import java.util.Map;
import java.util.Objects;

@JsonIgnoreProperties(ignoreUnknown = true)
@ToString
public class SupportingDocumentType extends Resource {
    private static final long serialVersionUID = 122060765056135L;

    /**
     * Create a SupportingDocumentTypeReader to execute read.
     *
     * @return SupportingDocumentTypeReader capable of executing the read
     */
    public static SupportingDocumentTypeReader reader() {
        return new SupportingDocumentTypeReader();
    }

    /**
     * Create a SupportingDocumentTypeFetcher to execute fetch.
     *
     * @param pathSid The unique string that identifies the Supporting Document
     *                Type resource
     * @return SupportingDocumentTypeFetcher capable of executing the fetch
     */
    public static SupportingDocumentTypeFetcher fetcher(final String pathSid) {
        return new SupportingDocumentTypeFetcher(pathSid);
    }

    /**
     * Converts a JSON String into a SupportingDocumentType object using the
     * provided ObjectMapper.
     *
     * @param json Raw JSON String
     * @param objectMapper Jackson ObjectMapper
     * @return SupportingDocumentType object represented by the provided JSON
     */
    public static SupportingDocumentType fromJson(final String json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, SupportingDocumentType.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    /**
     * Converts a JSON InputStream into a SupportingDocumentType object using the
     * provided ObjectMapper.
     *
     * @param json Raw JSON InputStream
     * @param objectMapper Jackson ObjectMapper
     * @return SupportingDocumentType object represented by the provided JSON
     */
    public static SupportingDocumentType fromJson(final InputStream json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, SupportingDocumentType.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    private final String sid;
    private final String friendlyName;
    private final String machineName;
    private final List> fields;
    private final URI url;

    @JsonCreator
    private SupportingDocumentType(@JsonProperty("sid")
                                   final String sid,
                                   @JsonProperty("friendly_name")
                                   final String friendlyName,
                                   @JsonProperty("machine_name")
                                   final String machineName,
                                   @JsonProperty("fields")
                                   final List> fields,
                                   @JsonProperty("url")
                                   final URI url) {
        this.sid = sid;
        this.friendlyName = friendlyName;
        this.machineName = machineName;
        this.fields = fields;
        this.url = url;
    }

    /**
     * Returns The unique string that identifies the Supporting Document Type
     * resource.
     *
     * @return The unique string that identifies the Supporting Document Type
     *         resource
     */
    public final String getSid() {
        return this.sid;
    }

    /**
     * Returns A human-readable description of the Supporting Document Type
     * resource.
     *
     * @return A human-readable description of the Supporting Document Type resource
     */
    public final String getFriendlyName() {
        return this.friendlyName;
    }

    /**
     * Returns The machine-readable description of the Supporting Document Type
     * resource.
     *
     * @return The machine-readable description of the Supporting Document Type
     *         resource
     */
    public final String getMachineName() {
        return this.machineName;
    }

    /**
     * Returns The required information for creating a Supporting Document.
     *
     * @return The required information for creating a Supporting Document
     */
    public final List> getFields() {
        return this.fields;
    }

    /**
     * Returns The absolute URL of the Supporting Document Type resource.
     *
     * @return The absolute URL of the Supporting Document Type resource
     */
    public final URI getUrl() {
        return this.url;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        SupportingDocumentType other = (SupportingDocumentType) o;

        return Objects.equals(sid, other.sid) &&
               Objects.equals(friendlyName, other.friendlyName) &&
               Objects.equals(machineName, other.machineName) &&
               Objects.equals(fields, other.fields) &&
               Objects.equals(url, other.url);
    }

    @Override
    public int hashCode() {
        return Objects.hash(sid,
                            friendlyName,
                            machineName,
                            fields,
                            url);
    }
}