{"note":"OpenAPI conversion -- returning structured metadata","name":"handwrytten-com","description":"Handwrytten API","version":"1.0.0","base_url":"https://api.handwrytten.com/v1","endpoints":30,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Handwrytten API\n@base https://api.handwrytten.com/v1\n@version 1.0.0\n@endpoints 30\n@hint download_for_search\n@toc auth(5), profile(6), fonts(2), cards(5), giftCards(2), templateCategories(2), templates(6), countries(1), orders(1)\n\n@group auth\n@endpoint POST /auth/register\n@desc Registers a new account\n@required {body: map # New user account information}\n@returns(200) successful registration\n@errors {405: Invalid input}\n\n@endpoint POST /auth/authorization\n@desc Logs in to an existing account\n@required {body: map # Login to account}\n@returns(200) successful login\n@errors {400: auth error}\n\n@endpoint POST /auth/resetPasswordRequest\n@desc resets a user's password\n@required {body: map # Reset password}\n@returns(200) successful reset request\n@errors {405: Invalid input}\n\n@endpoint POST /auth/changePassword\n@desc changes a user's password\n@required {body: map # Change password}\n@returns(200) successful password change\n@errors {405: Invalid input}\n\n@endpoint POST /auth/logout\n@desc logs out a session uid\n@required {body: map # logout session}\n@returns(200) successful logout\n@errors {405: Invalid input}\n\n@endgroup\n\n@group profile\n@endpoint POST /profile/address\n@desc gets the user's return address information\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /profile/updateAddress\n@desc update the user's return address information\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /profile/recipientsList\n@desc list the addresses in the user's account\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /profile/profileAddRecipient\n@desc add a new recipient address\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /profile/updateRecipient\n@desc updates an existing new recipient address\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /profile/deleteRecipient\n@desc deletes an existing recipient address\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endgroup\n\n@group fonts\n@endpoint GET /fonts/list\n@desc Lists Handwryting styles available for use\n@returns(200) successful operation\n\n@endgroup\n\n@group cards\n@endpoint POST /cards/uploadCustomLogo\n@desc upload logo or cover image for card\n@required {file: any # upload images for customc cards, type: any # set to cover or header, uid: any # uid of the user}\n@returns(200) successful operation\n\n@endgroup\n\n@group fonts\n@endpoint GET /fonts/listForCustomizer\n@desc Lists fonts available for use with the card customizer\n@returns(200) successful operation\n\n@endgroup\n\n@group cards\n@endpoint POST /cards/createCustomCard\n@desc Create a new custom card\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint GET /cards/list\n@desc Lists information on cards\n@returns(200) successful operation\n@errors {400: Invalid status value}\n\n@endpoint POST /cards/list\n@desc Lists information on cards\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n@errors {400: Invalid status value}\n\n@endpoint POST /cards/view\n@desc Provides full information on a specific card\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n\n@endgroup\n\n@group giftCards\n@endpoint POST /giftCards/view\n@desc Lists information on gift cards\n@returns(200) successful operation\n\n@endpoint GET /giftCards/view\n@desc Lists information on gift cards\n@returns(200) successful operation\n\n@endgroup\n\n@group templateCategories\n@endpoint GET /templateCategories/list\n@desc List template categories\n@returns(200) successful operation\n\n@endpoint POST /templateCategories/list\n@desc List template categories\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n\n@endgroup\n\n@group templates\n@endpoint GET /templates/list\n@desc List template categories\n@returns(200) successful operation\n\n@endpoint POST /templates/list\n@desc List template categories\n@optional {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /templates/view\n@desc Get all info on a template\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /templates/create\n@desc Creates a New Template in the User’s Account\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /templates/update\n@desc Updates an Existing Template in the User’s Account\n@required {body: map # additional parameters}\n@returns(200) successful operation\n\n@endpoint POST /templates/delete\n@desc Deletes a users template\n@required {body: map # additional parameters}\n@returns(200) successful deletion\n\n@endgroup\n\n@group countries\n@endpoint GET /countries/list\n@desc Lists the countries to which Handwritten can mail, their associated country ID and any costs\n@returns(200) successful operation\n\n@endgroup\n\n@group orders\n@endpoint POST /orders/singleStepOrder\n@desc sends an order in a single step.  This is much easier than using other order commands\n@required {body: map # additional parameters}\n@returns(200) successful order placement\n\n@endgroup\n\n@end\n"}