support params in get api

Author: cb-karthikp

dist/chargebee-java-4.0.0-sources.jar

@@ -7,6 +7,7 @@
 
 import com.chargebee.v4.exceptions.codes.ApiErrorCode;
 import com.chargebee.v4.internal.JsonUtil;
+import com.chargebee.v4.transport.HttpException;
 import com.chargebee.v4.transport.Request;
 import com.chargebee.v4.transport.Response;
 
@@ -252,11 +253,12 @@ private String extractErrorCauseId(String jsonResponse) {
 
   /**
    * API errors are generally not retryable as they indicate business logic issues.
-   * 
+   *
    * <p>Exceptions that may warrant retry:
+   *
    * <ul>
-   *   <li>429 Too Many Requests - Rate limiting</li>
-   *   <li>5xx Server errors - Temporary server issues</li>
+   *   <li>429 Too Many Requests - Rate limiting
+   *   <li>5xx Server errors - Temporary server issues
    * </ul>
    *
    * @return true only for 429 or 5xx status codes

src/main/java/com/chargebee/v4/exceptions/APIException.java

@@ -11,6 +11,8 @@
 import com.chargebee.v4.client.request.RequestOptions;
 import com.chargebee.v4.transport.Response;
 
+import com.chargebee.v4.models.attachedItem.params.AttachedItemRetrieveParams;
+
 import com.chargebee.v4.models.attachedItem.params.AttachedItemUpdateParams;
 
 import com.chargebee.v4.models.attachedItem.params.AttachedItemsForItemParams;
@@ -73,6 +75,22 @@ Response retrieveRaw(String attachedItemId) throws Exception {
     return get(path, null);
   }
 
+  /**
+   * retrieve a attachedItem using immutable params (executes immediately) - returns raw Response.
+   */
+  Response retrieveRaw(String attachedItemId, AttachedItemRetrieveParams params) throws Exception {
+    String path =
+        buildPathWithParams(
+            "/attached_items/{attached-item-id}", "attached-item-id", attachedItemId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public AttachedItemRetrieveResponse retrieve(
+      String attachedItemId, AttachedItemRetrieveParams params) throws Exception {
+    Response response = retrieveRaw(attachedItemId, params);
+    return AttachedItemRetrieveResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public AttachedItemRetrieveResponse retrieve(String attachedItemId) throws Exception {
     Response response = retrieveRaw(attachedItemId);
     return AttachedItemRetrieveResponse.fromJson(response.getBodyAsString(), response);

src/main/java/com/chargebee/v4/services/AttachedItemService.java

@@ -31,6 +31,8 @@
 
 import com.chargebee.v4.models.creditNote.params.RemoveTaxWithheldRefundForCreditNoteParams;
 
+import com.chargebee.v4.models.creditNote.params.CreditNoteRetrieveParams;
+
 import com.chargebee.v4.models.creditNote.responses.RecordRefundForCreditNoteResponse;
 
 import com.chargebee.v4.models.creditNote.responses.ImportCreditNoteResponse;
@@ -493,6 +495,19 @@ Response retrieveRaw(String creditNoteId) throws Exception {
     return get(path, null);
   }
 
+  /** retrieve a creditNote using immutable params (executes immediately) - returns raw Response. */
+  Response retrieveRaw(String creditNoteId, CreditNoteRetrieveParams params) throws Exception {
+    String path =
+        buildPathWithParams("/credit_notes/{credit-note-id}", "credit-note-id", creditNoteId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public CreditNoteRetrieveResponse retrieve(String creditNoteId, CreditNoteRetrieveParams params)
+      throws Exception {
+    Response response = retrieveRaw(creditNoteId, params);
+    return CreditNoteRetrieveResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public CreditNoteRetrieveResponse retrieve(String creditNoteId) throws Exception {
     Response response = retrieveRaw(creditNoteId);
     return CreditNoteRetrieveResponse.fromJson(response.getBodyAsString(), response);

src/main/java/com/chargebee/v4/services/CreditNoteService.java

@@ -23,6 +23,8 @@
 
 import com.chargebee.v4.models.customer.params.CustomerMoveParams;
 
+import com.chargebee.v4.models.customer.params.HierarchyForCustomerParams;
+
 import com.chargebee.v4.models.customer.params.UpdatePaymentMethodForCustomerParams;
 
 import com.chargebee.v4.models.customer.params.CustomerUpdateParams;
@@ -358,6 +360,23 @@ Response hierarchyForCustomerRaw(String customerId) throws Exception {
     return get(path, null);
   }
 
+  /**
+   * hierarchyForCustomer a customer using immutable params (executes immediately) - returns raw
+   * Response.
+   */
+  Response hierarchyForCustomerRaw(String customerId, HierarchyForCustomerParams params)
+      throws Exception {
+    String path =
+        buildPathWithParams("/customers/{customer-id}/hierarchy", "customer-id", customerId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public HierarchyForCustomerResponse hierarchyForCustomer(
+      String customerId, HierarchyForCustomerParams params) throws Exception {
+    Response response = hierarchyForCustomerRaw(customerId, params);
+    return HierarchyForCustomerResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public HierarchyForCustomerResponse hierarchyForCustomer(String customerId) throws Exception {
     Response response = hierarchyForCustomerRaw(customerId);
     return HierarchyForCustomerResponse.fromJson(response.getBodyAsString(), response);

src/main/java/com/chargebee/v4/services/CustomerService.java

@@ -17,6 +17,8 @@
 
 import com.chargebee.v4.models.differentialPrice.params.DifferentialPriceListParams;
 
+import com.chargebee.v4.models.differentialPrice.params.DifferentialPriceRetrieveParams;
+
 import com.chargebee.v4.models.differentialPrice.params.DifferentialPriceUpdateParams;
 
 import com.chargebee.v4.models.differentialPrice.responses.DeleteDifferentialPriceResponse;
@@ -196,6 +198,26 @@ Response retrieveRaw(String differentialPriceId) throws Exception {
     return get(path, null);
   }
 
+  /**
+   * retrieve a differentialPrice using immutable params (executes immediately) - returns raw
+   * Response.
+   */
+  Response retrieveRaw(String differentialPriceId, DifferentialPriceRetrieveParams params)
+      throws Exception {
+    String path =
+        buildPathWithParams(
+            "/differential_prices/{differential-price-id}",
+            "differential-price-id",
+            differentialPriceId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public DifferentialPriceRetrieveResponse retrieve(
+      String differentialPriceId, DifferentialPriceRetrieveParams params) throws Exception {
+    Response response = retrieveRaw(differentialPriceId, params);
+    return DifferentialPriceRetrieveResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public DifferentialPriceRetrieveResponse retrieve(String differentialPriceId) throws Exception {
     Response response = retrieveRaw(differentialPriceId);
     return DifferentialPriceRetrieveResponse.fromJson(response.getBodyAsString(), response);

src/main/java/com/chargebee/v4/services/DifferentialPriceService.java

@@ -11,6 +11,8 @@
 import com.chargebee.v4.client.request.RequestOptions;
 import com.chargebee.v4.transport.Response;
 
+import com.chargebee.v4.models.estimate.params.RenewalEstimateForSubscriptionParams;
+
 import com.chargebee.v4.models.estimate.params.EstimateCreateSubscriptionForItemsParams;
 
 import com.chargebee.v4.models.estimate.params.EstimatePaymentSchedulesParams;
@@ -39,6 +41,8 @@
 
 import com.chargebee.v4.models.estimate.params.EstimateGiftSubscriptionParams;
 
+import com.chargebee.v4.models.estimate.params.CreateSubscriptionEstimateForCustomerParams;
+
 import com.chargebee.v4.models.estimate.params.EstimateCreateSubscriptionParams;
 
 import com.chargebee.v4.models.estimate.params.EstimateCreateInvoiceParams;
@@ -128,6 +132,24 @@ Response renewalEstimateForSubscriptionRaw(String subscriptionId) throws Excepti
     return get(path, null);
   }
 
+  /**
+   * renewalEstimateForSubscription a estimate using immutable params (executes immediately) -
+   * returns raw Response.
+   */
+  Response renewalEstimateForSubscriptionRaw(
+      String subscriptionId, RenewalEstimateForSubscriptionParams params) throws Exception {
+    String path =
+        buildPathWithParams(
+            "/subscriptions/{subscription-id}/renewal_estimate", "subscription-id", subscriptionId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public RenewalEstimateForSubscriptionResponse renewalEstimateForSubscription(
+      String subscriptionId, RenewalEstimateForSubscriptionParams params) throws Exception {
+    Response response = renewalEstimateForSubscriptionRaw(subscriptionId, params);
+    return RenewalEstimateForSubscriptionResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public RenewalEstimateForSubscriptionResponse renewalEstimateForSubscription(
       String subscriptionId) throws Exception {
     Response response = renewalEstimateForSubscriptionRaw(subscriptionId);
@@ -702,6 +724,25 @@ Response createSubscriptionEstimateForCustomerRaw(String customerId) throws Exce
     return get(path, null);
   }
 
+  /**
+   * createSubscriptionEstimateForCustomer a estimate using immutable params (executes immediately)
+   * - returns raw Response.
+   */
+  Response createSubscriptionEstimateForCustomerRaw(
+      String customerId, CreateSubscriptionEstimateForCustomerParams params) throws Exception {
+    String path =
+        buildPathWithParams(
+            "/customers/{customer-id}/create_subscription_estimate", "customer-id", customerId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public CreateSubscriptionEstimateForCustomerResponse createSubscriptionEstimateForCustomer(
+      String customerId, CreateSubscriptionEstimateForCustomerParams params) throws Exception {
+    Response response = createSubscriptionEstimateForCustomerRaw(customerId, params);
+    return CreateSubscriptionEstimateForCustomerResponse.fromJson(
+        response.getBodyAsString(), response);
+  }
+
   public CreateSubscriptionEstimateForCustomerResponse createSubscriptionEstimateForCustomer(
       String customerId) throws Exception {
     Response response = createSubscriptionEstimateForCustomerRaw(customerId);

src/main/java/com/chargebee/v4/services/EstimateService.java

@@ -41,6 +41,8 @@
 
 import com.chargebee.v4.models.invoice.params.ApplyCreditsForInvoiceParams;
 
+import com.chargebee.v4.models.invoice.params.InvoiceRetrieveParams;
+
 import com.chargebee.v4.models.invoice.params.InvoiceCreateForChargeItemParams;
 
 import com.chargebee.v4.models.invoice.params.InvoiceCreateForChargeItemsAndChargesParams;
@@ -718,6 +720,18 @@ Response retrieveRaw(String invoiceId) throws Exception {
     return get(path, null);
   }
 
+  /** retrieve a invoice using immutable params (executes immediately) - returns raw Response. */
+  Response retrieveRaw(String invoiceId, InvoiceRetrieveParams params) throws Exception {
+    String path = buildPathWithParams("/invoices/{invoice-id}", "invoice-id", invoiceId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public InvoiceRetrieveResponse retrieve(String invoiceId, InvoiceRetrieveParams params)
+      throws Exception {
+    Response response = retrieveRaw(invoiceId, params);
+    return InvoiceRetrieveResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public InvoiceRetrieveResponse retrieve(String invoiceId) throws Exception {
     Response response = retrieveRaw(invoiceId);
     return InvoiceRetrieveResponse.fromJson(response.getBodyAsString(), response);

src/main/java/com/chargebee/v4/services/InvoiceService.java

@@ -13,6 +13,8 @@
 
 import com.chargebee.v4.models.usage.params.UsagePdfParams;
 
+import com.chargebee.v4.models.usage.params.UsagesForSubscriptionParams;
+
 import com.chargebee.v4.models.usage.params.AddUsageForSubscriptionParams;
 
 import com.chargebee.v4.models.usage.params.DeleteUsageForSubscriptionParams;
@@ -90,6 +92,24 @@ Response usagesForSubscriptionRaw(String subscriptionId) throws Exception {
     return get(path, null);
   }
 
+  /**
+   * usagesForSubscription a usage using immutable params (executes immediately) - returns raw
+   * Response.
+   */
+  Response usagesForSubscriptionRaw(String subscriptionId, UsagesForSubscriptionParams params)
+      throws Exception {
+    String path =
+        buildPathWithParams(
+            "/subscriptions/{subscription-id}/usages", "subscription-id", subscriptionId);
+    return get(path, params != null ? params.toQueryParams() : null);
+  }
+
+  public UsagesForSubscriptionResponse usagesForSubscription(
+      String subscriptionId, UsagesForSubscriptionParams params) throws Exception {
+    Response response = usagesForSubscriptionRaw(subscriptionId, params);
+    return UsagesForSubscriptionResponse.fromJson(response.getBodyAsString(), response);
+  }
+
   public UsagesForSubscriptionResponse usagesForSubscription(String subscriptionId)
       throws Exception {
     Response response = usagesForSubscriptionRaw(subscriptionId);