Skip to content

Latest commit

 

History

History
336 lines (258 loc) · 10.1 KB

PostReturnAddressApi.md

File metadata and controls

336 lines (258 loc) · 10.1 KB
Raw

IO.ClickSend.ClickSend.Api.PostReturnAddressApi

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

Method HTTP request Description
PostReturnAddressesByReturnAddressIdDelete DELETE /post/return-addresses/{return_address_id} Delete specific post return address
PostReturnAddressesByReturnAddressIdGet GET /post/return-addresses/{return_address_id} Get specific post return address
PostReturnAddressesByReturnAddressIdPut PUT /post/return-addresses/{return_address_id} Update post return address
PostReturnAddressesGet GET /post/return-addresses Get list of post return addresses
PostReturnAddressesPost POST /post/return-addresses Create post return address

PostReturnAddressesByReturnAddressIdDelete

string PostReturnAddressesByReturnAddressIdDelete (int? returnAddressId)

Delete specific post return address

Delete specific post return address

Example

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

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

            var apiInstance = new PostReturnAddressApi();
            var returnAddressId = 56;  // int? | Return address ID

            try
            {
                // Delete specific post return address
                string result = apiInstance.PostReturnAddressesByReturnAddressIdDelete(returnAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostReturnAddressApi.PostReturnAddressesByReturnAddressIdDelete: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
returnAddressId int? Return address 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]

PostReturnAddressesByReturnAddressIdGet

string PostReturnAddressesByReturnAddressIdGet (int? returnAddressId)

Get specific post return address

Get specific post return address

Example

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

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

            var apiInstance = new PostReturnAddressApi();
            var returnAddressId = 56;  // int? | Return address ID

            try
            {
                // Get specific post return address
                string result = apiInstance.PostReturnAddressesByReturnAddressIdGet(returnAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostReturnAddressApi.PostReturnAddressesByReturnAddressIdGet: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
returnAddressId int? Return address 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]

PostReturnAddressesByReturnAddressIdPut

string PostReturnAddressesByReturnAddressIdPut (Address body, int? returnAddressId)

Update post return address

Update post return address

Example

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

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

            var apiInstance = new PostReturnAddressApi();
            var body = new Address(); // Address | Address model
            var returnAddressId = 56;  // int? | Return address ID

            try
            {
                // Update post return address
                string result = apiInstance.PostReturnAddressesByReturnAddressIdPut(body, returnAddressId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostReturnAddressApi.PostReturnAddressesByReturnAddressIdPut: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
body Address Address model
returnAddressId int? Return address 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]

PostReturnAddressesGet

string PostReturnAddressesGet (int? page = null, int? limit = null)

Get list of post return addresses

Get list of post return addresses

Example

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

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

            var apiInstance = new PostReturnAddressApi();
            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 list of post return addresses
                string result = apiInstance.PostReturnAddressesGet(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostReturnAddressApi.PostReturnAddressesGet: " + e.Message );
            }
        }
    }
}

Parameters

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

PostReturnAddressesPost

string PostReturnAddressesPost (Address body)

Create post return address

Create post return address

Example

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

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

            var apiInstance = new PostReturnAddressApi();
            var body = new Address(); // Address | Address model

            try
            {
                // Create post return address
                string result = apiInstance.PostReturnAddressesPost(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PostReturnAddressApi.PostReturnAddressesPost: " + e.Message );
            }
        }
    }
}

Parameters

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