Type Alias ListOffersRequest

ListOffersRequest: {
    controlPanels?: string[];
    hostingId?: string;
    onlyOptions: boolean;
    orderBy?: Webhosting.v1alpha1.ListOffersRequestOrderBy;
    region?: Region;
    withoutOptions: boolean;
}

Type declaration

  • OptionalcontrolPanels?: string[]

    Name of the control panel to filter for.

  • OptionalhostingId?: string

    ID of a Web Hosting plan, to check compatibility with returned offers (in case of wanting to update the plan).

  • onlyOptions: boolean

    Defines whether the response should consist of options only, without offers.

  • OptionalorderBy?: Webhosting.v1alpha1.ListOffersRequestOrderBy

    Sort order of offers in the response.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • withoutOptions: boolean

    Defines whether the response should consist of offers only, without options.

Settings