Static acceptStatic acceptThe route to accept an influnecers request to join the campaign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static addAssociate a country with the campaign.
The country information to be passed to update the country campaigns information.
Optional params: Record<string, any>Promise
Static addAssociate an ethnicity with the campaign.
The ethnicity information to be passed to update the campaign information.
Optional params: Record<string, any>Promise
Static addAssociate a gender with the campaign.
The gener information to be passed to update the gender information.
Optional params: Record<string, any>Promise
Static addAssociate a type with the campaign.
The type information to be passed to update the campaign information.
Optional params: Record<string, any>Promise
Static assignAssigns an available access key to an influencer for a specific campaign. This will find the next available key for the given platform and assign it.
The ID of the campaign.
The ID of the user (influencer).
The platform for which to assign a key.
The platform of the key to assign (e.g., 'steam').
Optional params: Record<string, any>promise
Static createStatic createStatic createStatic createCreate an influencer campaign
The data to be passed when creating a campaign.
Optional params: Record<string, any>Promise
Static declineThe route for an influencer to decline an invite.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static declineThe route to deny an influencer request to join the campaign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static deleteStatic deleteDelete the information for a single campaign mention.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static enrichManually trigger a real-time profile enrichment for a sourced creator. This synchronously scrapes and parses social media profiles to enrich the creator's data and returns the updated record.
The UUID of the campaign.
The UUID of the sourced creator to enrich.
promise containing the fully enriched SourcedCreator object.
Static exportExport sourced creators for a campaign to a CSV or XLSX file. This method applies the same filtering and sorting parameters as getSourcedCreators. The browser will automatically trigger a download for the returned file.
The UUID of the campaign.
Query parameters for the export, including the required 'format' and any filters.
The desired file format ('csv' or 'xlsx').
A promise that resolves with the file blob for download.
Static finishThe route to mark an influencer reachout and finished, and it will no longer send reachouts.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static generateGenerate a contract for the influencer based on the values in the campaign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static generateGenerate post content for the influencer to help them with their content creation.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static generateGenerate a contract for the influencer based on the values in the invite.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static getStatic getStatic getRetrieve the information for a single campaign mention.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static getStatic getStatic getStatic getStatic getGet sourced creators for a campaign from the database.
The UUID of the campaign.
Optional params: Record<string, any>Query parameters for filtering, sorting, and pagination.
promise
Static getStatic listStatic listStatic listStatic listStatic listStatic listStatic listGet a list of influencer invites that have been sent for this campaign.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static listStatic markMark an influencer campaign as completed.
The data to be passed when creating a campaign.
Optional params: Record<string, any>Promise
Static markMark an influencer campaign as incomplete.
The data to be passed when creating a campaign.
Optional params: Record<string, any>Promise
Static payPay the influencer a custom amount for the campaign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static removeStatic removeStatic removeStatic removeStatic resendResend the acceptance email for the influencer.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static reviewThe route the route to mark the influencers request as in review.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static sendSend a contract with Docusign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static sendSend a contract with Docusign.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Static sendStatic sourcingFind and save content creators for selected games to the database.
The UUID of the campaign.
The search criteria (source, igdb_ids, etc.).
promise
Static sourcingFind and save Twitch creators for selected games to the database.
The UUID of the campaign.
The search criteria (source, igdb_ids, etc.).
promise
Static sourcingFind and save YouTube creators for selected games to the database.
The UUID of the campaign.
The search criteria (igdb_ids, period).
promise
Static sourcingFind content creators for selected games. This does not save them to the database.
The UUID of the campaign.
The search criteria (source, igdb_ids, etc.).
promise
Static sourcingGet full game details from a list of IGDB IDs.
The UUID of the campaign.
An object containing the array of IGDB IDs.
An array of IGDB game IDs.
promise
Static sourcingStatic sourcingSearch IGDB for any game by a query string.
The UUID of the campaign (for permission checking).
Query parameters including 'search_query' and optional 'limit'.
Optional limit?: numberpromise
Static sourcingSearch IGDB for the campaign's game.
The UUID of the campaign.
Optional params: Record<string, any>Query parameters (e.g., search_query, limit).
promise
Static statisticsStatic updateStatic updateUpdate a campaign.
The id of the campaign to update.
The data to update.
Optional params: Record<string, any>promise
Static updateUpdate a campaign mention.
The id of the campaign to update.
The data to update.
Optional params: Record<string, any>promise
Static updateUpdate an influencer campaign.
The id of the campaign to update.
The data to update.
Optional params: Record<string, any>promise
Static updateUpdates the influencer invite compenstation information.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static updateUpdates the influencer invite information.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static updateUpdate a sourced creator (e.g., approve or reject).
The UUID of the campaign.
The UUID of the sourced creator to update.
The update data (e.g., is_approved, is_rejected).
promise
Static updateStatic viewStatic viewRetrieve the information for a single campaign.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static viewInvites an influencer to join this campaign.
The id fo the campaign to retrieve.
Optional params: Record<string, any>promise
Static widthdrawThe route for an influencer to decline an invite.
The id fo the campaign to retrieve.
Optional data: objectOptional params: Record<string, any>promise
Generated using TypeDoc
The route for an influencer to accept an invite.