Booklinker.API

<back to all web services

GetAppleServicesSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v2/settings/apple-services
"use strict";
export class V2BaseRequest {
    constructor(init) { Object.assign(this, init) }
}
export class V2BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
/** @typedef {'none'|'custom'|'booklinker'} */
export var AffiliateSettingsOption;
(function (AffiliateSettingsOption) {
    AffiliateSettingsOption["None"] = "none"
    AffiliateSettingsOption["Custom"] = "custom"
    AffiliateSettingsOption["Booklinker"] = "booklinker"
})(AffiliateSettingsOption || (AffiliateSettingsOption = {}));
/** @typedef {'none'|'pending'|'approved'|'rejected'} */
export var EnrollmentState;
(function (EnrollmentState) {
    EnrollmentState["None"] = "none"
    EnrollmentState["Pending"] = "pending"
    EnrollmentState["Approved"] = "approved"
    EnrollmentState["Rejected"] = "rejected"
})(EnrollmentState || (EnrollmentState = {}));
export class GetAppleServicesSettingsResponseData {
    /** @param {{selectedOption?:AffiliateSettingsOption,username?:string,userEmail?:string,booklinkerToken?:string,customToken?:string,enrollmentState?:EnrollmentState}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AffiliateSettingsOption} */
    selectedOption;
    /** @type {string} */
    username;
    /** @type {string} */
    userEmail;
    /** @type {string} */
    booklinkerToken;
    /** @type {string} */
    customToken;
    /** @type {EnrollmentState} */
    enrollmentState;
}
export class GetAppleServicesSettingsResponse extends V2BaseResponse {
    /** @param {{data?:GetAppleServicesSettingsResponseData,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {GetAppleServicesSettingsResponseData} */
    data;
}
export class GetAppleServicesSettingsRequest extends V2BaseRequest {
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript GetAppleServicesSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v2/settings/apple-services HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"selectedOption":"none","username":"String","userEmail":"String","booklinkerToken":"String","customToken":"String","enrollmentState":"none"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}