Skip to content

Latest commit

 

History

History
432 lines (294 loc) · 14.8 KB

ObjectWebhookAPI.md

File metadata and controls

432 lines (294 loc) · 14.8 KB

ObjectWebhookAPI

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

Method HTTP request Description
webhookCreateObjectV2 POST /2/object/webhook Create a new Webhook
webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
webhookRegenerateApikeyV1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url

webhookCreateObjectV2

    open class func webhookCreateObjectV2(webhookCreateObjectV2Request: WebhookCreateObjectV2Request, completion: @escaping (_ data: WebhookCreateObjectV2Response?, _ error: Error?) -> Void)

Create a new Webhook

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 webhookCreateObjectV2Request = webhook-createObject-v2-Request(aObjWebhook: [webhook-RequestCompound(pkiWebhookID: 123, fkiEzsignfoldertypeID: 123, sWebhookDescription: "sWebhookDescription_example", eWebhookModule: Field-eWebhookModule(), eWebhookEzsignevent: Field-eWebhookEzsignevent(), eWebhookManagementevent: Field-eWebhookManagementevent(), sWebhookUrl: "sWebhookUrl_example", sWebhookEmailfailed: "sWebhookEmailfailed_example", bWebhookIsactive: true, bWebhookIssigned: true, bWebhookSkipsslvalidation: false, aObjWebhookheader: [webhookheader-RequestCompound(pkiWebhookheaderID: 123, sWebhookheaderName: "sWebhookheaderName_example", sWebhookheaderValue: "sWebhookheaderValue_example")])]) // WebhookCreateObjectV2Request | 

// Create a new Webhook
ObjectWebhookAPI.webhookCreateObjectV2(webhookCreateObjectV2Request: webhookCreateObjectV2Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
webhookCreateObjectV2Request WebhookCreateObjectV2Request

Return type

WebhookCreateObjectV2Response

Authorization

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]

webhookDeleteObjectV1

    open class func webhookDeleteObjectV1(pkiWebhookID: Int, completion: @escaping (_ data: WebhookDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Webhook

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 pkiWebhookID = 987 // Int | 

// Delete an existing Webhook
ObjectWebhookAPI.webhookDeleteObjectV1(pkiWebhookID: pkiWebhookID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int

Return type

WebhookDeleteObjectV1Response

Authorization

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]

webhookEditObjectV1

    open class func webhookEditObjectV1(pkiWebhookID: Int, webhookEditObjectV1Request: WebhookEditObjectV1Request, completion: @escaping (_ data: WebhookEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Webhook

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 pkiWebhookID = 987 // Int | 
let webhookEditObjectV1Request = webhook-editObject-v1-Request(objWebhook: webhook-RequestCompound(pkiWebhookID: 123, fkiEzsignfoldertypeID: 123, sWebhookDescription: "sWebhookDescription_example", eWebhookModule: Field-eWebhookModule(), eWebhookEzsignevent: Field-eWebhookEzsignevent(), eWebhookManagementevent: Field-eWebhookManagementevent(), sWebhookUrl: "sWebhookUrl_example", sWebhookEmailfailed: "sWebhookEmailfailed_example", bWebhookIsactive: true, bWebhookIssigned: true, bWebhookSkipsslvalidation: false, aObjWebhookheader: [webhookheader-RequestCompound(pkiWebhookheaderID: 123, sWebhookheaderName: "sWebhookheaderName_example", sWebhookheaderValue: "sWebhookheaderValue_example")])) // WebhookEditObjectV1Request | 

// Edit an existing Webhook
ObjectWebhookAPI.webhookEditObjectV1(pkiWebhookID: pkiWebhookID, webhookEditObjectV1Request: webhookEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int
webhookEditObjectV1Request WebhookEditObjectV1Request

Return type

WebhookEditObjectV1Response

Authorization

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]

webhookGetHistoryV1

    open class func webhookGetHistoryV1(pkiWebhookID: Int, eWebhookHistoryinterval: EWebhookHistoryinterval_webhookGetHistoryV1, completion: @escaping (_ data: WebhookGetHistoryV1Response?, _ error: Error?) -> Void)

Retrieve the logs for recent Webhook calls

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 pkiWebhookID = 987 // Int | 
let eWebhookHistoryinterval = "eWebhookHistoryinterval_example" // String | The number of days to return

// Retrieve the logs for recent Webhook calls
ObjectWebhookAPI.webhookGetHistoryV1(pkiWebhookID: pkiWebhookID, eWebhookHistoryinterval: eWebhookHistoryinterval) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int
eWebhookHistoryinterval String The number of days to return

Return type

WebhookGetHistoryV1Response

Authorization

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]

webhookGetListV1

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

Retrieve Webhook list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated |

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 Webhook list
ObjectWebhookAPI.webhookGetListV1(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

WebhookGetListV1Response

Authorization

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]

webhookGetObjectV2

    open class func webhookGetObjectV2(pkiWebhookID: Int, completion: @escaping (_ data: WebhookGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Webhook

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 pkiWebhookID = 987 // Int | 

// Retrieve an existing Webhook
ObjectWebhookAPI.webhookGetObjectV2(pkiWebhookID: pkiWebhookID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int

Return type

WebhookGetObjectV2Response

Authorization

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]

webhookRegenerateApikeyV1

    open class func webhookRegenerateApikeyV1(pkiWebhookID: Int, webhookRegenerateApikeyV1Request: WebhookRegenerateApikeyV1Request, completion: @escaping (_ data: WebhookRegenerateApikeyV1Response?, _ error: Error?) -> Void)

Regenerate the Apikey

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 pkiWebhookID = 987 // Int | 
let webhookRegenerateApikeyV1Request = webhook-regenerateApikey-v1-Request(bWebhookIssigned: true) // WebhookRegenerateApikeyV1Request | 

// Regenerate the Apikey
ObjectWebhookAPI.webhookRegenerateApikeyV1(pkiWebhookID: pkiWebhookID, webhookRegenerateApikeyV1Request: webhookRegenerateApikeyV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int
webhookRegenerateApikeyV1Request WebhookRegenerateApikeyV1Request

Return type

WebhookRegenerateApikeyV1Response

Authorization

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]

webhookTestV1

    open class func webhookTestV1(pkiWebhookID: Int, body: AnyCodable, completion: @escaping (_ data: WebhookTestV1Response?, _ error: Error?) -> Void)

Test the Webhook by calling the Url

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 pkiWebhookID = 987 // Int | 
let body = "TODO" // AnyCodable | 

// Test the Webhook by calling the Url
ObjectWebhookAPI.webhookTestV1(pkiWebhookID: pkiWebhookID, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiWebhookID Int
body AnyCodable

Return type

WebhookTestV1Response

Authorization

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]