diff --git a/packages/stripe/src/clients/stripe.client.ts b/packages/stripe/src/clients/stripe.client.ts index 7450efa0a..81d824047 100644 --- a/packages/stripe/src/clients/stripe.client.ts +++ b/packages/stripe/src/clients/stripe.client.ts @@ -37,6 +37,11 @@ export class StripeClient implements StripeClientInterface{ ) { } + /** + * This method filters the Credentials Provider base on the provided this.credentialProviderUniqueName attribute. It + * checks that there's actually a credential provider that matches the provided unique name. + * @private + */ private getCredentialProvider(): CredentialsProviderInterface { if(!this.credentialProviderUniqueName) { this.logHandler.error(`The configuration '${StripeModuleKeyname}.credential_provider.name' contains an invalid unique name: '${this.credentialProviderUniqueName}'}`) diff --git a/packages/stripe/src/interfaces/credentials-provider.interface.ts b/packages/stripe/src/interfaces/credentials-provider.interface.ts index 279ceba0b..75d967cce 100644 --- a/packages/stripe/src/interfaces/credentials-provider.interface.ts +++ b/packages/stripe/src/interfaces/credentials-provider.interface.ts @@ -1,5 +1,11 @@ export interface CredentialsProviderInterface { + /** + * This method returns the Stripe API Key. + */ getStripeApiKey(): string; + /** + * This method returns a unique string uniquely identifying the Credential Provider. + */ getUniqueName(): string } \ No newline at end of file