Function ShopOrderApiAxiosParamCreator

ShopOrderApi - axios parameter creator

Export

  • ShopOrderApiAxiosParamCreator(configuration?): {
        shopOrderControllerCancel: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerClaim: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerCreate: ((shopOrderCreateDTO?: ShopOrderCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerSearch: ((shopOrderSearchInputDTO?: ShopOrderSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        shopOrderControllerCancel: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerClaim: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerCreate: ((shopOrderCreateDTO?: ShopOrderCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        shopOrderControllerSearch: ((shopOrderSearchInputDTO?: ShopOrderSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • shopOrderControllerCancel: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Cancel

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • shopOrderControllerClaim: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Claiming an order will mark it as completed and give the user the item in-game

      Summary

      Claim an order

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • shopOrderControllerCreate: ((shopOrderCreateDTO?: ShopOrderCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Create

      Throws

        • (shopOrderCreateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalshopOrderCreateDTO: ShopOrderCreateDTO

            ShopOrderCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • shopOrderControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get an order by its ID. This endpoint only returns orders that belong to the caller. When the caller has permission to view all orders, they can get any order.

      Summary

      Get order by ID

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • shopOrderControllerSearch: ((shopOrderSearchInputDTO?: ShopOrderSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Search for orders. By default, this endpoint only returns your own orders. When the caller has permission to view all orders, they can search for all orders.

      Summary

      Search orders

      Throws

        • (shopOrderSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalshopOrderSearchInputDTO: ShopOrderSearchInputDTO

            ShopOrderSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility