You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/main/java/wtx/woocommerce/api/client/CustomersApi.java
+30-30Lines changed: 30 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -366,17 +366,17 @@ public okhttp3.Call deleteCustomerByIdAsync(Integer customerId, String force, In
366
366
}
367
367
/**
368
368
* 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)
372
372
* @param search Limit results to those matching a string. (optional)
373
373
* @param exclude Ensure result set excludes specific IDs. (optional)
374
374
* @param include Limit result set to specific IDs. (optional)
375
375
* @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)
380
380
* @param _callback Callback for upload/download progress
381
381
* @return Call to execute
382
382
* @throws ApiException If fail to serialize the request body object
@@ -431,11 +431,11 @@ public okhttp3.Call listAllCustomersCall(String context, Integer page, Integer p
* @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)
492
492
* @param search Limit results to those matching a string. (optional)
493
493
* @param exclude Ensure result set excludes specific IDs. (optional)
494
494
* @param include Limit result set to specific IDs. (optional)
495
495
* @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)
500
500
* @return List<Customer>
501
501
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
502
502
* @http.response.details
@@ -516,17 +516,17 @@ public List<Customer> listAllCustomers(String context, Integer page, Integer per
516
516
/**
517
517
* This API helps you to view all the customers.
518
518
*
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)
522
522
* @param search Limit results to those matching a string. (optional)
523
523
* @param exclude Ensure result set excludes specific IDs. (optional)
524
524
* @param include Limit result set to specific IDs. (optional)
525
525
* @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)
530
530
* @return ApiResponse<List<Customer>>
531
531
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
532
532
* @http.response.details
@@ -547,17 +547,17 @@ public ApiResponse<List<Customer>> listAllCustomersWithHttpInfo(String context,
547
547
/**
548
548
* This API helps you to view all the customers. (asynchronously)
549
549
*
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)
553
553
* @param search Limit results to those matching a string. (optional)
554
554
* @param exclude Ensure result set excludes specific IDs. (optional)
555
555
* @param include Limit result set to specific IDs. (optional)
556
556
* @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)
561
561
* @param _callback The callback to be executed when the API call finishes
562
562
* @return The request call
563
563
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
0 commit comments