Class ByProjectKeyDiscountGroupsRequestBuilder

Index

Constructors

Properties

Methods

get head post withId withKey

Constructors

constructor

new ByProjectKeyDiscountGroupsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyDiscountGroupsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyDiscountGroupsRequestBuilder
- Defined in generated/client/discount-groups/by-project-key-discount-groups-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<DiscountGroupPagedQueryResponse>
Retrieves all DiscountGroups 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<DiscountGroupPagedQueryResponse>
- Defined in generated/client/discount-groups/by-project-key-discount-groups-request-builder.ts:56

head

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

post

post(
    methodArgs: {
        body: DiscountGroupDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<DiscountGroup>
Creates a DiscountGroup in the Project. This request generates the DiscountGroupCreated Message.
```
If the [limit](/../api/limits#discount-groups) for active Discount Groups has been reached, a [MaxDiscountGroupsReached](ctp:api:type:MaxDiscountGroupsReachedError) error is returned.
```
Parameters
- methodArgs: {
      body: DiscountGroupDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<DiscountGroup>
- Defined in generated/client/discount-groups/by-project-key-discount-groups-request-builder.ts:119

withId

withId(
childPathArgs: { ID: string },
): ByProjectKeyDiscountGroupsByIDRequestBuilder
Parameters
- childPathArgs: { ID: string }
Returns ByProjectKeyDiscountGroupsByIDRequestBuilder
- Defined in generated/client/discount-groups/by-project-key-discount-groups-request-builder.ts:39

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyDiscountGroupsKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyDiscountGroupsKeyByKeyRequestBuilder
- Defined in generated/client/discount-groups/by-project-key-discount-groups-request-builder.ts:27