Package com.stripe.model

Class File

    • Constructor Detail

      • File

        public File()

    • Method Detail

      • create

        public static File create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                   throws StripeException
        To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
        Throws:
        StripeException

      • create

        public static File create​(FileCreateParams params)
                   throws StripeException
        To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
        Throws:
        StripeException

      • create

        public static File create​(FileCreateParams params,
                          RequestOptions options)
                   throws StripeException
        To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
        Throws:
        StripeException

      • create

        public static File create​(java.util.Map<java.lang.String,​java.lang.Object> params,
                          RequestOptions options)
                   throws StripeException
        To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
        Throws:
        StripeException

      • list

        public static FileCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                           throws StripeException
        Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
        Throws:
        StripeException

      • list

        public static FileCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                  RequestOptions options)
                           throws StripeException
        Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
        Throws:
        StripeException

      • retrieve

        public static File retrieve​(java.lang.String id)
                     throws StripeException
        Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
        Throws:
        StripeException

      • retrieve

        public static File retrieve​(java.lang.String id,
                            RequestOptions options)
                     throws StripeException
        Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
        Throws:
        StripeException

      • retrieve

        public static File retrieve​(java.lang.String id,
                            java.util.Map<java.lang.String,​java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException
        Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object.
        Throws:
        StripeException

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getExpiresAt

        public java.lang.Long getExpiresAt()
        The time at which the file expires and is no longer available in epoch seconds.

      • getFilename

        public java.lang.String getFilename()
        A filename for the file, suitable for saving to a filesystem.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

      • getPurpose

        public java.lang.String getPurpose()
        The purpose of the file. Possible values are business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.

      • getSize

        public java.lang.Long getSize()
        The size in bytes of the file object.

      • getTitle

        public java.lang.String getTitle()
        A user friendly title for the document.

      • getType

        public java.lang.String getType()
        The type of the file returned (e.g., csv, pdf, jpg, or png).

      • getUrl

        public java.lang.String getUrl()
        The URL from which the file can be downloaded using your live secret API key.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setExpiresAt

        public void setExpiresAt​(java.lang.Long expiresAt)
        The time at which the file expires and is no longer available in epoch seconds.

      • setFilename

        public void setFilename​(java.lang.String filename)
        A filename for the file, suitable for saving to a filesystem.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

      • setPurpose

        public void setPurpose​(java.lang.String purpose)
        The purpose of the file. Possible values are business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.

      • setSize

        public void setSize​(java.lang.Long size)
        The size in bytes of the file object.

      • setTitle

        public void setTitle​(java.lang.String title)
        A user friendly title for the document.

      • setType

        public void setType​(java.lang.String type)
        The type of the file returned (e.g., csv, pdf, jpg, or png).

      • setUrl

        public void setUrl​(java.lang.String url)
        The URL from which the file can be downloaded using your live secret API key.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId