Skip to content

Latest commit

 

History

History
338 lines (260 loc) · 9.93 KB

InboundFAXRulesApi.md

File metadata and controls

338 lines (260 loc) · 9.93 KB

IO.ClickSend.ClickSend.Api.InboundFAXRulesApi

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

Method HTTP request Description
FaxInboundAutomationDelete DELETE /automations/fax/inbound/{inbound_rule_id} Delete inbound fax automation
FaxInboundAutomationGet GET /automations/fax/inbound/{inbound_rule_id} Get specific inbound fax automation
FaxInboundAutomationPost POST /automations/fax/inbound Create new inbound fax automation
FaxInboundAutomationPut PUT /automations/fax/inbound/{inbound_rule_id} Update inbound fax automation
FaxInboundAutomationsGet GET /automations/fax/inbound Get all inbound fax automations

FaxInboundAutomationDelete

string FaxInboundAutomationDelete (int? inboundRuleId)

Delete inbound fax automation

Delete inbound fax 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 FaxInboundAutomationDeleteExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new InboundFAXRulesApi();
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Delete inbound fax automation
                string result = apiInstance.FaxInboundAutomationDelete(inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundFAXRulesApi.FaxInboundAutomationDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
inboundRuleId int? Inbound 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]

FaxInboundAutomationGet

string FaxInboundAutomationGet (int? inboundRuleId)

Get specific inbound fax automation

Get specific inbound fax 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 FaxInboundAutomationGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new InboundFAXRulesApi();
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Get specific inbound fax automation
                string result = apiInstance.FaxInboundAutomationGet(inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundFAXRulesApi.FaxInboundAutomationGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
inboundRuleId int? Inbound 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]

FaxInboundAutomationPost

string FaxInboundAutomationPost (InboundFaxRule body)

Create new inbound fax automation

Create new inbound fax 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 FaxInboundAutomationPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new InboundFAXRulesApi();
            var body = new InboundFaxRule(); // InboundFaxRule | Inbound fax rule model

            try
            {
                // Create new inbound fax automation
                string result = apiInstance.FaxInboundAutomationPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundFAXRulesApi.FaxInboundAutomationPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body InboundFaxRule Inbound fax 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]

FaxInboundAutomationPut

string FaxInboundAutomationPut (InboundFaxRule body, int? inboundRuleId)

Update inbound fax automation

Update inbound fax 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 FaxInboundAutomationPutExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new InboundFAXRulesApi();
            var body = new InboundFaxRule(); // InboundFaxRule | Inbound fax rule model
            var inboundRuleId = 56;  // int? | Inbound rule id

            try
            {
                // Update inbound fax automation
                string result = apiInstance.FaxInboundAutomationPut(body, inboundRuleId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundFAXRulesApi.FaxInboundAutomationPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body InboundFaxRule Inbound fax rule model
inboundRuleId int? Inbound 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]

FaxInboundAutomationsGet

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

Get all inbound fax automations

Get all inbound fax 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 FaxInboundAutomationsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new InboundFAXRulesApi();
            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 inbound fax automations
                string result = apiInstance.FaxInboundAutomationsGet(q, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboundFAXRulesApi.FaxInboundAutomationsGet: " + 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]