Update function name purgeSendingQueue

sinch · Dec 12, 2024 · caa680c · caa680c
1 parent 68c14c5
commit caa680c
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/...s/src/mailgun/emails/purgeDomainQueues.ts → ...s/src/mailgun/emails/purgeSendingQueue.ts b/...s/src/mailgun/emails/purgeDomainQueues.ts → ...s/src/mailgun/emails/purgeSendingQueue.ts
@@ -1,18 +1,18 @@
 import { getMailgunDomainFromConfig, initMailgunService, printFullResponse } from '../../config';
 
 (async () => {
-  console.log('********************');
-  console.log('* PurgeDomainQueue *');
-  console.log('********************');
+  console.log('*********************');
+  console.log('* PurgeSendingQueue *');
+  console.log('*********************');
 
   const domainName = getMailgunDomainFromConfig();
 
   const mailgunService = initMailgunService();
   let response;
   try {
-    response = await mailgunService.emails.purgeDomainQueue(domainName, 'https://storage-us-west1.api.mailgun.net');
+    response = await mailgunService.emails.purgeSendingQueue(domainName, 'https://storage-us-west1.api.mailgun.net');
   } catch (error) {
-    console.error('Error when trying to purge the domain queue');
+    console.error('Error when trying to purge the sending queue');
     throw error;
   }
 

diff --git a/packages/mailgun/src/rest/v1/emails/emails-api.jest.fixture.ts b/packages/mailgun/src/rest/v1/emails/emails-api.jest.fixture.ts
@@ -23,9 +23,9 @@ export class EmailsApiFixture implements Partial<Readonly<EmailsApi>> {
    */
   public getStoredEmail: jest.Mock<Promise<GetStoredEmailResponse>, [string, string]> = jest.fn();
   /**
-   * Fixture associated to function purgeDomainQueue
+   * Fixture associated to function purgeSendingQueue
    */
-  public purgeDomainQueue: jest.Mock<Promise<GenericResponse>, [string, MailgunStorageHostname]> = jest.fn();
+  public purgeSendingQueue: jest.Mock<Promise<GenericResponse>, [string, MailgunStorageHostname]> = jest.fn();
   /**
    * Fixture associated to function getSendingQueuesStatus
    */

diff --git a/packages/mailgun/src/rest/v1/emails/emails-api.ts b/packages/mailgun/src/rest/v1/emails/emails-api.ts
@@ -130,7 +130,7 @@ export class EmailsApi extends MailgunDomainApi {
    * @param { string } domainName - The name of the domain you want to delete envelope from
    * @param { MailgunStorageHostname } storageHostname - The storage hostname to be purged
    */
-  public async purgeDomainQueue(
+  public async purgeSendingQueue(
     domainName: string,
     storageHostname: MailgunStorageHostname,
   ): Promise<GenericResponse> {
@@ -156,7 +156,7 @@ export class EmailsApi extends MailgunDomainApi {
       url,
       requestOptions,
       apiName: this.apiName,
-      operationId: 'purgeDomainQueue',
+      operationId: 'purgeSendingQueue',
     });
 
     return transformGenericResponseIntoClientResponse(apiResponse);

diff --git a/packages/mailgun/tests/rest/v1/emails/emails-api.test.ts b/packages/mailgun/tests/rest/v1/emails/emails-api.test.ts
@@ -73,20 +73,20 @@ describe('EmailsApi', () => {
     });
   });
 
-  describe('purgeDomainQueues', () => {
-    it('should make a DELETE request to purge the domain queues', async () => {
+  describe('purgeSendingQueue', () => {
+    it('should make a DELETE request to purge a sending queue', async () => {
       // Given
       const domainName: string = 'domainName';
       const storageHostname: MailgunStorageHostname = 'storageHostname';
 
       // When
-      fixture.purgeDomainQueue.mockResolvedValue(genericResponse);
-      emailsApi.purgeDomainQueue = fixture.purgeDomainQueue;
-      const response = await emailsApi.purgeDomainQueue(domainName, storageHostname);
+      fixture.purgeSendingQueue.mockResolvedValue(genericResponse);
+      emailsApi.purgeSendingQueue = fixture.purgeSendingQueue;
+      const response = await emailsApi.purgeSendingQueue(domainName, storageHostname);
 
       // Then
       expect(response).toEqual(genericResponse);
-      expect(fixture.purgeDomainQueue).toHaveBeenCalledWith(domainName, storageHostname);
+      expect(fixture.purgeSendingQueue).toHaveBeenCalledWith(domainName, storageHostname);
     });
   });
 

diff --git a/packages/mailgun/tests/rest/v1/emails/emails.steps.ts b/packages/mailgun/tests/rest/v1/emails/emails.steps.ts
@@ -7,7 +7,7 @@ let sendEmailResponse: Mailgun.SendEmailResponse;
 let sendMimeEmailResponse: Mailgun.SendEmailResponse;
 let getEmailResponse: Mailgun.GetStoredEmailResponse;
 let sendingQueuesStatusResponse: Mailgun.SendingQueuesStatusResponse;
-let purgeDomainQueuesResponse: Mailgun.GenericResponse;
+let purgeSendingQueueResponse: Mailgun.GenericResponse;
 const domainName = 'sandbox123.mailgun.org';
 
 Given('the Mailgun service "Emails" is available', () => {
@@ -106,10 +106,10 @@ Then('the response contains the sending queues status', () => {
   assert.equal(sendingQueuesStatusResponse.scheduled.disabled?.reason, '');
 });
 
-When('I send a request to purge the domain queues', async () => {
-  purgeDomainQueuesResponse = await emailsApi.purgeDomainQueue(domainName, 'http://localhost:3021');
+When('I send a request to purge a sending queue', async () => {
+  purgeSendingQueueResponse = await emailsApi.purgeSendingQueue(domainName, 'http://localhost:3021');
 });
 
 Then('the response indicates the purge has been done', () => {
-  assert.equal(purgeDomainQueuesResponse.message, 'done');
+  assert.equal(purgeSendingQueueResponse.message, 'done');
 });