Function ShopOrderApiAxiosParamCreator

ShopOrderApi - axios parameter creator

Export

  • ShopOrderApiAxiosParamCreator(
        configuration?: 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>


      OperationId: ShopOrderControllerCancel

      Throws

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

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

      Throws

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


      OperationId: ShopOrderControllerCreate

      Throws

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

      Throws

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

      Throws

Settings

Member Visibility