Class ByProjectKeyStoresRequestBuilder
Constructors
constructor
- new ByProjectKeyStoresRequestBuilder(args): ByProjectKeyStoresRequestBuilder
Parameters
- args: {
baseUri?: string;
executeRequest: executeRequest;
pathArgs: {
projectKey: string;
};
}Optional baseUri?: string
pathArgs: {
projectKey: string;
}
Properties
Protected Readonly args
args: { baseUri?: string; executeRequest: executeRequest; pathArgs: { projectKey: string; }; } Type declaration
Optional baseUri?: string
pathArgs: {
projectKey: string;
}
Methods
get
- get(methodArgs?): ApiRequest<StorePagedQueryResponse>
Parameters
Optional 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;
};
}Optional headers?: {
[key: string]: string | string[];
}
[key: string]: string | string[]
Optional queryArgs?: {
expand?: string | string[];
limit?: number;
offset?: number;
sort?: string | string[];
where?: string | string[];
withTotal?: boolean;
[key: string]: QueryParam;
}
Optional expand?: string | string[]
Optional limit?: number
Optional offset?: number
Optional sort?: string | string[]
Optional where?: string | string[]
Optional withTotal?: boolean
head
- head(methodArgs?): ApiRequest<void>
Parameters
Optional methodArgs: {
headers?: {
[key: string]: string | string[];
};
queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
};
}Optional headers?: {
[key: string]: string | string[];
}
[key: string]: string | string[]
Optional queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
}
Optional where?: string | string[]
Returns ApiRequest<void>
post
- post(methodArgs): ApiRequest<Store>
Parameters
- methodArgs: {
body: StoreDraft;
headers?: {
[key: string]: string | string[];
};
queryArgs?: {
expand?: string | string[];
[key: string]: QueryParam;
};
}Optional headers?: {
[key: string]: string | string[];
}
[key: string]: string | string[]
Optional queryArgs?: {
expand?: string | string[];
[key: string]: QueryParam;
}
Optional expand?: string | string[]
Returns ApiRequest<Store>
Checks if a Store exists for a given Query Predicate. Returns a
200 OKstatus if any Stores match the Query Predicate or a404 Not Foundotherwise.