sap-commerce-sdk/dist/Basesites.ts

A TypeScript SDK for SAP Commerce Cloud storefront integration.

/* eslint-disable */
/* tslint:disable */
/*
 * ---------------------------------------------------------------
 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
 * ##                                                           ##
 * ## AUTHOR: acacode                                           ##
 * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
 * ---------------------------------------------------------------
 */

import { BaseSiteList, ErrorList } from "./data-contracts";
import { HttpClient, RequestParams } from "./http-client";

export class Basesites<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
  /**
   * @description Retrieves the base sites and the details of the corresponding base stores.
   *
   * @tags Base Sites
   * @name GetBaseSites
   * @summary Retrieves the base sites.
   * @request GET:/basesites
   * @secure
   */
  getBaseSites = (
    query?: {
      /**
       * Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL
       * @default "DEFAULT"
       */
      fields?: string;
    },
    params: RequestParams = {},
  ) =>
    this.request<BaseSiteList, ErrorList>({
      path: `/basesites`,
      method: "GET",
      query: query,
      secure: true,
      format: "json",
      ...params,
    });
}