Files
medusa-store/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00

3.1 KiB

Class: AdminCustomersResource

Hierarchy

  • default

    AdminCustomersResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Creates a customer

Parameters

Name Type Description
payload AdminPostCustomersReq information of customer
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:18


list

list(query?, customHeaders?): ResponsePromise<AdminCustomersListRes>

Lists customers

Parameters

Name Type Description
query? AdminGetCustomersParams optional
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCustomersListRes>

Defined in

medusa-js/src/resources/admin/customers.ts:59


retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminCustomersRes>

Retrieves a customer

Parameters

Name Type Description
id string customer id
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:46


update

update(id, payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Updates a customer

Parameters

Name Type Description
id string customer id
payload AdminPostCustomersCustomerReq data to update customer with
customHeaders Record<string, any>

Returns

ResponsePromise<AdminCustomersRes>

Defined in

medusa-js/src/resources/admin/customers.ts:32