Class ByProjectKeyCustomersPasswordTokenRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` `Readonly`args

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

Methods

post

post(
    methodArgs: {
        body: CustomerCreatePasswordResetToken;
        headers?: { [key: string]: string | string[] };
    },
): ApiRequest<CustomerToken>
Use this method to create a password reset token for a global Customer during their password reset process.
```
Creating a password reset token for the Customer produces the [CustomerPasswordTokenCreated](ctp:api:type:CustomerPasswordTokenCreatedMessage) Message.
The Message will include the token's value, if the token's validity is 60 minutes or less.
```
Parameters
- methodArgs: {
  body: CustomerCreatePasswordResetToken;
  headers?: { [key: string]: string | string[] };
  }
Returns ApiRequest<CustomerToken>
- Defined in generated/client/password-token/by-project-key-customers-password-token-request-builder.ts:31