asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
2e350b204cd5f8381e9cd7c2a33ec5d9e5d6bd4b
medusa-store/docs/content/references/js-client/modules/internal.md
Shahed Nasser 8ca9354c50 docs: updated js client reference (#2414) 
* docs: updated js client reference

* docs: fixed link
2022-10-11 16:32:41 +03:00

219 lines
8.1 KiB
Markdown
Raw Blame History

---
displayed_sidebar: jsClientSidebar
---
# Namespace: internal
## Enumerations
- [AllocationType](../enums/internal.AllocationType.md)
- [CartType](../enums/internal.CartType.md)
- [ClaimFulfillmentStatus](../enums/internal.ClaimFulfillmentStatus.md)
- [ClaimPaymentStatus](../enums/internal.ClaimPaymentStatus.md)
- [ClaimReason](../enums/internal.ClaimReason.md)
- [ClaimType](../enums/internal.ClaimType.md)
- [DiscountConditionOperator](../enums/internal.DiscountConditionOperator.md)
- [DiscountConditionType](../enums/internal.DiscountConditionType.md)
- [DiscountRuleType](../enums/internal.DiscountRuleType.md)
- [DraftOrderStatus](../enums/internal.DraftOrderStatus.md)
- [FulfillmentStatus](../enums/internal.FulfillmentStatus.md)
- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal.OrderEditStatus.md)
- [OrderStatus](../enums/internal.OrderStatus.md)
- [PaymentStatus](../enums/internal.PaymentStatus.md)
- [PriceListStatus](../enums/internal.PriceListStatus.md)
- [PriceListType](../enums/internal.PriceListType.md)
- [ProductStatus](../enums/internal.ProductStatus.md)
- [RequirementType](../enums/internal.RequirementType.md)
- [ReturnStatus](../enums/internal.ReturnStatus.md)
- [ShippingOptionPriceType](../enums/internal.ShippingOptionPriceType.md)
- [ShippingProfileType](../enums/internal.ShippingProfileType.md)
- [SwapFulfillmentStatus](../enums/internal.SwapFulfillmentStatus.md)
- [SwapPaymentStatus](../enums/internal.SwapPaymentStatus.md)
## Classes
- [Address](../classes/internal.Address.md)
- [AddressCreatePayload](../classes/internal.AddressCreatePayload.md)
- [AddressPayload](../classes/internal.AddressPayload.md)
- [Axios](../classes/internal.Axios.md)
- [BaseEntity](../classes/internal.BaseEntity.md)
- [Cart](../classes/internal.Cart.md)
- [ClaimImage](../classes/internal.ClaimImage.md)
- [ClaimItem](../classes/internal.ClaimItem.md)
- [ClaimOrder](../classes/internal.ClaimOrder.md)
- [ClaimTag](../classes/internal.ClaimTag.md)
- [Client](../classes/internal.Client.md)
- [Country](../classes/internal.Country.md)
- [Currency](../classes/internal.Currency.md)
- [Customer](../classes/internal.Customer.md)
- [CustomerGroup](../classes/internal.CustomerGroup.md)
- [Discount](../classes/internal.Discount.md)
- [DiscountCondition](../classes/internal.DiscountCondition.md)
- [DiscountRule](../classes/internal.DiscountRule.md)
- [DraftOrder](../classes/internal.DraftOrder.md)
- [Fulfillment](../classes/internal.Fulfillment.md)
- [FulfillmentItem](../classes/internal.FulfillmentItem.md)
- [FulfillmentProvider](../classes/internal.FulfillmentProvider.md)
- [GiftCard](../classes/internal.GiftCard.md)
- [GiftCardTransaction](../classes/internal.GiftCardTransaction.md)
- [Image](../classes/internal.Image.md)
- [LineItem](../classes/internal.LineItem.md)
- [LineItemAdjustment](../classes/internal.LineItemAdjustment.md)
- [LineItemTaxLine](../classes/internal.LineItemTaxLine.md)
- [MoneyAmount](../classes/internal.MoneyAmount.md)
- [Order](../classes/internal.Order.md)
- [OrderEdit](../classes/internal.OrderEdit.md)
- [OrderItemChange](../classes/internal.OrderItemChange.md)
- [Payment](../classes/internal.Payment.md)
- [PaymentProvider](../classes/internal.PaymentProvider.md)
- [PaymentSession](../classes/internal.PaymentSession.md)
- [PriceList](../classes/internal.PriceList.md)
- [Product](../classes/internal.Product.md)
- [ProductCollection](../classes/internal.ProductCollection.md)
- [ProductOption](../classes/internal.ProductOption.md)
- [ProductOptionValue](../classes/internal.ProductOptionValue.md)
- [ProductTag](../classes/internal.ProductTag.md)
- [ProductType](../classes/internal.ProductType.md)
- [ProductVariant](../classes/internal.ProductVariant.md)
- [Refund](../classes/internal.Refund.md)
- [Region](../classes/internal.Region.md)
- [Return](../classes/internal.Return.md)
- [ReturnItem](../classes/internal.ReturnItem.md)
- [ReturnReason](../classes/internal.ReturnReason.md)
- [SalesChannel](../classes/internal.SalesChannel.md)
- [ShippingMethod](../classes/internal.ShippingMethod.md)
- [ShippingMethodTaxLine](../classes/internal.ShippingMethodTaxLine.md)
- [ShippingOption](../classes/internal.ShippingOption.md)
- [ShippingOptionRequirement](../classes/internal.ShippingOptionRequirement.md)
- [ShippingProfile](../classes/internal.ShippingProfile.md)
- [SoftDeletableEntity](../classes/internal.SoftDeletableEntity.md)
- [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md)
- [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md)
- [Swap](../classes/internal.Swap.md)
- [TaxLine](../classes/internal.TaxLine.md)
- [TaxProvider](../classes/internal.TaxProvider.md)
- [TaxRate](../classes/internal.TaxRate.md)
- [TrackingLink](../classes/internal.TrackingLink.md)
## Interfaces
- [AxiosAdapter](../interfaces/internal.AxiosAdapter.md)
- [AxiosBasicCredentials](../interfaces/internal.AxiosBasicCredentials.md)
- [AxiosDefaults](../interfaces/internal.AxiosDefaults.md)
- [AxiosError](../interfaces/internal.AxiosError.md)
- [AxiosInstance](../interfaces/internal.AxiosInstance.md)
- [AxiosInterceptorManager](../interfaces/internal.AxiosInterceptorManager.md)
- [AxiosPromise](../interfaces/internal.AxiosPromise.md)
- [AxiosProxyConfig](../interfaces/internal.AxiosProxyConfig.md)
- [AxiosRequestConfig](../interfaces/internal.AxiosRequestConfig.md)
- [AxiosRequestTransformer](../interfaces/internal.AxiosRequestTransformer.md)
- [AxiosResponse](../interfaces/internal.AxiosResponse.md)
- [AxiosResponseTransformer](../interfaces/internal.AxiosResponseTransformer.md)
- [Cancel](../interfaces/internal.Cancel.md)
- [CancelToken](../interfaces/internal.CancelToken.md)
- [Config](../interfaces/internal.Config.md)
- [HTTPResponse](../interfaces/internal.HTTPResponse.md)
- [HeadersDefaults](../interfaces/internal.HeadersDefaults.md)
- [RequestOptions](../interfaces/internal.RequestOptions.md)
- [RetryConfig](../interfaces/internal.RetryConfig.md)
- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md)
## Type Aliases
### AxiosRequestHeaders
Ƭ **AxiosRequestHeaders**: `Record`<`string`, `string`\>
#### Defined in
medusa-js/node_modules/axios/index.d.ts:3
___
### AxiosResponseHeaders
Ƭ **AxiosResponseHeaders**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] }
#### Defined in
medusa-js/node_modules/axios/index.d.ts:5
___
### Method
Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``
#### Defined in
medusa-js/node_modules/axios/index.d.ts:36
___
### RequestMethod
Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"``
#### Defined in
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L21)
___
### Response
Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal.HTTPResponse.md) }
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L17)
___
### ResponsePromise
Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal.md#response)<`T`\>\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | `any` |
#### Defined in
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L21)
___
### ResponseType
Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"``
#### Defined in
medusa-js/node_modules/axios/index.d.ts:48
___
### StoreCustomersRes
Ƭ **StoreCustomersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | `Omit`<[`Customer`](../classes/internal.Customer.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:9
Reference in New Issue View Git Blame Copy Permalink