chore(docs): Generated JS Client Reference (#5334)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
@@ -1,23 +1,80 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
# Module: internal
## Classes
- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md)
- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md)
- [Group](../classes/internal-6.Group.md)
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md)
- [AdminGetCustomerGroupsGroupParams](../classes/internal-6.AdminGetCustomerGroupsGroupParams.md)
- [AdminGetCustomerGroupsParams](../classes/internal-6.AdminGetCustomerGroupsParams.md)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md)
- [AdminPostCustomerGroupsGroupReq](../classes/internal-6.AdminPostCustomerGroupsGroupReq.md)
- [AdminPostCustomerGroupsReq](../classes/internal-6.AdminPostCustomerGroupsReq.md)
- [CustomerGroupsBatchCustomer](../classes/internal-6.CustomerGroupsBatchCustomer.md)
- [FilterableCustomerGroupProps](../classes/internal-6.FilterableCustomerGroupProps.md)
- [FindParams](../classes/internal-6.FindParams.md)
- [StringComparisonOperator](../classes/internal-6.StringComparisonOperator.md)
## Type Aliases
### AdminCustomersRes
### AdminCustomerGroupsListRes
Ƭ **AdminCustomersRes**: `Object`
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal-3.CustomerGroup.md)[] }
**`Schema`**
AdminCustomerGroupsListRes
type: object
required:
- customer_groups
- count
- offset
- limit
properties:
customer_groups:
type: array
description: An array of customer group details.
items:
$ref: "#/components/schemas/CustomerGroup"
count:
type: integer
description: The total number of items available
offset:
type: integer
description: The number of customer groups skipped when retrieving the customer groups.
limit:
type: integer
description: The number of items per page
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:63
___
### AdminCustomerGroupsRes
Ƭ **AdminCustomerGroupsRes**: `Object`
**`Schema`**
AdminCustomerGroupsRes
type: object
required:
- customer_group
properties:
customer_group:
description: Customer group details.
$ref: "#/components/schemas/CustomerGroup"
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
| `customer_group` | [`CustomerGroup`](../classes/internal-3.CustomerGroup.md) |
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:5
packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:15