@ambassify/crusade-client
v6.2.1
Published
API Client for crusade service
Downloads
364
Readme
@ambassify/crusade-client
API Client for crusade service
CrusadeApi
#getAllCampaignCollection(resource, endpoint, campaignId, query)
#getCampaignCollection(endpoint, campaignId, query)
#getAllOrganizations(query, options)
#getOrganizations(query, options)
#getOrganization(id, query, options)
#getCurrentOrganization(query, options)
#updateCurrentOrganization(updates, options)
#getEmailTemplate(query, options)
#updateEmailTemplate(updates, options)
#getAllTags(query, options)
#getTags(query, options)
#getTag(id, query, options)
#createTag(tag = {}, options)
#updateTag(id, updates, options)
#deleteTag(id, options)
#getAllCampaignTabs(query, options)
#getCampaignTabs(query, options)
#getCampaignTab(id, query, options)
#createCampaignTab(campaignTab = {}, options)
#updateCampaignTab(id, updates, options)
#deleteCampaignTab(id, options)
#getAllCampaigns(query, options)
#getCampaigns(query, options)
#getAllCampaignsByTab(tabId, query, options)
#getCampaignsByTab(tabId, query, options)
#getCampaign(id, query, options)
#createCampaign(campaign = {}, options)
#createMemberCampaign(tabId, campaign = {}, options)
#updateCampaign(id, updates, options)
#deleteCampaign(id, options)
#duplicateCampaign(id, params, options)
#likeCampaign(id, options)
#unlikeCampaign(id, options)
#dismissCampaign(id, options)
#getAllConversions(campaignId, query, options)
#getConversions(campaignId, query, options)
#getConversion(id, query, options)
#createConversion(campaignId, conversion = {}, options)
#updateConversion(conversionId, data, options)
#deleteConversion(id, options)
#getAllInteractions(campaignId, query, options)
#getInteractions(campaignId, query, options)
#getInteraction(id, query, options)
#createInteraction(campaignId, interaction = {}, options)
#updateInteraction(id, updates, options)
#deleteInteraction(id, options)
#getCommunity(query, options)
#getAllWebhooks(query, options)
#getWebhooks(query, options)
#getWebhook(id, query, options)
#getRewards(query, options)
#getReward(id, query, options)
#createReward(reward, options)
#updateReward(id, updates, options)
#deleteReward(id, options)
#getAllRewardRequests(query, options)
#getRewardRequests(query, options)
#getRewardRequest(id, query, options)
#createRewardRequest(rewardId, request = {}, options)
#updateRewardRequest(id, updates, options)
#deleteRewardRequest(id, options)
#getAllRewardRequesters(query, { rewardId, ...options } = {})
#getRewardRequesters(query, { rewardId, ...options } = {})
#getRewardRequester(id, query, options)
#getAllCustomProperties(query, { organizationId, ...options } = {})
#getCustomProperties(query, { organizationId, ...options } = {})
#getCustomProperty(id, query, options)
#createCustomProperty(customProperty, options)
#updateCustomProperty(id, updates, options)
#deleteCustomProperty(id, options)
#getAllImportSources(query, options)
#getImportSources(query, options)
#getImportSource(id, query, options)
#createImportSource(importSource, options)
#updateImportSource(id, updates, options)
#deleteImportSource(id, options)
#getAllIntegrations(query, options)
#getIntegrations(query, options)
#getIntegration(id, query, options)
#createIntegration(integration, options)
#updateIntegration(id, updates, options)
#deleteIntegration(id, options)
#getAllParticipants(query, options)
#getParticipants(query, options)
#getParticipant(id, query, options)
#getAllCommenters(query, options)
#getCommenters(query, options)
#getCommenter(id, query, options)
#getAllShortlinks(campaignId, query, options)
#getShortlinks(campaignId, query, options)
#getShortlink(id, query, options)
#createShortlink(campaignId, integration, options)
#updateShortlink(id, updates, options)
#deleteShortlink(id, options)
#getAllComments(query, options)
#getComments(query, options)
#getComment(id, query, options)
#createComment(comment = {}, options)
#updateComment(id, updates, options)
#deleteComment(id, options)
#getAllCampaignComments(campaignId, query, options)
#getCampaignComments(campaignId, query, options)
#createCampaignComment(campaignId, comment = {}, options)
#getAllCommentReplies(commentId, query, options)
#getCommentReplies(commentId, query, options)
#createCommentReply(commentId, comment = {}, options)
#getAllGoals(query, options)
#getGoals(query, options)
#getGoal(id, query, options)
#createGoal(goal, options)
#updateGoal(id, updates, options)
#deleteGoal(id, options)
#getAllGoalObjectives(goalId, query, options)
#getGoalObjectives(goalId, query, options)
#getGoalObjective(id, query, options)
#createGoalObjective(goalId, objective, options)
#updateGoalObjective(id, updates, options)
#deleteGoalObjective(id, options)
#getAllGoalEvents({ goalId, objectiveId, ...query } = {}, options)
#getGoalEvents({ goalId, objectiveId, ...query } = {}, options)
#bulkUpdateGoalEvents(condition, operations, options)
#getGoalEvent(id, query, options)
#createGoalEvent(objectiveId, event, options)
#updateGoalEvent(id, updates, options)
#deleteGoalEvent(id, options)
#getAllGoalContributors(goalId, query, options)
#getGoalContributors(goalId, query, options)
#getAllGoalObjectiveContributors(objectiveId, query, options)
#getGoalObjectiveContributors(objectiveId, query, options)
#getAllShareVariants(campaignId, query, options)
#getShareVariants(campaignId, query, options)
#getShareVariant(id, query, options)
#createShareVariant(campaignId, variant, options)
#updateShareVariant(id, updates, options)
#deleteShareVariant(id, options)
#getFeatureFlagConfig(query, options)
#getAllFeatureFlags(query, options)
#getFeatureFlags(query, options)
#getAllFeatureFlagsByOrganization(organizationId, query, options)
#getFeatureFlagsByOrganization(organizationId, query, options)
#getFeatureFlag(id, query, options)
#createFeatureFlag(flag, options)
#updateFeatureFlag(id, updates, options)
#replaceFeatureFlag(id, flag, options)
#deleteFeatureFlag(id, options)