Class ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`args

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

Methods

delete

delete(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            dataErasure?: boolean;
            expand?: string | string[];
            version: number;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<Customer>
Deleting a Customer produces the CustomerDeleted Message.
```
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
```
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          dataErasure?: boolean;
          expand?: string | string[];
          version: number;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<Customer>
- Defined in generated/client/customers/by-project-key-in-store-key-by-store-key-customers-key-by-key-request-builder.ts:112

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Customer>
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
Parameters
- OptionalmethodArgs: {
  headers?: { [key: string]: string | string[] };
  queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Customer>
- Defined in generated/client/customers/by-project-key-in-store-key-by-store-key-customers-key-by-key-request-builder.ts:27

head

head(
methodArgs?: { headers?: { [key: string]: string | string[] } },
): ApiRequest<void>
Checks if a Customer exists with the provided key. Returns a 200 status if the Customer exists, or a 404 status otherwise.
Parameters
- OptionalmethodArgs: { headers?: { [key: string]: string | string[] } }
Returns ApiRequest<void>
- Defined in generated/client/customers/by-project-key-in-store-key-by-store-key-customers-key-by-key-request-builder.ts:54

post

post(
    methodArgs: {
        body: CustomerUpdate;
        headers?: { [key: string]: string | string[] };
        queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
    },
): ApiRequest<Customer>
If the Customer exists in the Project but the stores field references a different Store, this method returns a ResourceNotFound error.
```
Simultaneously updating two Customers with the same email address can return a [LockedField](ctp:api:type:LockedFieldError) error.
```
Parameters
- methodArgs: {
      body: CustomerUpdate;
      headers?: { [key: string]: string | string[] };
      queryArgs?: { expand?: string | string[]; [key: string]: QueryParam };
  }
Returns ApiRequest<Customer>
- Defined in generated/client/customers/by-project-key-in-store-key-by-store-key-customers-key-by-key-request-builder.ts:79

Class ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

Properties

`Protected` `Readonly`args

Methods

delete

Parameters

Returns ApiRequest<Customer>

get

Parameters

Returns ApiRequest<Customer>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Customer>

Settings

On This Page

Class ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyRequestBuilder

Properties

Protected Readonlyargs

Methods

delete

Parameters

Returns ApiRequest<Customer>

get

Parameters

Returns ApiRequest<Customer>

head

Parameters

Returns ApiRequest<void>

post

Parameters

Returns ApiRequest<Customer>

Settings

On This Page

`Protected` `Readonly`args