Function ShopOrderApiFp

ShopOrderApi - functional programming interface

Export

  • ShopOrderApiFp(
        configuration?: Configuration,
    ): {
        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>,
        >;
    }

  • 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
      • shopOrderControllerCancel(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShopOrderOutputDTOAPI>,
        >


      • OperationId: ShopOrderControllerCancel

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • shopOrderControllerClaim:function
      • shopOrderControllerClaim(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShopOrderOutputDTOAPI>,
        >

      • 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>,
        >

        Throws

    • shopOrderControllerCreate:function
      • shopOrderControllerCreate(
            shopOrderCreateDTO?: ShopOrderCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShopOrderOutputDTOAPI>,
        >


      • OperationId: ShopOrderControllerCreate

        Parameters

        • OptionalshopOrderCreateDTO: ShopOrderCreateDTO

          ShopOrderCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • shopOrderControllerGetOne:function
      • shopOrderControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShopOrderOutputDTOAPI>,
        >

      • 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>,
        >

        Throws

    • shopOrderControllerSearch:function
      • shopOrderControllerSearch(
            shopOrderSearchInputDTO?: ShopOrderSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ShopOrderOutputArrayDTOAPI>,
        >

      • 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>,
        >

        Throws

Settings

Member Visibility