@learncard/network-plugin 3.1.4 → 3.2.0

package/src/types.ts

@@ -1,5 +1,20 @@
 import type { SendContractRequest, ConsentFlowContractRequestForProfile } from '@learncard/types';
 import type { LCNClient } from '@learncard/network-brain-client';
+import type {
+    Campaign,
+    CampaignAudienceInput,
+    CampaignEvent,
+    CampaignStats,
+    CampaignStatus,
+    CreateCampaignInput,
+    UpdateCampaignInput,
+    ListCampaignsInput,
+    MyCampaign,
+    PageCampaignAudienceInput,
+    PaginatedCampaigns,
+    PaginatedCampaignAudience,
+    PublishCredentialSharePreview,
+} from '@learncard/types';
 import {
     LCNProfile,
     LCNVisibleProfile,
@@ -213,6 +228,15 @@ export type LearnCardNetworkPluginDependentMethods = {
 
 /** @group LearnCardNetwork Plugin */
 export type LearnCardNetworkPluginMethods = {
+    /**
+     * Publish opted-in, publisher-supplied metadata bound to an encrypted presentation URI.
+     * Provide an owned preview ID and the same URI to refresh it; its URI cannot be rebound.
+     * A missing or mismatched refresh returns NOT_FOUND. This does not verify the credential or issuer.
+     * Returns an opaque UUID; public lookup also requires the matching share URI.
+     */
+    publishCredentialSharePreview: (preview: PublishCredentialSharePreview) => Promise<string>;
+    /** Remove an owned preview; returns false if absent/unowned. Social copies may persist. */
+    deleteCredentialSharePreview: (id: string) => Promise<boolean>;
     createProfile: (
         profile: Omit<LCNProfile, 'did' | 'isServiceProfile'> & { authToken?: string }
     ) => Promise<string>;
@@ -1106,6 +1130,20 @@ export type LearnCardNetworkPluginMethods = {
     }>;
 
     isAppStoreAdmin: () => Promise<boolean>;
+    campaignsIsAdmin: () => Promise<boolean>;
+    campaignsCreate: (input: CreateCampaignInput) => Promise<Campaign>;
+    campaignsUpdate: (input: UpdateCampaignInput) => Promise<Campaign>;
+    campaignsGet: (campaignId: string) => Promise<Campaign>;
+    campaignsList: (input?: ListCampaignsInput) => Promise<PaginatedCampaigns>;
+    campaignsDelete: (campaignId: string) => Promise<boolean>;
+    campaignsSetStatus: (campaignId: string, status: CampaignStatus) => Promise<Campaign>;
+    campaignsPreviewAudience: (input: CampaignAudienceInput) => Promise<{ count: number }>;
+    campaignsAddAudience: (input: CampaignAudienceInput) => Promise<{ count: number }>;
+    campaignsPageAudience: (input: PageCampaignAudienceInput) => Promise<PaginatedCampaignAudience>;
+    campaignsGetStats: (campaignId: string) => Promise<CampaignStats>;
+    getMyCampaigns: () => Promise<MyCampaign[]>;
+    recordCampaignEvent: (campaignId: string, event: CampaignEvent) => Promise<boolean>;
+    enrollInCampaign: (campaignId: string) => Promise<boolean>;
     adminUpdateListingStatus: (listingId: string, status: AppListingStatus) => Promise<boolean>;
     adminUpdatePromotionLevel: (
         listingId: string,