docs: update Typedoc and regenerate references (#1994)

* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
medusajs · Aug 4, 2022 · 02d5c1d · 02d5c1d
1 parent 6663a62
commit 02d5c1d
Show file tree

Hide file tree

Showing 630 changed files with 21,028 additions and 16,153 deletions.
diff --git a/.github/workflows/generate-js-reference.yml b/.github/workflows/generate-js-reference.yml
@@ -0,0 +1,53 @@
+name: Generate JS Client Reference
+on: 
+  push:
+    branches:
+      - "master"
+    paths:
+      - packages/medusa-js/src/resources/**
+  pull_request:
+    types:
+      - closed
+    branches:
+      - "master"
+    paths:
+      - packages/medusa-js/src/resources/**
+jobs:
+  services:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.9.1
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/checkout@v2.3.5
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.4.1
+        with:
+          node-version: "14"
+          cache: "yarn"
+
+      - name: Install dependencies
+        uses: ./.github/actions/cache-deps
+        with:
+          extension: reference
+
+      - name: Build Packages
+        run: yarn build
+
+      - name: Generate Services Reference
+        run: yarn generate:services
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: 'docs: Generated JS Client Reference (automated)'
+          base: 'master'
+          title: 'docs: Generated JS Client Reference (automated)'
+          labels: 'type: docs'
+          add-paths: docs/content/references/js-client/**
diff --git a/.github/workflows/generate-reference.yml b/.github/workflows/generate-reference.yml
@@ -1,5 +1,10 @@
-name: Generate References
+name: Generate Reference
 on: 
+  push:
+    branches:
+      - "master"
+    paths:
+      - packages/medusa/src/services/**
   pull_request:
     types:
       - closed
@@ -19,7 +24,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2.3.5
         with:
-          token: ${{ secrets.REFERENCE_PAT }}
           fetch-depth: 0
 
       - name: Setup Node.js environment
@@ -39,9 +43,11 @@ jobs:
       - name: Generate Services Reference
         run: yarn generate:services
 
-      - uses: stefanzweifel/git-auto-commit-action@v4
-        with: 
-          commit_message: "docs: automatically Generated Services Reference"
-          file_pattern: docs/content/*
-          skip_dirty_check: false
-          branch: master
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v4
+        with:
+          commit-message: 'docs: Generated Services Reference (automated)'
+          base: 'master'
+          title: 'docs: Generated Services Reference (automated)'
+          labels: 'type: docs'
+          add-paths: docs/content/references/services/**
diff --git a/docs/content/references/js-client/classes/AddressesResource.md b/docs/content/references/js-client/classes/AddressesResource.md
@@ -19,15 +19,15 @@ Adds an address to a customers saved addresses
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address |
-| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |  |
+| `customHeaders` | `Record`<`string`, `any`\> |  |
 
 #### Returns
 
 [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
 
 #### Defined in
 
-[packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L16)
+[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L16)
 
 ___
 
@@ -42,15 +42,15 @@ Deletes an address of a customer
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `address_id` | `string` | id of the address to delete |
-| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |  |
+| `customHeaders` | `Record`<`string`, `any`\> |  |
 
 #### Returns
 
 [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
 
 #### Defined in
 
-[packages/medusa-js/src/resources/addresses.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L29)
+[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L30)
 
 ___
 
@@ -66,12 +66,12 @@ Update an address of a customer
 | :------ | :------ | :------ |
 | `address_id` | `string` | id of customer |
 | `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update |
-| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |  |
+| `customHeaders` | `Record`<`string`, `any`\> |  |
 
 #### Returns
 
 [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
 
 #### Defined in
 
-[packages/medusa-js/src/resources/addresses.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L41)
+[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L45)
diff --git a/docs/content/references/js-client/classes/Admin.md b/docs/content/references/js-client/classes/Admin.md
@@ -14,7 +14,17 @@
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L30)
+[medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L32)
+
+___
+
+### batchJobs
+
+• **batchJobs**: [`AdminBatchJobsResource`](AdminBatchJobsResource.md)
+
+#### Defined in
+
+[medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L33)
 
 ___
 
@@ -24,7 +34,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L34)
+[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L37)
 
 ___
 
@@ -34,7 +44,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L32)
+[medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L35)
 
 ___
 
@@ -44,7 +54,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L31)
+[medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L34)
 
 ___
 
@@ -54,7 +64,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L33)
+[medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L36)
 
 ___
 
@@ -64,7 +74,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L35)
+[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L38)
 
 ___
 
@@ -74,7 +84,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L36)
+[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L39)
 
 ___
 
@@ -84,7 +94,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L37)
+[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L40)
 
 ___
 
@@ -94,7 +104,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L38)
+[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L41)
 
 ___
 
@@ -104,7 +114,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L53)
+[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L57)
 
 ___
 
@@ -114,7 +124,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L45)
+[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L48)
 
 ___
 
@@ -124,7 +134,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L39)
+[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L42)
 
 ___
 
@@ -134,7 +144,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L41)
+[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L44)
 
 ___
 
@@ -144,7 +154,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L42)
+[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L45)
 
 ___
 
@@ -154,7 +164,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L40)
+[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L43)
 
 ___
 
@@ -164,7 +174,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L52)
+[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L56)
 
 ___
 
@@ -174,7 +184,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L46)
+[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L49)
 
 ___
 
@@ -184,7 +194,17 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L44)
+[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L47)
+
+___
+
+### salesChannels
+
+• **salesChannels**: [`AdminSalesChannelsResource`](AdminSalesChannelsResource.md)
+
+#### Defined in
+
+[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L51)
 
 ___
 
@@ -194,7 +214,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L51)
+[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L55)
 
 ___
 
@@ -204,7 +224,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L49)
+[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L53)
 
 ___
 
@@ -214,7 +234,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L50)
+[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L54)
 
 ___
 
@@ -224,7 +244,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L48)
+[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L52)
 
 ___
 
@@ -234,7 +254,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L54)
+[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L58)
 
 ___
 
@@ -244,7 +264,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L55)
+[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L59)
 
 ___
 
@@ -254,7 +274,7 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L43)
+[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L46)
 
 ___
 
@@ -264,4 +284,4 @@ ___
 
 #### Defined in
 
-[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L47)
+[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L50)