Takaro - v0.6.0
    Preparing search index...

    Function ShopOrderApiFp

    • ShopOrderApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          shopOrderControllerCancel(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >;
          shopOrderControllerClaim(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >;
          shopOrderControllerCreate(
              shopOrderCreateDTO?: ShopOrderCreateDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >;
          shopOrderControllerGetOne(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >;
          shopOrderControllerSearch(
              shopOrderSearchInputDTO?: ShopOrderSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputArrayDTOAPI>,
          >;
      }

      • shopOrderControllerCancel: function

        • OperationId: ShopOrderControllerCancel

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >

      • shopOrderControllerClaim: function
        • Claiming an order will mark it as completed and give the user the item in-game
          OperationId: ShopOrderControllerClaim

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >

      • shopOrderControllerCreate: function

        • OperationId: ShopOrderControllerCreate

          Parameters

          • OptionalshopOrderCreateDTO: ShopOrderCreateDTO

            ShopOrderCreateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >

      • shopOrderControllerGetOne: function
        • 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.
          OperationId: ShopOrderControllerGetOne

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputDTOAPI>,
          >

      • shopOrderControllerSearch: function
        • 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.
          OperationId: ShopOrderControllerSearch

          Parameters

          • OptionalshopOrderSearchInputDTO: ShopOrderSearchInputDTO

            ShopOrderSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopOrderOutputArrayDTOAPI>,
          >