@artsy/cohesion
Version:
Analytics schema
138 lines (137 loc) • 3.85 kB
TypeScript
import { AuthContextModule, FollowedArtist, FollowedFair, FollowedGene, FollowedPartner, OwnerType, UnfollowedArtist, UnfollowedFair, UnfollowedGene, UnfollowedPartner } from "../../Schema";
export interface FollowedArgs {
contextModule: AuthContextModule;
contextOwnerId?: string;
contextOwnerSlug?: string;
contextOwnerType: OwnerType;
ownerId: string;
ownerSlug: string;
}
/**
* A user follows an artist
*
* @example
* ```
* followedArtist({
* contextModule: ContextModule.artistSeriesRail
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol",
* contextOwnerType: OwnerType.artist,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "sturtevant",
* })
* ```
*/
export declare const followedArtist: (args: FollowedArgs) => FollowedArtist;
/**
* A user unfollows an artist
*
* @example
* ```
* unfollowedArtist({
* contextModule: ContextModule.artistSeriesRail
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol",
* contextOwnerType: OwnerType.artist,
* OwnerId: "5359794d1a1e86c3740001f7",
* OwnerSlug: "sturtevant",
* })
* ```
*/
export declare const unfollowedArtist: (args: FollowedArgs) => UnfollowedArtist;
/**
* A user follows a fair
*
* @example
* ```
* followedFair({
* contextModule: ContextModule.otherWorksFromPartnerRail,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol-skull",
* contextOwnerType: OwnerType.artwork,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "frieze-london",
* })
* ```
*/
export declare const followedFair: (args: FollowedArgs) => FollowedFair;
/**
* A user unfollows a fair
*
* @example
* ```
* unfollowedFair({
* contextModule: ContextModule.otherWorksFromPartnerRail,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol-skull",
* contextOwnerType: OwnerType.artwork,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "frieze-london",
* })
* ```
*/
export declare const unfollowedFair: (args: FollowedArgs) => UnfollowedFair;
/**
* A user follows a gene
*
* @example
* ```
* followedGene({
* contextModule: ContextModule.intextTooltip,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "artsy-editorial-future-of-art",
* contextOwnerType: OwnerType.article,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "surrealism",
* })
* ```
*/
export declare const followedGene: (args: FollowedArgs) => FollowedGene;
/**
* A user unfollows a gene
*
* @example
* ```
* unfollowedGene({
* contextModule: ContextModule.intextTooltip,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "artsy-editorial-future-of-art",
* contextOwnerType: OwnerType.article,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "surrealism",
* })
* ```
*/
export declare const unfollowedGene: (args: FollowedArgs) => UnfollowedGene;
/**
* A user follows a partner
*
* @example
* ```
* followedPartner({
* contextModule: ContextModule.aboutTheWork,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol-skull",
* contextOwnerType: OwnerType.artwork,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "pace-prints",
* })
* ```
*/
export declare const followedPartner: (args: FollowedArgs) => FollowedPartner;
/**
* A user unfollows a partner
*
* @example
* ```
* unfollowedPartner({
* contextModule: ContextModule.aboutTheWork,
* contextOwnerId: "5359794d2a1e86c3741001f8",
* contextOwnerSlug: "andy-warhol-skull",
* contextOwnerType: OwnerType.artwork,
* ownerId: "5359794d1a1e86c3740001f7",
* ownerSlug: "pace-prints",
* })
* ```
*/
export declare const unfollowedPartner: (args: FollowedArgs) => UnfollowedPartner;