Handwrytten API

AddressBook

addRecipient

Add recipient address to user addressbook

Add recipient address to user addressbook


/profile/addRecipient

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/addRecipient"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Boolean validateAddress = true; // Boolean | 
        String state = state_example; // String | 
        String countryId = countryId_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String name = name_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String zip = zip_example; // String | 
        String birthday = birthday_example; // String | 
        try {
            inline_response_200_12 result = apiInstance.addRecipient(validateAddress, state, countryId, firstName, lastName, name, address1, address2, city, zip, birthday);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#addRecipient");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Boolean validateAddress = true; // Boolean | 
        String state = state_example; // String | 
        String countryId = countryId_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String name = name_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String zip = zip_example; // String | 
        String birthday = birthday_example; // String | 
        try {
            inline_response_200_12 result = apiInstance.addRecipient(validateAddress, state, countryId, firstName, lastName, name, address1, address2, city, zip, birthday);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#addRecipient");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Boolean *validateAddress = true; //  (optional)
String *state = state_example; //  (optional)
String *countryId = countryId_example; //  (optional)
String *firstName = firstName_example; //  (optional)
String *lastName = lastName_example; //  (optional)
String *name = name_example; //  (optional)
String *address1 = address1_example; //  (optional)
String *address2 = address2_example; //  (optional)
String *city = city_example; //  (optional)
String *zip = zip_example; //  (optional)
String *birthday = birthday_example; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Add recipient address to user addressbook
[apiInstance addRecipientWith:validateAddress
    state:state
    countryId:countryId
    firstName:firstName
    lastName:lastName
    name:name
    address1:address1
    address2:address2
    city:city
    zip:zip
    birthday:birthday
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addRecipient(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addRecipientExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var validateAddress = true;  // Boolean |  (optional) 
            var state = state_example;  // String |  (optional) 
            var countryId = countryId_example;  // String |  (optional) 
            var firstName = firstName_example;  // String |  (optional) 
            var lastName = lastName_example;  // String |  (optional) 
            var name = name_example;  // String |  (optional) 
            var address1 = address1_example;  // String |  (optional) 
            var address2 = address2_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 
            var zip = zip_example;  // String |  (optional) 
            var birthday = birthday_example;  // String |  (optional) 

            try
            {
                // Add recipient address to user addressbook
                inline_response_200_12 result = apiInstance.addRecipient(validateAddress, state, countryId, firstName, lastName, name, address1, address2, city, zip, birthday);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.addRecipient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$validateAddress = true; // Boolean | 
$state = state_example; // String | 
$countryId = countryId_example; // String | 
$firstName = firstName_example; // String | 
$lastName = lastName_example; // String | 
$name = name_example; // String | 
$address1 = address1_example; // String | 
$address2 = address2_example; // String | 
$city = city_example; // String | 
$zip = zip_example; // String | 
$birthday = birthday_example; // String | 

try {
    $result = $api_instance->addRecipient($validateAddress, $state, $countryId, $firstName, $lastName, $name, $address1, $address2, $city, $zip, $birthday);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->addRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $validateAddress = true; # Boolean | 
my $state = state_example; # String | 
my $countryId = countryId_example; # String | 
my $firstName = firstName_example; # String | 
my $lastName = lastName_example; # String | 
my $name = name_example; # String | 
my $address1 = address1_example; # String | 
my $address2 = address2_example; # String | 
my $city = city_example; # String | 
my $zip = zip_example; # String | 
my $birthday = birthday_example; # String | 

eval { 
    my $result = $api_instance->addRecipient(validateAddress => $validateAddress, state => $state, countryId => $countryId, firstName => $firstName, lastName => $lastName, name => $name, address1 => $address1, address2 => $address2, city => $city, zip => $zip, birthday => $birthday);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->addRecipient: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
validateAddress = true # Boolean |  (optional)
state = state_example # String |  (optional)
countryId = countryId_example # String |  (optional)
firstName = firstName_example # String |  (optional)
lastName = lastName_example # String |  (optional)
name = name_example # String |  (optional)
address1 = address1_example # String |  (optional)
address2 = address2_example # String |  (optional)
city = city_example # String |  (optional)
zip = zip_example # String |  (optional)
birthday = birthday_example # String |  (optional)

try: 
    # Add recipient address to user addressbook
    api_response = api_instance.add_recipient(validateAddress=validateAddress, state=state, countryId=countryId, firstName=firstName, lastName=lastName, name=name, address1=address1, address2=address2, city=city, zip=zip, birthday=birthday)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->addRecipient: %s\n" % e)

Parameters

Form parameters
Name Description
validate_address
Boolean
state
String
country_id
String
first_name
String
last_name
String
name
String
address1
String
address2
String
city
String
zip
String
birthday
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Error


basketItemFromAddress

Get sender address for basket item

Get sender address for basket item. Used in editing basket item flow. (Return address_ids)


/basket/itemFromAddress

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/basket/itemFromAddress?id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | basket item id (basket_id)
        try {
            inline_response_200_49 result = apiInstance.basketItemFromAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#basketItemFromAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | basket item id (basket_id)
        try {
            inline_response_200_49 result = apiInstance.basketItemFromAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#basketItemFromAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *id = 56; // basket item id (basket_id)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get sender address for basket item
[apiInstance basketItemFromAddressWith:id
              completionHandler: ^(inline_response_200_49 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()
var id = 56; // {{Integer}} basket item id (basket_id)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.basketItemFromAddress(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class basketItemFromAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var id = 56;  // Integer | basket item id (basket_id)

            try
            {
                // Get sender address for basket item
                inline_response_200_49 result = apiInstance.basketItemFromAddress(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.basketItemFromAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$id = 56; // Integer | basket item id (basket_id)

try {
    $result = $api_instance->basketItemFromAddress($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->basketItemFromAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $id = 56; # Integer | basket item id (basket_id)

eval { 
    my $result = $api_instance->basketItemFromAddress(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->basketItemFromAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
id = 56 # Integer | basket item id (basket_id)

try: 
    # Get sender address for basket item
    api_response = api_instance.basket_item_from_address(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->basketItemFromAddress: %s\n" % e)

Parameters

Query parameters
Name Description
id*
Integer
basket item id (basket_id)
Required

Responses

Status: 200 - successful

Status: 400 - Error

Status: 401 - no auth


bulkAddressParseXls

Parse XLS/CSV file with bulk addresses

Parse XLS/CSV file with bulk addresses, save to addressbook.


/profile/parseXls

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/parseXls"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        byte[] file = file_example; // byte[] | 
        try {
            inline_response_200_15 result = apiInstance.bulkAddressParseXls(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#bulkAddressParseXls");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        byte[] file = file_example; // byte[] | 
        try {
            inline_response_200_15 result = apiInstance.bulkAddressParseXls(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#bulkAddressParseXls");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
byte[] *file = file_example; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Parse XLS/CSV file with bulk addresses
[apiInstance bulkAddressParseXlsWith:file
              completionHandler: ^(inline_response_200_15 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulkAddressParseXls(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class bulkAddressParseXlsExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var file = file_example;  // byte[] |  (optional) 

            try
            {
                // Parse XLS/CSV file with bulk addresses
                inline_response_200_15 result = apiInstance.bulkAddressParseXls(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.bulkAddressParseXls: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$file = file_example; // byte[] | 

try {
    $result = $api_instance->bulkAddressParseXls($file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->bulkAddressParseXls: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $file = file_example; # byte[] | 

eval { 
    my $result = $api_instance->bulkAddressParseXls(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->bulkAddressParseXls: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
file = file_example # byte[] |  (optional)

try: 
    # Parse XLS/CSV file with bulk addresses
    api_response = api_instance.bulk_address_parse_xls(file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->bulkAddressParseXls: %s\n" % e)

Parameters

Form parameters
Name Description
file
byte[] (binary)

Responses

Status: 200 - successful

Status: 400 - Error


createUserAddress

Add new user`s address

Add new user`s address


/profile/createAddress

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/createAddress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Boolean default = true; // Boolean | 
        Boolean validateAddress = true; // Boolean | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.createUserAddress(default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#createUserAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Boolean default = true; // Boolean | 
        Boolean validateAddress = true; // Boolean | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.createUserAddress(default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#createUserAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Boolean *default = true; //  (optional)
Boolean *validateAddress = true; //  (optional)
String *name = name_example; //  (optional)
String *firstName = firstName_example; //  (optional)
String *lastName = lastName_example; //  (optional)
String *businessName = businessName_example; //  (optional)
String *address1 = address1_example; //  (optional)
String *address2 = address2_example; //  (optional)
String *city = city_example; //  (optional)
String *state = state_example; //  (optional)
String *zip = zip_example; //  (optional)
String *countryId = countryId_example; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Add new user`s address
[apiInstance createUserAddressWith:default
    validateAddress:validateAddress
    name:name
    firstName:firstName
    lastName:lastName
    businessName:businessName
    address1:address1
    address2:address2
    city:city
    state:state
    zip:zip
    countryId:countryId
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUserAddress(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUserAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var default = true;  // Boolean |  (optional) 
            var validateAddress = true;  // Boolean |  (optional) 
            var name = name_example;  // String |  (optional) 
            var firstName = firstName_example;  // String |  (optional) 
            var lastName = lastName_example;  // String |  (optional) 
            var businessName = businessName_example;  // String |  (optional) 
            var address1 = address1_example;  // String |  (optional) 
            var address2 = address2_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 
            var state = state_example;  // String |  (optional) 
            var zip = zip_example;  // String |  (optional) 
            var countryId = countryId_example;  // String |  (optional) 

            try
            {
                // Add new user`s address
                inline_response_200_9 result = apiInstance.createUserAddress(default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.createUserAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$default = true; // Boolean | 
$validateAddress = true; // Boolean | 
$name = name_example; // String | 
$firstName = firstName_example; // String | 
$lastName = lastName_example; // String | 
$businessName = businessName_example; // String | 
$address1 = address1_example; // String | 
$address2 = address2_example; // String | 
$city = city_example; // String | 
$state = state_example; // String | 
$zip = zip_example; // String | 
$countryId = countryId_example; // String | 

try {
    $result = $api_instance->createUserAddress($default, $validateAddress, $name, $firstName, $lastName, $businessName, $address1, $address2, $city, $state, $zip, $countryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->createUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $default = true; # Boolean | 
my $validateAddress = true; # Boolean | 
my $name = name_example; # String | 
my $firstName = firstName_example; # String | 
my $lastName = lastName_example; # String | 
my $businessName = businessName_example; # String | 
my $address1 = address1_example; # String | 
my $address2 = address2_example; # String | 
my $city = city_example; # String | 
my $state = state_example; # String | 
my $zip = zip_example; # String | 
my $countryId = countryId_example; # String | 

eval { 
    my $result = $api_instance->createUserAddress(default => $default, validateAddress => $validateAddress, name => $name, firstName => $firstName, lastName => $lastName, businessName => $businessName, address1 => $address1, address2 => $address2, city => $city, state => $state, zip => $zip, countryId => $countryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->createUserAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
default = true # Boolean |  (optional)
validateAddress = true # Boolean |  (optional)
name = name_example # String |  (optional)
firstName = firstName_example # String |  (optional)
lastName = lastName_example # String |  (optional)
businessName = businessName_example # String |  (optional)
address1 = address1_example # String |  (optional)
address2 = address2_example # String |  (optional)
city = city_example # String |  (optional)
state = state_example # String |  (optional)
zip = zip_example # String |  (optional)
countryId = countryId_example # String |  (optional)

try: 
    # Add new user`s address
    api_response = api_instance.create_user_address(default=default, validateAddress=validateAddress, name=name, firstName=firstName, lastName=lastName, businessName=businessName, address1=address1, address2=address2, city=city, state=state, zip=zip, countryId=countryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->createUserAddress: %s\n" % e)

Parameters

Form parameters
Name Description
default
Boolean
validate_address
Boolean
name
String
first_name
String
last_name
String
business_name
String
address1
String
address2
String
city
String
state
String
zip
String
country_id
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Error


deleteRecipient

Delete user`s recipient address

Delete user`s recipient address


/profile/deleteRecipient

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/deleteRecipient"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Integer addressId = 56; // Integer | 
        array[Integer] addressIds = ; // array[Integer] | 
        try {
            inline_response_200_14 result = apiInstance.deleteRecipient(addressId, addressIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#deleteRecipient");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer addressId = 56; // Integer | 
        array[Integer] addressIds = ; // array[Integer] | 
        try {
            inline_response_200_14 result = apiInstance.deleteRecipient(addressId, addressIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#deleteRecipient");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *addressId = 56; //  (optional)
array[Integer] *addressIds = ; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Delete user`s recipient address
[apiInstance deleteRecipientWith:addressId
    addressIds:addressIds
              completionHandler: ^(inline_response_200_14 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRecipient(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRecipientExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var addressId = 56;  // Integer |  (optional) 
            var addressIds = new array[Integer](); // array[Integer] |  (optional) 

            try
            {
                // Delete user`s recipient address
                inline_response_200_14 result = apiInstance.deleteRecipient(addressId, addressIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.deleteRecipient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$addressId = 56; // Integer | 
$addressIds = ; // array[Integer] | 

try {
    $result = $api_instance->deleteRecipient($addressId, $addressIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->deleteRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $addressId = 56; # Integer | 
my $addressIds = []; # array[Integer] | 

eval { 
    my $result = $api_instance->deleteRecipient(addressId => $addressId, addressIds => $addressIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->deleteRecipient: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
addressId = 56 # Integer |  (optional)
addressIds =  # array[Integer] |  (optional)

try: 
    # Delete user`s recipient address
    api_response = api_instance.delete_recipient(addressId=addressId, addressIds=addressIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->deleteRecipient: %s\n" % e)

Parameters

Form parameters
Name Description
address_id
Integer
address_ids
array[Integer]

Responses

Status: 200 - successful

Status: 400 - Error


deleteUserAddress

Delete exists user`s address

Delete exists user`s address


/profile/deleteAddress

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/deleteAddress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        array[Integer] ids = ; // array[Integer] | 
        try {
            inline_response_200 result = apiInstance.deleteUserAddress(id, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#deleteUserAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        array[Integer] ids = ; // array[Integer] | 
        try {
            inline_response_200 result = apiInstance.deleteUserAddress(id, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#deleteUserAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *id = 56; //  (optional)
array[Integer] *ids = ; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Delete exists user`s address
[apiInstance deleteUserAddressWith:id
    ids:ids
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUserAddress(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUserAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var id = 56;  // Integer |  (optional) 
            var ids = new array[Integer](); // array[Integer] |  (optional) 

            try
            {
                // Delete exists user`s address
                inline_response_200 result = apiInstance.deleteUserAddress(id, ids);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.deleteUserAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$id = 56; // Integer | 
$ids = ; // array[Integer] | 

try {
    $result = $api_instance->deleteUserAddress($id, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->deleteUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $id = 56; # Integer | 
my $ids = []; # array[Integer] | 

eval { 
    my $result = $api_instance->deleteUserAddress(id => $id, ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->deleteUserAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
id = 56 # Integer |  (optional)
ids =  # array[Integer] |  (optional)

try: 
    # Delete exists user`s address
    api_response = api_instance.delete_user_address(id=id, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->deleteUserAddress: %s\n" % e)

Parameters

Form parameters
Name Description
id
Integer
ids
array[Integer]

Responses

Status: 200 - successful

Status: 400 - Error


getListAddresses

Get list of user addresses

Get list of user addresses


/profile/listAddresses

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/profile/listAddresses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_11 result = apiInstance.getListAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#getListAddresses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_11 result = apiInstance.getListAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#getListAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get list of user addresses
[apiInstance getListAddressesWithCompletionHandler: 
              ^(inline_response_200_11 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getListAddresses(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getListAddressesExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();

            try
            {
                // Get list of user addresses
                inline_response_200_11 result = apiInstance.getListAddresses();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.getListAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();

try {
    $result = $api_instance->getListAddresses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->getListAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();

eval { 
    my $result = $api_instance->getListAddresses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->getListAddresses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()

try: 
    # Get list of user addresses
    api_response = api_instance.get_list_addresses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->getListAddresses: %s\n" % e)

Parameters

Responses

Status: 200 - successful

Status: 400 - Error


getUserAddress

Get user address

Get user address


/profile/address

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/profile/address"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_10 result = apiInstance.getUserAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#getUserAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_10 result = apiInstance.getUserAddress();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#getUserAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get user address
[apiInstance getUserAddressWithCompletionHandler: 
              ^(inline_response_200_10 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserAddress(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();

            try
            {
                // Get user address
                inline_response_200_10 result = apiInstance.getUserAddress();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.getUserAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();

try {
    $result = $api_instance->getUserAddress();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->getUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();

eval { 
    my $result = $api_instance->getUserAddress();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->getUserAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()

try: 
    # Get user address
    api_response = api_instance.get_user_address()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->getUserAddress: %s\n" % e)

Parameters

Responses

Status: 200 - successful

Status: 400 - Error


listCountries

Get list of countries

Get list of countries


/countries/list

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/countries/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        
        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_16 result = apiInstance.listCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listCountries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_16 result = apiInstance.listCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listCountries");
            e.printStackTrace();
        }
    }
}

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get list of countries
[apiInstance listCountriesWithCompletionHandler: 
              ^(inline_response_200_16 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AddressBookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCountries(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listCountriesExample
    {
        public void main()
        {

            var apiInstance = new AddressBookApi();

            try
            {
                // Get list of countries
                inline_response_200_16 result = apiInstance.listCountries();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.listCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAddressBookApi();

try {
    $result = $api_instance->listCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->listCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();

eval { 
    my $result = $api_instance->listCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->listCountries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()

try: 
    # Get list of countries
    api_response = api_instance.list_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->listCountries: %s\n" % e)

Parameters

Responses

Status: 200 - successful


listRecipients

Get recipients addresses list

Get recipients addresses list


/profile/recipientsList

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/profile/recipientsList"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_13 result = apiInstance.listRecipients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listRecipients");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        try {
            inline_response_200_13 result = apiInstance.listRecipients();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listRecipients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get recipients addresses list
[apiInstance listRecipientsWithCompletionHandler: 
              ^(inline_response_200_13 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRecipients(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listRecipientsExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();

            try
            {
                // Get recipients addresses list
                inline_response_200_13 result = apiInstance.listRecipients();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.listRecipients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();

try {
    $result = $api_instance->listRecipients();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->listRecipients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();

eval { 
    my $result = $api_instance->listRecipients();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->listRecipients: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()

try: 
    # Get recipients addresses list
    api_response = api_instance.list_recipients()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->listRecipients: %s\n" % e)

Parameters

Responses

Status: 200 - successful

Status: 400 - Error


listStates

Get list of states

Get list of states


/countries/listStates

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/countries/listStates?country_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        
        AddressBookApi apiInstance = new AddressBookApi();
        Integer countryId = 56; // Integer | Country ID
        try {
            inline_response_200_17 result = apiInstance.listStates(countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listStates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer countryId = 56; // Integer | Country ID
        try {
            inline_response_200_17 result = apiInstance.listStates(countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#listStates");
            e.printStackTrace();
        }
    }
}
Integer *countryId = 56; // Country ID (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Get list of states
[apiInstance listStatesWith:countryId
              completionHandler: ^(inline_response_200_17 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AddressBookApi()
var opts = { 
  'countryId': 56 // {{Integer}} Country ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStates(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listStatesExample
    {
        public void main()
        {

            var apiInstance = new AddressBookApi();
            var countryId = 56;  // Integer | Country ID (optional) 

            try
            {
                // Get list of states
                inline_response_200_17 result = apiInstance.listStates(countryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.listStates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$countryId = 56; // Integer | Country ID

try {
    $result = $api_instance->listStates($countryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->listStates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $countryId = 56; # Integer | Country ID

eval { 
    my $result = $api_instance->listStates(countryId => $countryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->listStates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
countryId = 56 # Integer | Country ID (optional)

try: 
    # Get list of states
    api_response = api_instance.list_states(countryId=countryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->listStates: %s\n" % e)

Parameters

Query parameters
Name Description
country_id
Integer
Country ID

Responses

Status: 200 - successful

Status: 400 - Error


setDefaultAddress

Set default user`s address

Set default user`s address


/profile/setDefaultAddress

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/setDefaultAddress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        try {
            inline_response_200 result = apiInstance.setDefaultAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#setDefaultAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        try {
            inline_response_200 result = apiInstance.setDefaultAddress(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#setDefaultAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *id = 56; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Set default user`s address
[apiInstance setDefaultAddressWith:id
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setDefaultAddress(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setDefaultAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var id = 56;  // Integer |  (optional) 

            try
            {
                // Set default user`s address
                inline_response_200 result = apiInstance.setDefaultAddress(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.setDefaultAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->setDefaultAddress($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->setDefaultAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->setDefaultAddress(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->setDefaultAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
id = 56 # Integer |  (optional)

try: 
    # Set default user`s address
    api_response = api_instance.set_default_address(id=id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->setDefaultAddress: %s\n" % e)

Parameters

Form parameters
Name Description
id
Integer

Responses

Status: 200 - successful

Status: 400 - Error


updateRecipient

Update user`s recipient address

Update user`s recipient address


/profile/updateRecipient

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/updateRecipient"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Boolean validateAddress = true; // Boolean | 
        Integer addressId = 56; // Integer | 
        Long id = 789; // Long | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        String birthday = birthday_example; // String | 
        try {
            inline_response_200_12 result = apiInstance.updateRecipient(validateAddress, addressId, id, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId, birthday);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#updateRecipient");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Boolean validateAddress = true; // Boolean | 
        Integer addressId = 56; // Integer | 
        Long id = 789; // Long | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        String birthday = birthday_example; // String | 
        try {
            inline_response_200_12 result = apiInstance.updateRecipient(validateAddress, addressId, id, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId, birthday);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#updateRecipient");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Boolean *validateAddress = true; //  (optional)
Integer *addressId = 56; //  (optional)
Long *id = 789; //  (optional)
String *name = name_example; //  (optional)
String *firstName = firstName_example; //  (optional)
String *lastName = lastName_example; //  (optional)
String *businessName = businessName_example; //  (optional)
String *address1 = address1_example; //  (optional)
String *address2 = address2_example; //  (optional)
String *city = city_example; //  (optional)
String *state = state_example; //  (optional)
String *zip = zip_example; //  (optional)
String *countryId = countryId_example; //  (optional)
String *birthday = birthday_example; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Update user`s recipient address
[apiInstance updateRecipientWith:validateAddress
    addressId:addressId
    id:id
    name:name
    firstName:firstName
    lastName:lastName
    businessName:businessName
    address1:address1
    address2:address2
    city:city
    state:state
    zip:zip
    countryId:countryId
    birthday:birthday
              completionHandler: ^(inline_response_200_12 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRecipient(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRecipientExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var validateAddress = true;  // Boolean |  (optional) 
            var addressId = 56;  // Integer |  (optional) 
            var id = 789;  // Long |  (optional) 
            var name = name_example;  // String |  (optional) 
            var firstName = firstName_example;  // String |  (optional) 
            var lastName = lastName_example;  // String |  (optional) 
            var businessName = businessName_example;  // String |  (optional) 
            var address1 = address1_example;  // String |  (optional) 
            var address2 = address2_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 
            var state = state_example;  // String |  (optional) 
            var zip = zip_example;  // String |  (optional) 
            var countryId = countryId_example;  // String |  (optional) 
            var birthday = birthday_example;  // String |  (optional) 

            try
            {
                // Update user`s recipient address
                inline_response_200_12 result = apiInstance.updateRecipient(validateAddress, addressId, id, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId, birthday);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.updateRecipient: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$validateAddress = true; // Boolean | 
$addressId = 56; // Integer | 
$id = 789; // Long | 
$name = name_example; // String | 
$firstName = firstName_example; // String | 
$lastName = lastName_example; // String | 
$businessName = businessName_example; // String | 
$address1 = address1_example; // String | 
$address2 = address2_example; // String | 
$city = city_example; // String | 
$state = state_example; // String | 
$zip = zip_example; // String | 
$countryId = countryId_example; // String | 
$birthday = birthday_example; // String | 

try {
    $result = $api_instance->updateRecipient($validateAddress, $addressId, $id, $name, $firstName, $lastName, $businessName, $address1, $address2, $city, $state, $zip, $countryId, $birthday);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->updateRecipient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $validateAddress = true; # Boolean | 
my $addressId = 56; # Integer | 
my $id = 789; # Long | 
my $name = name_example; # String | 
my $firstName = firstName_example; # String | 
my $lastName = lastName_example; # String | 
my $businessName = businessName_example; # String | 
my $address1 = address1_example; # String | 
my $address2 = address2_example; # String | 
my $city = city_example; # String | 
my $state = state_example; # String | 
my $zip = zip_example; # String | 
my $countryId = countryId_example; # String | 
my $birthday = birthday_example; # String | 

eval { 
    my $result = $api_instance->updateRecipient(validateAddress => $validateAddress, addressId => $addressId, id => $id, name => $name, firstName => $firstName, lastName => $lastName, businessName => $businessName, address1 => $address1, address2 => $address2, city => $city, state => $state, zip => $zip, countryId => $countryId, birthday => $birthday);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->updateRecipient: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
validateAddress = true # Boolean |  (optional)
addressId = 56 # Integer |  (optional)
id = 789 # Long |  (optional)
name = name_example # String |  (optional)
firstName = firstName_example # String |  (optional)
lastName = lastName_example # String |  (optional)
businessName = businessName_example # String |  (optional)
address1 = address1_example # String |  (optional)
address2 = address2_example # String |  (optional)
city = city_example # String |  (optional)
state = state_example # String |  (optional)
zip = zip_example # String |  (optional)
countryId = countryId_example # String |  (optional)
birthday = birthday_example # String |  (optional)

try: 
    # Update user`s recipient address
    api_response = api_instance.update_recipient(validateAddress=validateAddress, addressId=addressId, id=id, name=name, firstName=firstName, lastName=lastName, businessName=businessName, address1=address1, address2=address2, city=city, state=state, zip=zip, countryId=countryId, birthday=birthday)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->updateRecipient: %s\n" % e)

Parameters

Form parameters
Name Description
validate_address
Boolean
address_id
Integer
id
Long (int64)
name
String
first_name
String
last_name
String
business_name
String
address1
String
address2
String
city
String
state
String
zip
String
country_id
String
birthday
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Error


updateUserAddress

Add new or update exists user`s address

Add new or update exists user`s address


/profile/updateAddress

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/updateAddress"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AddressBookApi;

import java.io.File;
import java.util.*;

public class AddressBookApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        Boolean default = true; // Boolean | 
        Boolean validateAddress = true; // Boolean | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.updateUserAddress(id, default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#updateUserAddress");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AddressBookApi;

public class AddressBookApiExample {

    public static void main(String[] args) {
        AddressBookApi apiInstance = new AddressBookApi();
        Integer id = 56; // Integer | 
        Boolean default = true; // Boolean | 
        Boolean validateAddress = true; // Boolean | 
        String name = name_example; // String | 
        String firstName = firstName_example; // String | 
        String lastName = lastName_example; // String | 
        String businessName = businessName_example; // String | 
        String address1 = address1_example; // String | 
        String address2 = address2_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String zip = zip_example; // String | 
        String countryId = countryId_example; // String | 
        try {
            inline_response_200_9 result = apiInstance.updateUserAddress(id, default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressBookApi#updateUserAddress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *id = 56; //  (optional)
Boolean *default = true; //  (optional)
Boolean *validateAddress = true; //  (optional)
String *name = name_example; //  (optional)
String *firstName = firstName_example; //  (optional)
String *lastName = lastName_example; //  (optional)
String *businessName = businessName_example; //  (optional)
String *address1 = address1_example; //  (optional)
String *address2 = address2_example; //  (optional)
String *city = city_example; //  (optional)
String *state = state_example; //  (optional)
String *zip = zip_example; //  (optional)
String *countryId = countryId_example; //  (optional)

AddressBookApi *apiInstance = [[AddressBookApi alloc] init];

// Add new or update exists user`s address
[apiInstance updateUserAddressWith:id
    default:default
    validateAddress:validateAddress
    name:name
    firstName:firstName
    lastName:lastName
    businessName:businessName
    address1:address1
    address2:address2
    city:city
    state:state
    zip:zip
    countryId:countryId
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AddressBookApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserAddress(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserAddressExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AddressBookApi();
            var id = 56;  // Integer |  (optional) 
            var default = true;  // Boolean |  (optional) 
            var validateAddress = true;  // Boolean |  (optional) 
            var name = name_example;  // String |  (optional) 
            var firstName = firstName_example;  // String |  (optional) 
            var lastName = lastName_example;  // String |  (optional) 
            var businessName = businessName_example;  // String |  (optional) 
            var address1 = address1_example;  // String |  (optional) 
            var address2 = address2_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 
            var state = state_example;  // String |  (optional) 
            var zip = zip_example;  // String |  (optional) 
            var countryId = countryId_example;  // String |  (optional) 

            try
            {
                // Add new or update exists user`s address
                inline_response_200_9 result = apiInstance.updateUserAddress(id, default, validateAddress, name, firstName, lastName, businessName, address1, address2, city, state, zip, countryId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AddressBookApi.updateUserAddress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAddressBookApi();
$id = 56; // Integer | 
$default = true; // Boolean | 
$validateAddress = true; // Boolean | 
$name = name_example; // String | 
$firstName = firstName_example; // String | 
$lastName = lastName_example; // String | 
$businessName = businessName_example; // String | 
$address1 = address1_example; // String | 
$address2 = address2_example; // String | 
$city = city_example; // String | 
$state = state_example; // String | 
$zip = zip_example; // String | 
$countryId = countryId_example; // String | 

try {
    $result = $api_instance->updateUserAddress($id, $default, $validateAddress, $name, $firstName, $lastName, $businessName, $address1, $address2, $city, $state, $zip, $countryId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressBookApi->updateUserAddress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AddressBookApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AddressBookApi->new();
my $id = 56; # Integer | 
my $default = true; # Boolean | 
my $validateAddress = true; # Boolean | 
my $name = name_example; # String | 
my $firstName = firstName_example; # String | 
my $lastName = lastName_example; # String | 
my $businessName = businessName_example; # String | 
my $address1 = address1_example; # String | 
my $address2 = address2_example; # String | 
my $city = city_example; # String | 
my $state = state_example; # String | 
my $zip = zip_example; # String | 
my $countryId = countryId_example; # String | 

eval { 
    my $result = $api_instance->updateUserAddress(id => $id, default => $default, validateAddress => $validateAddress, name => $name, firstName => $firstName, lastName => $lastName, businessName => $businessName, address1 => $address1, address2 => $address2, city => $city, state => $state, zip => $zip, countryId => $countryId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AddressBookApi->updateUserAddress: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AddressBookApi()
id = 56 # Integer |  (optional)
default = true # Boolean |  (optional)
validateAddress = true # Boolean |  (optional)
name = name_example # String |  (optional)
firstName = firstName_example # String |  (optional)
lastName = lastName_example # String |  (optional)
businessName = businessName_example # String |  (optional)
address1 = address1_example # String |  (optional)
address2 = address2_example # String |  (optional)
city = city_example # String |  (optional)
state = state_example # String |  (optional)
zip = zip_example # String |  (optional)
countryId = countryId_example # String |  (optional)

try: 
    # Add new or update exists user`s address
    api_response = api_instance.update_user_address(id=id, default=default, validateAddress=validateAddress, name=name, firstName=firstName, lastName=lastName, businessName=businessName, address1=address1, address2=address2, city=city, state=state, zip=zip, countryId=countryId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AddressBookApi->updateUserAddress: %s\n" % e)

Parameters

Form parameters
Name Description
id
Integer
default
Boolean
validate_address
Boolean
name
String
first_name
String
last_name
String
business_name
String
address1
String
address2
String
city
String
state
String
zip
String
country_id
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Error


Auth

activateAccount

Post-registration user activation

Post-registration user activation


/auth/activation

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/activation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String hash = hash_example; // String | 
        try {
            inline_response_200_2 result = apiInstance.activateAccount(hash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#activateAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String hash = hash_example; // String | 
        try {
            inline_response_200_2 result = apiInstance.activateAccount(hash);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#activateAccount");
            e.printStackTrace();
        }
    }
}
String *hash = hash_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Post-registration user activation
[apiInstance activateAccountWith:hash
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateAccount(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class activateAccountExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var hash = hash_example;  // String |  (optional) 

            try
            {
                // Post-registration user activation
                inline_response_200_2 result = apiInstance.activateAccount(hash);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.activateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$hash = hash_example; // String | 

try {
    $result = $api_instance->activateAccount($hash);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->activateAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $hash = hash_example; # String | 

eval { 
    my $result = $api_instance->activateAccount(hash => $hash);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->activateAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
hash = hash_example # String |  (optional)

try: 
    # Post-registration user activation
    api_response = api_instance.activate_account(hash=hash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->activateAccount: %s\n" % e)

Parameters

Form parameters
Name Description
hash
String

Responses

Status: 200 - successful login

Status: 400 - Error


auth

Authorize user

Logs in to an existing account by email and password.


/auth/authorization

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/authorization"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        String password = password_example; // String | 
        try {
            inline_response_200_4 result = apiInstance.auth(login, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#auth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        String password = password_example; // String | 
        try {
            inline_response_200_4 result = apiInstance.auth(login, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#auth");
            e.printStackTrace();
        }
    }
}
String *login = login_example; //  (optional)
String *password = password_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Authorize user
[apiInstance authWith:login
    password:password
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.auth(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var login = login_example;  // String |  (optional) 
            var password = password_example;  // String |  (optional) 

            try
            {
                // Authorize user
                inline_response_200_4 result = apiInstance.auth(login, password);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.auth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$login = login_example; // String | 
$password = password_example; // String | 

try {
    $result = $api_instance->auth($login, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->auth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $login = login_example; # String | 
my $password = password_example; # String | 

eval { 
    my $result = $api_instance->auth(login => $login, password => $password);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->auth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
login = login_example # String |  (optional)
password = password_example # String |  (optional)

try: 
    # Authorize user
    api_response = api_instance.auth(login=login, password=password)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->auth: %s\n" % e)

Parameters

Form parameters
Name Description
login
String
password
String

Responses

Status: 200 - successful login

Status: 400 - Error


authProvider

Authorize by social network

Authorize/Register by social network


/auth/socialNetworkRegistration

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/socialNetworkRegistration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String provider = provider_example; // String | 
        String accessToken = accessToken_example; // String | 
        String discountCode = discountCode_example; // String | 
        String addEmailStatus = addEmailStatus_example; // String | 
        String fullname = fullname_example; // String | 
        String fname = fname_example; // String | 
        String lname = lname_example; // String | 
        String login = login_example; // String | 
        String id = id_example; // String | 
        String client = client_example; // String | 
        String xClient = xClient_example; // String | 
        try {
            inline_response_200_3 result = apiInstance.authProvider(provider, accessToken, discountCode, addEmailStatus, fullname, fname, lname, login, id, client, xClient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authProvider");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String provider = provider_example; // String | 
        String accessToken = accessToken_example; // String | 
        String discountCode = discountCode_example; // String | 
        String addEmailStatus = addEmailStatus_example; // String | 
        String fullname = fullname_example; // String | 
        String fname = fname_example; // String | 
        String lname = lname_example; // String | 
        String login = login_example; // String | 
        String id = id_example; // String | 
        String client = client_example; // String | 
        String xClient = xClient_example; // String | 
        try {
            inline_response_200_3 result = apiInstance.authProvider(provider, accessToken, discountCode, addEmailStatus, fullname, fname, lname, login, id, client, xClient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#authProvider");
            e.printStackTrace();
        }
    }
}
String *provider = provider_example; //  (optional)
String *accessToken = accessToken_example; //  (optional)
String *discountCode = discountCode_example; //  (optional)
String *addEmailStatus = addEmailStatus_example; //  (optional)
String *fullname = fullname_example; //  (optional)
String *fname = fname_example; //  (optional)
String *lname = lname_example; //  (optional)
String *login = login_example; //  (optional)
String *id = id_example; //  (optional)
String *client = client_example; //  (optional)
String *xClient = xClient_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Authorize by social network
[apiInstance authProviderWith:provider
    accessToken:accessToken
    discountCode:discountCode
    addEmailStatus:addEmailStatus
    fullname:fullname
    fname:fname
    lname:lname
    login:login
    id:id
    client:client
    xClient:xClient
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()
var opts = { 
  'provider': provider_example // {{String}} 
  'accessToken': accessToken_example // {{String}} 
  'discountCode': discountCode_example // {{String}} 
  'addEmailStatus': addEmailStatus_example // {{String}} 
  'fullname': fullname_example // {{String}} 
  'fname': fname_example // {{String}} 
  'lname': lname_example // {{String}} 
  'login': login_example // {{String}} 
  'id': id_example // {{String}} 
  'client': client_example // {{String}} 
  'xClient': xClient_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authProvider(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class authProviderExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var provider = provider_example;  // String |  (optional) 
            var accessToken = accessToken_example;  // String |  (optional) 
            var discountCode = discountCode_example;  // String |  (optional) 
            var addEmailStatus = addEmailStatus_example;  // String |  (optional) 
            var fullname = fullname_example;  // String |  (optional) 
            var fname = fname_example;  // String |  (optional) 
            var lname = lname_example;  // String |  (optional) 
            var login = login_example;  // String |  (optional) 
            var id = id_example;  // String |  (optional) 
            var client = client_example;  // String |  (optional) 
            var xClient = xClient_example;  // String |  (optional) 

            try
            {
                // Authorize by social network
                inline_response_200_3 result = apiInstance.authProvider(provider, accessToken, discountCode, addEmailStatus, fullname, fname, lname, login, id, client, xClient);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.authProvider: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$provider = provider_example; // String | 
$accessToken = accessToken_example; // String | 
$discountCode = discountCode_example; // String | 
$addEmailStatus = addEmailStatus_example; // String | 
$fullname = fullname_example; // String | 
$fname = fname_example; // String | 
$lname = lname_example; // String | 
$login = login_example; // String | 
$id = id_example; // String | 
$client = client_example; // String | 
$xClient = xClient_example; // String | 

try {
    $result = $api_instance->authProvider($provider, $accessToken, $discountCode, $addEmailStatus, $fullname, $fname, $lname, $login, $id, $client, $xClient);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authProvider: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $provider = provider_example; # String | 
my $accessToken = accessToken_example; # String | 
my $discountCode = discountCode_example; # String | 
my $addEmailStatus = addEmailStatus_example; # String | 
my $fullname = fullname_example; # String | 
my $fname = fname_example; # String | 
my $lname = lname_example; # String | 
my $login = login_example; # String | 
my $id = id_example; # String | 
my $client = client_example; # String | 
my $xClient = xClient_example; # String | 

eval { 
    my $result = $api_instance->authProvider(provider => $provider, accessToken => $accessToken, discountCode => $discountCode, addEmailStatus => $addEmailStatus, fullname => $fullname, fname => $fname, lname => $lname, login => $login, id => $id, client => $client, xClient => $xClient);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->authProvider: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
provider = provider_example # String |  (optional)
accessToken = accessToken_example # String |  (optional)
discountCode = discountCode_example # String |  (optional)
addEmailStatus = addEmailStatus_example # String |  (optional)
fullname = fullname_example # String |  (optional)
fname = fname_example # String |  (optional)
lname = lname_example # String |  (optional)
login = login_example # String |  (optional)
id = id_example # String |  (optional)
client = client_example # String |  (optional)
xClient = xClient_example # String |  (optional)

try: 
    # Authorize by social network
    api_response = api_instance.auth_provider(provider=provider, accessToken=accessToken, discountCode=discountCode, addEmailStatus=addEmailStatus, fullname=fullname, fname=fname, lname=lname, login=login, id=id, client=client, xClient=xClient)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->authProvider: %s\n" % e)

Parameters

Header parameters
Name Description
X-Client
String
Form parameters
Name Description
provider
String
Enum: facebook, google
access_token
String
discount_code
String
add_email_status
String
fullname
String
fname
String
lname
String
login
String
id
String
client
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Auth error


changePassword

Change user password

Change user password


/profile/changePassword

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/changePassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        String oldPassword = oldPassword_example; // String | 
        String newPassword = newPassword_example; // String | 
        try {
            inline_response_200 result = apiInstance.changePassword(oldPassword, newPassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String oldPassword = oldPassword_example; // String | 
        String newPassword = newPassword_example; // String | 
        try {
            inline_response_200 result = apiInstance.changePassword(oldPassword, newPassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#changePassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
String *oldPassword = oldPassword_example; //  (optional)
String *newPassword = newPassword_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Change user password
[apiInstance changePasswordWith:oldPassword
    newPassword:newPassword
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changePassword(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();
            var oldPassword = oldPassword_example;  // String |  (optional) 
            var newPassword = newPassword_example;  // String |  (optional) 

            try
            {
                // Change user password
                inline_response_200 result = apiInstance.changePassword(oldPassword, newPassword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();
$oldPassword = oldPassword_example; // String | 
$newPassword = newPassword_example; // String | 

try {
    $result = $api_instance->changePassword($oldPassword, $newPassword);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $oldPassword = oldPassword_example; # String | 
my $newPassword = newPassword_example; # String | 

eval { 
    my $result = $api_instance->changePassword(oldPassword => $oldPassword, newPassword => $newPassword);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
oldPassword = oldPassword_example # String |  (optional)
newPassword = newPassword_example # String |  (optional)

try: 
    # Change user password
    api_response = api_instance.change_password(oldPassword=oldPassword, newPassword=newPassword)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->changePassword: %s\n" % e)

Parameters

Form parameters
Name Description
old_password
String
new_password
String

Responses

Status: 200 - successful

Status: 400 - Error


checkAuth

Check auth

Check auth


/checkauth/auth

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/checkauth/auth"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        try {
            inline_response_200_8 result = apiInstance.checkAuth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkAuth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        try {
            inline_response_200_8 result = apiInstance.checkAuth();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkAuth");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AuthApi *apiInstance = [[AuthApi alloc] init];

// Check auth
[apiInstance checkAuthWithCompletionHandler: 
              ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkAuth(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkAuthExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();

            try
            {
                // Check auth
                inline_response_200_8 result = apiInstance.checkAuth();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.checkAuth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();

try {
    $result = $api_instance->checkAuth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->checkAuth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();

eval { 
    my $result = $api_instance->checkAuth();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->checkAuth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Check auth
    api_response = api_instance.check_auth()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->checkAuth: %s\n" % e)

Parameters

Responses

Status: 200 - successful

Status: 400 - no uid


checkLogin

Check user`s email in database

Check user`s email in database. Is used for checking if email is already exists while registering.


/auth/checkLogin

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/auth/checkLogin?login="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | login
        try {
            inline_response_200 result = apiInstance.checkLogin(login);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkLogin");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | login
        try {
            inline_response_200 result = apiInstance.checkLogin(login);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkLogin");
            e.printStackTrace();
        }
    }
}
String *login = login_example; // login

AuthApi *apiInstance = [[AuthApi alloc] init];

// Check user`s email in database
[apiInstance checkLoginWith:login
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()
var login = login_example; // {{String}} login

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkLogin(login, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkLoginExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var login = login_example;  // String | login

            try
            {
                // Check user`s email in database
                inline_response_200 result = apiInstance.checkLogin(login);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.checkLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$login = login_example; // String | login

try {
    $result = $api_instance->checkLogin($login);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->checkLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $login = login_example; # String | login

eval { 
    my $result = $api_instance->checkLogin(login => $login);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->checkLogin: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
login = login_example # String | login

try: 
    # Check user`s email in database
    api_response = api_instance.check_login(login)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->checkLogin: %s\n" % e)

Parameters

Query parameters
Name Description
login*
String
login
Required

Responses

Status: 200 - login is not taken

Status: 400 - Error


checkToken

Authorize user by generated token

Logs in to an existing account by generated token


/auth/token

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/token"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String token = token_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.checkToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkToken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String token = token_example; // String | 
        try {
            inline_response_200_5 result = apiInstance.checkToken(token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#checkToken");
            e.printStackTrace();
        }
    }
}
String *token = token_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Authorize user by generated token
[apiInstance checkTokenWith:token
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkToken(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkTokenExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var token = token_example;  // String |  (optional) 

            try
            {
                // Authorize user by generated token
                inline_response_200_5 result = apiInstance.checkToken(token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.checkToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$token = token_example; // String | 

try {
    $result = $api_instance->checkToken($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->checkToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $token = token_example; # String | 

eval { 
    my $result = $api_instance->checkToken(token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->checkToken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
token = token_example # String |  (optional)

try: 
    # Authorize user by generated token
    api_response = api_instance.check_token(token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->checkToken: %s\n" % e)

Parameters

Form parameters
Name Description
token
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 401 - Auth error


getUser

Get current user info

Get current user info


/auth/getUser

Usage and SDK Samples

curl -X GET "https://api.handwrytten.com/v1/auth/getUser"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        try {
            inline_response_200_6 result = apiInstance.getUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        try {
            inline_response_200_6 result = apiInstance.getUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AuthApi *apiInstance = [[AuthApi alloc] init];

// Get current user info
[apiInstance getUserWithCompletionHandler: 
              ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();

            try
            {
                // Get current user info
                inline_response_200_6 result = apiInstance.getUser();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();

try {
    $result = $api_instance->getUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();

eval { 
    my $result = $api_instance->getUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Get current user info
    api_response = api_instance.get_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->getUser: %s\n" % e)

Parameters

Responses

Status: 200 - successful login

Status: 401 - No auth


logout

Logout user from application

Logout user from application


/auth/logout

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#logout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];

AuthApi *apiInstance = [[AuthApi alloc] init];

// Logout user from application
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();

            try
            {
                // Logout user from application
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();

try {
    $api_instance->logout();
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();

eval { 
    $api_instance->logout();
};
if ($@) {
    warn "Exception when calling AuthApi->logout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Logout user from application
    api_instance.logout()
except ApiException as e:
    print("Exception when calling AuthApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - successful logout


register

Register new user

Register new user using email address and password. Sends activation email to user email address. User status is not_active until email is confirmed by clicking the link in the email.


/auth/registration

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/registration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        String password = password_example; // String | 
        String passwordConfirmation = passwordConfirmation_example; // String | 
        String fname = fname_example; // String | 
        String lname = lname_example; // String | 
        String fullname = fullname_example; // String | 
        String discountCode = discountCode_example; // String | 
        Boolean silentAdd = true; // Boolean | 
        Boolean silent = true; // Boolean | 
        try {
            inline_response_200_1 result = apiInstance.register(login, password, passwordConfirmation, fname, lname, fullname, discountCode, silentAdd, silent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#register");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        String password = password_example; // String | 
        String passwordConfirmation = passwordConfirmation_example; // String | 
        String fname = fname_example; // String | 
        String lname = lname_example; // String | 
        String fullname = fullname_example; // String | 
        String discountCode = discountCode_example; // String | 
        Boolean silentAdd = true; // Boolean | 
        Boolean silent = true; // Boolean | 
        try {
            inline_response_200_1 result = apiInstance.register(login, password, passwordConfirmation, fname, lname, fullname, discountCode, silentAdd, silent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#register");
            e.printStackTrace();
        }
    }
}
String *login = login_example; //  (optional)
String *password = password_example; //  (optional)
String *passwordConfirmation = passwordConfirmation_example; //  (optional)
String *fname = fname_example; //  (optional)
String *lname = lname_example; //  (optional)
String *fullname = fullname_example; //  (optional)
String *discountCode = discountCode_example; //  (optional)
Boolean *silentAdd = true; //  (optional)
Boolean *silent = true; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Register new user
[apiInstance registerWith:login
    password:password
    passwordConfirmation:passwordConfirmation
    fname:fname
    lname:lname
    fullname:fullname
    discountCode:discountCode
    silentAdd:silentAdd
    silent:silent
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.register(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var login = login_example;  // String |  (optional) 
            var password = password_example;  // String |  (optional) 
            var passwordConfirmation = passwordConfirmation_example;  // String |  (optional) 
            var fname = fname_example;  // String |  (optional) 
            var lname = lname_example;  // String |  (optional) 
            var fullname = fullname_example;  // String |  (optional) 
            var discountCode = discountCode_example;  // String |  (optional) 
            var silentAdd = true;  // Boolean |  (optional) 
            var silent = true;  // Boolean |  (optional) 

            try
            {
                // Register new user
                inline_response_200_1 result = apiInstance.register(login, password, passwordConfirmation, fname, lname, fullname, discountCode, silentAdd, silent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.register: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$login = login_example; // String | 
$password = password_example; // String | 
$passwordConfirmation = passwordConfirmation_example; // String | 
$fname = fname_example; // String | 
$lname = lname_example; // String | 
$fullname = fullname_example; // String | 
$discountCode = discountCode_example; // String | 
$silentAdd = true; // Boolean | 
$silent = true; // Boolean | 

try {
    $result = $api_instance->register($login, $password, $passwordConfirmation, $fname, $lname, $fullname, $discountCode, $silentAdd, $silent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->register: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $login = login_example; # String | 
my $password = password_example; # String | 
my $passwordConfirmation = passwordConfirmation_example; # String | 
my $fname = fname_example; # String | 
my $lname = lname_example; # String | 
my $fullname = fullname_example; # String | 
my $discountCode = discountCode_example; # String | 
my $silentAdd = true; # Boolean | 
my $silent = true; # Boolean | 

eval { 
    my $result = $api_instance->register(login => $login, password => $password, passwordConfirmation => $passwordConfirmation, fname => $fname, lname => $lname, fullname => $fullname, discountCode => $discountCode, silentAdd => $silentAdd, silent => $silent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->register: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
login = login_example # String |  (optional)
password = password_example # String |  (optional)
passwordConfirmation = passwordConfirmation_example # String |  (optional)
fname = fname_example # String |  (optional)
lname = lname_example # String |  (optional)
fullname = fullname_example # String |  (optional)
discountCode = discountCode_example # String |  (optional)
silentAdd = true # Boolean |  (optional)
silent = true # Boolean |  (optional)

try: 
    # Register new user
    api_response = api_instance.register(login=login, password=password, passwordConfirmation=passwordConfirmation, fname=fname, lname=lname, fullname=fullname, discountCode=discountCode, silentAdd=silentAdd, silent=silent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->register: %s\n" % e)

Parameters

Form parameters
Name Description
login
String
password
String
password_confirmation
String
fname
String
lname
String
fullname
String
discount_code
String
silent_add
Boolean
silent
Boolean

Responses

Status: 200 - successful

Status: 400 - Error

Status: 500 - Error


resetPassword

Request reset password

Request reset password. Send an email with a link to a page where user can set a new password.


/auth/resetPasswordRequest

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/resetPasswordRequest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        try {
            inline_response_200 result = apiInstance.resetPassword(login);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#resetPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String login = login_example; // String | 
        try {
            inline_response_200 result = apiInstance.resetPassword(login);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#resetPassword");
            e.printStackTrace();
        }
    }
}
String *login = login_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Request reset password
[apiInstance resetPasswordWith:login
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetPassword(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetPasswordExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var login = login_example;  // String |  (optional) 

            try
            {
                // Request reset password
                inline_response_200 result = apiInstance.resetPassword(login);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$login = login_example; // String | 

try {
    $result = $api_instance->resetPassword($login);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $login = login_example; # String | 

eval { 
    my $result = $api_instance->resetPassword(login => $login);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->resetPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
login = login_example # String |  (optional)

try: 
    # Request reset password
    api_response = api_instance.reset_password(login=login)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->resetPassword: %s\n" % e)

Parameters

Form parameters
Name Description
login
String

Responses

Status: 200 - successful

Status: 400 - Error


resetPasswordConfirm

Password reset confirmation

Set a new password after password reset.


/auth/resetPasswordConfirm

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/resetPasswordConfirm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        
        AuthApi apiInstance = new AuthApi();
        String hash = hash_example; // String | 
        String pass = pass_example; // String | 
        String passConfirm = passConfirm_example; // String | 
        try {
            inline_response_200 result = apiInstance.resetPasswordConfirm(hash, pass, passConfirm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#resetPasswordConfirm");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String hash = hash_example; // String | 
        String pass = pass_example; // String | 
        String passConfirm = passConfirm_example; // String | 
        try {
            inline_response_200 result = apiInstance.resetPasswordConfirm(hash, pass, passConfirm);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#resetPasswordConfirm");
            e.printStackTrace();
        }
    }
}
String *hash = hash_example; //  (optional)
String *pass = pass_example; //  (optional)
String *passConfirm = passConfirm_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Password reset confirmation
[apiInstance resetPasswordConfirmWith:hash
    pass:pass
    passConfirm:passConfirm
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resetPasswordConfirm(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetPasswordConfirmExample
    {
        public void main()
        {

            var apiInstance = new AuthApi();
            var hash = hash_example;  // String |  (optional) 
            var pass = pass_example;  // String |  (optional) 
            var passConfirm = passConfirm_example;  // String |  (optional) 

            try
            {
                // Password reset confirmation
                inline_response_200 result = apiInstance.resetPasswordConfirm(hash, pass, passConfirm);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.resetPasswordConfirm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthApi();
$hash = hash_example; // String | 
$pass = pass_example; // String | 
$passConfirm = passConfirm_example; // String | 

try {
    $result = $api_instance->resetPasswordConfirm($hash, $pass, $passConfirm);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->resetPasswordConfirm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $hash = hash_example; # String | 
my $pass = pass_example; # String | 
my $passConfirm = passConfirm_example; # String | 

eval { 
    my $result = $api_instance->resetPasswordConfirm(hash => $hash, pass => $pass, passConfirm => $passConfirm);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->resetPasswordConfirm: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
hash = hash_example # String |  (optional)
pass = pass_example # String |  (optional)
passConfirm = passConfirm_example # String |  (optional)

try: 
    # Password reset confirmation
    api_response = api_instance.reset_password_confirm(hash=hash, pass=pass, passConfirm=passConfirm)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->resetPasswordConfirm: %s\n" % e)

Parameters

Form parameters
Name Description
hash
String
pass
String
pass_confirm
String

Responses

Status: 200 - successful

Status: 400 - Error


setPassword

Convert account from social network to password

Convert account from social network to password. Send an email with a link to a page where user can set a password.


/auth/setPassword

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/setPassword"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        String email = email_example; // String | 
        try {
            inline_response_200 result = apiInstance.setPassword(email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#setPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String email = email_example; // String | 
        try {
            inline_response_200 result = apiInstance.setPassword(email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#setPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
String *email = email_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Convert account from social network to password
[apiInstance setPasswordWith:email
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setPassword(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setPasswordExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();
            var email = email_example;  // String |  (optional) 

            try
            {
                // Convert account from social network to password
                inline_response_200 result = apiInstance.setPassword(email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.setPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();
$email = email_example; // String | 

try {
    $result = $api_instance->setPassword($email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->setPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $email = email_example; # String | 

eval { 
    my $result = $api_instance->setPassword(email => $email);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->setPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
email = email_example # String |  (optional)

try: 
    # Convert account from social network to password
    api_response = api_instance.set_password(email=email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->setPassword: %s\n" % e)

Parameters

Form parameters
Name Description
email
String

Responses

Status: 200 - successful

Status: 400 - Error

Status: 401 - No auth


setTestMode

Set test mode for current user

Set test mode for current user. Test mode allows user to test Handwrytten. Cards will not be sent, money will return to credit card.


/auth/setTestMode

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/auth/setTestMode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        Integer testMode = 56; // Integer | 
        try {
            inline_response_200_7 result = apiInstance.setTestMode(testMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#setTestMode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        Integer testMode = 56; // Integer | 
        try {
            inline_response_200_7 result = apiInstance.setTestMode(testMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#setTestMode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *testMode = 56; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Set test mode for current user
[apiInstance setTestModeWith:testMode
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setTestMode(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setTestModeExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();
            var testMode = 56;  // Integer |  (optional) 

            try
            {
                // Set test mode for current user
                inline_response_200_7 result = apiInstance.setTestMode(testMode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.setTestMode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();
$testMode = 56; // Integer | 

try {
    $result = $api_instance->setTestMode($testMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->setTestMode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $testMode = 56; # Integer | 

eval { 
    my $result = $api_instance->setTestMode(testMode => $testMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthApi->setTestMode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: uidKey
swagger_client.configuration.api_key['uid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['uid'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
testMode = 56 # Integer |  (optional)

try: 
    # Set test mode for current user
    api_response = api_instance.set_test_mode(testMode=testMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->setTestMode: %s\n" % e)

Parameters

Form parameters
Name Description
test_mode
Integer
Enum: 0, 1

Responses

Status: 200 - successful

Status: 401 - Error


updateBillingInfo

Update user billing info (country, zip, address) using for taxes

Update user billing info (country, zip, address) using for taxes


/profile/updateBillingInfo

Usage and SDK Samples

curl -X POST "https://api.handwrytten.com/v1/profile/updateBillingInfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

import java.io.File;
import java.util.*;

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: uidKey
        ApiKeyAuth uidKey = (ApiKeyAuth) defaultClient.getAuthentication("uidKey");
        uidKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //uidKey.setApiKeyPrefix("Token");

        AuthApi apiInstance = new AuthApi();
        Integer countryId = 56; // Integer | 
        String zip = zip_example; // String | 
        String address = address_example; // String | 
        try {
            inline_response_200 result = apiInstance.updateBillingInfo(countryId, zip, address);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#updateBillingInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        Integer countryId = 56; // Integer | 
        String zip = zip_example; // String | 
        String address = address_example; // String | 
        try {
            inline_response_200 result = apiInstance.updateBillingInfo(countryId, zip, address);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#updateBillingInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: uidKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"uid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"uid"];
Integer *countryId = 56; //  (optional)
String *zip = zip_example; //  (optional)
String *address = address_example; //  (optional)

AuthApi *apiInstance = [[AuthApi alloc] init];

// Update user billing info (country, zip, address) using for taxes
[apiInstance updateBillingInfoWith:countryId
    zip:zip
    address:address
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HandwryttenApi = require('handwrytten_api');
var defaultClient = HandwryttenApi.ApiClient.instance;

// Configure API key authorization: uidKey
var uidKey = defaultClient.authentications['uidKey'];
uidKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uidKey.apiKeyPrefix['uid'] = "Token"

var api = new HandwryttenApi.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateBillingInfo(, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateBillingInfoExample
    {
        public void main()
        {

            // Configure API key authorization: uidKey
            Configuration.Default.ApiKey.Add("uid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("uid", "Bearer");

            var apiInstance = new AuthApi();
            var countryId = 56;  // Integer |  (optional) 
            var zip = zip_example;  // String |  (optional) 
            var address = address_example;  // String |  (optional) 

            try
            {
                // Update user billing info (country, zip, address) using for taxes
                inline_response_200 result = apiInstance.updateBillingInfo(countryId, zip, address);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.updateBillingInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: uidKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('uid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('uid', 'Bearer');

$api_instance = new Swagger\Client\ApiAuthApi();
$countryId = 56; // Integer | 
$zip = zip_example; // String | 
$address = address_example; // String | 

try {
    $result = $api_instance->updateBillingInfo($countryId, $zip, $address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->updateBillingInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthApi;

# Configure API key authorization: uidKey
$WWW::SwaggerClient::Configuration::api_key->{'uid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'uid'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $countryId = 56; # Integer | 
my $zip = zip_example; # String | 
my $address = address_example; # String | 

eval { 
    my $result = $api_instance->updateBillingInfo(countryId => $countryId, zip => $zip, address => $address);
    print Dumper($result);
};
if ($@) {
    warn "Exceptio