Changelog for Zuora client libraries

• Introduced the includeNullFields parameter to all query methods in the ObjectQueriesApi class. This parameter is used to control whether to include fields with null values in the response.
• Added a the originalListPrice field to the UsageOveragePricingOverride and UsageOveragePricingUpdate classes.
• For the BulkUpdateInvoicesRequest class, the type of the invoices field has been changed from List<UpdateInvoiceRequest> to List<InvoiceForBulkUpdate>.
• Refactored the CreatePaymentMethodRequest and UpdatePaymentMethodRequest classes to more intuitive type-specific classes for different payment method types, such as CreateCreditCardPaymentMethod and UpdateCreditCardPaymentMethod.

  Now you can use the corresponding payment method class depending on the payment method type you want to create or update. For example:

  Copy

  Copied

  CreateCreditCardPaymentMethod creditCardPaymentMethod = new CreateCreditCardPaymentMethod();
  creditCardPaymentMethod.type("CreditCard");
  ...
  CreatePaymentMethodRequest createCreditCardRequest = new CreatePaymentMethodRequest(creditCardPaymentMethod);

  Previously, CreatePaymentMethodRequest supported all types of payment methods in a single class, containing all possible fields across all payment method types. You had to instantiate the payment method type using the following format, which were more prone to errors:

  Copy

  Copied

  CreatePaymentMethodRequest creditCardRequest = new CreatePaymentMethodRequest()
        .type("CreditCard")
        ...;

For more detailed changes, see Java client library changelog.

• For the ObjectQueriesApi class, added support for querying ContactSnapshots with filters, expands, and sort capabilities.
• For the ObjectQueriesApi class, added the fields parameter to allow specifying which fields are returned in the response.
• For the SubscriptionsApi class, added the asOfDate parameter for chargeDetail when chargeDetail is SPECIFIC_SEGMENT.
• Added the billToContactSnapshot, soldToContactSnapshot, and shipToContactSnapshot fields to the ExpandedInvoice, ExpandedCreditMemo, and ExpandedDebitMemo classes, respectively.

For more detailed changes, see Java client library changelog.

• Added asynchronous methods for applying credit memos with applyCreditMemoAsync and ApplyCreditMemoAsyncApi to the CreditMemosApi class.
• Added asynchronous methods for unapplying credit memos with unapplyCreditMemoAsync and UnapplyCreditMemoAsyncApi to the CreditMemosApi class.
• Added getApplyCreditMemoAsyncJob and GetApplyCreditMemoAsyncJobApi to the CreditMemosApi class for retrieving information about async credit memo apply jobs.
• Added getUnapplyCreditMemoAsyncJob and GetUnapplyCreditMemoAsyncJobApi to the CreditMemosApi class for retrieving information about async credit memo unapply jobs.
• Changed the type of productCategory from ProductCategory to String for the GetSubscriptionRatePlanChargesWithAllSegments class. This change requires developers to update the code to handle productCategory as a String instead of a ProductCategory object.

For more detailed changes, see Java client library changelog.

• Added the communicationProfileId field to the multiple classes, allowing developers to associate a communication profile with an object such as order line item, subscription, and invoice.
• Added the clearingExistingCommunicationProfile field to allow clearing the existing communication profile at the subscription level. This field is mutually exclusive with communicationProfileId.
• Added the REVERSE operation job type to the OperationJobType class.

For more detailed changes, see Java client library changelog.

• Introduced a Builder pattern for ZuoraClient, allowing for more flexible and readable client configuration.
• Changed the type of relationships of CustomObjectDefinitionSchema from List<Object> to List<CustomObjectDefinitionRelationship>, which may require developers to update the code to handle the new type.
• Added support for expanding invoiceschedulebookings, invoiceschedulebookings.order, and invoiceschedulebookings.subscription to the query methods for InvoiceSchedule.

For more detailed changes, see Java client library changelog.

• Introduced support for APAC environments: CSBX_AP and PROD_AP.
• Added DataLabelingApi API integration to support the Multi-Org feature.
• Added new API integrations, DeploymentApi and DeploymentConfigurationTemplatesApi, to support the Deployment Manager feature.
• Added OmniChannelSubscriptionsApi API integration for omni-channel subscription management.
• Added CreatePredebitNotificationApi class and createPredebitNotification method to support triggering a pre-debit notification for an invoice.
• Added the retryOnConnectionFailure method to configure HTTP client behavior regarding connection failures.
• Added field condition of type Condition and objectType of type ObjectTypeEnum to the BillRunFilter class to support bill run advanced filters.
• Fixed issue: The OrdersApi.previewOrderApi() method throws errors when high-volume concurrent requests are submitted.
• Fixed issue: The UsageRecordsApi.createUsage() method could not parse response and throws exceptions.

For more detailed changes, see Java client library changelog.