other: Fix client name

mailgun · Dec 23, 2024 · 23b3414 · 23b3414
1 parent 2b43542
commit 23b3414
Show file tree

Hide file tree

Showing 9 changed files with 1,020 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -2231,12 +2231,12 @@ A client to manage members within a specific mailing list.
 - #### SeedsLists
 
   - #### list
-    `mg.inbox_placements.seedsLists.list()`
+    `mg.inboxPlacements.seedsLists.list()`
 
       Example:
 
       ```JS
-      mg.inbox_placements.seedsLists.list()
+      mg.inboxPlacements.seedsLists.list()
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -2324,12 +2324,12 @@ A client to manage members within a specific mailing list.
       ```
 
   - #### get
-    `mg.inbox_placements.seedsLists.get(seedsListId)`
+    `mg.inboxPlacements.seedsLists.get(seedsListId)`
 
     Example:
 
     ```JS
-    mg.inbox_placements.seedsLists.get(seedsListId);
+    mg.inboxPlacements.seedsLists.get(seedsListId);
     .then(data => console.log(data)) // logs response data
     .catch(err => console.error(err)); //logs any error
     ```
@@ -2407,7 +2407,7 @@ A client to manage members within a specific mailing list.
 
   - #### create
     ```js
-    mg.inbox_placements.seedsLists.create({
+    mg.inboxPlacements.seedsLists.create({
       name: 'seedLists name',
       sending_domains: 'your_sending_domain',
       seed_filter: 'seed filter',
@@ -2419,7 +2419,7 @@ A client to manage members within a specific mailing list.
     Example:
 
     ```JS
-    mg.inbox_placements.seedsLists.create({
+    mg.inboxPlacements.seedsLists.create({
       sending_domains: 'your_sending_domain',
       name: 'seedLists name';
       seed_filter: 'seed filter';
@@ -2469,7 +2469,7 @@ A client to manage members within a specific mailing list.
   - #### update
 
     ```JS
-    mg.inbox_placements.seedsLists.update(seedsListId,{
+    mg.inboxPlacements.seedsLists.update(seedsListId,{
       name: 'new seedLists name', // optional
       provider_filter: 'provider_filter', // optional
       shuffle: true, // optional
@@ -2481,7 +2481,7 @@ A client to manage members within a specific mailing list.
     Example:
 
     ```JS
-     mg.inbox_placements.seedsLists.update(seedsListId,{
+     mg.inboxPlacements.seedsLists.update(seedsListId,{
       name: 'new seedLists name',
       provider_filter: 'gmail.com',
       sending_domains: 'your_sending_domain'
@@ -2529,13 +2529,13 @@ A client to manage members within a specific mailing list.
 
   - #### destroy
     ```js
-    mg.inbox_placements.seedsLists.destroy(seedsListId)
+    mg.inboxPlacements.seedsLists.destroy(seedsListId)
     ```
 
     Example:
 
     ```JS
-     mg.inbox_placements.seedsLists.destroy(seedsListId)
+     mg.inboxPlacements.seedsLists.destroy(seedsListId)
     .then(data => console.log(data)) // logs response data
     .catch(err => console.error(err)); //logs any error
     ```
@@ -2551,12 +2551,12 @@ A client to manage members within a specific mailing list.
   - #### Attributes
 
     - #### list
-      `mg.inbox_placements.seedsLists.attributes.list()`
+      `mg.inboxPlacements.seedsLists.attributes.list()`
 
       Example:
 
       ```JS
-      mg.inbox_placements.seedsLists.attributes.list()
+      mg.inboxPlacements.seedsLists.attributes.list()
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -2572,11 +2572,11 @@ A client to manage members within a specific mailing list.
       ```
 
     - #### get
-      `mg.inbox_placements.attributes.get('attribute_name');`
+      `mg.inboxPlacements.attributes.get('attribute_name');`
 
       Example:
       ```JS
-      mg.inbox_placements.seedsLists.attributes.get('attribute_name')
+      mg.inboxPlacements.seedsLists.attributes.get('attribute_name')
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -2594,12 +2594,12 @@ A client to manage members within a specific mailing list.
   - #### Filters
 
     - #### list
-      `mg.inbox_placements.seedsLists.filters.list()`
+      `mg.inboxPlacements.seedsLists.filters.list()`
 
       Example:
 
       ```JS
-      mg.inbox_placements.seedsLists.filters.list()
+      mg.inboxPlacements.seedsLists.filters.list()
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -2623,12 +2623,12 @@ A client to manage members within a specific mailing list.
   - #### list
     List all available email providers.
 
-    `mg.inbox_placements.providers.list()`
+    `mg.inboxPlacements.providers.list()`
 
     Example:
 
     ```JS
-    mg.inbox_placements.providers.list()
+    mg.inboxPlacements.providers.list()
     .then(data => console.log(data)) // logs response data
     .catch(err => console.error(err)); //logs any error
     ```
@@ -2654,7 +2654,7 @@ A client to manage members within a specific mailing list.
       Get the details for all placement test results.
 
       ```js
-      mg.inbox_placements.results.list({
+      mg.inboxPlacements.results.list({
         'sender': 'sender value', // optional
         'subject': 'subject value', // optional
         'provider': 'provider value', // optional
@@ -2672,7 +2672,7 @@ A client to manage members within a specific mailing list.
       Example:
 
       ```JS
-      mg.inbox_placements.results.list({
+      mg.inboxPlacements.results.list({
         'sender': 'sender value', // optional
         'subject': 'subject value', // optional
       })
@@ -2782,12 +2782,12 @@ A client to manage members within a specific mailing list.
 
     Get the details for a single result.
 
-    `mg.inbox_placements.results.get(IBPResultId)`
+    `mg.inboxPlacements.results.get(IBPResultId)`
 
     Example:
 
     ```JS
-    mg.inbox_placements.results.get(IBPResultId);
+    mg.inboxPlacements.results.get(IBPResultId);
     .then(data => console.log(data)) // logs response data
     .catch(err => console.error(err)); //logs any error
     ```
@@ -2886,12 +2886,12 @@ A client to manage members within a specific mailing list.
   - #### destroy
     Delete the result and all associated information.
 
-    `mg.inbox_placements.results.destroy(IBPResultId)`
+    `mg.inboxPlacements.results.destroy(IBPResultId)`
 
     Example:
 
     ```JS
-    mg.inbox_placements.results.destroy(IBPResultId)
+    mg.inboxPlacements.results.destroy(IBPResultId)
     .then(data => console.log(data)) // logs response data
     .catch(err => console.error(err)); //logs any error
     ```
@@ -2907,13 +2907,13 @@ A client to manage members within a specific mailing list.
   - #### getResultByShareId
       Get a result by the share ID.
       ```js
-      mg.inbox_placements.results.getResultByShareId('result_sharing_id')
+      mg.inboxPlacements.results.getResultByShareId('result_sharing_id')
       ```
 
       Example:
 
       ```JS
-      mg.inbox_placements.results.getResultByShareId('result_sharing_id')
+      mg.inboxPlacements.results.getResultByShareId('result_sharing_id')
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -3012,12 +3012,12 @@ A client to manage members within a specific mailing list.
   - #### Attributes
 
     - #### list
-      `mg.inbox_placements.results.attributes.list()`
+      `mg.inboxPlacements.results.attributes.list()`
 
       Example:
 
       ```JS
-      mg.inbox_placements.results.attributes.list()
+      mg.inboxPlacements.results.attributes.list()
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -3033,11 +3033,11 @@ A client to manage members within a specific mailing list.
       ```
 
     - #### get
-      `mg.inbox_placements.attributes.get('attribute_name');`
+      `mg.inboxPlacements.attributes.get('attribute_name');`
 
       Example:
       ```JS
-      mg.inbox_placements.results.attributes.get('attribute_name')
+      mg.inboxPlacements.results.attributes.get('attribute_name')
       .then(data => console.log(data)) // logs response data
       .catch(err => console.error(err)); //logs any error
       ```
@@ -3055,12 +3055,12 @@ A client to manage members within a specific mailing list.
   - #### Filters
 
     - #### list
-        `mg.inbox_placements.results.filters.list()`
+        `mg.inboxPlacements.results.filters.list()`
 
         Example:
 
         ```JS
-        mg.inbox_placements.results.filters.list()
+        mg.inboxPlacements.results.filters.list()
         .then(data => console.log(data)) // logs response data
         .catch(err => console.error(err)); //logs any error
         ```
@@ -3083,10 +3083,10 @@ A client to manage members within a specific mailing list.
     - #### get
       The sharing status of a result.
 
-      `mg.inbox_placements.results.sharing.get('result_id');`
+      `mg.inboxPlacements.results.sharing.get('result_id');`
       Example:
         ```JS
-        mg.inbox_placements.results.sharing.get('result_id');
+        mg.inboxPlacements.results.sharing.get('result_id');
         .then(data => console.log(data)) // logs response data
         .catch(err => console.error(err)); //logs any error
         ```
@@ -3105,11 +3105,11 @@ A client to manage members within a specific mailing list.
     - #### update
       Change the sharing status of a result or create a new share URL
 
-      `mg.inbox_placements.results.sharing.update('result_id', IPRSharingUpdateData);`
+      `mg.inboxPlacements.results.sharing.update('result_id', IPRSharingUpdateData);`
 
       Example:
         ```JS
-        mg.inbox_placements.results.sharing.update('result_id', { enabled: false });
+        mg.inboxPlacements.results.sharing.update('result_id', { enabled: false });
         .then(data => console.log(data)) // logs response data
         .catch(err => console.error(err)); //logs any error
         ```
@@ -3133,11 +3133,11 @@ A client to manage members within a specific mailing list.
 
   'variables' are Template variables, which could be used in html or template. You can use next recipient variables inside Template variables, which will be filled for every seed automatically: %recipient.first_name%, %recipient.last_name%.
 
-  `mg.inbox_placements.runTest(InboxPlacementsData);`
+  `mg.inboxPlacements.runTest(InboxPlacementsData);`
 
   Example:
   ```JS
-    mg.inbox_placements.runTest({
+    mg.inboxPlacements.runTest({
       from: 'Excited User <[email protected]>',
       subject: 'Subject of test email',
       provider_filter: ['o365.mailgun.email'],

diff --git a/dist/Classes/MailgunClient.d.ts b/dist/Classes/MailgunClient.d.ts
@@ -14,7 +14,7 @@ export default class MailgunClient implements IMailgunClient {
     ip_pools: IIPPoolsClient;
     lists: IMailingListsClient;
     subaccounts: ISubaccountsClient;
-    inbox_placements: IInboxPlacementsClient;
+    inboxPlacements: IInboxPlacementsClient;
     constructor(options: MailgunClientOptions, formData: InputFormData);
     setSubaccount(subaccountId: string): void;
     resetSubaccount(): void;

diff --git a/dist/Interfaces/MailgunClient/IMailgunClient.d.ts b/dist/Interfaces/MailgunClient/IMailgunClient.d.ts
@@ -24,7 +24,7 @@ export interface IMailgunClient {
     ip_pools: IIPPoolsClient;
     lists: IMailingListsClient;
     subaccounts: ISubaccountsClient;
-    inbox_placements: IInboxPlacementsClient;
+    inboxPlacements: IInboxPlacementsClient;
     setSubaccount(subaccountId: string): void;
     resetSubaccount(): void;
 }