UNPKG

@allofshop/aos-sdk-nodejs

Version:
1,756 lines (1,755 loc) 62.6 kB
import { OrderItemStatus } from '~/sales/order/vo'; import { CustomerServiceItemType, CustomerServiceStatus, CustomerServiceType } from '~/user/customerService/vo'; import { OrderStatus } from '~/user/order/vo'; export declare function genPaymentMethod(): Promise<{ data: { card: { type: string; id: string; provider: string; }; wireTransfers: { id: string; bank: { id: string; name: string; }; account: { owner: string; number: string; }; }[]; }; }>; export declare function genShop(): Promise<{ data: { id: string; setting: { paymentMethod: { pgs: never[]; wireTransfers: { id: string; bank: string; account: { owner: string; number: string; }; }[]; }; }; }; }>; export declare function genArticleList(): Promise<{ data: { currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; items: { id: string; createdAt: Date; board: { name: string; categories: never[]; order: number; }; title: string; content: string; author: { displayName: string; ip: string; }; isSecret: boolean; viewCount: number; comments: { author: { displayName: string; }; content: string; }[]; }[]; }; }>; export declare function genArticleDetail(): Promise<{ data: { id: string; createdAt: Date; board: { name: string; categories: never[]; order: number; }; title: string; content: string; author: { displayName: string; ip: string; }; isSecret: boolean; viewCount: number; comments: { author: { displayName: string; }; content: string; }[]; }; }>; export declare function genCartDetail(): Promise<{ data: { id: string; items: { id: string; quantity: number; product: { id: string; name: string; price: number; option: { type: string; name: string; items: { id: string; name: string; values: { value: number; }[]; renderingStyle: string; required: boolean; }[]; variants: { id: string; name: string; code: string; raws: never[]; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }[]; extras: { id: string; type: string; name: string; required: boolean; }[]; }; }; stats: { totalPrice: number; }; }[]; stats: { productPrice: number; discountPrice: number; deliveryPrice: number; totalPrice: number; }; }; }>; export declare function genCategoryList(): Promise<{ data: { currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; items: any[]; }; }>; export declare function genProductList(): Promise<{ data: { items: { id: string; name: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; price: number; discountedPrice: number; discountPrice: number; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genProductDetail(): Promise<{ data: { id: string; createdAt: string; updatedAt: string; displayable: boolean; displayedAt: string; sellable: boolean; categories: never[]; name: string; code: string; quality: string; tags: never[]; grossPrice: number; taxType: string; taxRatio: number; taxPrice: number; priceBeforeTax: number; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; price: number; orderQuantity: { type: string; minimum: number; }; useAdultAuthentication: boolean; option: { type: string; items: { shopId: string; id: string; name: string; values: { id: string; productOption: string; value: string; }[]; renderingStyle: string; required: boolean; }[]; variants: { id: string; optionValues: string[]; product: string; name: string; code: string; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }[]; extras: never[]; }; images: never[]; brand: null; manufacturer: string; supplier: string; delivery: { range: string; separated: boolean; carriers: never[]; weight: number; hsCodes: never[]; type: string; }; bundleProducts: never[]; relativeProducts: never[]; stats: { orderCount: number; reviewCount: number; reviewAverageScore: number; }; wishlists: string[]; discountedPrice: number; discountPrice: number; discounts: never[]; coupons: never[]; downloadableCoupons: never[]; deliveryPrice: number; }; }>; export declare function genProductOptionItem(): Promise<{ id: string; name: string; values: { value: number; }[]; renderingStyle: string; required: boolean; }>; export declare function genProductOptionItemValue(): Promise<{ value: number; }>; export declare function genProductVariant(): Promise<{ id: string; name: string; code: string; raws: never[]; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }>; export declare function genProductOptionExtra(): Promise<{ id: string; type: string; name: string; required: boolean; }>; export declare function genOrderCheckout(): Promise<{ data: { availableMileage: number; availableCoupons: { id: string; coupon: { applicableProduct: { type: string; items: { id: string; name: string; }[]; }; applicableCategory: { type: string; items: { id: string; name: string; }[]; }; }; availableDate: { minimum: Date; maximum: Date; }; }[]; id: string; createdAt: Date; items: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; status: OrderStatus; type: string; code: string; orderer: { name: string; subPhoneNumber: string; mainPhoneNumber: string; email: string; user: { id: string; name: string; }; }; payments: never[]; deliveries: never[]; coupons: never[]; usingMileage: number; recipient: { name: string; mainPhoneNumber: string; subPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; delivery: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; areaPrice: number; }; paymentPrice: number; mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; memoForDelivery: string; }; }>; export declare function genReviewDetail(): Promise<{ data: { id: string; content: string; score: number; createdAt: Date; images: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; orderItem: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }; }; }>; export declare function genReviewList(): Promise<{ data: { items: { id: string; content: string; score: number; images: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; orderItem: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }; createdAt: Date; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genOrder(): Promise<{ data: { id: string; createdAt: Date; items: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; status: OrderStatus; type: string; code: string; orderer: { name: string; subPhoneNumber: string; mainPhoneNumber: string; email: string; user: { id: string; name: string; }; }; payments: never[]; deliveries: never[]; coupons: never[]; usingMileage: number; availableCoupons: never[]; recipient: { name: string; mainPhoneNumber: string; subPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; delivery: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; areaPrice: number; }; paymentPrice: number; mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; memoForDelivery: string; }; }>; export declare function genOrderItem(): Promise<{ data: Promise<{ id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }>; }>; export declare function _genOrderListItem(): Promise<{ status: string; type: string; code: string; id: string; availableCoupons: never[]; items: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; recipient: { name: string; mainPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; mileagePoint: number; paymentPrice: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }>; export declare function getOrderList(): Promise<{ data: { items: { status: string; type: string; code: string; id: string; availableCoupons: never[]; items: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; recipient: { name: string; mainPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; mileagePoint: number; paymentPrice: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function getRealOrderDetail(): Promise<{ data: { id: string; createdAt: string; updatedAt: string; deliveries: { id: string; createdAt: string; updatedAt: string; order: string; code: string; status: string; items: { id: string; createdAt: string; updatedAt: string; status: string; delivery: string; orderItemId: string; }[]; carrier: { id: string; createdAt: string; updatedAt: string; name: string; description: string; type: string; priceType: string; prices: { id: string; createdAt: string; updatedAt: string; minimum: number; maximum: number; value: number; }[]; extraCharges: never[]; }; recipient: { name: string; subPhoneNumber: string; }; address: { zipCode: string; locality: string; address1: string; address2: string; country: string; }; stats: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; areaPrice: number; }; }[]; payments: { id: string; createdAt: string; updatedAt: string; order: string; items: never[]; status: string; type: string; stats: { refundPrice: number; paymentPrice: number; totalPrice: number; }; deposit: { account: { number: string; }; depositor: string; }; }[]; status: string; type: string; code: string; orderer: { name: string; ip: string; email: string; user: string; }; recipient: { name: string; mainPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; items: { id: string; createdAt: string; updatedAt: string; review: string; code: string; quantity: number; status: string; product: { id: string; name: string; code: string; taxPrice: number; priceBeforeTax: number; price: number; taxRatio: number; delivery: { range: string; separated: boolean; carriers: never[]; weight: number; hsCodes: never[]; type: string; }; categories: never[]; }; deliveryItem: string; discounts: never[]; coupons: never[]; mileages: never[]; stats: { product: { basic: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; }; mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; coupons: never[]; usingMileage: number; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; delivery: { areaPrice: number; price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; }; mileagePoint: number; discountPrice: number; couponPrice: number; orderItemCouponPrice: number; paymentPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }; }>; export declare function getRealOrderList(): Promise<{ data: { currentItemCount: number; itemsPerPage: number; startIndex: number; pageIndex: number; totalItems: number; totalPages: number; items: { id: string; createdAt: string; updatedAt: string; deliveries: { id: string; createdAt: string; updatedAt: string; order: string; code: string; status: string; items: { id: string; createdAt: string; updatedAt: string; status: string; delivery: string; orderItemId: string; }[]; carrier: { id: string; createdAt: string; updatedAt: string; name: string; description: string; type: string; priceType: string; prices: { id: string; createdAt: string; updatedAt: string; minimum: number; maximum: number; value: number; }[]; extraCharges: never[]; }; recipient: { name: string; subPhoneNumber: string; }; address: { zipCode: string; locality: string; address1: string; address2: string; country: string; }; stats: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; areaPrice: number; }; }[]; payments: { id: string; createdAt: string; updatedAt: string; order: string; items: never[]; status: string; type: string; stats: { refundPrice: number; paymentPrice: number; totalPrice: number; }; deposit: { account: { number: string; }; depositor: string; }; }[]; status: string; type: string; code: string; orderer: { name: string; ip: string; email: string; user: string; }; recipient: { name: string; mainPhoneNumber: string; address: { zipCode: string; address1: string; address2: string; }; }; items: { id: string; createdAt: string; updatedAt: string; review: string; code: string; quantity: number; status: string; product: { id: string; name: string; code: string; taxPrice: number; priceBeforeTax: number; price: number; taxRatio: number; delivery: { range: string; separated: boolean; carriers: never[]; weight: number; hsCodes: never[]; type: string; }; categories: never[]; }; deliveryItem: string; discounts: never[]; coupons: never[]; mileages: never[]; stats: { product: { basic: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; }; mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; coupons: never[]; usingMileage: number; stats: { product: { price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; mileagePoint: number; }; delivery: { areaPrice: number; price: number; priceBeforeTax: number; taxPrice: number; priceBeforeDiscount: number; discountPrice: number; couponPrice: number; }; mileagePoint: number; discountPrice: number; couponPrice: number; orderItemCouponPrice: number; paymentPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; }; }>; export declare function genCartItem(): Promise<{ id: string; quantity: number; product: { id: string; name: string; price: number; option: { type: string; name: string; items: { id: string; name: string; values: { value: number; }[]; renderingStyle: string; required: boolean; }[]; variants: { id: string; name: string; code: string; raws: never[]; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }[]; extras: { id: string; type: string; name: string; required: boolean; }[]; }; }; stats: { totalPrice: number; }; }>; export declare function genCartItemUpdate(): Promise<{ data: { stats: { productPrice: number; discountPrice: number; deliveryPrice: number; totalPrice: number; }; id: string; quantity: number; product: { id: string; name: string; price: number; option: { type: string; name: string; items: { id: string; name: string; values: { value: number; }[]; renderingStyle: string; required: boolean; }[]; variants: { id: string; name: string; code: string; raws: never[]; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }[]; extras: { id: string; type: string; name: string; required: boolean; }[]; }; }; }; }>; export declare function genShowcase(slug?: string): Promise<{ data: { id: string; name: string; createdAt: Date; description: string; displaable: boolean; slug: string; products: { id: string; name: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; price: number; discountedPrice: number; discountPrice: number; }[]; }; }>; export declare function genShowcases(slug?: string): Promise<{ data: { items: { id: string; name: string; createdAt: Date; description: string; displaable: boolean; slug: string; products: { id: string; name: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; price: number; discountedPrice: number; discountPrice: number; }[]; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genUser(): Promise<{ data: { id: string; nickname: string; birthdate: Date; email: { address: string; }; gender: string; name: { first: string; last: string; middle: string; }; phone: { nmber: string; }; }; }>; export declare function genLogin(secret: string): Promise<{ data: { access_token: string; expires_in: number; id_token: string; refresh_token: string; scope: string; token_type: string; }; }>; export declare function genJoin(): Promise<{ data: { success: boolean; }; }>; export declare function genLogout(): Promise<{ data: { success: boolean; }; }>; export declare function genChangePassword(): Promise<{ data: { success: boolean; }; }>; export declare function _genBanner(sectionName?: string): Promise<{ id: string; title: string; subtitle: string; sectionName: string; pc: { link: string; image: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }; }; }>; export declare function genBanners(sectionName?: string): Promise<{ data: { items: { id: string; title: string; subtitle: string; sectionName: string; pc: { link: string; image: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }; }; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genReputation(): Promise<{ data: { score: number; }; }>; export declare function genWishlist(): Promise<{ data: { id: string; name: string; description: string; isDefault: boolean; products: { id: string; name: string; price: number; option: { type: string; name: string; items: { id: string; name: string; values: { value: number; }[]; renderingStyle: string; required: boolean; }[]; variants: { id: string; name: string; code: string; raws: never[]; stockManagement: { grade: string; quantityCheckTrigger: string; stock: number; safetyStock: number; }; displayable: boolean; sellable: boolean; additionalPrice: number; additionalPriceBeforeTax: number; additionalTaxPrice: number; }[]; extras: { id: string; type: string; name: string; required: boolean; }[]; }; }[]; }; }>; export declare function genWritableOrderItem(): Promise<{ data: { items: { id: string; code: string; status: OrderItemStatus; quantity: number; product: { name: string; price: number; code: string; featuredImages: { original: { location: string; }; '1x': { location: string; }; '2x': { location: string; }; '3x': { location: string; }; }[]; }; stats: { mileagePoint: number; discountPrice: number; couponPrice: number; price: number; priceBeforeDiscount: number; priceBeforeTax: number; taxPrice: number; }; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genUserMileageList(): Promise<{ data: { items: { id: string; available: boolean; point: number; comment: string; createdAt: Date; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genUserDeliveryAddress(): Promise<{ data: { id: string; isDefault: boolean; name: string; recipientName: string; address: { zipCode: string; address1: string; address2: string; }; mainPhoneNumber: string; subPhoneNumber: string; }; }>; export declare function genUserDeliveryAddressList(): Promise<{ data: { items: { id: string; isDefault: boolean; name: string; recipientName: string; address: { zipCode: string; address1: string; address2: string; }; mainPhoneNumber: string; subPhoneNumber: string; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genUserCouponList(): Promise<{ data: { items: { id: string; code: string; coupon: { name: string; benefit: any; }; availableDate: { minimum: Date; maximum: Date; }; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genComment(): Promise<{ data: { id: string; author: { displayName: string; }; content: string; }; }>; export declare function genCommentList(): Promise<{ data: { items: { id: string; author: { displayName: string; }; content: string; }[]; currentItemCount: number; itemsPerPage: number; pageIndex: number; startIndex: number; totalItems: number; totalPages: number; }; }>; export declare function genCSDetail(): Promise<{ data: { id: string; createdAt: Date; updatedAt: Date; type: CustomerServiceType; code: string; status: CustomerServiceStatus; reason: string; reasonDetail: string; order: { id: string; createdAt: string; updatedAt: string; deliveries: { id: string; createdAt: string; updatedAt: string; order: string; code: string; status: string; items: { id: string; createdAt: string; updatedAt: string; status: string; delivery: string; orderItemId: string; }[]; carrier: { id: string; createdAt: string; updatedAt: string; name: string; description: string; type: string; priceType: string; prices: { id: string; createdAt: string; updatedAt: string; minimum: number; maximum: number; value: number; }[]; extraCharges: never[]; }; recipient: { name: string; subPhoneNumber: string; }; address: { zipCode: string; locality: string; address1: string;