| POST | /business/next-to-accept-invite |
|---|
"use strict";
/** @typedef {'Authenticate'|'AuthenticateWithVipps'|'InviteIsForAnotherUser'|'CreatePassword'|'AcceptBusinessTermsOfService'|'AcceptInvite'} */
export var NextInviteStep;
(function (NextInviteStep) {
NextInviteStep["Authenticate"] = "Authenticate"
NextInviteStep["AuthenticateWithVipps"] = "AuthenticateWithVipps"
NextInviteStep["InviteIsForAnotherUser"] = "InviteIsForAnotherUser"
NextInviteStep["CreatePassword"] = "CreatePassword"
NextInviteStep["AcceptBusinessTermsOfService"] = "AcceptBusinessTermsOfService"
NextInviteStep["AcceptInvite"] = "AcceptInvite"
})(NextInviteStep || (NextInviteStep = {}));
export class ClaimUserInfo {
/** @param {{firstName?:string,lastName?:string,email?:string,legalIdentityVerified?:boolean,phoneNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
firstName;
/** @type {?string} */
lastName;
/** @type {string} */
email;
/** @type {?boolean} */
legalIdentityVerified;
/** @type {string} */
phoneNumber;
}
export class OpeningHour {
/** @param {{openAtHour?:number,openAtMinute?:number,closeAtHour?:number,closeAtMinute?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
openAtHour;
/** @type {?number} */
openAtMinute;
/** @type {?number} */
closeAtHour;
/** @type {?number} */
closeAtMinute;
}
export class WeeklyOpeningHours {
/** @param {{monday?:OpeningHour,tuesday?:OpeningHour,wednesday?:OpeningHour,thursday?:OpeningHour,friday?:OpeningHour,saturday?:OpeningHour,sunday?:OpeningHour}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?OpeningHour} */
monday;
/** @type {?OpeningHour} */
tuesday;
/** @type {?OpeningHour} */
wednesday;
/** @type {?OpeningHour} */
thursday;
/** @type {?OpeningHour} */
friday;
/** @type {?OpeningHour} */
saturday;
/** @type {?OpeningHour} */
sunday;
}
export class OpeningHours {
/** @param {{weekly?:WeeklyOpeningHours}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WeeklyOpeningHours} */
weekly;
}
/** @typedef {'Mall'|'Regular'} */
export var PlaceType;
(function (PlaceType) {
PlaceType["Mall"] = "Mall"
PlaceType["Regular"] = "Regular"
})(PlaceType || (PlaceType = {}));
/** @typedef {'Value'|'Medium'|'High'|'FineDining'} */
export var PriceMainDish;
(function (PriceMainDish) {
PriceMainDish["Value"] = "Value"
PriceMainDish["Medium"] = "Medium"
PriceMainDish["High"] = "High"
PriceMainDish["FineDining"] = "FineDining"
})(PriceMainDish || (PriceMainDish = {}));
export class PriceMainDishApiDto {
/** @param {{title?:string,slug?:PriceMainDish}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
title;
/** @type {?PriceMainDish} */
slug;
}
export class TimeZoneDto {
/** @param {{baseUtcOffset?:string,daylightName?:string,displayName?:string,id?:string,standardName?:string,supportsDaylightSavingTime?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
baseUtcOffset;
/** @type {string} */
daylightName;
/** @type {string} */
displayName;
/** @type {string} */
id;
/** @type {string} */
standardName;
/** @type {?boolean} */
supportsDaylightSavingTime;
}
export class PlaceContact {
/** @param {{phone?:string,email?:string,website?:string,webShop?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
phone;
/** @type {?string} */
email;
/** @type {?string} */
website;
/** @type {?string} */
webShop;
}
export class PlaceAddress {
/** @param {{street?:string,postalCode?:string,region?:string,countryCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
street;
/** @type {string} */
postalCode;
/** @type {string} */
region;
/** @type {string} */
countryCode;
}
export class CategoryTreeApiDto {
/** @param {{name?:string,slug?:string,absoluteSlug?:string,imageUrl?:string,allImageUrl?:string,iconImageUrl?:string,position?:number,children?:CategoryTreeApiDto[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
slug;
/** @type {string} */
absoluteSlug;
/** @type {?string} */
imageUrl;
/** @type {?string} */
allImageUrl;
/** @type {?string} */
iconImageUrl;
/** @type {?number} */
position;
/** @type {?CategoryTreeApiDto[]} */
children = [];
}
export class ImageUrls {
/** @param {{preview?:string,small?:string,medium?:string,large?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
preview;
/** @type {string} */
small;
/** @type {string} */
medium;
/** @type {string} */
large;
}
export class WearPriceProfileEsDto {
/** @param {{slug?:string,label?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
slug;
/** @type {string} */
label;
}
export class BrandApiDto {
/** @param {{name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
}
export class PlaceCustomBrandApiDto {
/** @param {{name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
}
export class PlaceSelectedBrandApiDto {
/** @param {{brand?:BrandApiDto,categoryAbsoluteSlugs?:string[],placeCustomBrand?:PlaceCustomBrandApiDto}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?BrandApiDto} */
brand;
/** @type {?string[]} */
categoryAbsoluteSlugs = [];
/** @type {?PlaceCustomBrandApiDto} */
placeCustomBrand;
}
export class PlaceBasicApiDto {
/** @param {{id?:number,guid?:string,overview?:string,name?:string,longitude?:number,latitude?:number,claimed?:boolean,organizationNumber?:string,countryCode?:string,openingHours?:OpeningHours,wheelchairAccessible?:boolean,wifi?:boolean,outdoorSeating?:boolean,saveFoodAndMoney?:boolean,placeType?:PlaceType,priceMainDish?:PriceMainDishApiDto,timeZoneDto?:TimeZoneDto,businessId?:number,contact?:PlaceContact,address?:PlaceAddress,categories?:CategoryTreeApiDto[],logoUrl?:ImageUrls,imageUrl?:ImageUrls,wearPriceProfiles?:WearPriceProfileEsDto[],brands?:PlaceSelectedBrandApiDto[],floor?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
id;
/** @type {?string} */
guid;
/** @type {?string} */
overview;
/** @type {string} */
name;
/** @type {?number} */
longitude;
/** @type {?number} */
latitude;
/** @type {?boolean} */
claimed;
/** @type {?string} */
organizationNumber;
/** @type {string} */
countryCode;
/** @type {?OpeningHours} */
openingHours;
/** @type {?boolean} */
wheelchairAccessible;
/** @type {?boolean} */
wifi;
/** @type {?boolean} */
outdoorSeating;
/** @type {?boolean} */
saveFoodAndMoney;
/** @type {?PlaceType} */
placeType;
/** @type {?PriceMainDishApiDto} */
priceMainDish;
/** @type {TimeZoneDto} */
timeZoneDto;
/** @type {?number} */
businessId;
/** @type {PlaceContact} */
contact;
/** @type {PlaceAddress} */
address;
/** @type {CategoryTreeApiDto[]} */
categories = [];
/** @type {?ImageUrls} */
logoUrl;
/** @type {?ImageUrls} */
imageUrl;
/** @type {WearPriceProfileEsDto[]} */
wearPriceProfiles = [];
/** @type {PlaceSelectedBrandApiDto[]} */
brands = [];
/** @type {?string} */
floor;
}
/** @typedef {'Owner'|'Manager'|'Sales'|'Marketing'|'Other'} */
export var BusinessRole;
(function (BusinessRole) {
BusinessRole["Owner"] = "Owner"
BusinessRole["Manager"] = "Manager"
BusinessRole["Sales"] = "Sales"
BusinessRole["Marketing"] = "Marketing"
BusinessRole["Other"] = "Other"
})(BusinessRole || (BusinessRole = {}));
export class BusinessInviteUserInfo {
/** @param {{firstName?:string,lastName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
firstName;
/** @type {string} */
lastName;
}
export class InviteInfo {
/** @param {{staffRole?:StaffRole,businessRole?:BusinessRole,invitingUser?:BusinessInviteUserInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?StaffRole} */
staffRole;
/** @type {?BusinessRole} */
businessRole;
/** @type {BusinessInviteUserInfo} */
invitingUser;
}
export class NextToAcceptBusinessInviteResponse {
/** @param {{nextStep?:NextInviteStep,user?:ClaimUserInfo,place?:PlaceBasicApiDto,invite?:InviteInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?NextInviteStep} */
nextStep;
/** @type {ClaimUserInfo} */
user;
/** @type {PlaceBasicApiDto} */
place;
/** @type {InviteInfo} */
invite;
}
export class NextToAcceptBusinessInviteRequest {
/** @param {{inviteKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
inviteKey;
}
JavaScript NextToAcceptBusinessInviteRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /business/next-to-accept-invite HTTP/1.1
Host: consumer-api.brovs.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<NextToAcceptBusinessInviteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
<InviteKey>String</InviteKey>
</NextToAcceptBusinessInviteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NextToAcceptBusinessInviteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
<Invite>
<BusinessRole>Owner</BusinessRole>
<InvitingUser>
<FirstName>String</FirstName>
<LastName>String</LastName>
</InvitingUser>
<StaffRole>Owner</StaffRole>
</Invite>
<NextStep>Authenticate</NextStep>
<Place>
<Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:CountryCode>String</d3p1:CountryCode>
<d3p1:PostalCode>String</d3p1:PostalCode>
<d3p1:Region>String</d3p1:Region>
<d3p1:Street>String</d3p1:Street>
</Address>
<Brands>
<PlaceSelectedBrandApiDto>
<Brand>
<Name>String</Name>
</Brand>
<CategoryAbsoluteSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</CategoryAbsoluteSlugs>
<PlaceCustomBrand>
<Name>String</Name>
</PlaceCustomBrand>
</PlaceSelectedBrandApiDto>
</Brands>
<BusinessId>0</BusinessId>
<Categories>
<CategoryTreeApiDto>
<AbsoluteSlug>String</AbsoluteSlug>
<AllImageUrl>String</AllImageUrl>
<Children>
<CategoryTreeApiDto>
<AbsoluteSlug>String</AbsoluteSlug>
<AllImageUrl>String</AllImageUrl>
<Children>
<CategoryTreeApiDto>
<AbsoluteSlug>String</AbsoluteSlug>
<AllImageUrl>String</AllImageUrl>
<Children i:nil="true" />
<IconImageUrl>String</IconImageUrl>
<ImageUrl>String</ImageUrl>
<Name>String</Name>
<Position>0</Position>
<Slug>String</Slug>
</CategoryTreeApiDto>
</Children>
<IconImageUrl>String</IconImageUrl>
<ImageUrl>String</ImageUrl>
<Name>String</Name>
<Position>0</Position>
<Slug>String</Slug>
</CategoryTreeApiDto>
</Children>
<IconImageUrl>String</IconImageUrl>
<ImageUrl>String</ImageUrl>
<Name>String</Name>
<Position>0</Position>
<Slug>String</Slug>
</CategoryTreeApiDto>
</Categories>
<Claimed>false</Claimed>
<Contact xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:Email>String</d3p1:Email>
<d3p1:Phone>String</d3p1:Phone>
<d3p1:WebShop>String</d3p1:WebShop>
<d3p1:Website>String</d3p1:Website>
</Contact>
<CountryCode>String</CountryCode>
<Floor>String</Floor>
<Guid>00000000-0000-0000-0000-000000000000</Guid>
<Id>0</Id>
<ImageUrl xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:Large>String</d3p1:Large>
<d3p1:Medium>String</d3p1:Medium>
<d3p1:Preview>String</d3p1:Preview>
<d3p1:Small>String</d3p1:Small>
</ImageUrl>
<Latitude>0</Latitude>
<LogoUrl xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:Large>String</d3p1:Large>
<d3p1:Medium>String</d3p1:Medium>
<d3p1:Preview>String</d3p1:Preview>
<d3p1:Small>String</d3p1:Small>
</LogoUrl>
<Longitude>0</Longitude>
<Name>String</Name>
<OpeningHours xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:Weekly>
<d3p1:Friday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Friday>
<d3p1:Monday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Monday>
<d3p1:Saturday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Saturday>
<d3p1:Sunday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Sunday>
<d3p1:Thursday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Thursday>
<d3p1:Tuesday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Tuesday>
<d3p1:Wednesday>
<d3p1:CloseAtHour>0</d3p1:CloseAtHour>
<d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
<d3p1:OpenAtHour>0</d3p1:OpenAtHour>
<d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
</d3p1:Wednesday>
</d3p1:Weekly>
</OpeningHours>
<OrganizationNumber>String</OrganizationNumber>
<OutdoorSeating>false</OutdoorSeating>
<Overview>String</Overview>
<PlaceType>Mall</PlaceType>
<PriceMainDish>
<Slug>Value</Slug>
<Title>String</Title>
</PriceMainDish>
<SaveFoodAndMoney>false</SaveFoodAndMoney>
<TimeZoneDto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
<d3p1:BaseUtcOffset>PT0S</d3p1:BaseUtcOffset>
<d3p1:DaylightName>String</d3p1:DaylightName>
<d3p1:DisplayName>String</d3p1:DisplayName>
<d3p1:Id>String</d3p1:Id>
<d3p1:StandardName>String</d3p1:StandardName>
<d3p1:SupportsDaylightSavingTime>false</d3p1:SupportsDaylightSavingTime>
</TimeZoneDto>
<WearPriceProfiles>
<WearPriceProfileEsDto>
<Label>String</Label>
<Slug>String</Slug>
</WearPriceProfileEsDto>
</WearPriceProfiles>
<WheelchairAccessible>false</WheelchairAccessible>
<Wifi>false</Wifi>
</Place>
<User>
<Email>String</Email>
<FirstName>String</FirstName>
<LastName>String</LastName>
<LegalIdentityVerified>false</LegalIdentityVerified>
<PhoneNumber>String</PhoneNumber>
</User>
</NextToAcceptBusinessInviteResponse>