Package model

Class ModelFile

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ModelFile
extends Object
    ModelFile

    • Constructor Detail

      • ModelFile

        public ModelFile()

    • Method Detail

      • getId

        @Nullable
public String getId()
        The ID of the `File` resource.
        Returns:
        id

      • setId

        public void setId​(String id)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        Timestamp of when the object was created.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getUpdatedAt

        @Nullable
public OffsetDateTime getUpdatedAt()
        Timestamp of when the object was last updated.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getApplicationId

        @Nullable
public String getApplicationId()
        The ID of the `Application` that the `File` was created under.
        Returns:
        applicationId

      • setApplicationId

        public void setApplicationId​(String applicationId)

      • getDisplayName

        @Nullable
public String getDisplayName()
        The name of the `File` object. If you don't provide a name, Finix will name the object with the convention: **FILE_(file_id)**.
        Returns:
        displayName

      • setDisplayName

        public void setDisplayName​(String displayName)

      • getExtension

        @Nullable
public String getExtension()
        The extension of the file.
        Returns:
        extension

      • setExtension

        public void setExtension​(String extension)

      • getIdentityId

        @Nullable
public String getIdentityId()
        ID of the `Identity` that created the `File`.
        Returns:
        identityId

      • setIdentityId

        public void setIdentityId​(String identityId)

      • getLinkedTo

        @Nullable
public String getLinkedTo()
        The resource ID the `File` is linked to.
        Returns:
        linkedTo

      • setLinkedTo

        public void setLinkedTo​(String linkedTo)

      • getLinkedType

        @Nullable
public String getLinkedType()
        Autofills to **Merchant**.
        Returns:
        linkedType

      • setLinkedType

        public void setLinkedType​(String linkedType)

      • getPlatformId

        @Nullable
public String getPlatformId()
        The ID of the `Platform` that the `File` was created under.
        Returns:
        platformId

      • setPlatformId

        public void setPlatformId​(String platformId)

      • getStatus

        @Nullable
public String getStatus()
        The status of the file's review. The statuses available includes:<br><li><strong>REQUIRES_UPLOAD</strong>: A file still needs to be uploaded to the file object.<br><li><strong>PENDING</strong>: Finix's underwriting team is still reviewing the uploaded files.<br><li><strong>INVALID</strong>: The file couldn't be read.<br><li><strong>UPLOADED</strong>: The file has been uploaded to the resource.
        Returns:
        status

      • setStatus

        public void setStatus​(String status)

      • getTags

        @Nullable
public Map<String,​String> getTags()
        Key value pair for annotating custom meta data (e.g. order numbers).
        Returns:
        tags

      • getType

        @Nullable
public String getType()
        The type of document.
        Returns:
        type

      • setType

        public void setType​(String type)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to ModelFile

      • fromJson

        public static ModelFile fromJson​(String jsonString)
                          throws IOException
        Create an instance of ModelFile given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ModelFile
        Throws:
        IOException - if the JSON string is invalid with respect to ModelFile

      • toJson

        public String toJson()
        Convert an instance of ModelFile to an JSON string
        Returns:
        JSON string