ConsumerApi

ReferBusinessLinkUsedRequest

ConsumerBusiness

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module ConsumerApi


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferBusinessUser:
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    profile_photo_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferredPlace:
    id: int = 0
    guid: Optional[str] = None
    name: Optional[str] = None
    logo_url: Optional[str] = None
    image_url: Optional[str] = None


class ReferBusinessState(str, Enum):
    SIGN_IN_TO_SEE = 'SignInToSee'
    AVAILABLE = 'Available'
    CAN_NOT_REFER_YOURSELF = 'CanNotReferYourself'
    ALREADY_CLAIMED_BY_YOU = 'AlreadyClaimedByYou'
    ALREADY_CLAIMED_BY_SOMEONE_ELSE = 'AlreadyClaimedBySomeoneElse'
    EXPIRED = 'Expired'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferBusinessLinkUsedResponse:
    referring_user: Optional[ReferBusinessUser] = None
    referred_place: Optional[ReferredPlace] = None
    state: Optional[ReferBusinessState] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReferBusinessLinkUsedRequest(IPost):
    refer_business_token: Optional[str] = None

Python ReferBusinessLinkUsedRequest DTOs

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

HTTP + CSV

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

POST /share/refer-business-link-used HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"referBusinessToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"referringUser":{"firstName":"String","lastName":"String","profilePhotoUrl":"String"},"referredPlace":{"id":0,"name":"String","logoUrl":"String","imageUrl":"String"},"state":"SignInToSee"}