Class ByProjectKeyCustomersSearchRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` `Readonly`args

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

Methods

head

head(
methodArgs?: { headers?: { [key: string]: string | string[] } },
): ApiRequest<void>
Checks whether a search index of Customers exists for a Project. Returns a 200 OK if an index exists; otherwise, returns a 409 Conflict.
Parameters
- OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }
Returns ApiRequest<void>
- Defined in generated/client/search/by-project-key-customers-search-request-builder.ts:55

post

post(
    methodArgs: {
        body: CustomerSearchRequest;
        headers?: { [key: string]: string | string[] };
    },
): ApiRequest<CustomerPagedSearchResponse>
If the initial indexing is in progress or the feature is inactive, a SearchNotReady error is returned. If inactive, you can reactivate it.
Parameters
- methodArgs: { body: CustomerSearchRequest; headers?: { [key: string]: string | string[] } }
Returns ApiRequest<CustomerPagedSearchResponse>
- Defined in generated/client/search/by-project-key-customers-search-request-builder.ts:29