Skip to content

WebhooksApi.md

Latest commit

 

History

History
397 lines (303 loc) · 10.7 KB

WebhooksApi.md

File metadata and controls

397 lines (303 loc) · 10.7 KB

SignRequest.Api.WebhooksApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
WebhooksCreate POST /webhooks/ Create a Webhook
WebhooksDelete DELETE /webhooks/{uuid}/ Delete a Webhook
WebhooksList GET /webhooks/ Retrieve a list of Webhooks
WebhooksPartialUpdate PATCH /webhooks/{uuid}/ Partially update a Webhook
WebhooksRead GET /webhooks/{uuid}/ Retrieve a Webhook
WebhooksUpdate PUT /webhooks/{uuid}/ Update a Webhook

WebhooksCreate

WebhookSubscription WebhooksCreate (WebhookSubscription data)

Create a Webhook

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksCreateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var data = new WebhookSubscription(); // WebhookSubscription | 

            try
            {
                // Create a Webhook
                WebhookSubscription result = apiInstance.WebhooksCreate(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksCreate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

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

WebhooksDelete

void WebhooksDelete (string uuid)

Delete a Webhook

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var uuid = uuid_example;  // string | 

            try
            {
                // Delete a Webhook
                apiInstance.WebhooksDelete(uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
uuid string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

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

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

WebhooksList

InlineResponse2009 WebhooksList (int? page = null, int? limit = null)

Retrieve a list of Webhooks

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksListExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var page = 56;  // int? | A page number within the paginated result set. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 

            try
            {
                // Retrieve a list of Webhooks
                InlineResponse2009 result = apiInstance.WebhooksList(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksList: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
page int? A page number within the paginated result set. [optional]
limit int? Number of results to return per page. [optional]

Return type

InlineResponse2009

Authorization

Token

HTTP request headers

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

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

WebhooksPartialUpdate

WebhookSubscription WebhooksPartialUpdate (string uuid, WebhookSubscription data)

Partially update a Webhook

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksPartialUpdateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var uuid = uuid_example;  // string | 
            var data = new WebhookSubscription(); // WebhookSubscription | 

            try
            {
                // Partially update a Webhook
                WebhookSubscription result = apiInstance.WebhooksPartialUpdate(uuid, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksPartialUpdate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
uuid string
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

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

WebhooksRead

WebhookSubscription WebhooksRead (string uuid)

Retrieve a Webhook

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksReadExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var uuid = uuid_example;  // string | 

            try
            {
                // Retrieve a Webhook
                WebhookSubscription result = apiInstance.WebhooksRead(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksRead: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
uuid string

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

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

WebhooksUpdate

WebhookSubscription WebhooksUpdate (string uuid, WebhookSubscription data)

Update a Webhook

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class WebhooksUpdateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new WebhooksApi();
            var uuid = uuid_example;  // string | 
            var data = new WebhookSubscription(); // WebhookSubscription | 

            try
            {
                // Update a Webhook
                WebhookSubscription result = apiInstance.WebhooksUpdate(uuid, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.WebhooksUpdate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
uuid string
data WebhookSubscription

Return type

WebhookSubscription

Authorization

Token

HTTP request headers

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

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