Skip to content

EmailSubscribersApi.md

Latest commit

 

History

History
498 lines (405 loc) · 16.1 KB

EmailSubscribersApi.md

File metadata and controls

498 lines (405 loc) · 16.1 KB
Raw

WalletInc.Api.EmailSubscribersApi

All URIs are relative to https://api.wall.et

Method HTTP request Description
ArchiveEmailSubscriber DELETE /v2/emailSubscriber/{id} Archive Email Subscriber
CreateEmailSubscriber POST /v2/emailSubscriber Create Email Subscriber
FetchAllEmailSubscribers GET /v2/emailSubscriber/all Get all Email Subscribers
RestoreEmailSubscriber PATCH /v2/emailSubscriber/{id} Restore Email Subscriber
UpdateEmailSubscriber PUT /v2/emailSubscriber/{id} Update Email Subscriber

ArchiveEmailSubscriber

EmailSubscriber ArchiveEmailSubscriber (string id)

Archive Email Subscriber

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using WalletInc.Api;
using WalletInc.Client;
using WalletInc.Model;

namespace Example
{
    public class ArchiveEmailSubscriberExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.wall.et";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new EmailSubscribersApi(httpClient, config, httpClientHandler);
            var id = "id_example";  // string | 

            try
            {
                // Archive Email Subscriber
                EmailSubscriber result = apiInstance.ArchiveEmailSubscriber(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmailSubscribersApi.ArchiveEmailSubscriber: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ArchiveEmailSubscriberWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Archive Email Subscriber
    ApiResponse<EmailSubscriber> response = apiInstance.ArchiveEmailSubscriberWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmailSubscribersApi.ArchiveEmailSubscriberWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string

Return type

EmailSubscriber

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

CreateEmailSubscriber

EmailSubscriber CreateEmailSubscriber (WTEmailSubscriberCreateParams wTEmailSubscriberCreateParams)

Create Email Subscriber

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using WalletInc.Api;
using WalletInc.Client;
using WalletInc.Model;

namespace Example
{
    public class CreateEmailSubscriberExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.wall.et";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new EmailSubscribersApi(httpClient, config, httpClientHandler);
            var wTEmailSubscriberCreateParams = new WTEmailSubscriberCreateParams(); // WTEmailSubscriberCreateParams | 

            try
            {
                // Create Email Subscriber
                EmailSubscriber result = apiInstance.CreateEmailSubscriber(wTEmailSubscriberCreateParams);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmailSubscribersApi.CreateEmailSubscriber: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreateEmailSubscriberWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create Email Subscriber
    ApiResponse<EmailSubscriber> response = apiInstance.CreateEmailSubscriberWithHttpInfo(wTEmailSubscriberCreateParams);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmailSubscribersApi.CreateEmailSubscriberWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
wTEmailSubscriberCreateParams WTEmailSubscriberCreateParams

Return type

EmailSubscriber

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

FetchAllEmailSubscribers

Object FetchAllEmailSubscribers (DateTime? startDateTime = null, DateTime? endDateTime = null, bool? isArchiveIncluded = null)

Get all Email Subscribers

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using WalletInc.Api;
using WalletInc.Client;
using WalletInc.Model;

namespace Example
{
    public class FetchAllEmailSubscribersExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.wall.et";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new EmailSubscribersApi(httpClient, config, httpClientHandler);
            var startDateTime = DateTime.Parse("2013-10-20T19:20:30+01:00");  // DateTime? |  (optional) 
            var endDateTime = DateTime.Parse("2013-10-20T19:20:30+01:00");  // DateTime? |  (optional) 
            var isArchiveIncluded = true;  // bool? |  (optional) 

            try
            {
                // Get all Email Subscribers
                Object result = apiInstance.FetchAllEmailSubscribers(startDateTime, endDateTime, isArchiveIncluded);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmailSubscribersApi.FetchAllEmailSubscribers: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the FetchAllEmailSubscribersWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get all Email Subscribers
    ApiResponse<Object> response = apiInstance.FetchAllEmailSubscribersWithHttpInfo(startDateTime, endDateTime, isArchiveIncluded);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmailSubscribersApi.FetchAllEmailSubscribersWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
startDateTime DateTime? [optional]
endDateTime DateTime? [optional]
isArchiveIncluded bool? [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

RestoreEmailSubscriber

EmailSubscriber RestoreEmailSubscriber (string id)

Restore Email Subscriber

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using WalletInc.Api;
using WalletInc.Client;
using WalletInc.Model;

namespace Example
{
    public class RestoreEmailSubscriberExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.wall.et";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new EmailSubscribersApi(httpClient, config, httpClientHandler);
            var id = "id_example";  // string | 

            try
            {
                // Restore Email Subscriber
                EmailSubscriber result = apiInstance.RestoreEmailSubscriber(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmailSubscribersApi.RestoreEmailSubscriber: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the RestoreEmailSubscriberWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Restore Email Subscriber
    ApiResponse<EmailSubscriber> response = apiInstance.RestoreEmailSubscriberWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmailSubscribersApi.RestoreEmailSubscriberWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string

Return type

EmailSubscriber

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

UpdateEmailSubscriber

EmailSubscriber UpdateEmailSubscriber (string id, WTEmailSubscriberUpdateParams wTEmailSubscriberUpdateParams)

Update Email Subscriber

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using WalletInc.Api;
using WalletInc.Client;
using WalletInc.Model;

namespace Example
{
    public class UpdateEmailSubscriberExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.wall.et";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new EmailSubscribersApi(httpClient, config, httpClientHandler);
            var id = "id_example";  // string | 
            var wTEmailSubscriberUpdateParams = new WTEmailSubscriberUpdateParams(); // WTEmailSubscriberUpdateParams | 

            try
            {
                // Update Email Subscriber
                EmailSubscriber result = apiInstance.UpdateEmailSubscriber(id, wTEmailSubscriberUpdateParams);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmailSubscribersApi.UpdateEmailSubscriber: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the UpdateEmailSubscriberWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Update Email Subscriber
    ApiResponse<EmailSubscriber> response = apiInstance.UpdateEmailSubscriberWithHttpInfo(id, wTEmailSubscriberUpdateParams);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling EmailSubscribersApi.UpdateEmailSubscriberWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
id string
wTEmailSubscriberUpdateParams WTEmailSubscriberUpdateParams

Return type

EmailSubscriber

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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