@congminh1254/shopee-sdk 0.10.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/README.md +172 -36
  2. package/lib/fetch.js +6 -0
  3. package/lib/fetch.js.map +1 -1
  4. package/lib/managers/add-on-deal.manager.d.ts +140 -0
  5. package/lib/managers/add-on-deal.manager.js +240 -0
  6. package/lib/managers/add-on-deal.manager.js.map +1 -0
  7. package/lib/managers/ads.manager.d.ts +217 -1
  8. package/lib/managers/ads.manager.js +312 -0
  9. package/lib/managers/ads.manager.js.map +1 -1
  10. package/lib/managers/bundle-deal.manager.d.ts +106 -0
  11. package/lib/managers/bundle-deal.manager.js +178 -0
  12. package/lib/managers/bundle-deal.manager.js.map +1 -0
  13. package/lib/managers/discount.manager.d.ts +102 -0
  14. package/lib/managers/discount.manager.js +167 -0
  15. package/lib/managers/discount.manager.js.map +1 -0
  16. package/lib/managers/fbs.manager.d.ts +115 -0
  17. package/lib/managers/fbs.manager.js +145 -0
  18. package/lib/managers/fbs.manager.js.map +1 -0
  19. package/lib/managers/first-mile.manager.d.ts +150 -0
  20. package/lib/managers/first-mile.manager.js +264 -0
  21. package/lib/managers/first-mile.manager.js.map +1 -0
  22. package/lib/managers/follow-prize.manager.d.ts +108 -0
  23. package/lib/managers/follow-prize.manager.js +152 -0
  24. package/lib/managers/follow-prize.manager.js.map +1 -0
  25. package/lib/managers/global-product.manager.d.ts +664 -0
  26. package/lib/managers/global-product.manager.js +904 -0
  27. package/lib/managers/global-product.manager.js.map +1 -0
  28. package/lib/managers/index.d.ts +17 -1
  29. package/lib/managers/index.js +17 -1
  30. package/lib/managers/index.js.map +1 -1
  31. package/lib/managers/livestream.manager.d.ts +377 -0
  32. package/lib/managers/livestream.manager.js +529 -0
  33. package/lib/managers/livestream.manager.js.map +1 -0
  34. package/lib/managers/logistics.manager.d.ts +267 -1
  35. package/lib/managers/logistics.manager.js +544 -0
  36. package/lib/managers/logistics.manager.js.map +1 -1
  37. package/lib/managers/media-space.manager.d.ts +179 -0
  38. package/lib/managers/media-space.manager.js +220 -0
  39. package/lib/managers/media-space.manager.js.map +1 -0
  40. package/lib/managers/media.manager.d.ts +226 -0
  41. package/lib/managers/media.manager.js +274 -0
  42. package/lib/managers/media.manager.js.map +1 -0
  43. package/lib/managers/merchant.manager.d.ts +100 -0
  44. package/lib/managers/merchant.manager.js +144 -0
  45. package/lib/managers/merchant.manager.js.map +1 -0
  46. package/lib/managers/order.manager.d.ts +213 -1
  47. package/lib/managers/order.manager.js +305 -0
  48. package/lib/managers/order.manager.js.map +1 -1
  49. package/lib/managers/payment.manager.d.ts +186 -1
  50. package/lib/managers/payment.manager.js +288 -0
  51. package/lib/managers/payment.manager.js.map +1 -1
  52. package/lib/managers/returns.manager.d.ts +200 -0
  53. package/lib/managers/returns.manager.js +300 -0
  54. package/lib/managers/returns.manager.js.map +1 -0
  55. package/lib/managers/sbs.manager.d.ts +112 -0
  56. package/lib/managers/sbs.manager.js +149 -0
  57. package/lib/managers/sbs.manager.js.map +1 -0
  58. package/lib/managers/shop-category.manager.d.ts +207 -0
  59. package/lib/managers/shop-category.manager.js +258 -0
  60. package/lib/managers/shop-category.manager.js.map +1 -0
  61. package/lib/managers/shop-flash-sale.manager.d.ts +242 -0
  62. package/lib/managers/shop-flash-sale.manager.js +321 -0
  63. package/lib/managers/shop-flash-sale.manager.js.map +1 -0
  64. package/lib/managers/shop.manager.d.ts +173 -0
  65. package/lib/managers/shop.manager.js +217 -0
  66. package/lib/managers/shop.manager.js.map +1 -0
  67. package/lib/managers/top-picks.manager.d.ts +62 -0
  68. package/lib/managers/top-picks.manager.js +91 -0
  69. package/lib/managers/top-picks.manager.js.map +1 -0
  70. package/lib/schemas/add-on-deal.d.ts +390 -0
  71. package/lib/schemas/add-on-deal.js +45 -0
  72. package/lib/schemas/add-on-deal.js.map +1 -0
  73. package/lib/schemas/ads.d.ts +437 -0
  74. package/lib/schemas/bundle-deal.d.ts +300 -0
  75. package/lib/schemas/bundle-deal.js +27 -0
  76. package/lib/schemas/bundle-deal.js.map +1 -0
  77. package/lib/schemas/discount.d.ts +334 -0
  78. package/lib/schemas/discount.js +15 -0
  79. package/lib/schemas/discount.js.map +1 -0
  80. package/lib/schemas/fbs.d.ts +117 -0
  81. package/lib/schemas/fbs.js +2 -0
  82. package/lib/schemas/fbs.js.map +1 -0
  83. package/lib/schemas/first-mile.d.ts +551 -0
  84. package/lib/schemas/first-mile.js +2 -0
  85. package/lib/schemas/first-mile.js.map +1 -0
  86. package/lib/schemas/follow-prize.d.ts +198 -0
  87. package/lib/schemas/follow-prize.js +27 -0
  88. package/lib/schemas/follow-prize.js.map +1 -0
  89. package/lib/schemas/global-product.d.ts +1127 -0
  90. package/lib/schemas/global-product.js +2 -0
  91. package/lib/schemas/global-product.js.map +1 -0
  92. package/lib/schemas/index.d.ts +13 -0
  93. package/lib/schemas/index.js +17 -0
  94. package/lib/schemas/index.js.map +1 -1
  95. package/lib/schemas/livestream.d.ts +649 -0
  96. package/lib/schemas/livestream.js +2 -0
  97. package/lib/schemas/livestream.js.map +1 -0
  98. package/lib/schemas/logistics.d.ts +979 -0
  99. package/lib/schemas/logistics.js +13 -0
  100. package/lib/schemas/logistics.js.map +1 -1
  101. package/lib/schemas/media-space.d.ts +189 -0
  102. package/lib/schemas/media-space.js +2 -0
  103. package/lib/schemas/media-space.js.map +1 -0
  104. package/lib/schemas/media.d.ts +230 -0
  105. package/lib/schemas/media.js +2 -0
  106. package/lib/schemas/media.js.map +1 -0
  107. package/lib/schemas/merchant.d.ts +236 -0
  108. package/lib/schemas/merchant.js +2 -0
  109. package/lib/schemas/merchant.js.map +1 -0
  110. package/lib/schemas/order.d.ts +431 -0
  111. package/lib/schemas/payment.d.ts +397 -0
  112. package/lib/schemas/returns.d.ts +632 -0
  113. package/lib/schemas/returns.js +63 -0
  114. package/lib/schemas/returns.js.map +1 -0
  115. package/lib/schemas/sbs.d.ts +484 -0
  116. package/lib/schemas/sbs.js +2 -0
  117. package/lib/schemas/sbs.js.map +1 -0
  118. package/lib/schemas/shop-category.d.ts +176 -0
  119. package/lib/schemas/shop-category.js +2 -0
  120. package/lib/schemas/shop-category.js.map +1 -0
  121. package/lib/schemas/shop-flash-sale.d.ts +473 -0
  122. package/lib/schemas/shop-flash-sale.js +43 -0
  123. package/lib/schemas/shop-flash-sale.js.map +1 -0
  124. package/lib/schemas/shop.d.ts +250 -0
  125. package/lib/schemas/shop.js +2 -0
  126. package/lib/schemas/shop.js.map +1 -0
  127. package/lib/schemas/top-picks.d.ts +99 -0
  128. package/lib/schemas/top-picks.js +2 -0
  129. package/lib/schemas/top-picks.js.map +1 -0
  130. package/lib/sdk.d.ts +34 -0
  131. package/lib/sdk.js +34 -0
  132. package/lib/sdk.js.map +1 -1
  133. package/lib/version.d.ts +1 -0
  134. package/lib/version.js +3 -0
  135. package/lib/version.js.map +1 -0
  136. package/package.json +4 -5
@@ -0,0 +1,115 @@
1
+ import { ShopeeConfig } from "../sdk.js";
2
+ import { BaseManager } from "./base.manager.js";
3
+ import { QueryBrShopEnrollmentStatusParams, QueryBrShopEnrollmentStatusResponse, QueryBrShopBlockStatusParams, QueryBrShopBlockStatusResponse, QueryBrShopInvoiceErrorParams, QueryBrShopInvoiceErrorResponse, QueryBrSkuBlockStatusParams, QueryBrSkuBlockStatusResponse } from "../schemas/fbs.js";
4
+ export declare class FbsManager extends BaseManager {
5
+ constructor(config: ShopeeConfig);
6
+ /**
7
+ * Check whether a given shop_id is eligible to enroll in the Brazil Fulfilled-by-Shopee (FBS) service.
8
+ * This API is for Brazil region only.
9
+ *
10
+ * @param params - Parameters for querying enrollment status (empty object)
11
+ *
12
+ * @returns A promise that resolves to the enrollment status response containing:
13
+ * - shop_id: Shopee's unique identifier for the shop
14
+ * - enrollment_status: 1=enable enrollment, 2=disable enrollment, 3=already enrollment
15
+ * - enable_enrollment_time: The time when the shop can enroll in FBS
16
+ *
17
+ * @throws {Error} When the API request fails or returns an error
18
+ *
19
+ * @example
20
+ * ```typescript
21
+ * const status = await sdk.fbs.queryBrShopEnrollmentStatus({});
22
+ * if (status.response.enrollment_status === 1) {
23
+ * console.log('Shop can enroll in FBS');
24
+ * }
25
+ * ```
26
+ */
27
+ queryBrShopEnrollmentStatus(params?: QueryBrShopEnrollmentStatusParams): Promise<QueryBrShopEnrollmentStatusResponse>;
28
+ /**
29
+ * Check whether an FBS shop is blocked due to invoice-related issues.
30
+ * When blocked, the shop cannot create new Inbound Requests, and its warehouse
31
+ * inventory is restricted from being sold. This API is for Brazil region only.
32
+ *
33
+ * @param params - Parameters for querying shop block status (empty object)
34
+ *
35
+ * @returns A promise that resolves to the block status response containing:
36
+ * - shop_id: Shopee's unique identifier for the shop
37
+ * - is_block: Whether the shop is blocked
38
+ *
39
+ * @throws {Error} When the API request fails or returns an error
40
+ *
41
+ * @example
42
+ * ```typescript
43
+ * const status = await sdk.fbs.queryBrShopBlockStatus({});
44
+ * if (status.response.is_block) {
45
+ * console.log('Shop is blocked due to invoice issues');
46
+ * }
47
+ * ```
48
+ */
49
+ queryBrShopBlockStatus(params?: QueryBrShopBlockStatusParams): Promise<QueryBrShopBlockStatusResponse>;
50
+ /**
51
+ * Get failed invoice issuance information for FBS-related processes.
52
+ * This covers Inbound Requests, RTS Requests, Sales Orders, and Move Transfer Orders.
53
+ * This API is for Brazil region only.
54
+ *
55
+ * @param params - Parameters for querying invoice errors
56
+ * @param params.page_no - Page number (default: 1)
57
+ * @param params.page_size - Page size, max: 100 (default: 10)
58
+ *
59
+ * @returns A promise that resolves to the invoice error response containing:
60
+ * - total: Total number of invoice errors
61
+ * - list: List of invoice errors with details including:
62
+ * - biz_request_type: Type of business request (1=Inbound, 2=RTS, 3=Sales, 4=Move Transfer, 5=IA)
63
+ * - biz_request_id: Business request ID
64
+ * - fail_reason: Reason for invoice failure
65
+ * - fail_type: 1=SKU tax info error, 2=seller tax info error
66
+ * - invoice_deadline_time: Deadline to fix the issue
67
+ * - shop_sku_list: List of SKUs with errors
68
+ *
69
+ * @throws {Error} When the API request fails or returns an error
70
+ *
71
+ * @example
72
+ * ```typescript
73
+ * const errors = await sdk.fbs.queryBrShopInvoiceError({
74
+ * page_no: 1,
75
+ * page_size: 20,
76
+ * });
77
+ *
78
+ * errors.response.list.forEach(error => {
79
+ * console.log(`Request ID: ${error.biz_request_id}`);
80
+ * console.log(`Failed reason: ${error.fail_reason}`);
81
+ * });
82
+ * ```
83
+ */
84
+ queryBrShopInvoiceError(params?: QueryBrShopInvoiceErrorParams): Promise<QueryBrShopInvoiceErrorResponse>;
85
+ /**
86
+ * Check whether an FBS product is blocked due to invoice-related issues.
87
+ * When blocked, the product cannot be included in new Inbound Requests, and its
88
+ * warehouse inventory is restricted from being sold. This API is for Brazil region only.
89
+ *
90
+ * @param params - Parameters for querying SKU block status
91
+ * @param params.shop_sku_id - Shop SKU ID in format "itemID_modelID"
92
+ *
93
+ * @returns A promise that resolves to the SKU block status response containing:
94
+ * - shop_sku_id: The queried SKU ID
95
+ * - is_block: Whether the SKU is blocked
96
+ * - shop_item_id: Item ID
97
+ * - shop_model_id: Model ID
98
+ * - shop_item_name: Item name
99
+ * - shop_model_name: Model name
100
+ *
101
+ * @throws {Error} When the API request fails or returns an error
102
+ *
103
+ * @example
104
+ * ```typescript
105
+ * const status = await sdk.fbs.queryBrSkuBlockStatus({
106
+ * shop_sku_id: '123456_789012',
107
+ * });
108
+ *
109
+ * if (status.response.is_block) {
110
+ * console.log(`SKU ${status.response.shop_item_name} is blocked`);
111
+ * }
112
+ * ```
113
+ */
114
+ queryBrSkuBlockStatus(params: QueryBrSkuBlockStatusParams): Promise<QueryBrSkuBlockStatusResponse>;
115
+ }
@@ -0,0 +1,145 @@
1
+ import { BaseManager } from "./base.manager.js";
2
+ import { ShopeeFetch } from "../fetch.js";
3
+ export class FbsManager extends BaseManager {
4
+ constructor(config) {
5
+ super(config);
6
+ }
7
+ /**
8
+ * Check whether a given shop_id is eligible to enroll in the Brazil Fulfilled-by-Shopee (FBS) service.
9
+ * This API is for Brazil region only.
10
+ *
11
+ * @param params - Parameters for querying enrollment status (empty object)
12
+ *
13
+ * @returns A promise that resolves to the enrollment status response containing:
14
+ * - shop_id: Shopee's unique identifier for the shop
15
+ * - enrollment_status: 1=enable enrollment, 2=disable enrollment, 3=already enrollment
16
+ * - enable_enrollment_time: The time when the shop can enroll in FBS
17
+ *
18
+ * @throws {Error} When the API request fails or returns an error
19
+ *
20
+ * @example
21
+ * ```typescript
22
+ * const status = await sdk.fbs.queryBrShopEnrollmentStatus({});
23
+ * if (status.response.enrollment_status === 1) {
24
+ * console.log('Shop can enroll in FBS');
25
+ * }
26
+ * ```
27
+ */
28
+ async queryBrShopEnrollmentStatus(params = {}) {
29
+ const response = await ShopeeFetch.fetch(this.config, "/fbs/query_br_shop_enrollment_status", {
30
+ method: "POST",
31
+ auth: true,
32
+ body: params,
33
+ });
34
+ return response;
35
+ }
36
+ /**
37
+ * Check whether an FBS shop is blocked due to invoice-related issues.
38
+ * When blocked, the shop cannot create new Inbound Requests, and its warehouse
39
+ * inventory is restricted from being sold. This API is for Brazil region only.
40
+ *
41
+ * @param params - Parameters for querying shop block status (empty object)
42
+ *
43
+ * @returns A promise that resolves to the block status response containing:
44
+ * - shop_id: Shopee's unique identifier for the shop
45
+ * - is_block: Whether the shop is blocked
46
+ *
47
+ * @throws {Error} When the API request fails or returns an error
48
+ *
49
+ * @example
50
+ * ```typescript
51
+ * const status = await sdk.fbs.queryBrShopBlockStatus({});
52
+ * if (status.response.is_block) {
53
+ * console.log('Shop is blocked due to invoice issues');
54
+ * }
55
+ * ```
56
+ */
57
+ async queryBrShopBlockStatus(params = {}) {
58
+ const response = await ShopeeFetch.fetch(this.config, "/fbs/query_br_shop_block_status", {
59
+ method: "POST",
60
+ auth: true,
61
+ body: params,
62
+ });
63
+ return response;
64
+ }
65
+ /**
66
+ * Get failed invoice issuance information for FBS-related processes.
67
+ * This covers Inbound Requests, RTS Requests, Sales Orders, and Move Transfer Orders.
68
+ * This API is for Brazil region only.
69
+ *
70
+ * @param params - Parameters for querying invoice errors
71
+ * @param params.page_no - Page number (default: 1)
72
+ * @param params.page_size - Page size, max: 100 (default: 10)
73
+ *
74
+ * @returns A promise that resolves to the invoice error response containing:
75
+ * - total: Total number of invoice errors
76
+ * - list: List of invoice errors with details including:
77
+ * - biz_request_type: Type of business request (1=Inbound, 2=RTS, 3=Sales, 4=Move Transfer, 5=IA)
78
+ * - biz_request_id: Business request ID
79
+ * - fail_reason: Reason for invoice failure
80
+ * - fail_type: 1=SKU tax info error, 2=seller tax info error
81
+ * - invoice_deadline_time: Deadline to fix the issue
82
+ * - shop_sku_list: List of SKUs with errors
83
+ *
84
+ * @throws {Error} When the API request fails or returns an error
85
+ *
86
+ * @example
87
+ * ```typescript
88
+ * const errors = await sdk.fbs.queryBrShopInvoiceError({
89
+ * page_no: 1,
90
+ * page_size: 20,
91
+ * });
92
+ *
93
+ * errors.response.list.forEach(error => {
94
+ * console.log(`Request ID: ${error.biz_request_id}`);
95
+ * console.log(`Failed reason: ${error.fail_reason}`);
96
+ * });
97
+ * ```
98
+ */
99
+ async queryBrShopInvoiceError(params = {}) {
100
+ const response = await ShopeeFetch.fetch(this.config, "/fbs/query_br_shop_invoice_error", {
101
+ method: "POST",
102
+ auth: true,
103
+ body: params,
104
+ });
105
+ return response;
106
+ }
107
+ /**
108
+ * Check whether an FBS product is blocked due to invoice-related issues.
109
+ * When blocked, the product cannot be included in new Inbound Requests, and its
110
+ * warehouse inventory is restricted from being sold. This API is for Brazil region only.
111
+ *
112
+ * @param params - Parameters for querying SKU block status
113
+ * @param params.shop_sku_id - Shop SKU ID in format "itemID_modelID"
114
+ *
115
+ * @returns A promise that resolves to the SKU block status response containing:
116
+ * - shop_sku_id: The queried SKU ID
117
+ * - is_block: Whether the SKU is blocked
118
+ * - shop_item_id: Item ID
119
+ * - shop_model_id: Model ID
120
+ * - shop_item_name: Item name
121
+ * - shop_model_name: Model name
122
+ *
123
+ * @throws {Error} When the API request fails or returns an error
124
+ *
125
+ * @example
126
+ * ```typescript
127
+ * const status = await sdk.fbs.queryBrSkuBlockStatus({
128
+ * shop_sku_id: '123456_789012',
129
+ * });
130
+ *
131
+ * if (status.response.is_block) {
132
+ * console.log(`SKU ${status.response.shop_item_name} is blocked`);
133
+ * }
134
+ * ```
135
+ */
136
+ async queryBrSkuBlockStatus(params) {
137
+ const response = await ShopeeFetch.fetch(this.config, "/fbs/query_br_sku_block_status", {
138
+ method: "POST",
139
+ auth: true,
140
+ body: params,
141
+ });
142
+ return response;
143
+ }
144
+ }
145
+ //# sourceMappingURL=fbs.manager.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fbs.manager.js","sourceRoot":"","sources":["../../src/managers/fbs.manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAWhD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC,YAAY,MAAoB;QAC9B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,2BAA2B,CAC/B,SAA4C,EAAE;QAE9C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,sCAAsC,EACtC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,SAAuC,EAAE;QAEzC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,iCAAiC,EACjC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,uBAAuB,CAC3B,SAAwC,EAAE;QAE1C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,kCAAkC,EAClC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,qBAAqB,CACzB,MAAmC;QAEnC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACtC,IAAI,CAAC,MAAM,EACX,gCAAgC,EAChC;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,MAAM;SACb,CACF,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
@@ -0,0 +1,150 @@
1
+ import { ShopeeConfig } from "../sdk.js";
2
+ import { BaseManager } from "./base.manager.js";
3
+ import { BindCourierDeliveryFirstMileTrackingNumberParams, BindCourierDeliveryFirstMileTrackingNumberResponse, BindFirstMileTrackingNumberParams, BindFirstMileTrackingNumberResponse, GenerateAndBindFirstMileTrackingNumberParams, GenerateAndBindFirstMileTrackingNumberResponse, GenerateFirstMileTrackingNumberParams, GenerateFirstMileTrackingNumberResponse, GetChannelListParams, GetChannelListResponse, GetCourierDeliveryChannelListParams, GetCourierDeliveryChannelListResponse, GetCourierDeliveryDetailParams, GetCourierDeliveryDetailResponse, GetCourierDeliveryTrackingNumberListParams, GetCourierDeliveryTrackingNumberListResponse, GetCourierDeliveryWaybillParams, GetCourierDeliveryWaybillResponse, GetDetailParams, GetDetailResponse, GetTrackingNumberListParams, GetTrackingNumberListResponse, GetTransitWarehouseListParams, GetTransitWarehouseListResponse, GetUnbindOrderListParams, GetUnbindOrderListResponse, GetWaybillParams, GetWaybillResponse, UnbindFirstMileTrackingNumberParams, UnbindFirstMileTrackingNumberResponse, UnbindFirstMileTrackingNumberAllParams, UnbindFirstMileTrackingNumberAllResponse } from "../schemas/first-mile.js";
4
+ export declare class FirstMileManager extends BaseManager {
5
+ constructor(config: ShopeeConfig);
6
+ /**
7
+ * Use this api to bind first mile tracking number for courier delivery method.
8
+ *
9
+ * @param params - Parameters for binding courier delivery first mile tracking number
10
+ * @returns A promise that resolves to the bind response
11
+ *
12
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_courier_delivery_first_mile_tracking_number
13
+ */
14
+ bindCourierDeliveryFirstMileTrackingNumber(params: BindCourierDeliveryFirstMileTrackingNumberParams): Promise<BindCourierDeliveryFirstMileTrackingNumberResponse>;
15
+ /**
16
+ * Use this api to bind first mile tracking number.
17
+ *
18
+ * @param params - Parameters for binding first mile tracking number
19
+ * @returns A promise that resolves to the bind response
20
+ *
21
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_first_mile_tracking_number
22
+ */
23
+ bindFirstMileTrackingNumber(params: BindFirstMileTrackingNumberParams): Promise<BindFirstMileTrackingNumberResponse>;
24
+ /**
25
+ * Use this api to generate first mile tracking number for courier delivery method.
26
+ *
27
+ * @param params - Parameters for generating and binding first mile tracking number
28
+ * @returns A promise that resolves to the generate and bind response
29
+ *
30
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_and_bind_first_mile_tracking_number
31
+ */
32
+ generateAndBindFirstMileTrackingNumber(params: GenerateAndBindFirstMileTrackingNumberParams): Promise<GenerateAndBindFirstMileTrackingNumberResponse>;
33
+ /**
34
+ * Use this api to generate first mile tracking number.
35
+ *
36
+ * @param params - Parameters for generating first mile tracking number
37
+ * @returns A promise that resolves to the generate response
38
+ *
39
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_first_mile_tracking_number
40
+ */
41
+ generateFirstMileTrackingNumber(params: GenerateFirstMileTrackingNumberParams): Promise<GenerateFirstMileTrackingNumberResponse>;
42
+ /**
43
+ * Use this api to get first mile channel list.
44
+ *
45
+ * @param params - Parameters for getting channel list (optional region filter)
46
+ * @returns A promise that resolves to the channel list response
47
+ *
48
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_channel_list
49
+ */
50
+ getChannelList(params?: GetChannelListParams): Promise<GetChannelListResponse>;
51
+ /**
52
+ * Use this api to get courier information for courier delivery method.
53
+ *
54
+ * @param params - Parameters for getting courier delivery channel list (optional region filter)
55
+ * @returns A promise that resolves to the courier delivery channel list response
56
+ *
57
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_channel_list
58
+ */
59
+ getCourierDeliveryChannelList(params?: GetCourierDeliveryChannelListParams): Promise<GetCourierDeliveryChannelListResponse>;
60
+ /**
61
+ * Use this api to get first mile detail for courier delivery method.
62
+ *
63
+ * @param params - Parameters for getting courier delivery detail
64
+ * @returns A promise that resolves to the courier delivery detail response
65
+ *
66
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_detail
67
+ */
68
+ getCourierDeliveryDetail(params: GetCourierDeliveryDetailParams): Promise<GetCourierDeliveryDetailResponse>;
69
+ /**
70
+ * Use this api to get tracking number for courier delivery method.
71
+ *
72
+ * @param params - Parameters for getting courier delivery tracking number list
73
+ * @returns A promise that resolves to the courier delivery tracking number list response
74
+ *
75
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_tracking_number_list
76
+ */
77
+ getCourierDeliveryTrackingNumberList(params: GetCourierDeliveryTrackingNumberListParams): Promise<GetCourierDeliveryTrackingNumberListResponse>;
78
+ /**
79
+ * Use this api to get first mile waybill file for courier delivery method.
80
+ *
81
+ * @param params - Parameters for getting courier delivery waybill
82
+ * @returns A promise that resolves to the courier delivery waybill response
83
+ *
84
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_waybill
85
+ */
86
+ getCourierDeliveryWaybill(params: GetCourierDeliveryWaybillParams): Promise<GetCourierDeliveryWaybillResponse>;
87
+ /**
88
+ * Use this api to get first mile detail.
89
+ *
90
+ * @param params - Parameters for getting first mile detail
91
+ * @returns A promise that resolves to the first mile detail response
92
+ *
93
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_detail
94
+ */
95
+ getDetail(params: GetDetailParams): Promise<GetDetailResponse>;
96
+ /**
97
+ * Use this api to get first mile tracking number list.
98
+ *
99
+ * @param params - Parameters for getting tracking number list
100
+ * @returns A promise that resolves to the tracking number list response
101
+ *
102
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_tracking_number_list
103
+ */
104
+ getTrackingNumberList(params: GetTrackingNumberListParams): Promise<GetTrackingNumberListResponse>;
105
+ /**
106
+ * Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.
107
+ *
108
+ * @param params - Parameters for getting transit warehouse list (optional region filter)
109
+ * @returns A promise that resolves to the transit warehouse list response
110
+ *
111
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_transit_warehouse_list
112
+ */
113
+ getTransitWarehouseList(params?: GetTransitWarehouseListParams): Promise<GetTransitWarehouseListResponse>;
114
+ /**
115
+ * Use this api to get unbind order list.
116
+ *
117
+ * @param params - Parameters for getting unbind order list
118
+ * @returns A promise that resolves to the unbind order list response
119
+ *
120
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_unbind_order_list
121
+ */
122
+ getUnbindOrderList(params?: GetUnbindOrderListParams): Promise<GetUnbindOrderListResponse>;
123
+ /**
124
+ * Use this api to get first mile waybill file.
125
+ *
126
+ * @param params - Parameters for getting waybill
127
+ * @returns A promise that resolves to the waybill response
128
+ *
129
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_waybill
130
+ */
131
+ getWaybill(params: GetWaybillParams): Promise<GetWaybillResponse>;
132
+ /**
133
+ * Use this api to unbind first mile.
134
+ *
135
+ * @param params - Parameters for unbinding first mile tracking number
136
+ * @returns A promise that resolves to the unbind response
137
+ *
138
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number
139
+ */
140
+ unbindFirstMileTrackingNumber(params: UnbindFirstMileTrackingNumberParams): Promise<UnbindFirstMileTrackingNumberResponse>;
141
+ /**
142
+ * Use this api to unbind orders from first mile tracking number or binding ID.
143
+ *
144
+ * @param params - Parameters for unbinding all first mile tracking numbers
145
+ * @returns A promise that resolves to the unbind response
146
+ *
147
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number_all
148
+ */
149
+ unbindFirstMileTrackingNumberAll(params: UnbindFirstMileTrackingNumberAllParams): Promise<UnbindFirstMileTrackingNumberAllResponse>;
150
+ }
@@ -0,0 +1,264 @@
1
+ import { BaseManager } from "./base.manager.js";
2
+ import { ShopeeFetch } from "../fetch.js";
3
+ export class FirstMileManager extends BaseManager {
4
+ constructor(config) {
5
+ super(config);
6
+ }
7
+ /**
8
+ * Use this api to bind first mile tracking number for courier delivery method.
9
+ *
10
+ * @param params - Parameters for binding courier delivery first mile tracking number
11
+ * @returns A promise that resolves to the bind response
12
+ *
13
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_courier_delivery_first_mile_tracking_number
14
+ */
15
+ async bindCourierDeliveryFirstMileTrackingNumber(params) {
16
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/bind_courier_delivery_first_mile_tracking_number", {
17
+ method: "POST",
18
+ auth: true,
19
+ body: params,
20
+ });
21
+ return response;
22
+ }
23
+ /**
24
+ * Use this api to bind first mile tracking number.
25
+ *
26
+ * @param params - Parameters for binding first mile tracking number
27
+ * @returns A promise that resolves to the bind response
28
+ *
29
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.bind_first_mile_tracking_number
30
+ */
31
+ async bindFirstMileTrackingNumber(params) {
32
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/bind_first_mile_tracking_number", {
33
+ method: "POST",
34
+ auth: true,
35
+ body: params,
36
+ });
37
+ return response;
38
+ }
39
+ /**
40
+ * Use this api to generate first mile tracking number for courier delivery method.
41
+ *
42
+ * @param params - Parameters for generating and binding first mile tracking number
43
+ * @returns A promise that resolves to the generate and bind response
44
+ *
45
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_and_bind_first_mile_tracking_number
46
+ */
47
+ async generateAndBindFirstMileTrackingNumber(params) {
48
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/generate_and_bind_first_mile_tracking_number", {
49
+ method: "POST",
50
+ auth: true,
51
+ body: params,
52
+ });
53
+ return response;
54
+ }
55
+ /**
56
+ * Use this api to generate first mile tracking number.
57
+ *
58
+ * @param params - Parameters for generating first mile tracking number
59
+ * @returns A promise that resolves to the generate response
60
+ *
61
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.generate_first_mile_tracking_number
62
+ */
63
+ async generateFirstMileTrackingNumber(params) {
64
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/generate_first_mile_tracking_number", {
65
+ method: "POST",
66
+ auth: true,
67
+ body: params,
68
+ });
69
+ return response;
70
+ }
71
+ /**
72
+ * Use this api to get first mile channel list.
73
+ *
74
+ * @param params - Parameters for getting channel list (optional region filter)
75
+ * @returns A promise that resolves to the channel list response
76
+ *
77
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_channel_list
78
+ */
79
+ async getChannelList(params) {
80
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_channel_list", {
81
+ method: "GET",
82
+ auth: true,
83
+ params,
84
+ });
85
+ return response;
86
+ }
87
+ /**
88
+ * Use this api to get courier information for courier delivery method.
89
+ *
90
+ * @param params - Parameters for getting courier delivery channel list (optional region filter)
91
+ * @returns A promise that resolves to the courier delivery channel list response
92
+ *
93
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_channel_list
94
+ */
95
+ async getCourierDeliveryChannelList(params) {
96
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_channel_list", {
97
+ method: "GET",
98
+ auth: true,
99
+ params,
100
+ });
101
+ return response;
102
+ }
103
+ /**
104
+ * Use this api to get first mile detail for courier delivery method.
105
+ *
106
+ * @param params - Parameters for getting courier delivery detail
107
+ * @returns A promise that resolves to the courier delivery detail response
108
+ *
109
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_detail
110
+ */
111
+ async getCourierDeliveryDetail(params) {
112
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_detail", {
113
+ method: "GET",
114
+ auth: true,
115
+ params,
116
+ });
117
+ return response;
118
+ }
119
+ /**
120
+ * Use this api to get tracking number for courier delivery method.
121
+ *
122
+ * @param params - Parameters for getting courier delivery tracking number list
123
+ * @returns A promise that resolves to the courier delivery tracking number list response
124
+ *
125
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_tracking_number_list
126
+ */
127
+ async getCourierDeliveryTrackingNumberList(params) {
128
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_tracking_number_list", {
129
+ method: "POST",
130
+ auth: true,
131
+ body: params,
132
+ });
133
+ return response;
134
+ }
135
+ /**
136
+ * Use this api to get first mile waybill file for courier delivery method.
137
+ *
138
+ * @param params - Parameters for getting courier delivery waybill
139
+ * @returns A promise that resolves to the courier delivery waybill response
140
+ *
141
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_courier_delivery_waybill
142
+ */
143
+ async getCourierDeliveryWaybill(params) {
144
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_courier_delivery_waybill", {
145
+ method: "POST",
146
+ auth: true,
147
+ body: params,
148
+ });
149
+ return response;
150
+ }
151
+ /**
152
+ * Use this api to get first mile detail.
153
+ *
154
+ * @param params - Parameters for getting first mile detail
155
+ * @returns A promise that resolves to the first mile detail response
156
+ *
157
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_detail
158
+ */
159
+ async getDetail(params) {
160
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_detail", {
161
+ method: "GET",
162
+ auth: true,
163
+ params,
164
+ });
165
+ return response;
166
+ }
167
+ /**
168
+ * Use this api to get first mile tracking number list.
169
+ *
170
+ * @param params - Parameters for getting tracking number list
171
+ * @returns A promise that resolves to the tracking number list response
172
+ *
173
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_tracking_number_list
174
+ */
175
+ async getTrackingNumberList(params) {
176
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_tracking_number_list", {
177
+ method: "GET",
178
+ auth: true,
179
+ params,
180
+ });
181
+ return response;
182
+ }
183
+ /**
184
+ * Use this api to get transit warehouse list which is used for first mile tracking number generation for courier delivery method.
185
+ *
186
+ * @param params - Parameters for getting transit warehouse list (optional region filter)
187
+ * @returns A promise that resolves to the transit warehouse list response
188
+ *
189
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_transit_warehouse_list
190
+ */
191
+ async getTransitWarehouseList(params) {
192
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_transit_warehouse_list", {
193
+ method: "GET",
194
+ auth: true,
195
+ params,
196
+ });
197
+ return response;
198
+ }
199
+ /**
200
+ * Use this api to get unbind order list.
201
+ *
202
+ * @param params - Parameters for getting unbind order list
203
+ * @returns A promise that resolves to the unbind order list response
204
+ *
205
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_unbind_order_list
206
+ */
207
+ async getUnbindOrderList(params) {
208
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_unbind_order_list", {
209
+ method: "GET",
210
+ auth: true,
211
+ params,
212
+ });
213
+ return response;
214
+ }
215
+ /**
216
+ * Use this api to get first mile waybill file.
217
+ *
218
+ * @param params - Parameters for getting waybill
219
+ * @returns A promise that resolves to the waybill response
220
+ *
221
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.get_waybill
222
+ */
223
+ async getWaybill(params) {
224
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/get_waybill", {
225
+ method: "POST",
226
+ auth: true,
227
+ body: params,
228
+ });
229
+ return response;
230
+ }
231
+ /**
232
+ * Use this api to unbind first mile.
233
+ *
234
+ * @param params - Parameters for unbinding first mile tracking number
235
+ * @returns A promise that resolves to the unbind response
236
+ *
237
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number
238
+ */
239
+ async unbindFirstMileTrackingNumber(params) {
240
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/unbind_first_mile_tracking_number", {
241
+ method: "POST",
242
+ auth: true,
243
+ body: params,
244
+ });
245
+ return response;
246
+ }
247
+ /**
248
+ * Use this api to unbind orders from first mile tracking number or binding ID.
249
+ *
250
+ * @param params - Parameters for unbinding all first mile tracking numbers
251
+ * @returns A promise that resolves to the unbind response
252
+ *
253
+ * @see https://open.shopee.com/documents/v2/v2.first_mile.unbind_first_mile_tracking_number_all
254
+ */
255
+ async unbindFirstMileTrackingNumberAll(params) {
256
+ const response = await ShopeeFetch.fetch(this.config, "/first_mile/unbind_first_mile_tracking_number_all", {
257
+ method: "POST",
258
+ auth: true,
259
+ body: params,
260
+ });
261
+ return response;
262
+ }
263
+ }
264
+ //# sourceMappingURL=first-mile.manager.js.map