# @carforyou/api-client 中文文档

规范地址：https://npmcn.com/package/%40carforyou/api-client/

版本：46\.4\.1
npm 元数据更新时间：2024-11-18T13:11:53.358Z
中文译文更新时间：2026-11-09T04:52:05.285Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40carforyou/api-client
原文对照：https://npmcn.com/package/%40carforyou/api-client/?lang=original
项目主页：https://github.com/autoricardo/carforyou-api-client-pkg#readme
源码仓库：https://github.com/autoricardo/carforyou-api-client-pkg

弃用说明：Platform was closed down and no longer maintained\. Check @smg-automotive/api-client-pkg as replacement

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.8 MB，867 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-09-20T12:57:22.715Z
- 最新版本发布：2022-03-21T14:27:35.563Z
- 近 30 天下载量：12259（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：917（近 12 个月 0 个）

## 中文简介

连接到 API 的 Api 客户端

## 安装

```sh
npm install @carforyou/api-client
```

也可以使用：`pnpm add @carforyou/api-client`、`yarn add @carforyou/api-client`、`bun add @carforyou/api-client`

## README

# 汽车给你的API客户端

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## 使用量

```
npm install @carforyou/api-client
```

初始化 API 客户端 :

```
import { ApiClient } from "@carforyou/api-client"

ApiClient.configure(<your_configuration_object>)
```

导入 `fetchXYZ` 您需要并使用代码 :

```
import { fetchReferenceData } from "@carforyou/api-client"

fetchReferenceData()
```

## 配置

| 选项名称 | 含义 |
| --- | --- |
| `host` | API 网关的 URL |
| `debug` | 设定为 `true` 改为 `console.log` 请求和API的答复. |

### 在开发过程中模仿API的呼叫

你可以通过一个习惯 `host` 与 API 调用选项对象.

后端报价 [每个服务的 API 站点](https://github.com/carforyou/carforyou-docs#stubs),用于:

```
import { fetchListings } from "@carforyou/api-client"

fetchListings({ host: "https://inventory-search-service-stub.dev.carforyou.ch" })
```

如果您想要提供自己的模拟数据, 请在本地提供模拟 json 文件 [json服务器](https://www.npmjs.com/package/json-server)。 。 。 .

```
import { fetchListings } from "@carforyou/api-client"

fetchListings({ host: "http://localhost:3001" })
```

### 已认证的请求

需要授权的请求,需要通过有效的JWT认证用户在请求的资源上.

#### 执行经认证的请求

要认证请求,只需通过 `isAuthorizedRequest` 选项到请求帮助器(牵引/后置/put/delate-Data),Api客户端将添加 `Authorization` 头曰. 对于服务器侧请求,不要忘记将选项传递到帮助器函数上,这样消费者就可以通过 `accessToken` 在援引请求时.

注:如果一个人忘记添加 `isAuthorizedRequest` 选项,访问符将不设为信头。 在消费者方面,如果访问令牌没有被通过,api客户端会出错.

#### 执行经认证的请求

将访问令牌作为请求选项传递到 api 呼叫 `dummyFetchCall(data, {accessToken: JWT})`

#### 刷新访问文件夹

消费者有责任确保向请求人传递有效标志。 API 客户端会通过提供的代号作为 `Authorization` api呼叫的页眉.

## 接通API电话

还输出附带模式和参数类型以及默认值.

### [CarForYou 服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service)

-   [交易商默认列表](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing)
    
    -   [`fetchDealerDefaultListingData`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing/get_1)
    -   [" 拯救违约者 "](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing/setAdditionalServices)
    -   [`saveDealerDefaultListingDescription`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing/setDescription)
    -   [`saveDealerDefaultListingWarranty`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing/setWarranty)
    -   [`saveDealerDefaultListingGeneralExternalNote`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Dealer%20Default%20Listing/setGeneralExternalNote)
-   [图像](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Image)
    
    -   [`generatePresignedImageUrl`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Image/generatePresignedUrl)
    -   [`saveDealerListingImages`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Image/setListingImages)
-   [列名](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing)
    
    -   [`fetchDealerListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/getDealerListing)
    -   [`validateDealerListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/validateCreate)
    -   [`publishDealerListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/publish_1)
    -   [`unpublishDealerListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/unpublish_2)
    -   [`bulkUnpublishDealerListings`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/bulkUnpublish_1)
    -   [`transferDealerListingToManual`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/transferToManual)
    -   [`transferDealerListingsToManual`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/bulkTransferToManual)
    -   [`getAllDealerFrameNumbers`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Listing/getAllDealerFrameNumbers)
-   [库存](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Inventory)
    
    -   [`saveDealerListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=carforyou-service#/Inventory/update)

### [选项服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service)

-   [选项](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Option)
    
    -   [`fetchListingOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Option/getListingEquipment_1)
    -   [`bulkFetchListingOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Option/bulkGetListingEquipment)
    -   [`fetchDealerListingOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Option/getDealerListingEquipment)
    -   [`saveDealerListingOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Option/setListingEquipment_1)
-   [类型](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Type)
    
    -   [`fetchTypeOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Type/getEquipment_1)
-   [车辆](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Vehicle)
    
    -   `fetchFrameNumberTypes`
        -   它会得到类型 IDs 从 [vin 搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Vehicle/getVehicle)
    -   [`fetchFrameNumberOptions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Vehicle/getEquipment)
    -   [`fetchProductionYearByFrameNumber`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=option-service#/Vehicle/getVehicle)

### [库存搜索服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service)

-   [列出搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search)
    
    -   [`fetchListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/get)
    -   [`bulkFetchListing`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/bulkGet)
-   [城市](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Cities)
    
    -   [`fetchCity`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Cities/get_2)
    -   [`fetchCitySuggestions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Cities/getSuggestions)

-   [当前制作/模型](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Current%20Makes%2FModels)
    
    -   [`fetchCurrentMakes`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Current%20Makes%2FModels/getCurrentMakes)
    -   [`fetchCurrentModels`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Current%20Makes%2FModels/getCurrentModels)
-   [列出搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search)
    
    -   [`fetchListingCount`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/count_1)
    -   [`fetchListings`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/search_1)
    -   [`fetchFacets`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/getFacets_1)
    -   [`fetchDealerListingsCount`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/dealerListingCount)
    -   [`fetchDealerListings`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/dealerListingSearch)
    -   [`fetchDealerListingsFacets`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/getDealerListingFacets)
    -   [`fetchSearchSuggestions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/getSearchSuggestions)
    -   [`fetchAggregations`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20Search/getAggregations)
-   [类型搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Type%20Search)
    
    -   [`fetchTypes`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Type%20Search/search)
    -   [`fetchTypeFacets`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Type%20Search/getFacets)
-   [已保存搜索( 自动提醒)](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20saved%20searches)
    
    -   [`fetchSavedSearches`](https://inventory-search-service.preprod.carforyou.ch/swagger-ui/index.html#/Listing%20saved%20searches/getAllAutoAlarmsUsingGET)
    -   [`putDealerSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20saved%20searches/updateAutoAlarm)
    -   [`postDealerSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20saved%20searches/createAutoAlarm)
    -   [`deleteDealerSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Listing%20saved%20searches/deleteAutoAlarm)
-   [交易商搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Dealer%20Search)
    
    -   [`fetchDealers`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=inventory-search-service#/Dealer%20Search/search_2)

### [目录服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=catalogue-service)

-   [产品目录](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=catalogue-service#/Product%20Catalogue)
    -   [`fetchMakes`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=catalogue-service#/Product%20Catalogue/getAll)
    -   [`fetchModels`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=catalogue-service#/Product%20Catalogue/getAll_1)
    -   [`fetchType`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=catalogue-service#/Product%20Catalogue/getType)

### [经纪人服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service)

-   [经纪人](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer)
    -   [`fetchDealer`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/get)
    -   [`bulkFetchDealer`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/bulkGet)
    -   [`fetchDealerSuggestions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/getSuggestions)
    -   [`fetchDealerProfile`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/getProfile)
    -   [`putDealerProfile`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/updateProfile)
    -   [`setLogo`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/setLogo)
    -   [`setImage`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/setImage)
    -   [`putDealerDescription`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/setDescription)
    -   [`fetchDealerPreferences`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/getPreferences)
    -   [`putDealerPreferences`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Dealer/updatePreferences)
-   [产品](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Product)
    -   [`purchaseAndUseListingProduct`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Product/purchaseProductAndUseSubscriptionForListing)
    -   [`bulkPurchaseAndUseListingsProduct`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Product/bulkPurchaseProductAndUseSubscriptionForListing)
    -   [`fetchCarSaleTrackingSubscription`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/Product/getValidCarSaleTrackingSubscription)
-   [用户](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/User)
    -   [设置用户账户](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/User/updateAccount)
    -   [`deleteUser`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=dealer-service#/User/deleteUser)

### [电子邮件发送服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=email-delivery-service)

-   [`sendSupportCase`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=email-delivery-service#/Support%20Case/create)
-   [`resendMessageLead`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=email-delivery-service#/Email%20delivery/resendMessageLead)

### [用户通知服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service)

-   [已保存的搜索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search)
    -   [`sendSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/createSavedSearch)
    -   [`deleteSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/deleteSavedSearch)
    -   [`fetchSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/getSavedSearchByKey)
    -   [`enableSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/enableSavedSearch)
    -   [`extendSavedSearch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/extendSavedSearch)
    -   [`sendSavedSearchFeedback`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=user-notification-service#/Saved%20Search/createUnsubscribeFeedback)

### [报告服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service)

-   [经纪人库存](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Dealer%20Inventory)
    
    -   [`fetchDealerMakes`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Dealer%20Inventory/getDealerMakes)
    -   [`fetchDealerOrAssociationMakes`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Dealer%20Inventory/getAllDealerMakes)
    -   [`fetchDealerOrAssociationModels`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Dealer%20Inventory/getAllDealerModels)
-   [国家](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Country)
    
    -   [`fetchCountries`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Country/getAll)
-   [参考数据](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reference%20data)
    
    -   [`fetchReferenceData`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reference%20data/getReferenceData)
-   [呼叫跟踪](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Call%20Tracking)
    
    -   [`postCallTrackingEntry`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Call%20Tracking/createCallTrackingEntry)
-   [何等应用跟踪](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/WhatsApp%20Tracking)
    
    -   [`postWhatsappTrackingEntry`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/WhatsApp%20Tracking/createWhatsAppTrackingEntry)
-   [报告](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting)
    
    -   [`hideMessageLead`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/hideDealerMessageLead)
    -   [`hideCallLead`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/hideDealerCallLead)
    -   [`fetchDealerCallLeads`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/getAllDealerCallLeads)
    -   [`fetchDealerWhatsappLeads`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/WhatsApp%20Tracking/getAllDealerWhatsAppTrackingEntries)
    -   [`hideWhatsappLead`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/WhatsApp%20Tracking/hideDealerWhatsAppTrackingEntry)
    -   [`fetchCarSales`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/getDealerCarSales)
    -   [`fetchBuyerFeedbackBatch`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/getBuyerFeedbackBatch)
    -   [`fetchMessageLeads`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/getAllUserMessageLeads)
    -   [`fetchFavourites`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Reporting/getUserFavoriteListings)
-   [分析](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Analytics)
    
    -   [`fetchAnalyticsData`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Analytics/getDealerListingsMetrics)
    -   [`fetchDealerAnalytics`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=reporting-service#/Analytics/getDealerAnalytics)

### [汽车销售跟踪服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service)

-   [买方反馈](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buyer%20Feedback)
    
    -   [`addPurchaseConfirmation`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buyer%20Feedback/addPurchaseConfirmation)
-   [交易商反馈](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Dealer%20Feedback)
    
    -   [`postDealerFeedback`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Dealer%20Feedback/createDealerFeedback)
    -   [`postBulkDealerFeedback`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Dealer%20Feedback/bulkCreateDealerFeedback)
-   [汽车销售](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Car%20Sale)
    
    -   [`fetchCarSalesCount`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Car%20Sale/countCarSales)
    -   [`rejectCarSales`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Car%20Sale/addCarSaleRejection)
    -   [`deleteCarSalesRejection`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Car%20Sale/removeCarSaleRejection)
-   [现在买](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buy%20Now%20Application)
    
    -   [`sendBuyNowApplication`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buy%20Now%20Application/createBuyNowApplication)
    -   [`fetchBuyNowConfiguration`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buy%20Now%20Dealer/getConfiguration)
    -   [`markBuyNowApplicationAsPaid`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=car-sale-tracking-service#/Buy%20Now%20Application/markAsPaid)

### [买方服务](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service)

-   [信件线索](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Message%20Lead)
    
    -   [`sendMessageLead`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Message%20Lead/createMessageLead)
    -   [`fetchDealerMessageLeads`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Message%20Lead/getListingMessageLeads)
-   [列出问题](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question)
    
    -   [`fetchListingQuestions`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question/getAllByListingId)
    -   [`createQuestion`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question/create_2)
    -   [`fetchDealerQuestionLeads`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question/getAllByDealerId)
    -   [`saveAnswerToQuestion`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question/answer)
    -   [`deleteQuestion`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Listing%20question/delete_2)
-   [保护买方](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Buyer%20Protection)
    
    -   [`sendBuyerProtectionApplication`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Buyer%20Protection/createBuyerProtectionApplication)
-   [贷款](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Loan%20Interest)
    
    -   [`createLoanInterest`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/Loan%20Interest/create_3)
    -   [`calculateMonthlyRate`](https://listing-enrichment-service.preprod.carforyou.ch/swagger-ui/index.html#/Listing/calculateLoanUsingPOST)
-   [爱好](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Favorite%20Listing)
    
    -   [`saveFavourite`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Favorite%20Listing/create_1)
    -   [`saveFavourites`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Favorite%20Listing/bulkCreate_1)
    -   [`deleteFavourite`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Favorite%20Listing/delete_1)
-   [列出比较](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison)
    
    -   [`fetchListingComparisons`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison/getAll)
    -   [`fetchListingComparison`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison/get)
    -   [`createListingComparison`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison/create)
    -   [`updateListingComparison`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison/update)
    -   [`deleteListingComparison`](https://internal.carforyou.dev/api-docs/swagger-ui/?urls.primaryName=buyer-service#/User%20Listing%20Comparison/delete)
-   [租赁](https://internal.carforyou.dev/api-docs/swagger-ui/#/Leasing%20Interest)
    
    -   [`createLeasingInterest`](https://internal.carforyou.dev/api-docs/swagger-ui/#/Leasing%20Interest/create_4)

## 在测试中模仿

为了能在测试中嘲弄Api呼叫,你需要:

-   要求测试文件中对 API 调用进行嘲弄 :
    
    ```javascript
    import { fetchListing } from "@carforyou/api-client"
    ```
    
-   使用嘲笑来嘲笑模块:
    
    ```javascript
    jest.mock("@carforyou/api-client", () => ({
      // Add this if you want to have access to other exported methods
      ...jest.requireActual("@carforyou/api-client"),
      fetchListing: jest.fn(),
    }))
    ```
    
-   您现在可以建立每个测试基础的模拟:
    
    ```javascript
      (fetchListing as jest.Mock).mockReturnValue(`<your mocked data>`)
    ```
    
    只在 TypeScript 工程中需要打字
-   并期望模拟函数:
    
    ```javascript
    expect(fetchListing).toHaveBeenCalled()
    ```
    

记住,这在你的测试中创造了一个全球模拟。 你需要清除模拟状态 `beforeEach`数字 :

```javascript
  (fetchListing as jest.Mock).mockClear()
```

## 工厂

下列工厂出口:

-   `TypeFactory`
-   `SearchTypeFactory`
-   `OptionsFactory`
-   `ListingFactory`
-   `SearchListingFactory`
-   `EmptyListing` - 建立一个没有任何价值的列表
-   `ListingFromType` - 从类型中初始化一个含有数值的空列表
-   `SearchMessageLeadFactory` - 建立主电子邮件列表
-   `SearchCallLeadFactory` - 建立牵头呼叫列表

## 发展

```
npm run build
```

您可以将本地 npm 软件包链接到任何本地项目中 :

```
cd carforyou-api-client-pkg
npm run build

cd carforyou-listings-web
npm link ../carforyou-api-client-pkg
```

## 发布新版本

新版本在Ci上发布,使用语义-放出,一旦您合并为主. 请 确保您的合并承诺信息符合相应的公约.

## 常见问题

### @carforyou/api-client 是什么？

连接到 API 的 Api 客户端注意：该包已被作者标记为弃用——Platform was closed down and no longer maintained\. Check @smg-automotive/api-client-pkg as replacement

### 如何安装 @carforyou/api-client？

在项目目录运行 npm install @carforyou/api-client，或使用 pnpm add / yarn add / bun add。

### @carforyou/api-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @carforyou/api-client 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @carforyou/api-client 可以商用吗？

@carforyou/api-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @carforyou/api-client 的下载量有多少？

根据 npm 官方下载统计，@carforyou/api-client 在 2026/10/09 – 2026/11/07 这 30 天内被下载 12,259 次，日均约 409 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @carforyou/api-client 还在维护吗？

最新版本 46\.4\.1 发布于 2022/03/21（4 年前）；至今共发布 917 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/09/20。作者已将其标记为弃用，新项目建议寻找替代方案。