Skip to content

Latest commit

 

History

History
338 lines (260 loc) · 10.6 KB

FAXDeliveryReceiptRulesApi.md

File metadata and controls

338 lines (260 loc) · 10.6 KB

IO.ClickSend.ClickSend.Api.FAXDeliveryReceiptRulesApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
FaxDeliveryReceiptAutomationDelete DELETE /automations/fax/receipts/{receipt_rule_id} Delete fax delivery receipt automation
FaxDeliveryReceiptAutomationGet GET /automations/fax/receipts/{receipt_rule_id} Get specific fax delivery receipt automation
FaxDeliveryReceiptAutomationPost POST /automations/fax/receipts Create fax delivery receipt automations
FaxDeliveryReceiptAutomationPut PUT /automations/fax/receipts/{receipt_rule_id} Update fax delivery receipt automation
FaxDeliveryReceiptAutomationsGet GET /automations/fax/receipts Get all fax delivery receipt automations

FaxDeliveryReceiptAutomationDelete

string FaxDeliveryReceiptAutomationDelete (int? receiptRuleId)

Delete fax delivery receipt automation

Delete fax delivery receipt automation

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class FaxDeliveryReceiptAutomationDeleteExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Delete fax delivery receipt automation
                string result = apiInstance.FaxDeliveryReceiptAutomationDelete(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXDeliveryReceiptRulesApi.FaxDeliveryReceiptAutomationDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

FaxDeliveryReceiptAutomationGet

string FaxDeliveryReceiptAutomationGet (int? receiptRuleId)

Get specific fax delivery receipt automation

Get specific fax delivery receipt automation

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class FaxDeliveryReceiptAutomationGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXDeliveryReceiptRulesApi();
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Get specific fax delivery receipt automation
                string result = apiInstance.FaxDeliveryReceiptAutomationGet(receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXDeliveryReceiptRulesApi.FaxDeliveryReceiptAutomationGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
receiptRuleId int? Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

FaxDeliveryReceiptAutomationPost

string FaxDeliveryReceiptAutomationPost (DeliveryReceiptRule body)

Create fax delivery receipt automations

Create fax delivery receipt automations

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class FaxDeliveryReceiptAutomationPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | fax delivery receipt rule model

            try
            {
                // Create fax delivery receipt automations
                string result = apiInstance.FaxDeliveryReceiptAutomationPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXDeliveryReceiptRulesApi.FaxDeliveryReceiptAutomationPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule fax delivery receipt rule model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

FaxDeliveryReceiptAutomationPut

string FaxDeliveryReceiptAutomationPut (DeliveryReceiptRule body, int? receiptRuleId)

Update fax delivery receipt automation

Update fax delivery receipt automation

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class FaxDeliveryReceiptAutomationPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXDeliveryReceiptRulesApi();
            var body = new DeliveryReceiptRule(); // DeliveryReceiptRule | Delivery receipt rule model
            var receiptRuleId = 56;  // int? | Receipt rule id

            try
            {
                // Update fax delivery receipt automation
                string result = apiInstance.FaxDeliveryReceiptAutomationPut(body, receiptRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXDeliveryReceiptRulesApi.FaxDeliveryReceiptAutomationPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body DeliveryReceiptRule Delivery receipt rule model
receiptRuleId int? Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

FaxDeliveryReceiptAutomationsGet

string FaxDeliveryReceiptAutomationsGet (string q = null, int? page = null, int? limit = null)

Get all fax delivery receipt automations

Get all fax delivery receipt automations

Example

using System;
using System.Diagnostics;
using IO.ClickSend.ClickSend.Api;
using IO.ClickSend.Client;
using IO.ClickSend.ClickSend.Model;

namespace Example
{
    public class FaxDeliveryReceiptAutomationsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FAXDeliveryReceiptRulesApi();
            var q = q_example;  // string | Your keyword or query. (optional) 
            var page = 56;  // int? | Page number (optional)  (default to 1)
            var limit = 56;  // int? | Number of records per page (optional)  (default to 10)

            try
            {
                // Get all fax delivery receipt automations
                string result = apiInstance.FaxDeliveryReceiptAutomationsGet(q, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FAXDeliveryReceiptRulesApi.FaxDeliveryReceiptAutomationsGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
q string Your keyword or query. [optional]
page int? Page number [optional] [default to 1]
limit int? Number of records per page [optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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