...
A Container is like a secure empty envelope on the internet and it can be opened by any receiving user with internet access. A Container holds one or more Feature(s), where each Feature adds a specific functionality to that Container. We will get more into each available Feature in the Feature section.
AuthCode:
An AuthCode protects the whole adds an extra layer of security to a Container with a Two Factor Authentication , when this functionality is ON, and you generate a container with that resource, you must specify an Email or SMS and you only get access to that specific Container when you inform the 6-digit code to authenticate. code. When enabled, the Container will be accessbible only to those who has the 6-digit PIN verification that can be sent via SMS or Email.
ContactNotificationSend:
A ContactNotificationSend is the capability of send or resend an Email/SMS to your Recipient(s) containing inside your secure Container. a track record of an Email or Sms sent to a given RecipientItem.
Recipient:
A Recipient is an individual receiving a Container. It defines the name, last name and the methods of contact for that individual which we call RecipientItem. A Container may have one or more Recipient associated with it.
RecipientItem:
A RecipientItem has the ability to store thecontacts methods (Email or SMS) and they belong to a Recipient, you can have multiple RecipientItem for each Recipient Object. like a contact in your phone contact list. It has first name, a last name and, several phones or emails addresses for that given contact. Each number or email inside this contact is called RecipientItem. The Recipient(s) represents all the individuals that should receive the Container
RecipientItem:
A RecipientItem is like a contact method for a given Recipient. This value can be either an email address or a mobile capable of receiving SMS. A Recipient may have one or more RecipientItem.
Feature:
A Feature are the resources is an abstraction of a functionality a Container, which are capable of requesting a Pull, a Push or even a DocuSign, if the Container is of type P2, you can add may have. This abstraction purposes is to serve as base for any specific Feature a Container is capable, such as: Push, Pull or DocuSign. A Container of type “pushpull” is capable only one Feature at a time and, it is limited to be either a Push or a Pull, while a container of type “p2” is capable of as many Feature(s) as you want, thus being unlimited, if the Container is of the PushPull type, you can add either a Pull or a Push, it is more limited.
Message:
Every secure Container has a message associated with it. Can be sent via Email or SMS, you must define what you want to say in those messages when the receiver gets the notification.
MessageReply:
A MessageReply is the chat inside the feature when it is opened, you can exchange the messages with the requester and the requester can send some messages to you. need inside the same session.
We will get in more details about each Feature available in their respective sections in this document.
Message:
A Container of type “p2” is capable of chat. This means, you can have a real-time secure chat with the Recipient defined that Container. The Message object defines a message from the creator of the Container to the Recipient(s) of a Container.
MessageReply:
The MessageReply object represents a message inside a Container of type “p2” chat that is comming from it Recipient(s) to the creator of that Container.
Requester:
A Requester is the person who requires some document from you, let's assume that: you are required to send some documents, the Requester, is the person who sent you a secure Container containing the Features, for example if the Requester requests some document for you, they will send a Pull, if the Requester request to you to download some document, they will send a Push, if the Requester requests from you to sign a Document, they will send you n DocuSign. an individual that can be defined as the indivual who is sending the Container. You can add personal contact methods, social media, avatars, among other attributes. This is useful in cases where your company have many employees and, each employee may be a Requester inside Botdoc. When each of your employees use your Botdoc API integration to request or send something to someone, that Container will be created with his identity.
RequesterContainer:
A RequesterContainer is a copy of Requester Object, when you create your secure Container and inform the Request in that Container, the API, will copy the Requester information in the day that secure Container was sent. The purpose of that is, when you generate a Container and tomorrow the Requester changes his information, you have a Copy of that Requester information when it was sent to you.
SMS:
A SMS Object is filled when in the RecipientItem you choose the method to send your secure Container by SMS, we store that information in order to send an SMS to your client with the information you typed in SMS box.
Email:
An Email Object is filled when in the RecipientItem you choose the method to send your secure Container by Email, we store that information in order to send an Email to a client with the information you typed in Email boxa Requester at the time you sent a Container to it Recipient(s).
We duplicate this entry at the time you send a Container because if you change that Requester data in the future, we want to maintain the exact data when that Container was actually sent to someone.
Sms:
A Sms is one of the ways you can send a Container to someone. When you create a RecipientItem, you have an option to set the “interface_class” attribute as a “sms” or “email”. For all the RecipentItem that has the attribute “interface_class” set as “sms”, we will send this Sms object to that RecipientItem.
Email:
A Email is another way you can send a Container to someone. When you create a RecipientItem, you have an option to set the “interface_class” attribute as a “sms” or “email”. For all the RecipentItem that has the attribute “interface_class” set as “email”, we will send this Email object to that RecipientItem.
module_container_pull
Pull:
A Pull Object is one Feature among other Features that you send some information (Document, Images, and other kind of files) to the Requester, you can upload that information and send back to the Requester. a Feature a Container of type “p2” may have. With this Feature, you allow your Container to retrieve any file with no size limit from one or more Recipient(s).
PullFile:
A PullFile Object allows you you store your file(s) securely from a Pull Feature, in order of the Requester receive that file and work with information that you sent.
PullFileMetadata:
A PullFileMetadata Object is required when you finish to upload a file, we store all the metadata information about this filerepresents each file sent by a Recipient to the related Pull.
PullFileMetadata:
For each PullFile sent in a Pull, Botdoc tries to parse as many metadata from that file as possible. For instance, jpeg images have what is called EXIF data, we extract all this data and save as new PullFileMetadata objects.
module_container_push
Push:
A Push Object is one Feature among other Features, where you can receive any kind of files / document(s) from the Requester.
PushFile:
A PushFile Object is linked to a determined Push, and a PushFIle store the files uploaded by the Requester, and when the Receiver open that Feature, you will be able to download that file and save a copy. is a Feature a Container of type “p2” may have. This Feature adds to the Container the functionality of sending files securely to one or more Recipient(s).
PushFile:
The PullFile object represents each file being sent inside a Push.
PushFileDownload:
The PushFileDownload Object is always linked to a PushFIle and stores all PushFile Downloaded by the Receiver object has details about each time a given PushFile was downloaded by someone.
module_container_
...
docusign
...
Docusign:
A Media Object is linked to a PushPull Feature Object, in order to in the same Object we store the Pull File and Push File.
MediaDownload:
A MediaDownload Object, stores all Push Feature which the Receiver downloaded, in a PushPull Container, always linked to a Media Object.
MediaTag:
A MediaTag Object the main goal, is add Tags on our Pull Feature inside a secure PushPull Container, you can add as many Tags as you want, and in a Pull page the Receiver will see your upload buttons named with that Tags.
PushPull:
A PushPull Object is always linked to a Feature Object which is linkedto a secure Container, so in PushPull we could have either a Pull Feature or a Push Feature, by default the expiration of Feature is 3 daysDocusign is a Feature a Container of type “p2” may have. This Feature adds to the Container the capability of signing documents. This object represents the envelope to be created in DocuSign, containg the document templates and signers.
DocusignDocument:
A DocusignDocument is a representation of a signed document. If your defined template inside the Docusign object has 5 documents, when the Recipient(s) signs all documents, 5 new DocusignDocument(s) will be created, each being a signed copy of the document inside the template.
DocusignDocumentDownload:
A DocusignDocumentDownload stores how many times the DocusignDocument was downloaded.
DocusignRecipientSigner:
A DocusignRecipientSigner represents a mapping of the signers present in your Docusign template, with the Recipient(s) defined inside the Container this Docusign object belongs to.
module_container_
...
pushpull
...
PushPull:
A DocuSign Object stores all requests made in the DocuSign API, the purpose of that is, store the envelope_id when you request a new DocuSign to the Receiver in Botdoc API.
DocuSignConfig:
A DocuSignConfig Object stores your configuration in order to make the inter-mediation between DocuSign API and Botdoc API.
DocuSignDocument:
A DocuSignDocument Object stores the signed documents after the Receiver read and Signed.
DocusignDocumentDownload:
A DocusignDocumentDownload Object stores how many times the DocuSign Document was downloaded.
DocusignRecipientSigner:
A DocusignRecipientSigner Object stores all the signers based on the Recipient Object, if the document needs to be signed by 2 or more people, you must add this signers in the Recipient ObjectPushPull is a special kind of Feature. It can be associated only with a Container of page_type “pushpull”.
This Feature is capable of a single functionality at a time, it can either PULL or PUSH files according to the type attribute of the PushPull object.
Media:
A Media represents a file inside the PushPull. This file can be either from a pull or a push.
MediaDownload:
The MediaDownload represents the downloads made for a given Media that belongs to a PushPull of type “push”.
MediaTag:
The MediaTag object, defines tags that can be created inside a PushPull of type “pull”. Users use tags to automatically tag files as they are sent in the pull page according to each button the end user clicks.
For each MediaTag associated with the PushPull, a new upload button will be added to the collection page and, all the files sent using this tagged button, the files will also receive the same tag.
This is helpful for our users to group files when creating pulls.