asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat(dashboard,js-sdk,admin-shared): add customer addresses + layout change (#11871)

Browse Source 
what:

- changes customer layout from 1 layout to 2
- adds ability to create and delete customer addresses
- adds 2 customer widget locations
- adds is_giftcard=false by default to products list

<img width="1663" alt="Screenshot 2025-03-08 at 21 34 02" src="https://github.com/user-attachments/assets/e66f05da-718c-4c25-81ce-67ba0a814ca3" />
This commit is contained in:
Riqwan Thamir
2025-03-17 16:16:27 +00:00
committed by GitHub
parent cc4c5c86e2
commit 5ab15a2988
24 changed files with 912 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core/js-sdk/src/admin/customer.ts
+193 -41
View File
@@ -1,7 +1,4 @@
import {
HttpTypes,
SelectParams,
} from "@medusajs/types"
import { HttpTypes, SelectParams } from "@medusajs/types"
import { Client } from "../client"
import { ClientHeaders } from "../types"
@@ -20,12 +17,12 @@ export class Customer {
/**
* This method creates a customer. It sends a request to the
* [Create Customer](https://docs.medusajs.com/api/admin#customers_postcustomers) API route.
*
*
* @param body - The customer's details.
* @param query - Configure the fields to retrieve in the customer.
* @param headers - Headers to pass in the request.
* @returns The customer's details.
*
*
* @example
* sdk.admin.customer.create({
* email: "customer@gmail.com"
@@ -39,26 +36,27 @@ export class Customer {
query?: SelectParams,
headers?: ClientHeaders
) {
return this.client.fetch<
HttpTypes.AdminCustomerResponse
>(`/admin/customers`, {
method: "POST",
headers,
body,
query,
})
return this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers`,
{
method: "POST",
headers,
body,
query,
}
)
}
/**
* This method updates a customer's details. It sends a request to the
* [Update Customer](https://docs.medusajs.com/api/admin#customers_postcustomersid) API route.
*
*
* @param id - The customer's ID.
* @param body - The details to update of the customer.
* @param query - Configure the fields to retrieve in the customer.
* @param headers - Headers to pass in the request.
* @returns The customer's details.
*
*
* @example
* sdk.admin.customer.update("cus_123", {
* first_name: "John"
@@ -88,25 +86,25 @@ export class Customer {
* This method retrieves a paginated list of customers. It sends a request to the
* [List Customers](https://docs.medusajs.com/api/admin#customers_getcustomers)
* API route.
*
*
* @param queryParams - Filters and pagination configurations.
* @param headers - Headers to pass in the request.
* @returns The paginated list of customers.
*
*
* @example
* To retrieve the list of customers:
*
*
* ```ts
* sdk.admin.customer.list()
* .then(({ customers, count, limit, offset }) => {
* console.log(customers)
* })
* ```
*
*
* To configure the pagination, pass the `limit` and `offset` query parameters.
*
*
* For example, to retrieve only 10 items and skip 10 items:
*
*
* ```ts
* sdk.admin.customer.list({
* limit: 10,
@@ -116,10 +114,10 @@ export class Customer {
* console.log(customers)
* })
* ```
*
*
* Using the `fields` query parameter, you can specify the fields and relations to retrieve
* in each customer:
*
*
* ```ts
* sdk.admin.customer.list({
* fields: "id,*groups"
@@ -128,43 +126,44 @@ export class Customer {
* console.log(customers)
* })
* ```
*
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
async list(
queryParams?: HttpTypes.AdminCustomerFilters,
headers?: ClientHeaders
) {
return this.client.fetch<
HttpTypes.AdminCustomerListResponse
>(`/admin/customers`, {
headers,
query: queryParams,
})
return this.client.fetch<HttpTypes.AdminCustomerListResponse>(
`/admin/customers`,
{
headers,
query: queryParams,
}
)
}
/**
* This method retrieves a customer by its ID. It sends a request to the
* This method retrieves a customer by its ID. It sends a request to the
* [Get Customer](https://docs.medusajs.com/api/admin#customers_getcustomersid)
* API route.
*
*
* @param id - The customer's ID.
* @param query - Configure the fields to retrieve in the customer.
* @param headers - Headers to pass in the request.
* @returns The customer's details.
*
*
* @example
* To retrieve a customer by its ID:
*
*
* ```ts
* sdk.admin.customer.retrieve("cus_123")
* .then(({ customer }) => {
* console.log(customer)
* })
* ```
*
*
* To specify the fields and relations to retrieve:
*
*
* ```ts
* sdk.admin.customer.retrieve("cus_123", {
* fields: "id,*groups"
@@ -173,7 +172,7 @@ export class Customer {
* console.log(customer)
* })
* ```
*
*
* Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
*/
async retrieve(id: string, query?: SelectParams, headers?: ClientHeaders) {
@@ -187,14 +186,14 @@ export class Customer {
}
/**
* This method deletes a customer by its ID. It sends a request to the
* This method deletes a customer by its ID. It sends a request to the
* [Delete Customer](https://docs.medusajs.com/api/admin#customers_deletecustomersid)
* API route.
*
*
* @param id - The customer's ID.
* @param headers - Headers to pass in the request.
* @returns The deletion's details.
*
*
* @example
* sdk.admin.customer.delete("cus_123")
* .then(({ deleted }) => {
@@ -244,4 +243,157 @@ export class Customer {
}
)
}
/**
* This method creates a customer address. It sends a request to the
* [Create Customer Address](https://docs.medusajs.com/api/admin#customers_postcustomersidaddresses)
* API route.
*
* @param id - The customer's ID.
* @param body - The customer address's details.
* @param headers - Headers to pass in the request.
* @returns The customer address's details.
*
* @example
* sdk.admin.customer.createAddress("cus_123", {
* address_1: "123 Main St",
* city: "Anytown",
* country_code: "US",
* postal_code: "12345"
* })
* .then(({ customer }) => {
* console.log(customer)
* })
*/
async createAddress(
id: string,
body: HttpTypes.AdminCreateCustomerAddress,
headers?: ClientHeaders
) {
return await this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers/${id}/addresses`,
{
method: "POST",
headers,
body,
}
)
}
/**
* This method updates a customer address. It sends a request to the
* [Update Customer Address](https://docs.medusajs.com/api/admin#customers_postcustomersidaddressesaddressid)
* API route.
*
* @param id - The customer's ID.
* @param addressId - The customer address's ID.
* @param body - The customer address's details.
* @param headers - Headers to pass in the request.
* @returns The customer address's details.
*
* @example
* sdk.admin.customer.updateAddress("cus_123", "cus_addr_123", {
* address_1: "123 Main St",
* city: "Anytown",
* country_code: "US",
* postal_code: "12345"
* })
* .then(({ customer }) => {
* console.log(customer)
* })
*/
async updateAddress(
id: string,
addressId: string,
body: HttpTypes.AdminUpdateCustomerAddress,
headers?: ClientHeaders
) {
return await this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers/${id}/addresses/${addressId}`,
{
method: "POST",
headers,
body,
}
)
}
/**
* This method deletes a customer address. It sends a request to the
* [Delete Customer Address](https://docs.medusajs.com/api/admin#customers_deletecustomersidaddressesaddressid)
* API route.
*
* @param id - The customer's ID.
* @param addressId - The customer address's ID.
* @param headers - Headers to pass in the request.
* @returns The customer address's details.
*
* @example
* sdk.admin.customer.deleteAddress("cus_123", "cus_addr_123")
* .then(({ customer }) => {
* console.log(customer)
* })
*/
async deleteAddress(id: string, addressId: string, headers?: ClientHeaders) {
return await this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers/${id}/addresses/${addressId}`,
{
method: "DELETE",
headers,
}
)
}
/**
* This method retrieves a customer address by its ID. It sends a request to the
* [Get Customer Address](https://docs.medusajs.com/api/admin#customers_getcustomersidaddressesaddressid)
* API route.
*
* @param id - The customer's ID.
* @param addressId - The customer address's ID.
* @param headers - Headers to pass in the request.
* @returns The customer address's details.
*
* @example
* sdk.admin.customer.retrieveAddress("cus_123", "cus_addr_123")
* .then(({ customer }) => {
* console.log(customer)
* })
*/
async retrieveAddress(
id: string,
addressId: string,
headers?: ClientHeaders
) {
return await this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers/${id}/addresses/${addressId}`,
{
headers,
}
)
}
/**
* This method retrieves a list of customer addresses. It sends a request to the
* [List Customer Addresses](https://docs.medusajs.com/api/admin#customers_getcustomersidaddresses)
* API route.
*
* @param id - The customer's ID.
* @param headers - Headers to pass in the request.
* @returns The list of customer addresses.
*
* @example
* sdk.admin.customer.listAddresses("cus_123")
* .then(({ addresses }) => {
* console.log(addresses)
* })
*/
async listAddresses(id: string, headers?: ClientHeaders) {
return await this.client.fetch<HttpTypes.AdminCustomerResponse>(
`/admin/customers/${id}/addresses`,
{
headers,
}
)
}
}