ConsumerApi

ReferFriendLinkUsedRequest

Consumer

The following routes are available for this service:
POST	/share/refer-friend-link-used	A friend referral link was used	Validates the JWT token with the identity of the referring user and returns relevant information.

"use strict";
export class ReferFriendUser {
    /** @param {{firstName?:string,lastName?:string,profilePhotoUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    firstName;
    /** @type {?string} */
    lastName;
    /** @type {?string} */
    profilePhotoUrl;
}
/** @typedef {'Available'|'Awarded'|'CanNotReferYourself'|'YouWereAlreadySignedUp'|'Expired'} */
export var ReferFriendState;
(function (ReferFriendState) {
    ReferFriendState["Available"] = "Available"
    ReferFriendState["Awarded"] = "Awarded"
    ReferFriendState["CanNotReferYourself"] = "CanNotReferYourself"
    ReferFriendState["YouWereAlreadySignedUp"] = "YouWereAlreadySignedUp"
    ReferFriendState["Expired"] = "Expired"
})(ReferFriendState || (ReferFriendState = {}));
export class ReferFriendLinkUsedResponse {
    /** @param {{referringUser?:ReferFriendUser,state?:ReferFriendState}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?ReferFriendUser} */
    referringUser;
    /** @type {?ReferFriendState} */
    state;
}
export class ReferFriendLinkUsedRequest {
    /** @param {{referFriendToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    referFriendToken;
}

JavaScript ReferFriendLinkUsedRequest DTOs

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

HTTP + XML

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

POST /share/refer-friend-link-used HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReferFriendLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferFriendToken>String</ReferFriendToken>
</ReferFriendLinkUsedRequest>

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

<ReferFriendLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferringUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </ReferringUser>
  <State>Available</State>
</ReferFriendLinkUsedResponse>