Skip to content

AccountApi.md

Latest commit

 

History

History
345 lines (283 loc) · 12.4 KB

AccountApi.md

File metadata and controls

345 lines (283 loc) · 12.4 KB

Account Methods

Method Description
CreateAccountImage Create an Account Image
DeleteAccountImageById Delete Account Image By Id
GetAccountSettingsImagesById Get Account Image By ID
ListAccountImages List Account Images
ListAccountSettings List Account Settings
UpdateAccountSettingsImagesById Update Account Image By ID

CreateAccountImage

GetAccountSettingsImagesResponseBody CreateAccountImage (CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default)

GetAccountSettingsImagesResponseBody CreateAccountImage (HttpClient methodClient, CreateAccountSettingsImageRequestBody createAccountSettingsImageRequestBody, CancellationToken cancellationToken = default)

Create an Account Image

Create an Account Image

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class CreateAccountImageExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var createAccountSettingsImageRequestBody = new CreateAccountSettingsImageRequestBody();

            try
            {
                // Create an Account Image
                GetAccountSettingsImagesResponseBody result = await shipEngine.CreateAccountImage(createAccountSettingsImageRequestBody);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.CreateAccountImage: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
createAccountSettingsImageRequestBody CreateAccountSettingsImageRequestBody
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetAccountSettingsImagesResponseBody

DeleteAccountImageById

string DeleteAccountImageById (string labelImageId, CancellationToken cancellationToken = default)

string DeleteAccountImageById (HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default)

Delete Account Image By Id

Delete Account Image By Id

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class DeleteAccountImageByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var labelImageId = "labelImageId_example";

            try
            {
                // Delete Account Image By Id
                string result = await shipEngine.DeleteAccountImageById(labelImageId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.DeleteAccountImageById: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
labelImageId string Label Image Id
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string

GetAccountSettingsImagesById

GetAccountSettingsImagesResponseBody GetAccountSettingsImagesById (string labelImageId, CancellationToken cancellationToken = default)

GetAccountSettingsImagesResponseBody GetAccountSettingsImagesById (HttpClient methodClient, string labelImageId, CancellationToken cancellationToken = default)

Get Account Image By ID

Retrieve information for an account image.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class GetAccountSettingsImagesByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var labelImageId = "labelImageId_example";

            try
            {
                // Get Account Image By ID
                GetAccountSettingsImagesResponseBody result = await shipEngine.GetAccountSettingsImagesById(labelImageId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.GetAccountSettingsImagesById: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
labelImageId string Label Image Id
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetAccountSettingsImagesResponseBody

ListAccountImages

ListAccountSettingsImagesResponseBody ListAccountImages (CancellationToken cancellationToken = default)

ListAccountSettingsImagesResponseBody ListAccountImages (HttpClient methodClient, CancellationToken cancellationToken = default)

List Account Images

List all account images for the ShipEngine account

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class ListAccountImagesExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");

            try
            {
                // List Account Images
                ListAccountSettingsImagesResponseBody result = await shipEngine.ListAccountImages();
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.ListAccountImages: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

ListAccountSettingsImagesResponseBody

ListAccountSettings

GetAccountSettingsResponseBody ListAccountSettings (CancellationToken cancellationToken = default)

GetAccountSettingsResponseBody ListAccountSettings (HttpClient methodClient, CancellationToken cancellationToken = default)

List Account Settings

List all account settings for the ShipEngine account

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class ListAccountSettingsExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");

            try
            {
                // List Account Settings
                GetAccountSettingsResponseBody result = await shipEngine.ListAccountSettings();
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.ListAccountSettings: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

GetAccountSettingsResponseBody

UpdateAccountSettingsImagesById

string UpdateAccountSettingsImagesById (UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)

string UpdateAccountSettingsImagesById (HttpClient methodClient, UpdateAccountSettingsImageRequestBody updateAccountSettingsImageRequestBody, string labelImageId, CancellationToken cancellationToken = default)

Update Account Image By ID

Update information for an account image.

Example

using System.Collections.Generic;
using System.Diagnostics;
using ShipEngineSDK;
using ShipEngineSDK.Model;

namespace Example
{
    public class UpdateAccountSettingsImagesByIdExample
    {
        public static async Task Main()
        {
            var shipEngine = new ShipEngine("api_key");
            var updateAccountSettingsImageRequestBody = new UpdateAccountSettingsImageRequestBody();
            var labelImageId = "labelImageId_example";

            try
            {
                // Update Account Image By ID
                string result = await shipEngine.UpdateAccountSettingsImagesById(updateAccountSettingsImageRequestBody, labelImageId);
                Debug.WriteLine(result);
            }
            catch (ShipEngineException e)
            {
                Debug.Print("Exception when calling AccountApi.UpdateAccountSettingsImagesById: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
methodClient HttpClient The HttpClient instance to use for the request.
updateAccountSettingsImageRequestBody UpdateAccountSettingsImageRequestBody
labelImageId string Label Image Id
cancellationToken CancellationToken The cancellation token to use for the request.

Return type

string