Class ByProjectKeyZonesRequestBuilder

Index

Constructors

Properties

Methods

get head post withId withKey

Constructors

constructor

new ByProjectKeyZonesRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyZonesRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyZonesRequestBuilder
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:14

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: string };
}

Methods

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: {
            expand?: string | string[];
            limit?: number;
            offset?: number;
            sort?: string | string[];
            where?: string | string[];
            withTotal?: boolean;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<ZonePagedQueryResponse>
Retrieves all Zones in the Project.
Parameters
- OptionalmethodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs?: {
          expand?: string | string[];
          limit?: number;
          offset?: number;
          sort?: string | string[];
          where?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<ZonePagedQueryResponse>
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:51

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if one or more Zones exist for the provided query predicate. Returns a 200 OK status if any Zones match the query predicate, or a Not Found error otherwise.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:82

post

post(
    methodArgs: {
        body: ZoneDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Zone>
Creates a Zone in the Project.
Parameters
- methodArgs: {
      body: ZoneDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Zone>
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:108

withId

withId(childPathArgs: { ID: string }): ByProjectKeyZonesByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyZonesByIDRequestBuilder
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:35

withKey

withKey(childPathArgs: { key: string }): ByProjectKeyZonesKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyZonesKeyByKeyRequestBuilder
- Defined in generated/client/zones/by-project-key-zones-request-builder.ts:23