city-gather/src/api/globals.d.ts

/* tslint:disable */
/* eslint-disable */
/**
 * Swagger Petstore - OpenAPI 3.0 - version 1.0.27
 *
 * This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
You can now help us improve the API whether it's by making changes to the definition itself or to the code.
That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:
- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
 *
 * OpenAPI version: 3.0.4
 *
 * Contact:
 *
 * NOTE: This file is auto generated by the alova's vscode plugin.
 *
 * https://alova.js.org/devtools/vscode
 *
 * **Do not edit the file manually.**
 */
import type { Alova, AlovaMethodCreateConfig, AlovaGenerics, Method } from 'alova';
import type { $$userConfigMap, alovaInstance } from './index';
import type apiDefinitions from './apiDefinitions';

type CollapsedAlova = typeof alovaInstance;
type UserMethodConfigMap = typeof $$userConfigMap;

type Alova2MethodConfig<Responded> =
  CollapsedAlova extends Alova<
    AlovaGenerics<
      any,
      any,
      infer RequestConfig,
      infer Response,
      infer ResponseHeader,
      infer L1Cache,
      infer L2Cache,
      infer SE
    >
  >
  ? Omit<
    AlovaMethodCreateConfig<
      AlovaGenerics<Responded, any, RequestConfig, Response, ResponseHeader, L1Cache, L2Cache, SE>,
      any,
      Responded
    >,
    'params'
  >
  : never;

// Extract the return type of transform function that define in $$userConfigMap, if it not exists, use the default type.
type ExtractUserDefinedTransformed<
  DefinitionKey extends keyof typeof apiDefinitions,
  Default
> = DefinitionKey extends keyof UserMethodConfigMap
  ? UserMethodConfigMap[DefinitionKey]['transform'] extends (...args: any[]) => any
  ? Awaited<ReturnType<UserMethodConfigMap[DefinitionKey]['transform']>>
  : Default
  : Default;
type Alova2Method<
  Responded,
  DefinitionKey extends keyof typeof apiDefinitions,
  CurrentConfig extends Alova2MethodConfig<any>
> =
  CollapsedAlova extends Alova<
    AlovaGenerics<
      any,
      any,
      infer RequestConfig,
      infer Response,
      infer ResponseHeader,
      infer L1Cache,
      infer L2Cache,
      infer SE
    >
  >
  ? Method<
    AlovaGenerics<
      CurrentConfig extends undefined
      ? ExtractUserDefinedTransformed<DefinitionKey, Responded>
      : CurrentConfig['transform'] extends (...args: any[]) => any
      ? Awaited<ReturnType<CurrentConfig['transform']>>
      : ExtractUserDefinedTransformed<DefinitionKey, Responded>,
      any,
      RequestConfig,
      Response,
      ResponseHeader,
      L1Cache,
      L2Cache,
      SE
    >
  >
  : never;

export interface ApiResponse {
  code?: number;
  type?: string;
  msg?: string;
  data: any
}

interface listData<T> {
  data?: {
    list: T[]
  }
}
interface apiResData<T> {
  data: T;
  code: string
  msg: string
}
declare global {
  interface Apis {
    sys: {
      auth<
        Config extends Alova2MethodConfig<apiResData<logoinToken>> & {
          params: loginModel;
        }
      >(
        config: Config
      ): Alova2Method<apiResData<logoinToken>, 'sys.auth', Config>;
      userInfo<
        Config extends Alova2MethodConfig<apiResData<userInfo>>
      >(
        config: Config
      ): Alova2Method<apiResData<userInfo>, 'sys.userInfo', Config>;
      updateUserInfo<
        Config extends Alova2MethodConfig<any> & {
          pathParams: { memberId: number };
          data: Api.userInfo;
        }
      >(
        config: Config
      ): Alova2Method<any, 'sys.updateUserInfo', Config>;
      uploadFile<
        Config extends Alova2MethodConfig<{ url: string }> & {
          data: {
            name: string;
            filePath: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<{ url: string }, 'sys.uploadFile', Config>;
      addresses<
        Config extends Alova2MethodConfig<apiResData<Api.addressList[]>> & {

        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.addressList[]>, 'sys.addresses', Config>;
      Addaddresses<
        Config extends Alova2MethodConfig<any> & {
          data: Api.addressList;
        }
      >(
        config: Config
      ): Alova2Method<any, 'sys.Addaddresses', Config>;
      deleteAddresses<
        Config extends Alova2MethodConfig<any> & {
          pathParams: { ids: string };
        }
      >(
        config: Config
      ): Alova2Method<any, 'sys.deleteAddresses', Config>;
      updateAddresses<
        Config extends Alova2MethodConfig<any> & {
          data: Api.addressList;
        }
      >(
        config: Config
      ): Alova2Method<any, 'sys.updateAddresses', Config>;
      addressesDetail<
        Config extends Alova2MethodConfig<apiResData<Api.addressList>> & {
          pathParams: { addressId: number };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.addressList>, 'sys.addressesDetail', Config>;
      dictPage<
        Config extends Alova2MethodConfig<listData<Api.sysDict>> & {
          data: {
            typeCode: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<listData<Api.sysDict>, 'sys.dictPage', Config>;
    }
    xsb: {
      refundDetails<
        Config extends Alova2MethodConfig<apiResData<Api.OrderRefundDetails>> & {
          data: {
             refundNumber: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.OrderRefundDetails>, 'xsb.refundList', Config>;
      refundCancel<
        Config extends Alova2MethodConfig<any> & {
          data: {
            refundNumber: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<any, 'xsb.refundCancel', Config>;
      refundList<
        Config extends Alova2MethodConfig<listData<Api.AppRefundOrderListVo>> & {
          data: {
            pageNum: number;
            pageSize:number
          };
        }
      >(
        config: Config
      ): Alova2Method<listData<Api.AppRefundOrderListVo>, 'xsb.refundList', Config>;
      getWaybillToken<
        Config extends Alova2MethodConfig<apiResData<any>> & {
          data: {
            orderNumber: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<any>, 'xsb.getWaybillToken', Config>;
      findByOrderNumber<
        Config extends Alova2MethodConfig<apiResData<Api.xsbOmsOrderItem[]>> & {
          data: {
            orderNumber: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbOmsOrderItem[]>, 'xsb.findByOrderNumber', Config>;
      deliveryNode<
        Config extends Alova2MethodConfig<apiResData<Api.DeliveryNode[]>> & {
          data: {
            orderNumber: string;
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.DeliveryNode[]>, 'xsb.deliveryNode', Config>;
      riderInfo<
        Config extends Alova2MethodConfig<apiResData<Api.RiderInfo>> & {
          data: {
            orderNumber: string
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.RiderInfo>, 'xsb.riderInfo', Config>;
      calculateMoney<
        Config extends Alova2MethodConfig<apiResData<any>> & {
          data: {
            orderRefundSkuList: { orderItemId: number, productCount: number }[];
            orderNumber: string
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<any>, 'xsb.applyRefund', Config>;
      applyRefund<
        Config extends Alova2MethodConfig<apiResData<any>> & {
          data: {
            /**
    * 退款类型 1,仅退款,2退款退货,5差价退款
    */
            applyType?: number;
            /**
             * 退款订单业务类型 1-星闪豹
             */
            businessType?: number;
            /**
             * 备注说明
             */
            buyerDesc?: string;
            /**
             * 手机号码（默认当前订单手机号码）
             */
            buyerMobile?: string;
            /**
             * 仅退款-未收到货申请原因
             * 11(质量问题)
             * 12(拍错/多拍/不喜欢)
             * 3(商品描述不符)
             * 14(假货), 15(商家发错货)
             * 16(商品破损/少件)
             * 17(其他)
             * 仅退款-已收到货申请原因
             * 51(多买/买错/不想要)
             * 52(快递无记录)
             * 53(少货/空包裹)
             * 54(未按约定时间发货)
             * 55(快递一直未送达)
             * 56(其他)
             * 退货退款-申请原因
             * 101(商品破损/少件)
             * 102(商家发错货)
             * 103(商品描述不符)
             * 104(拍错/多拍/不喜欢)
             * 105(质量问题)
             * 107(其他)
             */
            buyerReason?: string;
            /**
             * 订单编号
             */
            orderNumber?: string;
            /**
             * 退款商品详情
             */
            orderRefundSkuList?: AppOrderRefundSkuVo[];
            /**
             * 凭证图片列表使用,分割
             */
            photoFiles?: string;
            /**
             * 退款金额
             */
            refundAmount?: number;
            /**
             * 退款单类型（1:整单退款,2:单个物品退款）
             */
            refundType?: number;
            [property: string]: any;
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<any>, 'xsb.applyRefund', Config>;
      nearestShop<
        Config extends Alova2MethodConfig<apiResData<{ nearestShopId: number }>> & {
          data: {
            latitude: number;
            longitude: number
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<{ nearestShopId: number }>, 'xsb.nearestShop', Config>;
      categories<
        Config extends Alova2MethodConfig<apiResData<Api.xsbCategories[]>> & {
          data: {
            channelId: number;
            shopId: number
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbCategories[]>, 'xsb.categories', Config>;
      getCategoryProductList<
        Config extends Alova2MethodConfig<apiResData<Api.xsbCategoryProductList[]>> & {
          data: {
            categoryId: number;
            shopId: number
            channelId: number
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbCategoryProductList[]>, 'xsb.getCategoryProductList', Config>;
      getProductDetail<
        Config extends Alova2MethodConfig<apiResData<Api.xsbProductDetail>> & {
          data: {
            id: number;
            shopId: number
            channelId: number
          };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbProductDetail>, 'xsb.getProductDetail', Config>;
      findUserPoints<
        Config extends Alova2MethodConfig<apiResData<Api.xsbFindUserPoints>> & {

        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbFindUserPoints>, 'xsb.findUserPoints', Config>;
      findUserPointsPage<
        Config extends Alova2MethodConfig<listData<Api.xsbFindUserPointsPage>> & {
          data: {
            pageNum: number;
            pageSize: number;
          };
        }
      >(
        config: Config
      ): Alova2Method<listData<Api.xsbFindUserPointsPage>, 'xsb.findUserPointsPage', Config>;
      getSearchProductList<
        Config extends Alova2MethodConfig<listData<Api.xsbCategoryProductList>> & {
          data: {
            /**
   * 暂定为商品名称，后面可能会加其他条件
   */
            keywords?: string;
            /**
             * 页码
             */
            pageNum?: number;
            /**
             * 每页记录数
             */
            pageSize?: number;
            /**
             * 价格排序不传时为空，默认不排 ASC:价格升序，DESC:价格倒序
             */
            priceSort?: string;
            /**
             * 销量排序不传时为空，默认不排 ASC:价格升序，DESC:价格倒序
             */
            salesNum?: string;
            shopId: number
            channelId: number
          };
        }
      >(
        config: Config
      ): Alova2Method<listData<Api.xsbCategoryProductList>, 'xsb.getSearchProductList', Config>;
      appAdvertInfo<
        Config extends Alova2MethodConfig<apiResData<Api.xsbAdvertInfo[]>> & {
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbAdvertInfo[]>, 'xsb.appAdvertInfo', Config>;
      SearchTerm<
        Config extends Alova2MethodConfig<apiResData<Api.xsbSearchTerm[]>> & {
          data: {
            type: number
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbSearchTerm[]>, 'xsb.SearchTerm', Config>;
      shopList<
        Config extends Alova2MethodConfig<apiResData<Api.xsbShopList[]>> & {
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbShopList[]>, 'xsb.shopList', Config>;
      orderList<
        Config extends Alova2MethodConfig<listData<Api.xsbOrderList>> & {
          data: {
            businessType?: string;
            orderStatus?: string;
            pageNum?: number;
            pageSize?: number;
            dvyType?: number | string;
          }
        }
      >(
        config: Config
      ): Alova2Method<listData<Api.xsbOrderList>, 'xsb.orderList', Config>;
      orderInfo<
        Config extends Alova2MethodConfig<apiResData<Api.xsbOrderList>> & {
          data: {
            orderNo: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbOrderList>, 'xsb.orderInfo', Config>;
      cancelOrder<
        Config extends Alova2MethodConfig<any> & {
          data: {
            orderNo: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<any, 'xsb.cancelOrder', Config>;
      deleteOrder<
        Config extends Alova2MethodConfig<any> & {
          pathParams: {
            ids: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<any, 'xsb.deleteOrder', Config>;
      skuOrderConfirm<
        Config extends Alova2MethodConfig<apiResData<Api.AppletOrderSkuVo>> & {
          data: {
            channelId?: number;
            num?: number;
            shopId?: number;
            skuId?: number;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.AppletOrderSkuVo>, 'xsb.skuOrderConfirm', Config>;
      myShoppingCartCategory<
        Config extends Alova2MethodConfig<apiResData<Api.xsbCategoriesCartList[]>> & {
          data: {
            channelId?: number;
            shopId?: number;
            businessType?: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.xsbCategoriesCartList[]>, 'xsb.myShoppingCartCategory', Config>;
      delivery<
        Config extends Alova2MethodConfig<apiResData<Api.xsbShoppingCartList[]>> & {
          data: {
            memberId?: number;
            shopId?: number;
            addressId?: number;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<{ deliveryType: number }>, 'xsb.delivery', Config>;
      confirmReceipt<
        Config extends Alova2MethodConfig<any> & {
          data: {
            orderNumber: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<any, 'xsb.confirmReceipt', Config>;
    }
    common: {
      myShoppingCart<
        Config extends Alova2MethodConfig<apiResData<Api.myShoppingCart[]>> & {
          data: {
            businessType: string;
            channelId: number;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.myShoppingCart[]>, 'common.myShoppingCart', Config>;
      addShoppingCart<
        Config extends Alova2MethodConfig<apiResData<Api.addShoppingCart>> & {
          data: {
            /**
              * 业务类型
            */
            businessType: string;
            /**
             * 渠道
             */
            channelId: number;
            /**
             * 数量
             */
            num: number;
            /**
             * 门店
             */
            shopId: number;
            /**
             * sku_id
             */
            skuId: number;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.addShoppingCart>, 'common.addShoppingCart', Config>;
      deleteShoppingCart<
        Config extends Alova2MethodConfig<apiResData<Api.deleteShoppingCart>> & {
          pathParams: { ids: string };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.deleteShoppingCart>, 'common.deleteShoppingCart', Config>;
      shoppingCartOrderConfirm<
        Config extends Alova2MethodConfig<apiResData<Api.shoppingCartOrderConfirm>> & {
          pathParams: { ids: string };
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.shoppingCartOrderConfirm>, 'common.shoppingCartOrderConfirm', Config>;
      addOrder<
        Config extends Alova2MethodConfig<any> & {
          data: {
            /**
       * 收货人地址id
       */
            addressId: number;
            /**
             * 业务类型
             */
            businessType: string;
            /**
             * 企业ID
             */
            channelId: number;
            /**
             * 配送类型 1:快递 2:自提 3：及时配送
             */
            dvyType: number;
            /**
             * 订单运费
             */
            freightAmount: number;
            /**
             * 商品信息
             */
            orderItemList: {
              /**
               * 数量
               */
              prodCount?: number;
              /**
               * 产品SkuID
               */
              skuId?: number;
              [property: string]: any;
            }[];
            /**
             * 买家备注
             */
            remarks?: string;
            /**
             * 店铺id
             */
            shopId: number;
            [property: string]: any;
          }
        }
      >(
        config: Config
      ): Alova2Method<any, 'common.addOrder', Config>;
      hybridPayment<
        Config extends Alova2MethodConfig<apiResData<wxpay>> & {
          data: {
            orderNumber: string;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<wxpay>, 'common.hybridPayment', Config>;
    }
    smqjh: {
      getCategoryList<
        Config extends Alova2MethodConfig<apiResData<Api.smqjhCategoryList[]>> & {
          data: {
            /**
    * 分类名称
    */
            name?: string;
            /**
             * 父级id
             */
            parentId?: number;
            /**
             * 分类状态
             */
            visible?: number;
          }
        }
      >(
        config: Config
      ): Alova2Method<apiResData<Api.smqjhCategoryList[]>, 'smqjh.getCategoryList', Config>;
    }

  }

  var Apis: Apis;
}


export interface loginModel {
  captchaCode?: string;
  code?: string;
  grant_type?: string;
  mobile?: string;
  password?: string;
  [property: string]: any;
}

export interface logoinToken {
  access_token: string
  code: string
  expires_in: number
  phoneCode: string
  refresh_token: string
  token_type: string
}

export interface wxpay {
  appId: string
  nonceStr: string
  package: string
  paySign: string
  signType: string
  timeStamp: string
  /**
   * 支付方式 0-微信 1-积分 2-混合
   */
  payType: number
}