ObjectEzsignfolderAPI

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ezsignfolderArchiveV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive	Archive the Ezsignfolder
ezsignfolderBatchDownloadV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload	Download multiples files from an Ezsignfolder
ezsignfolderCreateObjectV1	POST /1/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolderCreateObjectV2	POST /2/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolderDeleteObjectV1	DELETE /1/object/ezsignfolder/{pkiEzsignfolderID}	Delete an existing Ezsignfolder
ezsignfolderDisposeEzsignfoldersV1	POST /1/object/ezsignfolder/disposeEzsignfolders	Dispose Ezsignfolders
ezsignfolderDisposeV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose	Dispose the Ezsignfolder
ezsignfolderEditObjectV1	PUT /1/object/ezsignfolder/{pkiEzsignfolderID}	Edit an existing Ezsignfolder
ezsignfolderEndPrematurelyV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely	End prematurely
ezsignfolderGetActionableElementsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements	Retrieve actionable elements for the Ezsignfolder
ezsignfolderGetAttachmentCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount	Retrieve Attachment count
ezsignfolderGetAttachmentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments	Retrieve Ezsignfolder's Attachments
ezsignfolderGetCommunicationCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount	Retrieve Communication count
ezsignfolderGetCommunicationListV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList	Retrieve Communication list
ezsignfolderGetCommunicationrecipientsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients	Retrieve Ezsignfolder's Communicationrecipient
ezsignfolderGetCommunicationsendersV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders	Retrieve Ezsignfolder's Communicationsender
ezsignfolderGetEzsigndocumentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments	Retrieve an existing Ezsignfolder's Ezsigndocuments
ezsignfolderGetEzsignfoldersignerassociationsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations	Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ezsignfolderGetEzsignsignaturesAutomaticV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ezsignfolderGetFormsDataV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData	Retrieve an existing Ezsignfolder's forms data
ezsignfolderGetListV1	GET /1/object/ezsignfolder/getList	Retrieve Ezsignfolder list
ezsignfolderGetObjectV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolderGetObjectV2	GET /2/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolderImportEzsignfoldersignerassociationsV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations	Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ezsignfolderImportEzsigntemplatepackageV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage	Import an Ezsigntemplatepackage in the Ezsignfolder.
ezsignfolderReorderV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder	Reorder Ezsigndocuments in the Ezsignfolder
ezsignfolderSendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolderSendV3	POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolderUnsendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend	Unsend the Ezsignfolder

ezsignfolderArchiveV1

    open class func ezsignfolderArchiveV1(pkiEzsignfolderID: Int, body: AnyCodable, completion: @escaping (_ data: EzsignfolderArchiveV1Response?, _ error: Error?) -> Void)

Archive the Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let body = "TODO" // AnyCodable | 

// Archive the Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderArchiveV1(pkiEzsignfolderID: pkiEzsignfolderID, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
body	AnyCodable

Return type

EzsignfolderArchiveV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderBatchDownloadV1

    open class func ezsignfolderBatchDownloadV1(pkiEzsignfolderID: Int, ezsignfolderBatchDownloadV1Request: EzsignfolderBatchDownloadV1Request, completion: @escaping (_ data: URL?, _ error: Error?) -> Void)

Download multiples files from an Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderBatchDownloadV1Request = ezsignfolder-batchDownload-v1-Request(aPkiEzsigndocumentID: [123], aEDocumentType: ["aEDocumentType_example"]) // EzsignfolderBatchDownloadV1Request | 

// Download multiples files from an Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderBatchDownloadV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request: ezsignfolderBatchDownloadV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderBatchDownloadV1Request	EzsignfolderBatchDownloadV1Request

Return type

URL

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/zip, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderCreateObjectV1

    open class func ezsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request: [EzsignfolderCreateObjectV1Request], completion: @escaping (_ data: EzsignfolderCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let ezsignfolderCreateObjectV1Request = [ezsignfolder-createObject-v1-Request(objEzsignfolder: ezsignfolder-Request(pkiEzsignfolderID: 123, fkiEzsignfoldertypeID: 123, fkiEzsigntsarequirementID: 123, sEzsignfolderDescription: "sEzsignfolderDescription_example", tEzsignfolderNote: "tEzsignfolderNote_example", eEzsignfolderSendreminderfrequency: Field-eEzsignfolderSendreminderfrequency(), sEzsignfolderExternalid: "sEzsignfolderExternalid_example"), objEzsignfolderCompound: ezsignfolder-RequestCompound(pkiEzsignfolderID: 123, fkiEzsignfoldertypeID: 123, fkiEzsigntsarequirementID: 123, sEzsignfolderDescription: "sEzsignfolderDescription_example", tEzsignfolderNote: "tEzsignfolderNote_example", eEzsignfolderSendreminderfrequency: nil, sEzsignfolderExternalid: "sEzsignfolderExternalid_example"))] // [EzsignfolderCreateObjectV1Request] | 

// Create a new Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request: ezsignfolderCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV1Request	[EzsignfolderCreateObjectV1Request]

Return type

EzsignfolderCreateObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderCreateObjectV2

    open class func ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request: EzsignfolderCreateObjectV2Request, completion: @escaping (_ data: EzsignfolderCreateObjectV2Response?, _ error: Error?) -> Void)

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let ezsignfolderCreateObjectV2Request = ezsignfolder-createObject-v2-Request(aObjEzsignfolder: [ezsignfolder-RequestCompound(pkiEzsignfolderID: 123, fkiEzsignfoldertypeID: 123, fkiEzsigntsarequirementID: 123, sEzsignfolderDescription: "sEzsignfolderDescription_example", tEzsignfolderNote: "tEzsignfolderNote_example", eEzsignfolderSendreminderfrequency: Field-eEzsignfolderSendreminderfrequency(), sEzsignfolderExternalid: "sEzsignfolderExternalid_example")]) // EzsignfolderCreateObjectV2Request | 

// Create a new Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request: ezsignfolderCreateObjectV2Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV2Request	EzsignfolderCreateObjectV2Request

Return type

EzsignfolderCreateObjectV2Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderDeleteObjectV1

    open class func ezsignfolderDeleteObjectV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Delete an existing Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderDeleteObjectV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderDisposeEzsignfoldersV1

    open class func ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request: EzsignfolderDisposeEzsignfoldersV1Request, completion: @escaping (_ data: EzsignfolderDisposeEzsignfoldersV1Response?, _ error: Error?) -> Void)

Dispose Ezsignfolders

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let ezsignfolderDisposeEzsignfoldersV1Request = ezsignfolder-disposeEzsignfolders-v1-Request(aPkiEzsignfolderID: [123]) // EzsignfolderDisposeEzsignfoldersV1Request | 

// Dispose Ezsignfolders
ObjectEzsignfolderAPI.ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request: ezsignfolderDisposeEzsignfoldersV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
ezsignfolderDisposeEzsignfoldersV1Request	EzsignfolderDisposeEzsignfoldersV1Request

Return type

EzsignfolderDisposeEzsignfoldersV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderDisposeV1

    open class func ezsignfolderDisposeV1(pkiEzsignfolderID: Int, body: AnyCodable, completion: @escaping (_ data: EzsignfolderDisposeV1Response?, _ error: Error?) -> Void)

Dispose the Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let body = "TODO" // AnyCodable | 

// Dispose the Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderDisposeV1(pkiEzsignfolderID: pkiEzsignfolderID, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
body	AnyCodable

Return type

EzsignfolderDisposeV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderEditObjectV1

    open class func ezsignfolderEditObjectV1(pkiEzsignfolderID: Int, ezsignfolderEditObjectV1Request: EzsignfolderEditObjectV1Request, completion: @escaping (_ data: EzsignfolderEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderEditObjectV1Request = ezsignfolder-editObject-v1-Request(objEzsignfolder: ezsignfolder-RequestCompound(pkiEzsignfolderID: 123, fkiEzsignfoldertypeID: 123, fkiEzsigntsarequirementID: 123, sEzsignfolderDescription: "sEzsignfolderDescription_example", tEzsignfolderNote: "tEzsignfolderNote_example", eEzsignfolderSendreminderfrequency: Field-eEzsignfolderSendreminderfrequency(), sEzsignfolderExternalid: "sEzsignfolderExternalid_example")) // EzsignfolderEditObjectV1Request | 

// Edit an existing Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderEditObjectV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderEditObjectV1Request: ezsignfolderEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderEditObjectV1Request	EzsignfolderEditObjectV1Request

Return type

EzsignfolderEditObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderEndPrematurelyV1

    open class func ezsignfolderEndPrematurelyV1(pkiEzsignfolderID: Int, body: AnyCodable, completion: @escaping (_ data: EzsignfolderEndPrematurelyV1Response?, _ error: Error?) -> Void)

End prematurely

End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let body = "TODO" // AnyCodable | 

// End prematurely
ObjectEzsignfolderAPI.ezsignfolderEndPrematurelyV1(pkiEzsignfolderID: pkiEzsignfolderID, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
body	AnyCodable

Return type

EzsignfolderEndPrematurelyV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetActionableElementsV1

    open class func ezsignfolderGetActionableElementsV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetActionableElementsV1Response?, _ error: Error?) -> Void)

Retrieve actionable elements for the Ezsignfolder

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve actionable elements for the Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderGetActionableElementsV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetActionableElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetAttachmentCountV1

    open class func ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetAttachmentCountV1Response?, _ error: Error?) -> Void)

Retrieve Attachment count

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Attachment count
ObjectEzsignfolderAPI.ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetAttachmentCountV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetAttachmentsV1

    open class func ezsignfolderGetAttachmentsV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetAttachmentsV1Response?, _ error: Error?) -> Void)

Retrieve Ezsignfolder's Attachments

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Ezsignfolder's Attachments
ObjectEzsignfolderAPI.ezsignfolderGetAttachmentsV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetAttachmentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetCommunicationCountV1

    open class func ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetCommunicationCountV1Response?, _ error: Error?) -> Void)

Retrieve Communication count

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Communication count
ObjectEzsignfolderAPI.ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetCommunicationCountV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetCommunicationListV1

    open class func ezsignfolderGetCommunicationListV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetCommunicationListV1Response?, _ error: Error?) -> Void)

Retrieve Communication list

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Communication list
ObjectEzsignfolderAPI.ezsignfolderGetCommunicationListV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetCommunicationListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetCommunicationrecipientsV1

    open class func ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetCommunicationrecipientsV1Response?, _ error: Error?) -> Void)

Retrieve Ezsignfolder's Communicationrecipient

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Ezsignfolder's Communicationrecipient
ObjectEzsignfolderAPI.ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetCommunicationrecipientsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetCommunicationsendersV1

    open class func ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetCommunicationsendersV1Response?, _ error: Error?) -> Void)

Retrieve Ezsignfolder's Communicationsender

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve Ezsignfolder's Communicationsender
ObjectEzsignfolderAPI.ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetCommunicationsendersV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetEzsigndocumentsV1

    open class func ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetEzsigndocumentsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder's Ezsigndocuments

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder's Ezsigndocuments
ObjectEzsignfolderAPI.ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetEzsigndocumentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetEzsignfoldersignerassociationsV1

    open class func ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetEzsignfoldersignerassociationsV1Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ObjectEzsignfolderAPI.ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetEzsignfoldersignerassociationsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetEzsignsignaturesAutomaticV1

    open class func ezsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetEzsignsignaturesAutomaticV1Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ObjectEzsignfolderAPI.ezsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetEzsignsignaturesAutomaticV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetFormsDataV1

    open class func ezsignfolderGetFormsDataV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetFormsDataV1Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder's forms data

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder's forms data
ObjectEzsignfolderAPI.ezsignfolderGetFormsDataV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetFormsDataV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/zip

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetListV1

    open class func ezsignfolderGetListV1(eOrderBy: EOrderBy_ezsignfolderGetListV1? = nil, iRowMax: Int? = nil, iRowOffset: Int? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, sFilter: String? = nil, completion: @escaping (_ data: EzsignfolderGetListV1Response?, _ error: Error?) -> Void)

Retrieve Ezsignfolder list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter sFilter: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName |

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let eOrderBy = "eOrderBy_example" // String | Specify how you want the results to be sorted (optional)
let iRowMax = 987 // Int |  (optional)
let iRowOffset = 987 // Int |  (optional) (default to 0)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)
let sFilter = "sFilter_example" // String |  (optional)

// Retrieve Ezsignfolder list
ObjectEzsignfolderAPI.ezsignfolderGetListV1(eOrderBy: eOrderBy, iRowMax: iRowMax, iRowOffset: iRowOffset, acceptLanguage: acceptLanguage, sFilter: sFilter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
eOrderBy	String	Specify how you want the results to be sorted	[optional]
iRowMax	Int		[optional]
iRowOffset	Int		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage		[optional]
sFilter	String		[optional]

Return type

EzsignfolderGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetObjectV1

    open class func ezsignfolderGetObjectV1(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetObjectV1Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderGetObjectV1(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderGetObjectV2

    open class func ezsignfolderGetObjectV2(pkiEzsignfolderID: Int, completion: @escaping (_ data: EzsignfolderGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 

// Retrieve an existing Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderGetObjectV2(pkiEzsignfolderID: pkiEzsignfolderID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int

Return type

EzsignfolderGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderImportEzsignfoldersignerassociationsV1

    open class func ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID: Int, ezsignfolderImportEzsignfoldersignerassociationsV1Request: EzsignfolderImportEzsignfoldersignerassociationsV1Request, completion: @escaping (_ data: EzsignfolderImportEzsignfoldersignerassociationsV1Response?, _ error: Error?) -> Void)

Import an existing Ezsignfoldersignerassociation into this Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderImportEzsignfoldersignerassociationsV1Request = ezsignfolder-importEzsignfoldersignerassociations-v1-Request(aFkiEzsignfoldersignerassociationID: [123]) // EzsignfolderImportEzsignfoldersignerassociationsV1Request | 

// Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request: ezsignfolderImportEzsignfoldersignerassociationsV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderImportEzsignfoldersignerassociationsV1Request	EzsignfolderImportEzsignfoldersignerassociationsV1Request

Return type

EzsignfolderImportEzsignfoldersignerassociationsV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderImportEzsigntemplatepackageV1

    open class func ezsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID: Int, ezsignfolderImportEzsigntemplatepackageV1Request: EzsignfolderImportEzsigntemplatepackageV1Request, completion: @escaping (_ data: EzsignfolderImportEzsigntemplatepackageV1Response?, _ error: Error?) -> Void)

Import an Ezsigntemplatepackage in the Ezsignfolder.

This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderImportEzsigntemplatepackageV1Request = ezsignfolder-importEzsigntemplatepackage-v1-Request(fkiEzsigntemplatepackageID: 123, dtEzsigndocumentDuedate: "dtEzsigndocumentDuedate_example", aObjImportEzsigntemplatepackageRelation: [Custom-ImportEzsigntemplatepackageRelation-Request(fkiEzsigntemplatepackagesignerID: 123, fkiEzsignfoldersignerassociationID: 123, sEzsigntemplatepackagesignerDescription: "sEzsigntemplatepackagesignerDescription_example")]) // EzsignfolderImportEzsigntemplatepackageV1Request | 

// Import an Ezsigntemplatepackage in the Ezsignfolder.
ObjectEzsignfolderAPI.ezsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request: ezsignfolderImportEzsigntemplatepackageV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderImportEzsigntemplatepackageV1Request	EzsignfolderImportEzsigntemplatepackageV1Request

Return type

EzsignfolderImportEzsigntemplatepackageV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderReorderV1

    open class func ezsignfolderReorderV1(pkiEzsignfolderID: Int, ezsignfolderReorderV1Request: EzsignfolderReorderV1Request, completion: @escaping (_ data: EzsignfolderReorderV1Response?, _ error: Error?) -> Void)

Reorder Ezsigndocuments in the Ezsignfolder

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderReorderV1Request = ezsignfolder-reorder-v1-Request(aPkiEzsigndocumentID: [123]) // EzsignfolderReorderV1Request | 

// Reorder Ezsigndocuments in the Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderReorderV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderReorderV1Request: ezsignfolderReorderV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderReorderV1Request	EzsignfolderReorderV1Request

Return type

EzsignfolderReorderV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderSendV1

    open class func ezsignfolderSendV1(pkiEzsignfolderID: Int, ezsignfolderSendV1Request: EzsignfolderSendV1Request, completion: @escaping (_ data: EzsignfolderSendV1Response?, _ error: Error?) -> Void)

Send the Ezsignfolder to the signatories for signature

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderSendV1Request = ezsignfolder-send-v1-Request(tExtraMessage: "tExtraMessage_example") // EzsignfolderSendV1Request | 

// Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderAPI.ezsignfolderSendV1(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderSendV1Request: ezsignfolderSendV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderSendV1Request	EzsignfolderSendV1Request

Return type

EzsignfolderSendV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderSendV3

    open class func ezsignfolderSendV3(pkiEzsignfolderID: Int, ezsignfolderSendV3Request: EzsignfolderSendV3Request, completion: @escaping (_ data: EzsignfolderSendV3Response?, _ error: Error?) -> Void)

Send the Ezsignfolder to the signatories for signature

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let ezsignfolderSendV3Request = ezsignfolder-send-v3-Request(tEzsignfolderMessage: "tEzsignfolderMessage_example", dtEzsignfolderDelayedsenddate: "dtEzsignfolderDelayedsenddate_example", aFkiEzsignfoldersignerassociationID: [123]) // EzsignfolderSendV3Request | 

// Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderAPI.ezsignfolderSendV3(pkiEzsignfolderID: pkiEzsignfolderID, ezsignfolderSendV3Request: ezsignfolderSendV3Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
ezsignfolderSendV3Request	EzsignfolderSendV3Request

Return type

EzsignfolderSendV3Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsignfolderUnsendV1

    open class func ezsignfolderUnsendV1(pkiEzsignfolderID: Int, body: AnyCodable, completion: @escaping (_ data: EzsignfolderUnsendV1Response?, _ error: Error?) -> Void)

Unsend the Ezsignfolder

Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on "Non-completed" Ezsigndocuments will be lost.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiEzsignfolderID = 987 // Int | 
let body = "TODO" // AnyCodable | 

// Unsend the Ezsignfolder
ObjectEzsignfolderAPI.ezsignfolderUnsendV1(pkiEzsignfolderID: pkiEzsignfolderID, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	Int
body	AnyCodable

Return type

EzsignfolderUnsendV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ObjectEzsignfolderAPI.md

Latest commit

History

ObjectEzsignfolderAPI.md

File metadata and controls

ObjectEzsignfolderAPI

ezsignfolderArchiveV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderBatchDownloadV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDisposeEzsignfoldersV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDisposeV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderEndPrematurelyV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetActionableElementsV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetAttachmentCountV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetAttachmentsV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetCommunicationCountV1