Merge pull request #321 from recurly/operation-params

Adding a query param class for each operation instead of sharing a single class for all operations

Author: cbarton

.github/workflows/pr-review.yml

@@ -22,6 +22,6 @@ jobs:
       - name: Check Labels
         uses: docker://agilepathway/pull-request-label-checker:latest
         with:
-          one_of: V5
+          one_of: V6
           repo_token: ${{ secrets.GITHUB_TOKEN }}
 

openapi/api.yaml

@@ -515,7 +515,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListSitesParams params = new ListSitesParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Site> sites = client.listSites(params);
 
@@ -737,7 +737,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountsParams params = new ListAccountsParams();
           params.setLimit(200); // Pull 200 records at a time
           Pager<Account> accounts = client.listAccounts(params);
 
@@ -2999,8 +2999,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
-          params.setLimit(200); // Pull 200 records at a time
+          ListAccountCouponRedemptionsParams params = new ListAccountCouponRedemptionsParams();
           final Pager<CouponRedemption> redemptions = client.listAccountCouponRedemptions(accountId, params);
 
           for (CouponRedemption redemption : redemptions) {
@@ -3498,7 +3497,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountCreditPaymentsParams params = new ListAccountCreditPaymentsParams();
           params.setLimit(200); // Pull 200 records at a time
           Pager<CreditPayment> payments = client.listAccountCreditPayments(accountId, params);
 
@@ -3840,7 +3839,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountInvoicesParams params = new ListAccountInvoicesParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Invoice> invoices = client.listAccountInvoices(accountId, params);
 
@@ -4284,7 +4283,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountLineItemsParams params = new ListAccountLineItemsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<LineItem> lineItems = client.listAccountLineItems(accountId, params);
 
@@ -4543,8 +4542,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
-          params.setLimit(200); // Pull 200 records at a time
+          ListAccountNotesParams params = new ListAccountNotesParams();
           final Pager<AccountNote> notes = client.listAccountNotes(accountId, params);
 
           for (AccountNote note : notes) {
@@ -4828,7 +4826,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListShippingAddressesParams params = new ListShippingAddressesParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<ShippingAddress> addresses = client.listShippingAddresses(accountId, params);
 
@@ -5517,7 +5515,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountSubscriptionsParams params = new ListAccountSubscriptionsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Subscription> subscriptions = client.listAccountSubscriptions(accountId, params);
 
@@ -5623,7 +5621,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountTransactionsParams params = new ListAccountTransactionsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Transaction> transactions = client.listAccountTransactions(accountId, params);
 
@@ -5806,7 +5804,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAccountAcquisitionParams params = new ListAccountAcquisitionParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<AccountAcquisition> acquisitions = client.listAccountAcquisition(params);
 
@@ -5909,7 +5907,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListCouponsParams params = new ListCouponsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Coupon> coupons = client.listCoupons(params);
 
@@ -6757,7 +6755,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListCreditPaymentsParams params = new ListCreditPaymentsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<CreditPayment> payments = client.listCreditPayments(params);
 
@@ -6893,7 +6891,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListCustomFieldDefinitionsParams params = new ListCustomFieldDefinitionsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<CustomFieldDefinition> fields = client.listCustomFieldDefinitions(params);
 
@@ -7303,7 +7301,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListItemsParams params = new ListItemsParams();
           params.setLimit(200); // Pull 200 records at a time
           Pager<Item> items = client.listItems(params);
 
@@ -8810,7 +8808,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListInvoicesParams params = new ListInvoicesParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Invoice> invoices = client.listInvoices(params);
 
@@ -10128,7 +10126,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListInvoiceLineItemsParams params = new ListInvoiceLineItemsParams();
           params.setLimit(200);
           Pager<LineItem> lineItems = client.listInvoiceLineItems(invoiceId, params);
 
@@ -10222,8 +10220,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
-          params.setLimit(200); // Pull 200 records at a time
+          ListInvoiceCouponRedemptionsParams params = new ListInvoiceCouponRedemptionsParams();
           final Pager<CouponRedemption> redemptions = client.listInvoiceCouponRedemptions(invoiceId, params);
 
           for (CouponRedemption redemption : redemptions) {
@@ -10635,7 +10632,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListLineItemsParams params = new ListLineItemsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<LineItem> lineItems = client.listLineItems(params);
 
@@ -10972,7 +10969,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListPlansParams params = new ListPlansParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Plan> plans = client.listPlans(params);
 
@@ -11641,7 +11638,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListPlanAddOnsParams params = new ListPlanAddOnsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<AddOn> addOns = client.listPlanAddOns(planId, params);
 
@@ -12371,7 +12368,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListAddOnsParams params = new ListAddOnsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<AddOn> addOns = client.listAddOns(params);
 
@@ -12588,7 +12585,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListShippingMethodsParams params = new ListShippingMethodsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<ShippingMethod> shippingMethods = client.listShippingMethods(params);
 
@@ -12837,7 +12834,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListSubscriptionsParams params = new ListSubscriptionsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Subscription> subscriptions = client.listSubscriptions(params);
 
@@ -13430,7 +13427,7 @@ paths:
       - lang: Java
         source: |
           try {
-              QueryParams queryParams = new QueryParams();
+              TerminateSubscriptionParams queryParams = new TerminateSubscriptionParams();
               queryParams.setRefund(Constants.RefundType.NONE); // "full" for a full refund, "partial" for prorated refund
               client.terminateSubscription(subscriptionId, queryParams);
               System.out.println("Terminated Subscription: " + subscriptionId);
@@ -14718,7 +14715,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListSubscriptionInvoicesParams params = new ListSubscriptionInvoicesParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Invoice> invoices = client.listSubscriptionInvoices(subscriptionId, params);
 
@@ -14824,7 +14821,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListSubscriptionLineItemsParams params = new ListSubscriptionLineItemsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<LineItem> lineItems = client.listSubscriptionLineItems(subscriptionId, params);
 
@@ -14922,8 +14919,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
-          params.setLimit(200); // Pull 200 records at a time
+          ListSubscriptionCouponRedemptionsParams params = new ListSubscriptionCouponRedemptionsParams();
           final Pager<CouponRedemption> redemptions = client.listSubscriptionCouponRedemptions(subscriptionId, params);
 
           for (CouponRedemption redemption : redemptions) {
@@ -15293,7 +15289,7 @@ paths:
           end
       - lang: Java
         source: |
-          QueryParams params = new QueryParams();
+          ListTransactionsParams params = new ListTransactionsParams();
           params.setLimit(200); // Pull 200 records at a time
           final Pager<Transaction> transactions = client.listTransactions(params);
 

src/main/java/com/recurly/v3/AbstractQueryParams.java

@@ -0,0 +1,22 @@
+package com.recurly.v3;
+
+import java.util.HashMap;
+import java.util.List;
+
+public abstract class AbstractQueryParams
+ {
+
+  private HashMap<String, Object> params;
+
+  public AbstractQueryParams() {
+    this.params = new HashMap<String, Object>();
+  }
+
+  public HashMap<String, Object> getParams() {
+    return this.params;
+  }
+
+  protected void add(final String key, final Object value) {
+    this.params.put(key, value);
+  }
+}