asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
362abdfad7c4b7ffef225a063797e163cd4e2bce
medusa-store/www/docs/content/references/services/classes/CustomerService.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770) 
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

16 KiB
Raw Blame History

Class: CustomerService

Provides layer to manipulate customers.

Hierarchy

  • TransactionBaseService

    ↳ CustomerService

Constructors

constructor

• new CustomerService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/customer.ts:46

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

addressRepository_

• Protected Readonly addressRepository_: Repository<Address>

Defined in

medusa/src/services/customer.ts:37

customerRepository_

• Protected Readonly customerRepository_: Repository<Customer> & { listAndCount: (query: Omit<FindOneOptions<Customer>, "where" | "select" | "relations"> & { order?: FindOptionsOrder<Customer> ; relations?: FindOptionsRelations<Customer> ; select?: FindOptionsSelect<Customer> ; skip?: number ; take?: number ; where: FindOptionsWhere<Customer> | FindOptionsWhere<Customer>[] } & { where: FindOptionsWhere<Customer & { groups?: FindOperator<string[]> }> } & Omit<FindManyOptions<Customer>, "where" | "select" | "relations"> & { order?: FindOptionsOrder<Customer> ; relations?: FindOptionsRelations<Customer> ; select?: FindOptionsSelect<Customer> ; skip?: number ; take?: number ; where: FindOptionsWhere<Customer> | FindOptionsWhere<Customer>[] } & { where: FindOptionsWhere<Customer & { groups?: FindOperator<string[]> }> }, q: undefined | string) => Promise<[Customer[], number]> }

Defined in

medusa/src/services/customer.ts:36

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

medusa/src/services/customer.ts:38

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

▪ Static Events: Object

Type declaration

Name Type
CREATED string
PASSWORD_RESET string
UPDATED string

Defined in

medusa/src/services/customer.ts:40

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addAddress

▸ addAddress(customerId, address): Promise<Customer | Address>

Parameters

Name Type
customerId string
address AddressCreatePayload

Returns

Promise<Customer | Address>

Defined in

medusa/src/services/customer.ts:519

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

count

▸ count(): Promise<number>

Return the total number of documents in database

Returns

Promise<number>

the result of the count operation

Defined in

medusa/src/services/customer.ts:178

create

▸ create(customer): Promise<Customer>

Creates a customer from an email - customers can have accounts associated, e.g. to login and view order history, etc. If a password is provided the customer will automatically get an account, otherwise the customer is just used to hold details of customers.

Parameters

Name Type Description
customer CreateCustomerInput the customer to create

Returns

Promise<Customer>

the result of create

Defined in

medusa/src/services/customer.ts:306

delete

▸ delete(customerId): Promise<void | Customer>

Deletes a customer from a given customer id.

Parameters

Name Type Description
customerId string the id of the customer to delete. Must be castable as an ObjectId

Returns

Promise<void | Customer>

the result of the delete operation.

Defined in

medusa/src/services/customer.ts:565

generateResetPasswordToken

▸ generateResetPasswordToken(customerId): Promise<string>

Generate a JSON Web token, that will be sent to a customer, that wishes to reset password. The token will be signed with the customer's current password hash as a secret a long side a payload with userId and the expiry time for the token, which is always 15 minutes.

Parameters

Name Type Description
customerId string the customer to reset the password for

Returns

Promise<string>

the generated JSON web token

Defined in

medusa/src/services/customer.ts:68

hashPassword_

▸ hashPassword_(password): Promise<string>

Hashes a password

Parameters

Name Type Description
password string the value to hash

Returns

Promise<string>

hashed password

Defined in

medusa/src/services/customer.ts:293

list

▸ list(selector?, config?): Promise<Customer[]>

Parameters

Name Type Description
selector Selector<Customer> & { groups?: string[] ; q?: string } the query object for find
config FindConfig<Customer> the config object containing query settings

Returns

Promise<Customer[]>

the result of the find operation

Defined in

medusa/src/services/customer.ts:111

listAndCount

▸ listAndCount(selector, config?): Promise<[Customer[], number]>

Parameters

Name Type Description
selector Selector<Customer> & { groups?: string[] ; q?: string } the query object for find
config FindConfig<Customer> the config object containing query settings

Returns

Promise<[Customer[], number]>

the result of the find operation

Defined in

medusa/src/services/customer.ts:143

listByEmail

▸ listByEmail(email, config?): Promise<Customer[]>

Parameters

Name Type
email string
config FindConfig<Customer>

Returns

Promise<Customer[]>

Defined in

medusa/src/services/customer.ts:249

removeAddress

▸ removeAddress(customerId, addressId): Promise<void>

Parameters

Name Type
customerId string
addressId string

Returns

Promise<void>

Defined in

medusa/src/services/customer.ts:502

retrieve

▸ retrieve(customerId, config?): Promise<Customer>

Gets a customer by id.

Parameters

Name Type Description
customerId string the id of the customer to get.
config FindConfig<Customer> the config object containing query settings

Returns

Promise<Customer>

the customer document.

Defined in

medusa/src/services/customer.ts:274

retrieveByEmail

▸ retrieveByEmail(email, config?): Promise<Customer>

Gets a registered customer by email.

Deprecated

Parameters

Name Type Description
email string the email of the customer to get.
config FindConfig<Customer> the config object containing query settings

Returns

Promise<Customer>

the customer document.

Defined in

medusa/src/services/customer.ts:216

retrieveByPhone

▸ retrieveByPhone(phone, config?): Promise<Customer>

Gets a customer by phone.

Parameters

Name Type Description
phone string the phone of the customer to get.
config FindConfig<Customer> the config object containing query settings

Returns

Promise<Customer>

the customer document.

Defined in

medusa/src/services/customer.ts:261

retrieveRegisteredByEmail

▸ retrieveRegisteredByEmail(email, config?): Promise<Customer>

Parameters

Name Type
email string
config FindConfig<Customer>

Returns

Promise<Customer>

Defined in

medusa/src/services/customer.ts:239

retrieveUnregisteredByEmail

▸ retrieveUnregisteredByEmail(email, config?): Promise<Customer>

Parameters

Name Type
email string
config FindConfig<Customer>

Returns

Promise<Customer>

Defined in

medusa/src/services/customer.ts:230

retrieve_

▸ Private retrieve_(selector, config?): Promise<Customer>

Parameters

Name Type
selector Selector<Customer>
config FindConfig<Customer>

Returns

Promise<Customer>

Defined in

medusa/src/services/customer.ts:185

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(customerId, update): Promise<Customer>

Updates a customer.

Parameters

Name Type Description
customerId string the id of the variant. Must be a string that can be casted to an ObjectId
update UpdateCustomerInput an object with the update values.

Returns

Promise<Customer>

resolves to the update result.

Defined in

medusa/src/services/customer.ts:362

updateAddress

▸ updateAddress(customerId, addressId, address): Promise<Address>

Parameters

Name Type
customerId string
addressId string
address StorePostCustomersCustomerAddressesAddressReq

Returns

Promise<Address>

Defined in

medusa/src/services/customer.ts:474

updateBillingAddress_

▸ updateBillingAddress_(customer, addressOrId): Promise<void>

Updates the customers' billing address.

Parameters

Name Type Description
customer Customer the Customer to update
addressOrId undefined | string | DeepPartial<Address> the value to set the billing address to

Returns

Promise<void>

the result of the update operation

Defined in

medusa/src/services/customer.ts:422

withTransaction

▸ withTransaction(transactionManager?): CustomerService

Parameters

Name Type
transactionManager? EntityManager

Returns

CustomerService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Reference in New Issue View Git Blame Copy Permalink