interface IGalleryApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addAssetForEditExtensionDraft(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        extensionName: string,
        draftId: string,
        assetType: string,
    ): Promise<ExtensionDraftAsset>;
    addAssetForNewExtensionDraft(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        draftId: string,
        assetType: string,
    ): Promise<ExtensionDraftAsset>;
    associateAzurePublisher(
        publisherName: string,
        azurePublisherId: string,
    ): Promise<AzurePublisher>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createCategory(category: ExtensionCategory): Promise<ExtensionCategory>;
    createDraftForEditExtension(
        publisherName: string,
        extensionName: string,
    ): Promise<ExtensionDraft>;
    createDraftForNewExtension(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        product: String,
        fileName?: String,
    ): Promise<ExtensionDraft>;
    createExtension(
        customHeaders: any,
        contentStream: ReadableStream,
        extensionType?: string,
        reCaptchaToken?: string,
    ): Promise<PublishedExtension>;
    createExtensionJson(
        extensionPackage: ExtensionPackage,
    ): Promise<PublishedExtension>;
    createExtensionWithPublisher(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        extensionType?: string,
        reCaptchaToken?: string,
    ): Promise<PublishedExtension>;
    createExtensionWithPublisherJson(
        extensionPackage: ExtensionPackage,
        publisherName: string,
    ): Promise<PublishedExtension>;
    createPublisher(publisher: Publisher): Promise<Publisher>;
    createQuestion(
        question: Question,
        publisherName: string,
        extensionName: string,
    ): Promise<Question>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createResponse(
        response: Response,
        publisherName: string,
        extensionName: string,
        questionId: number,
    ): Promise<Response>;
    createReview(
        review: Review,
        pubName: string,
        extName: string,
    ): Promise<Review>;
    createSupportRequest(
        customerSupportRequest: CustomerSupportRequest,
    ): Promise<void>;
    deleteExtension(
        publisherName: string,
        extensionName: string,
        version?: string,
    ): Promise<void>;
    deleteExtensionById(extensionId: string, version?: string): Promise<void>;
    deletePublisher(publisherName: string): Promise<void>;
    deletePublisherAsset(
        publisherName: string,
        assetType?: string,
    ): Promise<void>;
    deleteQuestion(
        publisherName: string,
        extensionName: string,
        questionId: number,
    ): Promise<void>;
    deleteResponse(
        publisherName: string,
        extensionName: string,
        questionId: number,
        responseId: number,
    ): Promise<void>;
    deleteReview(
        pubName: string,
        extName: string,
        reviewId: number,
    ): Promise<void>;
    extensionValidator(
        azureRestApiRequestModel: AzureRestApiRequestModel,
    ): Promise<void>;
    fetchDomainToken(publisherName: string): Promise<string>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>;
    getAcquisitionOptions(
        itemId: string,
        installationTarget: string,
        testCommerce?: boolean,
        isFreeOrTrialInstall?: boolean,
    ): Promise<AcquisitionOptions>;
    getAsset(
        customHeaders: any,
        extensionId: string,
        version: string,
        assetType: string,
        accountToken?: string,
        acceptDefault?: boolean,
        accountTokenHeader?: String,
    ): Promise<ReadableStream>;
    getAssetAuthenticated(
        customHeaders: any,
        publisherName: string,
        extensionName: string,
        version: string,
        assetType: string,
        accountToken?: string,
        accountTokenHeader?: String,
    ): Promise<ReadableStream>;
    getAssetByName(
        customHeaders: any,
        publisherName: string,
        extensionName: string,
        version: string,
        assetType: string,
        accountToken?: string,
        acceptDefault?: boolean,
        accountTokenHeader?: String,
    ): Promise<ReadableStream>;
    getAssetFromEditExtensionDraft(
        publisherName: string,
        draftId: string,
        assetType: string,
        extensionName: string,
    ): Promise<ReadableStream>;
    getAssetFromNewExtensionDraft(
        publisherName: string,
        draftId: string,
        assetType: string,
    ): Promise<ReadableStream>;
    getAssetWithToken(
        customHeaders: any,
        publisherName: string,
        extensionName: string,
        version: string,
        assetType: string,
        assetToken?: string,
        accountToken?: string,
        acceptDefault?: boolean,
        accountTokenHeader?: String,
    ): Promise<ReadableStream>;
    getCategories(languages?: string): Promise<string[]>;
    getCategoryDetails(
        categoryName: string,
        languages?: string,
        product?: string,
    ): Promise<CategoriesResult>;
    getCategoryTree(
        product: string,
        categoryId: string,
        lcid?: number,
        source?: string,
        productVersion?: string,
        skus?: string,
        subSkus?: string,
        productArchitecture?: string,
    ): Promise<ProductCategory>;
    getCertificate(
        publisherName: string,
        extensionName: string,
        version?: string,
    ): Promise<ReadableStream>;
    getContentVerificationLog(
        publisherName: string,
        extensionName: string,
    ): Promise<ReadableStream>;
    getExtension(
        customHeaders: any,
        publisherName: string,
        extensionName: string,
        version?: string,
        flags?: ExtensionQueryFlags,
        accountToken?: string,
        accountTokenHeader?: String,
    ): Promise<PublishedExtension>;
    getExtensionById(
        extensionId: string,
        version?: string,
        flags?: ExtensionQueryFlags,
    ): Promise<PublishedExtension>;
    getExtensionDailyStats(
        publisherName: string,
        extensionName: string,
        days?: number,
        aggregate?: Daily,
        afterDate?: Date,
    ): Promise<ExtensionDailyStats>;
    getExtensionDailyStatsAnonymous(
        publisherName: string,
        extensionName: string,
        version: string,
    ): Promise<ExtensionDailyStats>;
    getExtensionEvents(
        publisherName: string,
        extensionName: string,
        count?: number,
        afterDate?: Date,
        include?: string,
        includeProperty?: string,
    ): Promise<ExtensionEvents>;
    getExtensionReports(
        publisherName: string,
        extensionName: string,
        days?: number,
        count?: number,
        afterDate?: Date,
    ): Promise<any>;
    getGalleryUserSettings(
        userScope: string,
        key?: string,
    ): Promise<{ [key: string]: any }>;
    getPackage(
        customHeaders: any,
        publisherName: string,
        extensionName: string,
        version: string,
        accountToken?: string,
        acceptDefault?: boolean,
        accountTokenHeader?: String,
    ): Promise<ReadableStream>;
    getPublisher(publisherName: string, flags?: number): Promise<Publisher>;
    getPublisherAsset(
        publisherName: string,
        assetType?: string,
    ): Promise<ReadableStream>;
    getPublisherWithoutToken(publisherName: string): Promise<Publisher>;
    getQuestions(
        publisherName: string,
        extensionName: string,
        count?: number,
        page?: number,
        afterDate?: Date,
    ): Promise<QuestionsResult>;
    getReviews(
        publisherName: string,
        extensionName: string,
        count?: number,
        filterOptions?: ReviewFilterOptions,
        beforeDate?: Date,
        afterDate?: Date,
    ): Promise<ReviewsResult>;
    getReviewsSummary(
        pubName: string,
        extName: string,
        beforeDate?: Date,
        afterDate?: Date,
    ): Promise<ReviewSummary>;
    getRootCategories(
        product: string,
        lcid?: number,
        source?: string,
        productVersion?: string,
        skus?: string,
        subSkus?: string,
    ): Promise<ProductCategoriesResult>;
    getSigningKey(keyType: string): Promise<string>;
    getVerificationLog(
        publisherName: string,
        extensionName: string,
        version: string,
        targetPlatform?: string,
    ): Promise<ReadableStream>;
    incrementExtensionDailyStat(
        publisherName: string,
        extensionName: string,
        version: string,
        statType: string,
        targetPlatform?: string,
    ): Promise<void>;
    performEditExtensionDraftOperation(
        draftPatch: ExtensionDraftPatch,
        publisherName: string,
        extensionName: string,
        draftId: string,
    ): Promise<ExtensionDraft>;
    performNewExtensionDraftOperation(
        draftPatch: ExtensionDraftPatch,
        publisherName: string,
        draftId: string,
    ): Promise<ExtensionDraft>;
    publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>;
    publishExtensionWithPublisherSignature(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        extensionName: string,
        extensionType?: string,
        reCaptchaToken?: string,
        bypassScopeCheck?: boolean,
    ): Promise<PublishedExtension>;
    queryAssociatedAzurePublisher(
        publisherName: string,
    ): Promise<AzurePublisher>;
    queryExtensions(
        customHeaders: any,
        extensionQuery: ExtensionQuery,
        accountToken?: string,
        accountTokenHeader?: String,
    ): Promise<ExtensionQueryResult>;
    queryPublishers(
        publisherQuery: PublisherQuery,
    ): Promise<PublisherQueryResult>;
    reportQuestion(
        concern: Concern,
        pubName: string,
        extName: string,
        questionId: number,
    ): Promise<Concern>;
    requestAcquisition(
        acquisitionRequest: ExtensionAcquisitionRequest,
    ): Promise<ExtensionAcquisitionRequest>;
    sendNotifications(notificationData: NotificationsData): Promise<void>;
    setGalleryUserSettings(
        entries: { [key: string]: any },
        userScope: string,
    ): Promise<void>;
    shareExtension(
        publisherName: string,
        extensionName: string,
        accountName: string,
    ): Promise<void>;
    shareExtensionById(extensionId: string, accountName: string): Promise<void>;
    shareExtensionWithHost(
        publisherName: string,
        extensionName: string,
        hostType: string,
        hostName: string,
    ): Promise<void>;
    unshareExtension(
        publisherName: string,
        extensionName: string,
        accountName: string,
    ): Promise<void>;
    unshareExtensionById(
        extensionId: string,
        accountName: string,
    ): Promise<void>;
    unshareExtensionWithHost(
        publisherName: string,
        extensionName: string,
        hostType: string,
        hostName: string,
    ): Promise<void>;
    updateExtension(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        extensionName: string,
        extensionType?: string,
        reCaptchaToken?: string,
        bypassScopeCheck?: boolean,
    ): Promise<PublishedExtension>;
    updateExtensionById(
        extensionId: string,
        reCaptchaToken?: string,
    ): Promise<PublishedExtension>;
    updateExtensionByIdJson(
        extensionPackage: ExtensionPackage,
        extensionId: string,
    ): Promise<PublishedExtension>;
    updateExtensionJson(
        extensionPackage: ExtensionPackage,
        publisherName: string,
        extensionName: string,
    ): Promise<PublishedExtension>;
    updateExtensionProperties(
        publisherName: string,
        extensionName: string,
        flags: PublishedExtensionFlags,
    ): Promise<PublishedExtension>;
    updateExtensionStatistics(
        extensionStatisticsUpdate: ExtensionStatisticUpdate,
        publisherName: string,
        extensionName: string,
    ): Promise<void>;
    updatePayloadInDraftForEditExtension(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        extensionName: string,
        draftId: string,
        fileName?: String,
    ): Promise<ExtensionDraft>;
    updatePayloadInDraftForNewExtension(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        draftId: string,
        fileName?: String,
    ): Promise<ExtensionDraft>;
    updatePublisher(
        publisher: Publisher,
        publisherName: string,
    ): Promise<Publisher>;
    updatePublisherAsset(
        customHeaders: any,
        contentStream: ReadableStream,
        publisherName: string,
        assetType?: string,
        fileName?: String,
    ): Promise<{ [key: string]: string }>;
    updatePublisherMembers(
        roleAssignments: PublisherUserRoleAssignmentRef[],
        publisherName: string,
        limitToCallerIdentityDomain?: boolean,
    ): Promise<PublisherRoleAssignment[]>;
    updateQuestion(
        question: Question,
        publisherName: string,
        extensionName: string,
        questionId: number,
    ): Promise<Question>;
    updateResponse(
        response: Response,
        publisherName: string,
        extensionName: string,
        questionId: number,
        responseId: number,
    ): Promise<Response>;
    updateReview(
        reviewPatch: ReviewPatch,
        pubName: string,
        extName: string,
        reviewId: number,
    ): Promise<ReviewPatch>;
    updateVSCodeWebExtensionStatistics(
        itemName: string,
        version: string,
        statType: VSCodeWebExtensionStatisicsType,
    ): Promise<void>;
    verifyDomainToken(publisherName: string): Promise<void>;
}

Hierarchy (View Summary)

Implemented by

Properties

Methods

addAssetForEditExtensionDraft addAssetForNewExtensionDraft associateAzurePublisher createAcceptHeader createCategory createDraftForEditExtension createDraftForNewExtension createExtension createExtensionJson createExtensionWithPublisher createExtensionWithPublisherJson createPublisher createQuestion createRequestOptions createResponse createReview createSupportRequest deleteExtension deleteExtensionById deletePublisher deletePublisherAsset deleteQuestion deleteResponse deleteReview extensionValidator fetchDomainToken formatResponse generateKey getAcquisitionOptions getAsset getAssetAuthenticated getAssetByName getAssetFromEditExtensionDraft getAssetFromNewExtensionDraft getAssetWithToken getCategories getCategoryDetails getCategoryTree getCertificate getContentVerificationLog getExtension getExtensionById getExtensionDailyStats getExtensionDailyStatsAnonymous getExtensionEvents getExtensionReports getGalleryUserSettings getPackage getPublisher getPublisherAsset getPublisherWithoutToken getQuestions getReviews getReviewsSummary getRootCategories getSigningKey getVerificationLog incrementExtensionDailyStat performEditExtensionDraftOperation performNewExtensionDraftOperation publishExtensionEvents publishExtensionWithPublisherSignature queryAssociatedAzurePublisher queryExtensions queryPublishers reportQuestion requestAcquisition sendNotifications setGalleryUserSettings shareExtension shareExtensionById shareExtensionWithHost unshareExtension unshareExtensionById unshareExtensionWithHost updateExtension updateExtensionById updateExtensionByIdJson updateExtensionJson updateExtensionProperties updateExtensionStatistics updatePayloadInDraftForEditExtension updatePayloadInDraftForNewExtension updatePublisher updatePublisherAsset updatePublisherMembers updateQuestion updateResponse updateReview updateVSCodeWebExtensionStatistics verifyDomainToken

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • extensionName: string
    • draftId: string
    • assetType: string

    Returns Promise<ExtensionDraftAsset>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • product: String
    • OptionalfileName: String

    Returns Promise<ExtensionDraft>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • OptionalextensionType: string
    • OptionalreCaptchaToken: string

    Returns Promise<PublishedExtension>

  • Parameters

    • publisherName: string
    • extensionName: string
    • Optionalversion: string

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • questionId: number

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • questionId: number
    • responseId: number

    Returns Promise<void>

  • Parameters

    • customHeaders: any
    • extensionId: string
    • version: string
    • assetType: string
    • OptionalaccountToken: string
    • OptionalacceptDefault: boolean
    • OptionalaccountTokenHeader: String

    Returns Promise<ReadableStream>

  • Parameters

    • customHeaders: any
    • publisherName: string
    • extensionName: string
    • version: string
    • assetType: string
    • OptionalaccountToken: string
    • OptionalaccountTokenHeader: String

    Returns Promise<ReadableStream>

  • Parameters

    • customHeaders: any
    • publisherName: string
    • extensionName: string
    • version: string
    • assetType: string
    • OptionalaccountToken: string
    • OptionalacceptDefault: boolean
    • OptionalaccountTokenHeader: String

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • draftId: string
    • assetType: string
    • extensionName: string

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • draftId: string
    • assetType: string

    Returns Promise<ReadableStream>

  • Parameters

    • customHeaders: any
    • publisherName: string
    • extensionName: string
    • version: string
    • assetType: string
    • OptionalassetToken: string
    • OptionalaccountToken: string
    • OptionalacceptDefault: boolean
    • OptionalaccountTokenHeader: String

    Returns Promise<ReadableStream>

  • Parameters

    • product: string
    • categoryId: string
    • Optionallcid: number
    • Optionalsource: string
    • OptionalproductVersion: string
    • Optionalskus: string
    • OptionalsubSkus: string
    • OptionalproductArchitecture: string

    Returns Promise<ProductCategory>

  • Parameters

    • publisherName: string
    • extensionName: string
    • Optionalversion: string

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • extensionName: string

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • extensionName: string
    • Optionalcount: number
    • OptionalafterDate: Date
    • Optionalinclude: string
    • OptionalincludeProperty: string

    Returns Promise<ExtensionEvents>

  • Parameters

    • publisherName: string
    • extensionName: string
    • Optionaldays: number
    • Optionalcount: number
    • OptionalafterDate: Date

    Returns Promise<any>

  • Parameters

    • userScope: string
    • Optionalkey: string

    Returns Promise<{ [key: string]: any }>

  • Parameters

    • customHeaders: any
    • publisherName: string
    • extensionName: string
    • version: string
    • OptionalaccountToken: string
    • OptionalacceptDefault: boolean
    • OptionalaccountTokenHeader: String

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • OptionalassetType: string

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • extensionName: string
    • version: string
    • OptionaltargetPlatform: string

    Returns Promise<ReadableStream>

  • Parameters

    • publisherName: string
    • extensionName: string
    • version: string
    • statType: string
    • OptionaltargetPlatform: string

    Returns Promise<void>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • extensionName: string
    • OptionalextensionType: string
    • OptionalreCaptchaToken: string
    • OptionalbypassScopeCheck: boolean

    Returns Promise<PublishedExtension>

  • Parameters

    • entries: { [key: string]: any }
    • userScope: string

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • accountName: string

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • hostType: string
    • hostName: string

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • accountName: string

    Returns Promise<void>

  • Parameters

    • publisherName: string
    • extensionName: string
    • hostType: string
    • hostName: string

    Returns Promise<void>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • extensionName: string
    • OptionalextensionType: string
    • OptionalreCaptchaToken: string
    • OptionalbypassScopeCheck: boolean

    Returns Promise<PublishedExtension>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • extensionName: string
    • draftId: string
    • OptionalfileName: String

    Returns Promise<ExtensionDraft>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • draftId: string
    • OptionalfileName: String

    Returns Promise<ExtensionDraft>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • publisherName: string
    • OptionalassetType: string
    • OptionalfileName: String

    Returns Promise<{ [key: string]: string }>