DocuSign.Api.Envelopes.pages_get_page_images

You're seeing just the function pages_get_page_images, go back to DocuSign.Api.Envelopes module for more information.
Link to this function

pages_get_page_images(connection, account_id, document_id, envelope_id, opts \\ [])

View Source

Specs

pages_get_page_images(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.PageImages.t()} | {:error, Tesla.Env.t()}

Returns document page image(s) based on input.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • document_id (String.t): The ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :count (String.t): The maximum number of results to be returned by this request.
    • :dpi (String.t): Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
    • :max_height (String.t): Sets the maximum height (in pixels) of the returned image.
    • :max_width (String.t): Sets the maximum width (in pixels) of the returned image.
    • :nocache (String.t):
    • :show_changes (String.t):
    • :start_position (String.t): The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Returns

} on success {:error, info} on failure