Class ByProjectKeyMeQuoteRequestsRequestBuilder

Index

Constructors

Properties

Methods

get head post withId withKey

Constructors

constructor

new ByProjectKeyMeQuoteRequestsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyMeQuoteRequestsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyMeQuoteRequestsRequestBuilder
- Defined in generated/client/quote-requests/by-project-key-me-quote-requests-request-builder.ts:18

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<QuoteRequestPagedQueryResponse>
Retrieves all QuoteRequests for the authenticated Customer. Returns a 200 OK status if successful.
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<QuoteRequestPagedQueryResponse>
- Defined in generated/client/quote-requests/by-project-key-me-quote-requests-request-builder.ts:57

head

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

post

post(
    methodArgs: {
        body: MyQuoteRequestDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<QuoteRequest>
Creates a QuoteRequest for the authenticated Customer.
Parameters
- methodArgs: {
      body: MyQuoteRequestDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<QuoteRequest>
- Defined in generated/client/quote-requests/by-project-key-me-quote-requests-request-builder.ts:117

withId

withId(
childPathArgs: { ID: string },
): ByProjectKeyMeQuoteRequestsByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyMeQuoteRequestsByIDRequestBuilder
- Defined in generated/client/quote-requests/by-project-key-me-quote-requests-request-builder.ts:27

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyMeQuoteRequestsKeyByKeyRequestBuilder
- Defined in generated/client/quote-requests/by-project-key-me-quote-requests-request-builder.ts:39