Variable: buildQuery

const buildQuery: { campaign: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Campaign, false, Includes, Attributes>; campaignMembers: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Member, true, Includes, Attributes>; campaignPosts: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Post, true, Includes, Attributes>; campaigns: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Campaign, true, Includes, Attributes>; identity: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<User, false, Includes, Attributes>; member: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Member, false, Includes, Attributes>; post: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Post, false, Includes, Attributes>; webhooks: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Webhook, true, Includes, Attributes>; }

Defined in: rest/v2/query.ts:20

Type declaration

campaign()

campaign: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Campaign, false, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "benefits" | "goals" | "tiers" | "creator"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Campaign, false, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Campaign, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Campaign, false, Includes, Attributes>

campaignMembers()

campaignMembers: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Member, true, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "address" | "campaign" | "user" | "pledge_history" | "currently_entitled_tiers"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Member, true, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Member, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Member, true, Includes, Attributes>

campaignPosts()

campaignPosts: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Post, true, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "campaign" | "user"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Post, true, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Post, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Post, true, Includes, Attributes>

campaigns()

campaigns: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Campaign, true, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "benefits" | "goals" | "tiers" | "creator"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Campaign, true, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Campaign, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Campaign, true, Includes, Attributes>

identity()

identity: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<User, false, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "campaign" | "memberships"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<User, false, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<User, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<User, false, Includes, Attributes>

member()

member: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Member, false, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "address" | "campaign" | "user" | "pledge_history" | "currently_entitled_tiers"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Member, false, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Member, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Member, false, Includes, Attributes>

post()

post: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Post, false, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "campaign" | "user"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Post, false, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Post, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Post, false, Includes, Attributes>

webhooks()

webhooks: <Includes>(include?) => <Attributes>(attributes?, options?) => QueryBuilder<Webhook, true, Includes, Attributes>

Type Parameters

Type Parameter	Default type
Includes extends "campaign" | "client"	never

Parameters

Parameter	Type
include?	Includes[]

Returns

<Attributes>(attributes?, options?): QueryBuilder<Webhook, true, Includes, Attributes>

Type Parameters

Type Parameter
Attributes extends RelationshipMap<Webhook, Includes>

Parameters

Parameter	Type
attributes?	Attributes
options?	QueryRequestOptions

Returns

QueryBuilder<Webhook, true, Includes, Attributes>

Deprecated

use QueryBuilder.{property}.build instead of buildQuery.