| PUT | /v1/account |
|---|
"use strict";
export class V2BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
}
export class PutAccountResponseData {
/** @param {{oneTimeToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
oneTimeToken;
}
export class PutAccountResponse extends V2BaseResponse {
/** @param {{data?:PutAccountResponseData,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {PutAccountResponseData} */
data;
}
/** @typedef {'none'|'text'|'upload'} */
export var SignatureAppearance;
(function (SignatureAppearance) {
SignatureAppearance["None"] = "none"
SignatureAppearance["Text"] = "text"
SignatureAppearance["Upload"] = "upload"
})(SignatureAppearance || (SignatureAppearance = {}));
export class PutAccountRequest {
/** @param {{emailAddress?:string,fullName?:string,profileImageId?:string,signatureImageId?:string,signatureFont?:string,signatureAppearance?:SignatureAppearance}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
emailAddress;
/** @type {string} */
fullName;
/** @type {string} */
profileImageId;
/** @type {string} */
signatureImageId;
/** @type {string} */
signatureFont;
/** @type {SignatureAppearance} */
signatureAppearance;
}
JavaScript PutAccountRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/account HTTP/1.1
Host: api.booklinker.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
newEmail: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
oneTimeToken: String,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}