wunaidage / zsign-nodejs-sdk Goto Github PK

 getRequest()  
    Params: i) request_id
            ii) [Oauth Object] user  
    Return: instance of RequestObject
    Throws: SignException
    Description: Fetch the details of a Zoho Sign Request by its request id.


 draftRequest()
    Params: i) [RequestObject] requestObject
            ii) [array] files
            iii) [Oauth Object] user
    Return: instance of RequestObject
    Throws: SignException
    Description: Uploads the files and draft's the request with the above properties.


 updateRequest()
    Params: i) [RequestObject] requestObject
            ii) [Oauth Object] user
            iii) [array] files
    Return: instance of RequestObject
    Throws: SignException
    Description: Uploads the files and draft's the request with the above properties.


 addFilesToRequest()
    Params: i) request_id
            ii) files
            iii) [Oauth Object] user
    Return: instance of RequestObject
    Throws: SignException
    Description: Uploads the files to a draft request.


submitForSignature()
    Params: i) [RequestObject] requestObject
            ii) [Oauth Object] user
    Return: instance of RequestObject
    Throws: SignException
    Description: The requestObject contains a reference for a 'draft' request with fields added. The function submits the 'draft' for signature.


selfSignRequest()
    Params: i) [RequestObject] requestObject
            ii) [Oauth Object] user
    Return: instance of RequestObject with
    Throws: SignException
    Description: The requestObject contains a reference for a 'draft' request with fields added. The function signs the document as the current user. If the document signing action fails, 'SignException' error is thrown, usually due to wrong field properties set.


getRequestList()
    Params: i) category    (values: ALL, DRAFT, INPROGRESS, RECALLED, COMPLETED, DECLINED, EXPIRED, EXPIRING, MY_REQUESTS, MY_PENDING, SHREDDED),
            ii) start_index (optional, default:0),
            iii) row_count   (optional, default:100, max:100),
            iv) sort_order  (optional, default:DESC, values : ASC, DESC),
            v) sort_column (optional, default:action_time, values: action_time, request_name, folder_name, owner_first_name, recipient_email, created_time, modified_time),
            vi) [Oauth Object] user
    Return: array of instances of RequestObject
    Throws: SignException
    Description: The function fetches the document list by category name.
    If only category name is specified, it fetches the 100 results sorted by last modified time of the category type.


generateEmbeddedSigningLink()
    Params: i) request_id,
            ii) action_id,
            iii) host (default:'null'/for opening in new tab)
            iv) [Oauth Object] user
    Return: URL string
    Throws: SignException
    Description: Generates and returns a signing link for the signer specified by action_id.
    Add the 'host' param for the website in which you want to embed.
    NOTE: The signing URL is valid ONLY for 3 minutes before which the link must be opened/loaded


getFieldDataFromCompletedDocument()
    Params: i) requestId
            ii)[Oauth Object] user
    Return: instance of DocumentFormData
    Throws: SignException
    Description: Returns the pdf fields form data with key:value as data_label:data_value


downloadRequest()
  Params: i) requrest_id
          ii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Downloads the documents of the request with its current version of signatures placed, either as a PDF if single document or as ZIP of multiple documents


downloadDocument()
  Params: i) request_id,
          ii) document_id
          iii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Downloads the specific document of the request with its current version of signatures placed as a PDF
               Documents will be downloaded to the directory path returned by 'getDownloadPath()' function.


downloadCompletionCertificate()
  Params: i) requrest_id
          ii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Downloads the completion certificate ONLY for the completed requests.
               Completion Cetrificate will be downloaded as PDF to the directory path.


recallRequest()
  Params: i) request_id
          ii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Recalls the request if submitted.


remindRequest()
  Params: i) request_id
          ii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Sends a reminder to the recipient of the request.


deleteRequest()
  Params: i) request_id
          ii) [Oauth Object] user
          iii)[boolean] inProgress
          iv) reason - (If request is inprogress, must need to add reason)
  Return: true
  Throws: SignException
  Description: Deletes the request. Deleted requests will be available in 'Trash'.


createNewFolder()
  Params: i) request_id
          ii) [Oauth Object] user
  Return: folder_id
  Throws: SignException
  Description: Creates new folder by the name, if it doesnt exist already.


getFieldTypes()
  Params: - i) [Oauth Object] user
  Return: [JSONObject] field_types
  Throws: -
  Description: Retrieves all field types.


getRequestTypes()
  Params: - i) [Oauth Object] user
  Return: array of instances of 'RequestType'
  Throws: -
  Description: Retrieves all request types.


createRequestType()
  Params: i) name
          ii) desctiption
          iii) [Oauth Object] user
  Return: instance of RequestType
  Throws:
  Description: Creates a new request type.


getFolderList()
  Params: - i) [Oauth Object] user
  Return: Array of JSON
  Throws:
  Description: Retrieves list of folders

createTemplate()
  Params: i) [TemplateObject] templateObject
          ii) [array] files
          iii) [Oauth Object] user
  Return: TemplateObject
  Throws: SignException
  Description: Creates a Zoho Sign template. Returns TemplateObect of the created template.


updateTemplate( $templateObject, $files=null )
  Params: i) [TemplateObject] templateObject
          ii)[Oauth Object] user
          iii) [array] files
  Return: TemplateObject
  Throws: SignException
  Description: Update an exsiting template with properties in the new templateObject, add files to the template.
              NOTE: The templateObject requires the request_id to be set.


addFilesToTemplate()
  Params: i) template_id
          ii) files
          iii) [Oauth Object] user
  Return: TemplateObject
  Throws: SignException
  Description: Adds files to the template.


getTemplate()
  Params: i)template_id
          ii) [Oauth Object] user
  return: TemplateObject
  Throws: SignException
  Description: Return the template object with its properties, which can be used to fill the prefill-fields and can be used for submission.


sendTemplate()
  Params: i) [TemplateObject] templateObject
          ii)[Oauth Object] user
          iii) [Boolean] quick_send - (by default its true)
  return: [RequestObject] requestObject
  Throws: SignException
  Description: The templateObject input param contains the TemplateObject returned by the "getTemplate()" function with the prefill-fields filled.
               Setting the quick send params as true sends the document for signature. Setting false, only creates a draft.
               Return value contains a RequestObject of the created request(either a DRAFT or INPROGRESS request).


getTemplatesList()
    Params: i)start_index (optional, default:0),
            ii)row_count   (optional, default:100, max:100),
            iii)sort_order  (optional, default:DESC, values : ASC, DESC),
            iv)sort_column (optional, default:action_time, values: action_time, request_name, folder_name, owner_first_name, recipient_email, created_time, modified_time)
            v)[Oauth Object] user
    Return: array of instances of TemplateObject
    Throws: SignException
    Description: The function fetches the templates list of the specified range, sorted by 'sort_column' name.
    If no params are passed, it fetches the 100 results sorted by last modified time of the category type.


deleteTemplate()
  Params: i)template_id
          ii) [Oauth Object] user
  Return: true
  Throws: SignException
  Description: Permanently deletes the template.