Skip to content

Latest commit

 

History

History
521 lines (400 loc) · 13.9 KB

AccountApi.md

File metadata and controls

521 lines (400 loc) · 13.9 KB

IO.ClickSend.ClickSend.Api.AccountApi

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

Method HTTP request Description
AccountGet GET /account Get account information
AccountPost POST /account Create a new account
AccountUseageBySubaccountGet GET /account/usage/{year}/{month}/subaccount Get account useage by subaccount
AccountVerifySendPut PUT /account-verify/send Send account activation token
AccountVerifyVerifyByActivationTokenPut PUT /account-verify/verify/{activation_token} Verify new account
ForgotPasswordPut PUT /forgot-password Forgot password
ForgotPasswordVerifyPut PUT /forgot-password/verify Verify forgot password
ForgotUsernamePut PUT /forgot-username Forgot username

AccountGet

string AccountGet ()

Get account information

Get account details

Example

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

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

            var apiInstance = new AccountApi();

            try
            {
                // Get account information
                string result = apiInstance.AccountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.AccountGet: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

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]

AccountPost

string AccountPost (Account body)

Create a new account

Create An Account

Example

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

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

            var apiInstance = new AccountApi();
            var body = new Account(); // Account | Account model

            try
            {
                // Create a new account
                string result = apiInstance.AccountPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.AccountPost: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body Account Account 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]

AccountUseageBySubaccountGet

string AccountUseageBySubaccountGet (int? year, int? month)

Get account useage by subaccount

Get account useage by subaccount

Example

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

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

            var apiInstance = new AccountApi();
            var year = 56;  // int? | Year to filter by (yyyy)
            var month = 56;  // int? | Month to filter by (mm)

            try
            {
                // Get account useage by subaccount
                string result = apiInstance.AccountUseageBySubaccountGet(year, month);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.AccountUseageBySubaccountGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
year int? Year to filter by (yyyy)
month int? Month to filter by (mm)

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]

AccountVerifySendPut

string AccountVerifySendPut (AccountVerify body)

Send account activation token

Send account activation token

Example

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

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

            var apiInstance = new AccountApi();
            var body = new AccountVerify(); // AccountVerify | Account details

            try
            {
                // Send account activation token
                string result = apiInstance.AccountVerifySendPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.AccountVerifySendPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body AccountVerify Account details

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]

AccountVerifyVerifyByActivationTokenPut

string AccountVerifyVerifyByActivationTokenPut (int? activationToken)

Verify new account

Verify new account

Example

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

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

            var apiInstance = new AccountApi();
            var activationToken = 56;  // int? | 

            try
            {
                // Verify new account
                string result = apiInstance.AccountVerifyVerifyByActivationTokenPut(activationToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.AccountVerifyVerifyByActivationTokenPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
activationToken int?

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]

ForgotPasswordPut

string ForgotPasswordPut (ForgotPassword body = null)

Forgot password

Forgot password

Example

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

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

            var apiInstance = new AccountApi();
            var body = new ForgotPassword(); // ForgotPassword |  (optional) 

            try
            {
                // Forgot password
                string result = apiInstance.ForgotPasswordPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.ForgotPasswordPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body ForgotPassword [optional]

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]

ForgotPasswordVerifyPut

string ForgotPasswordVerifyPut (AccountForgotPasswordVerify body)

Verify forgot password

Verify forgot password

Example

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

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

            var apiInstance = new AccountApi();
            var body = new AccountForgotPasswordVerify(); // AccountForgotPasswordVerify | verifyPassword data

            try
            {
                // Verify forgot password
                string result = apiInstance.ForgotPasswordVerifyPut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.ForgotPasswordVerifyPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body AccountForgotPasswordVerify verifyPassword data

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]

ForgotUsernamePut

string ForgotUsernamePut (ForgotUsername body = null)

Forgot username

Forgot username

Example

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

namespace Example
{
    public class ForgotUsernamePutExample
    {
        public void main()
        {
            var apiInstance = new AccountApi();
            var body = new ForgotUsername(); // ForgotUsername |  (optional) 

            try
            {
                // Forgot username
                string result = apiInstance.ForgotUsernamePut(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountApi.ForgotUsernamePut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body ForgotUsername [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

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

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