fix: medusa-js admin endpoint types (#968)
This commit is contained in:
1 parent
0ac52b70fa
commit
7cc3640796
5 files changed
+50
-14
No files matched your search
@@ -3,6 +3,7 @@ import {
|
|||||||
AdminCustomersRes,
|
AdminCustomersRes,
|
||||||
AdminGetCustomersParams,
|
AdminGetCustomersParams,
|
||||||
AdminPostCustomersReq,
|
AdminPostCustomersReq,
|
||||||
|
AdminPostCustomersCustomerReq,
|
||||||
} from "@medusajs/medusa"
|
} from "@medusajs/medusa"
|
||||||
import { ResponsePromise } from "../.."
|
import { ResponsePromise } from "../.."
|
||||||
import BaseResource from "../base"
|
import BaseResource from "../base"
|
||||||
@@ -24,7 +25,7 @@ class AdminCustomersResource extends BaseResource {
|
|||||||
*/
|
*/
|
||||||
update(
|
update(
|
||||||
id: string,
|
id: string,
|
||||||
payload: AdminPostCustomersReq
|
payload: AdminPostCustomersCustomerReq
|
||||||
): ResponsePromise<AdminCustomersRes> {
|
): ResponsePromise<AdminCustomersRes> {
|
||||||
const path = `/admin/customers/${id}`
|
const path = `/admin/customers/${id}`
|
||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ class AdminDraftOrdersResource extends BaseResource {
|
|||||||
id: string,
|
id: string,
|
||||||
payload: AdminPostDraftOrdersDraftOrderLineItemsReq
|
payload: AdminPostDraftOrdersDraftOrderLineItemsReq
|
||||||
): ResponsePromise<AdminDraftOrdersRes> {
|
): ResponsePromise<AdminDraftOrdersRes> {
|
||||||
const path = `/admin/draft-orders/${id}`
|
const path = `/admin/draft-orders/${id}/line-items`
|
||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,9 +2,8 @@ import {
|
|||||||
AdminInviteDeleteRes,
|
AdminInviteDeleteRes,
|
||||||
AdminListInvitesRes,
|
AdminListInvitesRes,
|
||||||
AdminPostInvitesInviteAcceptReq,
|
AdminPostInvitesInviteAcceptReq,
|
||||||
AdminPostInvitesReq,
|
|
||||||
} from "@medusajs/medusa"
|
} from "@medusajs/medusa"
|
||||||
import { ResponsePromise } from "../.."
|
import { AdminPostInvitesPayload, ResponsePromise } from "../.."
|
||||||
import BaseResource from "../base"
|
import BaseResource from "../base"
|
||||||
|
|
||||||
class AdminInvitesResource extends BaseResource {
|
class AdminInvitesResource extends BaseResource {
|
||||||
@@ -13,7 +12,7 @@ class AdminInvitesResource extends BaseResource {
|
|||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
}
|
}
|
||||||
|
|
||||||
create(payload: AdminPostInvitesReq): ResponsePromise {
|
create(payload: AdminPostInvitesPayload): ResponsePromise {
|
||||||
const path = `/admin/invites`
|
const path = `/admin/invites`
|
||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,13 +1,15 @@
|
|||||||
import {
|
import {
|
||||||
AdminResetPasswordTokenRequest,
|
|
||||||
AdminResetPasswordRequest,
|
|
||||||
AdminCreateUserRequest,
|
|
||||||
AdminUpdateUserRequest,
|
|
||||||
AdminUsersListRes,
|
|
||||||
AdminUserRes,
|
|
||||||
AdminDeleteUserRes,
|
AdminDeleteUserRes,
|
||||||
|
AdminResetPasswordRequest,
|
||||||
|
AdminResetPasswordTokenRequest,
|
||||||
|
AdminUserRes,
|
||||||
|
AdminUsersListRes,
|
||||||
} from "@medusajs/medusa"
|
} from "@medusajs/medusa"
|
||||||
import { ResponsePromise } from "../.."
|
import {
|
||||||
|
ResponsePromise,
|
||||||
|
AdminCreateUserPayload,
|
||||||
|
AdminUpdateUserPayload,
|
||||||
|
} from "../.."
|
||||||
import BaseResource from "../base"
|
import BaseResource from "../base"
|
||||||
|
|
||||||
class AdminUsersResource extends BaseResource {
|
class AdminUsersResource extends BaseResource {
|
||||||
@@ -50,7 +52,7 @@ class AdminUsersResource extends BaseResource {
|
|||||||
* @param payload user creation request body
|
* @param payload user creation request body
|
||||||
* @returns created user
|
* @returns created user
|
||||||
*/
|
*/
|
||||||
create(payload: AdminCreateUserRequest): ResponsePromise<AdminUserRes> {
|
create(payload: AdminCreateUserPayload): ResponsePromise<AdminUserRes> {
|
||||||
const path = `/admin/users`
|
const path = `/admin/users`
|
||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
}
|
}
|
||||||
@@ -63,7 +65,7 @@ class AdminUsersResource extends BaseResource {
|
|||||||
*/
|
*/
|
||||||
update(
|
update(
|
||||||
id: string,
|
id: string,
|
||||||
payload: AdminUpdateUserRequest
|
payload: AdminUpdateUserPayload
|
||||||
): ResponsePromise<AdminUserRes> {
|
): ResponsePromise<AdminUserRes> {
|
||||||
const path = `/admin/users/${id}`
|
const path = `/admin/users/${id}`
|
||||||
return this.client.request("POST", path, payload)
|
return this.client.request("POST", path, payload)
|
||||||
|
|||||||
@@ -1,3 +1,9 @@
|
|||||||
|
import {
|
||||||
|
AdminCreateUserRequest,
|
||||||
|
AdminPostInvitesReq,
|
||||||
|
AdminUpdateUserRequest,
|
||||||
|
} from "@medusajs/medusa"
|
||||||
|
|
||||||
export interface HTTPResponse {
|
export interface HTTPResponse {
|
||||||
status: number
|
status: number
|
||||||
statusText: string
|
statusText: string
|
||||||
@@ -13,3 +19,31 @@ export type Response<T> = T & {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export type ResponsePromise<T = any> = Promise<Response<T>>
|
export type ResponsePromise<T = any> = Promise<Response<T>>
|
||||||
|
|
||||||
|
type NoUndefined<T> = T extends undefined ? never : T
|
||||||
|
|
||||||
|
type CreateUserRolesEnum = NoUndefined<AdminCreateUserRequest["role"]>
|
||||||
|
|
||||||
|
// convert Enum type to union of string literals
|
||||||
|
export type CreateUserRoles = `${CreateUserRolesEnum}`
|
||||||
|
|
||||||
|
// remove enum type and replace with union type
|
||||||
|
export type AdminCreateUserPayload =
|
||||||
|
| Omit<AdminCreateUserRequest, "role">
|
||||||
|
| {
|
||||||
|
role?: CreateUserRoles
|
||||||
|
}
|
||||||
|
|
||||||
|
type UpdateUserRolesEnum = NoUndefined<AdminUpdateUserRequest["role"]>
|
||||||
|
|
||||||
|
export type UpdateUserRoles = `${UpdateUserRolesEnum}`
|
||||||
|
|
||||||
|
export type AdminUpdateUserPayload = Omit<AdminUpdateUserRequest, "role"> & {
|
||||||
|
role?: UpdateUserRoles
|
||||||
|
}
|
||||||
|
|
||||||
|
export type InviteUserRolesEnum = `${AdminPostInvitesReq["role"]}`
|
||||||
|
|
||||||
|
export type AdminPostInvitesPayload = Omit<AdminPostInvitesReq, "role"> & {
|
||||||
|
role: InviteUserRolesEnum
|
||||||
|
}
|
||||||
Reference in new issue
Block a user