Class ByProjectKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

emailConfirm emailToken get head password passwordReset passwordToken post search searchIndexingStatus withEmailToken withId withKey withPasswordToken

Constructors

constructor

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

Properties

`Protected` `Readonly`args

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

Methods

emailConfirm

emailConfirm(): ByProjectKeyCustomersEmailConfirmRequestBuilder
Returns ByProjectKeyCustomersEmailConfirmRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:69

emailToken

emailToken(): ByProjectKeyCustomersEmailTokenRequestBuilder
Returns ByProjectKeyCustomersEmailTokenRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:60

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<CustomerPagedQueryResponse>
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<CustomerPagedQueryResponse>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:155

head

head(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<void>
Checks if a Customer exists for a given Query Predicate. Returns a 200 OK status if any Customers match the Query Predicate, or a 404 Not Found otherwise.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<void>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:186

post

post(
    methodArgs: {
        body: CustomerDraft;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<CustomerSignInResult>
If the anonymousCart field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the anonymousId field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same anonymousId.
```
Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. Simultaneously creating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
```
Parameters
- methodArgs: {
      body: CustomerDraft;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<CustomerSignInResult>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:216

search

search(): ByProjectKeyCustomersSearchRequestBuilder
This endpoint provides high-performance search queries over Customers.

Returns ByProjectKeyCustomersSearchRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:136

searchIndexingStatus

searchIndexingStatus(): ByProjectKeyCustomersSearchIndexingStatusRequestBuilder
Returns ByProjectKeyCustomersSearchIndexingStatusRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:145

withEmailToken

withEmailToken(
childPathArgs: { emailToken: string },
): ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder
Parameters
- childPathArgs: { emailToken: string }
Returns ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:48

withId

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

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyCustomersKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyCustomersKeyByKeyRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:108

withPasswordToken

withPasswordToken(
childPathArgs: { passwordToken: string },
): ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder
Parameters
- childPathArgs: { passwordToken: string }
Returns ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:36

Class ByProjectKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyCustomersRequestBuilder

Properties

Protected Readonlyargs

Methods

emailConfirm

Returns ByProjectKeyCustomersEmailConfirmRequestBuilder

emailToken

Returns ByProjectKeyCustomersEmailTokenRequestBuilder

get

Parameters

Returns ApiRequest<CustomerPagedQueryResponse>

head

Parameters

Returns ApiRequest<void>

password

Returns ByProjectKeyCustomersPasswordRequestBuilder

passwordReset

Returns ByProjectKeyCustomersPasswordResetRequestBuilder

passwordToken

Returns ByProjectKeyCustomersPasswordTokenRequestBuilder

post

Parameters

Returns ApiRequest<CustomerSignInResult>

search

Returns ByProjectKeyCustomersSearchRequestBuilder

searchIndexingStatus

Returns ByProjectKeyCustomersSearchIndexingStatusRequestBuilder

withEmailToken

Parameters

Returns ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder

withId

Parameters

Returns ByProjectKeyCustomersByIDRequestBuilder

withKey

Parameters

Returns ByProjectKeyCustomersKeyByKeyRequestBuilder

withPasswordToken

Parameters

Returns ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder

Settings

On This Page

`Protected` `Readonly`args