docs: add comments & update action

pliancy · Nov 7, 2023 · d47b03b · d47b03b
1 parent 902dc09
commit d47b03b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,6 +9,8 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions: 
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -18,7 +20,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
       - name: Install dependencies
         run: yarn
       - name: Build

diff --git a/src/lib/microsoft-partnercenter.spec.ts b/src/lib/microsoft-partnercenter.spec.ts
@@ -144,7 +144,7 @@ describe('Microsoft Partner Center', () => {
         })
     })
 
-    it(' should create an application consent', async () => {
+    it('should create an application consent', async () => {
         const consent: ApplicationConsent = {
             applicationId: '1',
             applicationGrants: [

diff --git a/src/lib/microsoft-partnercenter.ts b/src/lib/microsoft-partnercenter.ts
@@ -154,6 +154,13 @@ export class MicrosoftPartnerCenter {
         return data.items
     }
 
+    /**
+     *  Creates an application consent
+     * https://learn.microsoft.com/en-us/partner-center/developer/control-panel-vendor-apis#acquire-consent
+     * @param customerId 
+     * @param applicationConsent 
+     * @returns 
+     */
     async createApplicationConsent(
         customerId: string,
         applicationConsent: ApplicationConsent,
@@ -163,6 +170,12 @@ export class MicrosoftPartnerCenter {
         return data
     }
 
+    /**
+     *  Removes an application consent
+     * https://learn.microsoft.com/en-us/partner-center/developer/control-panel-vendor-apis#remove-consent
+     * @param customerId 
+     * @param applicationConsentId 
+     */
     async removeApplicationConsent(customerId: string, applicationConsentId: string) {
         const url = `/customers/${customerId}/applicationconsents/${applicationConsentId}`
         await this.httpAgent.delete(url)