Class ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` `Readonly` args

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

Type declaration

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

Methods

emailConfirm

emailToken

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-in-store-key-by-store-key-customers-request-builder.ts:141

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-in-store-key-by-store-key-customers-request-builder.ts:172

password

passwordReset

passwordToken

post

post(methodArgs): ApiRequest<CustomerSignInResult>

When using this endpoint, if omitted, the Customer stores field is set to the Store specified in the path parameter.

If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart).
Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`.
If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter.

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>

Class ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; storeKey: string; }

projectKey: string

storeKey: string

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersRequestBuilder

Properties

Protected Readonly args

Type declaration

Optional baseUri?: string

executeRequest: executeRequest

pathArgs: { projectKey: string; storeKey: string; }

projectKey: string

storeKey: string

Methods

emailConfirm

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmRequestBuilder

emailToken

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenRequestBuilder

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 ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordRequestBuilder

passwordReset

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetRequestBuilder

passwordToken

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenRequestBuilder

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 ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenRequestBuilder

withId

Parameters

ID: string

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersByIDRequestBuilder

withKey

Parameters

key: string

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

withPasswordToken

Parameters

passwordToken: string

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenRequestBuilder

Settings

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
storeKey: string;
}

`Protected` `Readonly` args

`Optional` baseUri?: string

pathArgs: {
projectKey: string;
storeKey: 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[]