Skip to content

Commit 4d29240

Browse files
committed
All optional parameters added to API methods rersponsible for retrieving data
1 parent 35d66ba commit 4d29240

File tree

6 files changed

+1102
-122
lines changed

6 files changed

+1102
-122
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This API client provides a type-safe Java interface for WooCommerce REST API v3,
4545
4646
## 📦 Version Information
4747

48-
- **Current Version**: `0.1.6-alpha-20250609`
48+
- **Current Version**: `0.1.7-alpha-20250609`
4949
- **Supported WooCommerce API Version**: `v3`
5050
- **Java Compatibility**: Java 8+
5151

@@ -77,7 +77,7 @@ Then add the locally built artifact to your project:
7777
<dependency>
7878
<groupId>wtx.woocommerce</groupId>
7979
<artifactId>woocommerce-api-client</artifactId>
80-
<version>0.1.6-alpha-20250609</version>
80+
<version>0.1.7-alpha-20250609</version>
8181
</dependency>
8282
```
8383

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>wtx.woocommerce</groupId>
77
<artifactId>woocommerce-api-client</artifactId>
8-
<version>0.1.6-alpha-20250609</version>
8+
<version>0.1.7-alpha-20250609</version>
99
<packaging>jar</packaging>
1010

1111
<name>WooCommerce REST API Client</name>

src/main/java/wtx/woocommerce/api/client/CustomersApi.java

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -366,17 +366,17 @@ public okhttp3.Call deleteCustomerByIdAsync(Integer customerId, String force, In
366366
}
367367
/**
368368
* Build call for listAllCustomers
369-
* @param context Scope under which the request is made; determines fields present in response. (optional)
370-
* @param page Current page of the collection. (optional, default to 1)
371-
* @param perPage Maximum number of items to be returned in result set. (optional, default to 10)
369+
* @param context Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. (optional, default to view)
370+
* @param page Current page of the collection. Default is 1. (optional, default to 1)
371+
* @param perPage Maximum number of items to be returned in result set. Default is 10. (optional, default to 10)
372372
* @param search Limit results to those matching a string. (optional)
373373
* @param exclude Ensure result set excludes specific IDs. (optional)
374374
* @param include Limit result set to specific IDs. (optional)
375375
* @param offset Offset the result set by a specific number of items. (optional)
376-
* @param order Order sort attribute ascending or descending (asc as default). (optional)
377-
* @param orderby Sort collection by object attribute. (optional)
378-
* @param email Limit result set to resources with a specific email address. (optional)
379-
* @param role Limit result set to resources with a specific role. Default is customer. (optional)
376+
* @param order Order sort attribute ascending or descending. Options: asc and desc. Default is asc. (optional, default to asc)
377+
* @param orderby Sort collection by object attribute. Options: id, include, name and registered_date. Default is name. (optional, default to name)
378+
* @param email Limit result set to resources with a specific email. (optional)
379+
* @param role Limit result set to resources with a specific role. Options: all, administrator, editor, author, contributor, subscriber, customer and shop_manager. Default is customer. (optional, default to customer)
380380
* @param _callback Callback for upload/download progress
381381
* @return Call to execute
382382
* @throws ApiException If fail to serialize the request body object
@@ -431,11 +431,11 @@ public okhttp3.Call listAllCustomersCall(String context, Integer page, Integer p
431431
}
432432

433433
if (exclude != null) {
434-
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "exclude", exclude));
434+
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "exclude", exclude));
435435
}
436436

437437
if (include != null) {
438-
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "include", include));
438+
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("csv", "include", include));
439439
}
440440

441441
if (offset != null) {
@@ -486,17 +486,17 @@ private okhttp3.Call listAllCustomersValidateBeforeCall(String context, Integer
486486
/**
487487
* This API helps you to view all the customers.
488488
*
489-
* @param context Scope under which the request is made; determines fields present in response. (optional)
490-
* @param page Current page of the collection. (optional, default to 1)
491-
* @param perPage Maximum number of items to be returned in result set. (optional, default to 10)
489+
* @param context Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. (optional, default to view)
490+
* @param page Current page of the collection. Default is 1. (optional, default to 1)
491+
* @param perPage Maximum number of items to be returned in result set. Default is 10. (optional, default to 10)
492492
* @param search Limit results to those matching a string. (optional)
493493
* @param exclude Ensure result set excludes specific IDs. (optional)
494494
* @param include Limit result set to specific IDs. (optional)
495495
* @param offset Offset the result set by a specific number of items. (optional)
496-
* @param order Order sort attribute ascending or descending (asc as default). (optional)
497-
* @param orderby Sort collection by object attribute. (optional)
498-
* @param email Limit result set to resources with a specific email address. (optional)
499-
* @param role Limit result set to resources with a specific role. Default is customer. (optional)
496+
* @param order Order sort attribute ascending or descending. Options: asc and desc. Default is asc. (optional, default to asc)
497+
* @param orderby Sort collection by object attribute. Options: id, include, name and registered_date. Default is name. (optional, default to name)
498+
* @param email Limit result set to resources with a specific email. (optional)
499+
* @param role Limit result set to resources with a specific role. Options: all, administrator, editor, author, contributor, subscriber, customer and shop_manager. Default is customer. (optional, default to customer)
500500
* @return List&lt;Customer&gt;
501501
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
502502
* @http.response.details
@@ -516,17 +516,17 @@ public List<Customer> listAllCustomers(String context, Integer page, Integer per
516516
/**
517517
* This API helps you to view all the customers.
518518
*
519-
* @param context Scope under which the request is made; determines fields present in response. (optional)
520-
* @param page Current page of the collection. (optional, default to 1)
521-
* @param perPage Maximum number of items to be returned in result set. (optional, default to 10)
519+
* @param context Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. (optional, default to view)
520+
* @param page Current page of the collection. Default is 1. (optional, default to 1)
521+
* @param perPage Maximum number of items to be returned in result set. Default is 10. (optional, default to 10)
522522
* @param search Limit results to those matching a string. (optional)
523523
* @param exclude Ensure result set excludes specific IDs. (optional)
524524
* @param include Limit result set to specific IDs. (optional)
525525
* @param offset Offset the result set by a specific number of items. (optional)
526-
* @param order Order sort attribute ascending or descending (asc as default). (optional)
527-
* @param orderby Sort collection by object attribute. (optional)
528-
* @param email Limit result set to resources with a specific email address. (optional)
529-
* @param role Limit result set to resources with a specific role. Default is customer. (optional)
526+
* @param order Order sort attribute ascending or descending. Options: asc and desc. Default is asc. (optional, default to asc)
527+
* @param orderby Sort collection by object attribute. Options: id, include, name and registered_date. Default is name. (optional, default to name)
528+
* @param email Limit result set to resources with a specific email. (optional)
529+
* @param role Limit result set to resources with a specific role. Options: all, administrator, editor, author, contributor, subscriber, customer and shop_manager. Default is customer. (optional, default to customer)
530530
* @return ApiResponse&lt;List&lt;Customer&gt;&gt;
531531
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
532532
* @http.response.details
@@ -547,17 +547,17 @@ public ApiResponse<List<Customer>> listAllCustomersWithHttpInfo(String context,
547547
/**
548548
* This API helps you to view all the customers. (asynchronously)
549549
*
550-
* @param context Scope under which the request is made; determines fields present in response. (optional)
551-
* @param page Current page of the collection. (optional, default to 1)
552-
* @param perPage Maximum number of items to be returned in result set. (optional, default to 10)
550+
* @param context Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. (optional, default to view)
551+
* @param page Current page of the collection. Default is 1. (optional, default to 1)
552+
* @param perPage Maximum number of items to be returned in result set. Default is 10. (optional, default to 10)
553553
* @param search Limit results to those matching a string. (optional)
554554
* @param exclude Ensure result set excludes specific IDs. (optional)
555555
* @param include Limit result set to specific IDs. (optional)
556556
* @param offset Offset the result set by a specific number of items. (optional)
557-
* @param order Order sort attribute ascending or descending (asc as default). (optional)
558-
* @param orderby Sort collection by object attribute. (optional)
559-
* @param email Limit result set to resources with a specific email address. (optional)
560-
* @param role Limit result set to resources with a specific role. Default is customer. (optional)
557+
* @param order Order sort attribute ascending or descending. Options: asc and desc. Default is asc. (optional, default to asc)
558+
* @param orderby Sort collection by object attribute. Options: id, include, name and registered_date. Default is name. (optional, default to name)
559+
* @param email Limit result set to resources with a specific email. (optional)
560+
* @param role Limit result set to resources with a specific role. Options: all, administrator, editor, author, contributor, subscriber, customer and shop_manager. Default is customer. (optional, default to customer)
561561
* @param _callback The callback to be executed when the API call finishes
562562
* @return The request call
563563
* @throws ApiException If fail to process the API call, e.g. serializing the request body object

0 commit comments

Comments
 (0)