Class GalleryApi

constructor

• new GalleryApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): GalleryApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns GalleryApi

Static ReadonlyRESOURCE_AREA_ID

addAssetForEditExtensionDraft

• addAssetForEditExtensionDraft(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      extensionName: string,
      draftId: string,
      assetType: string,
  ): Promise<ExtensionDraftAsset>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • extensionName: string
  • draftId: string
  • assetType: string

  Returns Promise<ExtensionDraftAsset>

addAssetForNewExtensionDraft

• addAssetForNewExtensionDraft(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      draftId: string,
      assetType: string,
  ): Promise<ExtensionDraftAsset>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • draftId: string
  • assetType: string

  Returns Promise<ExtensionDraftAsset>

associateAzurePublisher

• associateAzurePublisher(
      publisherName: string,
      azurePublisherId: string,
  ): Promise<AzurePublisher>

  Parameters

  • publisherName: string
  • azurePublisherId: string

  Returns Promise<AzurePublisher>

createCategory

• createCategory(category: ExtensionCategory): Promise<ExtensionCategory>

  Parameters

  • category: ExtensionCategory

  Returns Promise<ExtensionCategory>

createDraftForEditExtension

• createDraftForEditExtension(
      publisherName: string,
      extensionName: string,
  ): Promise<ExtensionDraft>

  Parameters

  • publisherName: string
  • extensionName: string

  Returns Promise<ExtensionDraft>

createDraftForNewExtension

• createDraftForNewExtension(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      product: String,
      fileName?: String,
  ): Promise<ExtensionDraft>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • product: String

    Header to pass the product type of the payload file
  • OptionalfileName: String

    Header to pass the filename of the uploaded data

  Returns Promise<ExtensionDraft>

createExtension

• createExtension(
      customHeaders: any,
      contentStream: ReadableStream,
      extensionType?: string,
      reCaptchaToken?: string,
  ): Promise<PublishedExtension>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • OptionalextensionType: string
  • OptionalreCaptchaToken: string

  Returns Promise<PublishedExtension>

createExtensionWithPublisher

• createExtensionWithPublisher(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      extensionType?: string,
      reCaptchaToken?: string,
  ): Promise<PublishedExtension>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • OptionalextensionType: string
  • OptionalreCaptchaToken: string

  Returns Promise<PublishedExtension>

createPublisher

• createPublisher(publisher: Publisher): Promise<Publisher>

  Parameters

  • publisher: Publisher

  Returns Promise<Publisher>

createQuestion

• createQuestion(
      question: Question,
      publisherName: string,
      extensionName: string,
  ): Promise<Question>

  Creates a new question for an extension.

  Parameters

  • question: Question

    Question to be created for the extension.
  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.

  Returns Promise<Question>

createResponse

• createResponse(
      response: Response,
      publisherName: string,
      extensionName: string,
      questionId: number,
  ): Promise<Response>

  Creates a new response for a given question for an extension.

  Parameters

  • response: Response

    Response to be created for the extension.
  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • questionId: number

    Identifier of the question for which response is to be created for the extension.

  Returns Promise<Response>

createReview

• createReview(review: Review, pubName: string, extName: string): Promise<Review>

  Creates a new review for an extension

  Parameters

  • review: Review

    Review to be created for the extension
  • pubName: string

    Name of the publisher who published the extension
  • extName: string

    Name of the extension

  Returns Promise<Review>

createSupportRequest

• createSupportRequest(
      customerSupportRequest: CustomerSupportRequest,
  ): Promise<void>

  Parameters

  • customerSupportRequest: CustomerSupportRequest

  Returns Promise<void>

deleteExtension

• deleteExtension(
      publisherName: string,
      extensionName: string,
      version?: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

deleteExtensionById

• deleteExtensionById(extensionId: string, version?: string): Promise<void>

  Parameters

  • extensionId: string
  • Optionalversion: string

  Returns Promise<void>

deletePublisher

• deletePublisher(publisherName: string): Promise<void>

  Parameters

  • publisherName: string

  Returns Promise<void>

deletePublisherAsset

• deletePublisherAsset(publisherName: string, assetType?: string): Promise<void>

  Delete publisher asset like logo

  Parameters

  • publisherName: string

    Internal name of the publisher
  • OptionalassetType: string

    Type of asset. Default value is 'logo'.

  Returns Promise<void>

deleteQuestion

• deleteQuestion(
      publisherName: string,
      extensionName: string,
      questionId: number,
  ): Promise<void>

  Deletes an existing question and all its associated responses for an extension. (soft delete)

  Parameters

  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • questionId: number

    Identifier of the question to be deleted for the extension.

  Returns Promise<void>

deleteResponse

• deleteResponse(
      publisherName: string,
      extensionName: string,
      questionId: number,
      responseId: number,
  ): Promise<void>

  Deletes a response for an extension. (soft delete)

  Parameters

  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • questionId: number

    Identifies the question whose response is to be deleted.
  • responseId: number

    Identifies the response to be deleted.

  Returns Promise<void>

deleteReview

• deleteReview(pubName: string, extName: string, reviewId: number): Promise<void>

  Deletes a review

  Parameters

  • pubName: string

    Name of the publisher who published the extension
  • extName: string

    Name of the extension
  • reviewId: number

    Id of the review which needs to be updated

  Returns Promise<void>

extensionValidator

• extensionValidator(
      azureRestApiRequestModel: AzureRestApiRequestModel,
  ): Promise<void>

  Rest end point to validate if an Azure publisher owns an extension for 3rd party commerce scenario. Azure only supports POST operations and the above signature is not typical of the REST operations. http://sharepoint/sites/AzureUX/_layouts/15/WopiFrame2.aspx?sourcedoc={A793D31E-6DC6-4174-8FA3-DE3F82B51642}&file=Data Market Partner integration with Marketplace service.docx&action=default

  Parameters

  • azureRestApiRequestModel: AzureRestApiRequestModel

    All the parameters are sent in the request body

  Returns Promise<void>

fetchDomainToken

• fetchDomainToken(publisherName: string): Promise<string>

  Parameters

  • publisherName: string

  Returns Promise<string>

generateKey

• generateKey(keyType: string, expireCurrentSeconds?: number): Promise<void>

  Parameters

  • keyType: string
  • OptionalexpireCurrentSeconds: number

  Returns Promise<void>

getAcquisitionOptions

• getAcquisitionOptions(
      itemId: string,
      installationTarget: string,
      testCommerce?: boolean,
      isFreeOrTrialInstall?: boolean,
  ): Promise<AcquisitionOptions>

  Parameters

  • itemId: string
  • installationTarget: string
  • OptionaltestCommerce: boolean
  • OptionalisFreeOrTrialInstall: boolean

  Returns Promise<AcquisitionOptions>

getAsset

• getAsset(
      customHeaders: any,
      extensionId: string,
      version: string,
      assetType: string,
      accountToken?: string,
      acceptDefault?: boolean,
      accountTokenHeader?: String,
  ): Promise<ReadableStream>

  Parameters

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

    Header to pass the account token

  Returns Promise<ReadableStream>

getAssetAuthenticated

• getAssetAuthenticated(
      customHeaders: any,
      publisherName: string,
      extensionName: string,
      version: string,
      assetType: string,
      accountToken?: string,
      accountTokenHeader?: String,
  ): Promise<ReadableStream>

  Parameters

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

    Header to pass the account token

  Returns Promise<ReadableStream>

getAssetByName

• getAssetByName(
      customHeaders: any,
      publisherName: string,
      extensionName: string,
      version: string,
      assetType: string,
      accountToken?: string,
      acceptDefault?: boolean,
      accountTokenHeader?: String,
  ): Promise<ReadableStream>

  Parameters

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

    Header to pass the account token

  Returns Promise<ReadableStream>

getAssetFromEditExtensionDraft

• getAssetFromEditExtensionDraft(
      publisherName: string,
      draftId: string,
      assetType: string,
      extensionName: string,
  ): Promise<ReadableStream>

  Parameters

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

  Returns Promise<ReadableStream>

getAssetFromNewExtensionDraft

• getAssetFromNewExtensionDraft(
      publisherName: string,
      draftId: string,
      assetType: string,
  ): Promise<ReadableStream>

  Parameters

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

  Returns Promise<ReadableStream>

getAssetWithToken

• getAssetWithToken(
      customHeaders: any,
      publisherName: string,
      extensionName: string,
      version: string,
      assetType: string,
      assetToken?: string,
      accountToken?: string,
      acceptDefault?: boolean,
      accountTokenHeader?: String,
  ): Promise<ReadableStream>

  Parameters

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

    Header to pass the account token

  Returns Promise<ReadableStream>

getCategories

• getCategories(languages?: string): Promise<string[]>

  Parameters

  • Optionallanguages: string

  Returns Promise<string[]>

getCategoryDetails

• getCategoryDetails(
      categoryName: string,
      languages?: string,
      product?: string,
  ): Promise<CategoriesResult>

  Parameters

  • categoryName: string
  • Optionallanguages: string
  • Optionalproduct: string

  Returns Promise<CategoriesResult>

getCategoryTree

• getCategoryTree(
      product: string,
      categoryId: string,
      lcid?: number,
      source?: string,
      productVersion?: string,
      skus?: string,
      subSkus?: string,
      productArchitecture?: string,
  ): Promise<ProductCategory>

  Parameters

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

  Returns Promise<ProductCategory>

getCertificate

• getCertificate(
      publisherName: string,
      extensionName: string,
      version?: string,
  ): Promise<ReadableStream>

  Parameters

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

  Returns Promise<ReadableStream>

getContentVerificationLog

• getContentVerificationLog(
      publisherName: string,
      extensionName: string,
  ): Promise<ReadableStream>

  Parameters

  • publisherName: string
  • extensionName: string

  Returns Promise<ReadableStream>

getExtension

• getExtension(
      customHeaders: any,
      publisherName: string,
      extensionName: string,
      version?: string,
      flags?: ExtensionQueryFlags,
      accountToken?: string,
      accountTokenHeader?: String,
  ): Promise<PublishedExtension>

  Parameters

  • customHeaders: any
  • publisherName: string
  • extensionName: string
  • Optionalversion: string
  • Optionalflags: ExtensionQueryFlags
  • OptionalaccountToken: string
  • OptionalaccountTokenHeader: String

    Header to pass the account token

  Returns Promise<PublishedExtension>

getExtensionById

• getExtensionById(
      extensionId: string,
      version?: string,
      flags?: ExtensionQueryFlags,
  ): Promise<PublishedExtension>

  Parameters

  • extensionId: string
  • Optionalversion: string
  • Optionalflags: ExtensionQueryFlags

  Returns Promise<PublishedExtension>

getExtensionDailyStats

• getExtensionDailyStats(
      publisherName: string,
      extensionName: string,
      days?: number,
      aggregate?: Daily,
      afterDate?: Date,
  ): Promise<ExtensionDailyStats>

  Parameters

  • publisherName: string
  • extensionName: string
  • Optionaldays: number
  • Optionalaggregate: Daily
  • OptionalafterDate: Date

  Returns Promise<ExtensionDailyStats>

getExtensionDailyStatsAnonymous

• getExtensionDailyStatsAnonymous(
      publisherName: string,
      extensionName: string,
      version: string,
  ): Promise<ExtensionDailyStats>

  This route/location id only supports HTTP POST anonymously, so that the page view daily stat can be incremented from Marketplace client. Trying to call GET on this route should result in an exception. Without this explicit implementation, calling GET on this public route invokes the above GET implementation GetExtensionDailyStats.

  Parameters

  • publisherName: string

    Name of the publisher
  • extensionName: string

    Name of the extension
  • version: string

    Version of the extension

  Returns Promise<ExtensionDailyStats>

getExtensionEvents

• getExtensionEvents(
      publisherName: string,
      extensionName: string,
      count?: number,
      afterDate?: Date,
      include?: string,
      includeProperty?: string,
  ): Promise<ExtensionEvents>

  Get install/uninstall events of an extension. If both count and afterDate parameters are specified, count takes precedence.

  Parameters

  • publisherName: string

    Name of the publisher
  • extensionName: string

    Name of the extension
  • Optionalcount: number

    Count of events to fetch, applies to each event type.
  • OptionalafterDate: Date

    Fetch events that occurred on or after this date
  • Optionalinclude: string

    Filter options. Supported values: install, uninstall, review, acquisition, sales. Default is to fetch all types of events
  • OptionalincludeProperty: string

    Event properties to include. Currently only 'lastContactDetails' is supported for uninstall events

  Returns Promise<ExtensionEvents>

getExtensionReports

• getExtensionReports(
      publisherName: string,
      extensionName: string,
      days?: number,
      count?: number,
      afterDate?: Date,
  ): Promise<any>

  Returns extension reports

  Parameters

  • publisherName: string

    Name of the publisher who published the extension
  • extensionName: string

    Name of the extension
  • Optionaldays: number

    Last n days report. If afterDate and days are specified, days will take priority
  • Optionalcount: number

    Number of events to be returned
  • OptionalafterDate: Date

    Use if you want to fetch events newer than the specified date

  Returns Promise<any>

getGalleryUserSettings

• getGalleryUserSettings(
      userScope: string,
      key?: string,
  ): Promise<{ [key: string]: any }>

  Get all setting entries for the given user/all-users scope

  Parameters

  • userScope: string

    User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
  • Optionalkey: string

    Optional key under which to filter all the entries

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

getPackage

• getPackage(
      customHeaders: any,
      publisherName: string,
      extensionName: string,
      version: string,
      accountToken?: string,
      acceptDefault?: boolean,
      accountTokenHeader?: String,
  ): Promise<ReadableStream>

  This endpoint gets hit when you download a VSTS extension from the Web UI

  Parameters

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

    Header to pass the account token

  Returns Promise<ReadableStream>

getPublisher

• getPublisher(publisherName: string, flags?: number): Promise<Publisher>

  Parameters

  • publisherName: string
  • Optionalflags: number

  Returns Promise<Publisher>

getPublisherAsset

• getPublisherAsset(
      publisherName: string,
      assetType?: string,
  ): Promise<ReadableStream>

  Get publisher asset like logo as a stream

  Parameters

  • publisherName: string

    Internal name of the publisher
  • OptionalassetType: string

    Type of asset. Default value is 'logo'.

  Returns Promise<ReadableStream>

getPublisherWithoutToken

• getPublisherWithoutToken(publisherName: string): Promise<Publisher>

  Parameters

  • publisherName: string

  Returns Promise<Publisher>

getQuestions

• getQuestions(
      publisherName: string,
      extensionName: string,
      count?: number,
      page?: number,
      afterDate?: Date,
  ): Promise<QuestionsResult>

  Returns a list of questions with their responses associated with an extension.

  Parameters

  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • Optionalcount: number

    Number of questions to retrieve (defaults to 10).
  • Optionalpage: number

    Page number from which set of questions are to be retrieved.
  • OptionalafterDate: Date

    If provided, results questions are returned which were posted after this date

  Returns Promise<QuestionsResult>

getReviews

• getReviews(
      publisherName: string,
      extensionName: string,
      count?: number,
      filterOptions?: ReviewFilterOptions,
      beforeDate?: Date,
      afterDate?: Date,
  ): Promise<ReviewsResult>

  Returns a list of reviews associated with an extension

  Parameters

  • publisherName: string

    Name of the publisher who published the extension
  • extensionName: string

    Name of the extension
  • Optionalcount: number

    Number of reviews to retrieve (defaults to 5)
  • OptionalfilterOptions: ReviewFilterOptions

    FilterOptions to filter out empty reviews etcetera, defaults to none
  • OptionalbeforeDate: Date

    Use if you want to fetch reviews older than the specified date, defaults to null
  • OptionalafterDate: Date

    Use if you want to fetch reviews newer than the specified date, defaults to null

  Returns Promise<ReviewsResult>

getReviewsSummary

• getReviewsSummary(
      pubName: string,
      extName: string,
      beforeDate?: Date,
      afterDate?: Date,
  ): Promise<ReviewSummary>

  Returns a summary of the reviews

  Parameters

  • pubName: string

    Name of the publisher who published the extension
  • extName: string

    Name of the extension
  • OptionalbeforeDate: Date

    Use if you want to fetch summary of reviews older than the specified date, defaults to null
  • OptionalafterDate: Date

    Use if you want to fetch summary of reviews newer than the specified date, defaults to null

  Returns Promise<ReviewSummary>

getRootCategories

• getRootCategories(
      product: string,
      lcid?: number,
      source?: string,
      productVersion?: string,
      skus?: string,
      subSkus?: string,
  ): Promise<ProductCategoriesResult>

  Parameters

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

  Returns Promise<ProductCategoriesResult>

getSigningKey

• getSigningKey(keyType: string): Promise<string>

  Parameters

  • keyType: string

  Returns Promise<string>

getVerificationLog

• getVerificationLog(
      publisherName: string,
      extensionName: string,
      version: string,
      targetPlatform?: string,
  ): Promise<ReadableStream>

  Parameters

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

  Returns Promise<ReadableStream>

incrementExtensionDailyStat

• incrementExtensionDailyStat(
      publisherName: string,
      extensionName: string,
      version: string,
      statType: string,
      targetPlatform?: string,
  ): Promise<void>

  Increments a daily statistic associated with the extension

  Parameters

  • publisherName: string

    Name of the publisher
  • extensionName: string

    Name of the extension
  • version: string

    Version of the extension
  • statType: string

    Type of stat to increment
  • OptionaltargetPlatform: string

  Returns Promise<void>

performEditExtensionDraftOperation

• performEditExtensionDraftOperation(
      draftPatch: ExtensionDraftPatch,
      publisherName: string,
      extensionName: string,
      draftId: string,
  ): Promise<ExtensionDraft>

  Parameters

  • draftPatch: ExtensionDraftPatch
  • publisherName: string
  • extensionName: string
  • draftId: string

  Returns Promise<ExtensionDraft>

performNewExtensionDraftOperation

• performNewExtensionDraftOperation(
      draftPatch: ExtensionDraftPatch,
      publisherName: string,
      draftId: string,
  ): Promise<ExtensionDraft>

  Parameters

  • draftPatch: ExtensionDraftPatch
  • publisherName: string
  • draftId: string

  Returns Promise<ExtensionDraft>

publishExtensionEvents

• publishExtensionEvents(extensionEvents: ExtensionEvents[]): Promise<void>

  API endpoint to publish extension install/uninstall events. This is meant to be invoked by EMS only for sending us data related to install/uninstall of an extension.

  Parameters

  • extensionEvents: ExtensionEvents[]

  Returns Promise<void>

publishExtensionWithPublisherSignature

• publishExtensionWithPublisherSignature(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      extensionName: string,
      extensionType?: string,
      reCaptchaToken?: string,
      bypassScopeCheck?: boolean,
  ): Promise<PublishedExtension>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • extensionName: string
  • OptionalextensionType: string
  • OptionalreCaptchaToken: string
  • OptionalbypassScopeCheck: boolean

  Returns Promise<PublishedExtension>

queryAssociatedAzurePublisher

• queryAssociatedAzurePublisher(publisherName: string): Promise<AzurePublisher>

  Parameters

  • publisherName: string

  Returns Promise<AzurePublisher>

queryExtensions

• queryExtensions(
      customHeaders: any,
      extensionQuery: ExtensionQuery,
      accountToken?: string,
      accountTokenHeader?: String,
  ): Promise<ExtensionQueryResult>

  Parameters

  • customHeaders: any
  • extensionQuery: ExtensionQuery
  • OptionalaccountToken: string
  • OptionalaccountTokenHeader: String

    Header to pass the account token

  Returns Promise<ExtensionQueryResult>

queryPublishers

• queryPublishers(publisherQuery: PublisherQuery): Promise<PublisherQueryResult>

  Parameters

  • publisherQuery: PublisherQuery

  Returns Promise<PublisherQueryResult>

reportQuestion

• reportQuestion(
      concern: Concern,
      pubName: string,
      extName: string,
      questionId: number,
  ): Promise<Concern>

  Flags a concern with an existing question for an extension.

  Parameters

  • concern: Concern

    User reported concern with a question for the extension.
  • pubName: string

    Name of the publisher who published the extension.
  • extName: string

    Name of the extension.
  • questionId: number

    Identifier of the question to be updated for the extension.

  Returns Promise<Concern>

requestAcquisition

• requestAcquisition(
      acquisitionRequest: ExtensionAcquisitionRequest,
  ): Promise<ExtensionAcquisitionRequest>

  Parameters

  • acquisitionRequest: ExtensionAcquisitionRequest

  Returns Promise<ExtensionAcquisitionRequest>

sendNotifications

• sendNotifications(notificationData: NotificationsData): Promise<void>

  Send Notification

  Parameters

  • notificationData: NotificationsData

    Denoting the data needed to send notification

  Returns Promise<void>

setGalleryUserSettings

• setGalleryUserSettings(
      entries: { [key: string]: any },
      userScope: string,
  ): Promise<void>

  Set all setting entries for the given user/all-users scope

  Parameters

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

    A key-value pair of all settings that need to be set
  • userScope: string

    User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.

  Returns Promise<void>

shareExtension

• shareExtension(
      publisherName: string,
      extensionName: string,
      accountName: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

shareExtensionById

• shareExtensionById(extensionId: string, accountName: string): Promise<void>

  Parameters

  • extensionId: string
  • accountName: string

  Returns Promise<void>

shareExtensionWithHost

• shareExtensionWithHost(
      publisherName: string,
      extensionName: string,
      hostType: string,
      hostName: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

unshareExtension

• unshareExtension(
      publisherName: string,
      extensionName: string,
      accountName: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

unshareExtensionById

• unshareExtensionById(extensionId: string, accountName: string): Promise<void>

  Parameters

  • extensionId: string
  • accountName: string

  Returns Promise<void>

unshareExtensionWithHost

• unshareExtensionWithHost(
      publisherName: string,
      extensionName: string,
      hostType: string,
      hostName: string,
  ): Promise<void>

  Parameters

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

  Returns Promise<void>

updateExtension

• updateExtension(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      extensionName: string,
      extensionType?: string,
      reCaptchaToken?: string,
      bypassScopeCheck?: boolean,
  ): Promise<PublishedExtension>

  REST endpoint to update an extension.

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string

    Name of the publisher
  • extensionName: string

    Name of the extension
  • OptionalextensionType: string
  • OptionalreCaptchaToken: string
  • OptionalbypassScopeCheck: boolean

    This parameter decides if the scope change check needs to be invoked or not

  Returns Promise<PublishedExtension>

updateExtensionById

• updateExtensionById(
      extensionId: string,
      reCaptchaToken?: string,
  ): Promise<PublishedExtension>

  Parameters

  • extensionId: string
  • OptionalreCaptchaToken: string

  Returns Promise<PublishedExtension>

updateExtensionProperties

• updateExtensionProperties(
      publisherName: string,
      extensionName: string,
      flags: PublishedExtensionFlags,
  ): Promise<PublishedExtension>

  Parameters

  • publisherName: string
  • extensionName: string
  • flags: PublishedExtensionFlags

  Returns Promise<PublishedExtension>

updateExtensionStatistics

• updateExtensionStatistics(
      extensionStatisticsUpdate: ExtensionStatisticUpdate,
      publisherName: string,
      extensionName: string,
  ): Promise<void>

  Parameters

  • extensionStatisticsUpdate: ExtensionStatisticUpdate
  • publisherName: string
  • extensionName: string

  Returns Promise<void>

updatePayloadInDraftForEditExtension

• updatePayloadInDraftForEditExtension(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      extensionName: string,
      draftId: string,
      fileName?: String,
  ): Promise<ExtensionDraft>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • extensionName: string
  • draftId: string
  • OptionalfileName: String

    Header to pass the filename of the uploaded data

  Returns Promise<ExtensionDraft>

updatePayloadInDraftForNewExtension

• updatePayloadInDraftForNewExtension(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      draftId: string,
      fileName?: String,
  ): Promise<ExtensionDraft>

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string
  • draftId: string
  • OptionalfileName: String

    Header to pass the filename of the uploaded data

  Returns Promise<ExtensionDraft>

updatePublisher

• updatePublisher(publisher: Publisher, publisherName: string): Promise<Publisher>

  Parameters

  • publisher: Publisher
  • publisherName: string

  Returns Promise<Publisher>

updatePublisherAsset

• updatePublisherAsset(
      customHeaders: any,
      contentStream: ReadableStream,
      publisherName: string,
      assetType?: string,
      fileName?: String,
  ): Promise<{ [key: string]: string }>

  Update publisher asset like logo. It accepts asset file as an octet stream and file name is passed in header values.

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • publisherName: string

    Internal name of the publisher
  • OptionalassetType: string

    Type of asset. Default value is 'logo'.
  • OptionalfileName: String

    Header to pass the filename of the uploaded data

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

updatePublisherMembers

• updatePublisherMembers(
      roleAssignments: PublisherUserRoleAssignmentRef[],
      publisherName: string,
      limitToCallerIdentityDomain?: boolean,
  ): Promise<PublisherRoleAssignment[]>

  Endpoint to add/modify publisher membership. Currently Supports only addition/modification of 1 user at a time Works only for adding members of same tenant.

  Parameters

  • roleAssignments: PublisherUserRoleAssignmentRef[]

    List of user identifiers(email address) and role to be added. Currently only one entry is supported.
  • publisherName: string

    The name/id of publisher to which users have to be added
  • OptionallimitToCallerIdentityDomain: boolean

    Should cross tenant addtions be allowed or not.

  Returns Promise<PublisherRoleAssignment[]>

updateQuestion

• updateQuestion(
      question: Question,
      publisherName: string,
      extensionName: string,
      questionId: number,
  ): Promise<Question>

  Updates an existing question for an extension.

  Parameters

  • question: Question

    Updated question to be set for the extension.
  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • questionId: number

    Identifier of the question to be updated for the extension.

  Returns Promise<Question>

updateResponse

• updateResponse(
      response: Response,
      publisherName: string,
      extensionName: string,
      questionId: number,
      responseId: number,
  ): Promise<Response>

  Updates an existing response for a given question for an extension.

  Parameters

  • response: Response

    Updated response to be set for the extension.
  • publisherName: string

    Name of the publisher who published the extension.
  • extensionName: string

    Name of the extension.
  • questionId: number

    Identifier of the question for which response is to be updated for the extension.
  • responseId: number

    Identifier of the response which has to be updated.

  Returns Promise<Response>

updateReview

• updateReview(
      reviewPatch: ReviewPatch,
      pubName: string,
      extName: string,
      reviewId: number,
  ): Promise<ReviewPatch>

  Updates or Flags a review

  Parameters

  • reviewPatch: ReviewPatch

    ReviewPatch object which contains the changes to be applied to the review
  • pubName: string

    Name of the publisher who published the extension
  • extName: string

    Name of the extension
  • reviewId: number

    Id of the review which needs to be updated

  Returns Promise<ReviewPatch>

updateVSCodeWebExtensionStatistics

• updateVSCodeWebExtensionStatistics(
      itemName: string,
      version: string,
      statType: VSCodeWebExtensionStatisicsType,
  ): Promise<void>

  Parameters

  • itemName: string
  • version: string
  • statType: VSCodeWebExtensionStatisicsType

  Returns Promise<void>

verifyDomainToken

• verifyDomainToken(publisherName: string): Promise<void>

  Parameters

  • publisherName: string

  Returns Promise<void>