Class ByProjectKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` `Readonly` args

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

Type declaration

Optional baseUri?: string
executeRequest: executeRequest
pathArgs: {
projectKey: string;
}
- projectKey: string

Methods

emailConfirm

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

emailToken

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

get

get(methodArgs?): ApiRequest<CustomerPagedQueryResponse>
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;
    }
    - [key: string]: QueryParam
    - Optional expand?: string | string[]
    - Optional limit?: number
    - Optional offset?: number
    - Optional sort?: string | string[]
    - Optional where?: string | string[]
    - Optional withTotal?: boolean
Returns ApiRequest<CustomerPagedQueryResponse>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:131

head

head(methodArgs?): 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
- 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;
    }
    - [key: string]: QueryParam
    - Optional where?: string | string[]
Returns ApiRequest<void>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:162

post

post(methodArgs): 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;
      };
  }
  - body: CustomerDraft
  - Optional headers?: {
    [key: string]: string | string[];
    }
    - [key: string]: string | string[]
  - Optional queryArgs?: {
    expand?: string | string[];
    [key: string]: QueryParam;
    }
    - [key: string]: QueryParam
    - Optional expand?: string | string[]
Returns ApiRequest<CustomerSignInResult>
- Defined in generated/client/customers/by-project-key-customers-request-builder.ts:192

withEmailToken

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

withId

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

withKey

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

withPasswordToken

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

Class ByProjectKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Returns ByProjectKeyCustomersRequestBuilder

Properties

Protected Readonly args

Type declaration

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; }

projectKey: string

Methods

emailConfirm

Returns ByProjectKeyCustomersEmailConfirmRequestBuilder

emailToken

Returns ByProjectKeyCustomersEmailTokenRequestBuilder

get

Parameters

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; }

[key: string]: QueryParam

Optional expand?: string | string[]

Optional limit?: number

Optional offset?: number

Optional sort?: string | string[]

Optional where?: string | string[]

Optional withTotal?: boolean

Returns ApiRequest<CustomerPagedQueryResponse>

head

Parameters

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

Optional queryArgs?: { where?: string | string[]; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional where?: string | string[]

Returns ApiRequest<void>

password

Returns ByProjectKeyCustomersPasswordRequestBuilder

passwordReset

Returns ByProjectKeyCustomersPasswordResetRequestBuilder

passwordToken

Returns ByProjectKeyCustomersPasswordTokenRequestBuilder

post

Parameters

body: CustomerDraft

Optional headers?: { [key: string]: string | string[]; }

[key: string]: string | string[]

Optional queryArgs?: { expand?: string | string[]; [key: string]: QueryParam; }

[key: string]: QueryParam

Optional expand?: string | string[]

Returns ApiRequest<CustomerSignInResult>

withEmailToken

Parameters

emailToken: string

Returns ByProjectKeyCustomersEmailTokenByEmailTokenRequestBuilder

withId

Parameters

ID: string

Returns ByProjectKeyCustomersByIDRequestBuilder

withKey

Parameters

key: string

Returns ByProjectKeyCustomersKeyByKeyRequestBuilder

withPasswordToken

Parameters

passwordToken: string

Returns ByProjectKeyCustomersPasswordTokenByPasswordTokenRequestBuilder

Settings

Member Visibility

Theme

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Protected` `Readonly` args

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
}

`Optional` headers?: {
[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

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
where?: string | string[];
[key: string]: QueryParam;
}

`Optional` where?: string | string[]

`Optional` headers?: {
[key: string]: string | string[];
}

`Optional` queryArgs?: {
expand?: string | string[];
[key: string]: QueryParam;
}

`Optional` expand?: string | string[]