Files
medusa-store/docs/content/references/js-client/classes/Admin.md
2022-12-13 12:40:33 +02:00

338 lines
8.5 KiB
Markdown

# Class: Admin
## Hierarchy
- `default`
**`Admin`**
## Properties
### auth
**auth**: [`AdminAuthResource`](AdminAuthResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L37)
___
### batchJobs
**batchJobs**: [`AdminBatchJobsResource`](AdminBatchJobsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L38)
___
### collections
**collections**: [`AdminCollectionsResource`](AdminCollectionsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L43)
___
### currencies
**currencies**: [`AdminCurrenciesResource`](AdminCurrenciesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L42)
___
### customerGroups
**customerGroups**: [`AdminCustomerGroupsResource`](AdminCustomerGroupsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L40)
___
### customers
**customers**: [`AdminCustomersResource`](AdminCustomersResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L39)
___
### discounts
**discounts**: [`AdminDiscountsResource`](AdminDiscountsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L41)
___
### draftOrders
**draftOrders**: [`AdminDraftOrdersResource`](AdminDraftOrdersResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L44)
___
### giftCards
**giftCards**: [`AdminGiftCardsResource`](AdminGiftCardsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L45)
___
### invites
**invites**: [`AdminInvitesResource`](AdminInvitesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L46)
___
### notes
**notes**: [`AdminNotesResource`](AdminNotesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L47)
___
### notifications
**notifications**: [`AdminNotificationsResource`](AdminNotificationsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L65)
___
### orderEdits
**orderEdits**: [`AdminOrderEditsResource`](AdminOrderEditsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L55)
___
### orders
**orders**: [`AdminOrdersResource`](AdminOrdersResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L54)
___
### paymentCollections
**paymentCollections**: [`AdminPaymentCollectionsResource`](AdminPaymentCollectionsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L68)
___
### payments
**payments**: [`AdminPaymentsResource`](AdminPaymentsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L69)
___
### priceLists
**priceLists**: [`AdminPriceListResource`](AdminPriceListResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L48)
___
### productTags
**productTags**: [`AdminProductTagsResource`](AdminProductTagsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L50)
___
### productTypes
**productTypes**: [`AdminProductTypesResource`](AdminProductTypesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L51)
___
### products
**products**: [`AdminProductsResource`](AdminProductsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L49)
___
### publishableApiKeys
**publishableApiKeys**: [`AdminPublishableApiKeyResource`](AdminPublishableApiKeyResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L56)
___
### regions
**regions**: [`AdminRegionsResource`](AdminRegionsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L64)
___
### returnReasons
**returnReasons**: [`AdminReturnReasonsResource`](AdminReturnReasonsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L57)
___
### returns
**returns**: [`AdminReturnsResource`](AdminReturnsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L53)
___
### salesChannels
**salesChannels**: [`AdminSalesChannelsResource`](AdminSalesChannelsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L59)
___
### shippingOptions
**shippingOptions**: [`AdminShippingOptionsResource`](AdminShippingOptionsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L63)
___
### shippingProfiles
**shippingProfiles**: [`AdminShippingProfilesResource`](AdminShippingProfilesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L61)
___
### store
**store**: [`AdminStoresResource`](AdminStoresResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L62)
___
### swaps
**swaps**: [`AdminSwapsResource`](AdminSwapsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L60)
___
### taxRates
**taxRates**: [`AdminTaxRatesResource`](AdminTaxRatesResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L66)
___
### uploads
**uploads**: [`AdminUploadsResource`](AdminUploadsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L67)
___
### users
**users**: [`AdminUsersResource`](AdminUsersResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L52)
___
### variants
**variants**: [`AdminVariantsResource`](AdminVariantsResource.md)
#### Defined in
[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L58)