Skip to content

Commit 096f853

Browse files
author
Zaid
committed
Updated java docs
1 parent ab60650 commit 096f853

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

src/main/java/Api/ReportSubscriptionsApi.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ public void setApiClient(ApiClient apiClient) {
5656

5757
/**
5858
* Build call for createSubscription
59-
* @param reportName Name of the Report to Create (required)
6059
* @param requestBody Report subscription request payload (required)
6160
* @param merchantConfig (merchant details)
6261
* @param progressListener Progress listener
@@ -131,7 +130,6 @@ private com.squareup.okhttp.Call createSubscriptionValidateBeforeCall(RequestBod
131130
/**
132131
* Create Report Subscription for a report name by organization
133132
*
134-
* @param reportName Name of the Report to Create (required)
135133
* @param requestBody Report subscription request payload (required)
136134
* @param merchantConfig (merchant details)
137135
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -155,7 +153,7 @@ public ApiResponse<Void> createSubscriptionWithHttpInfo( RequestBody requestBody
155153

156154
/**
157155
* Create Report Subscription for a report name by organization (asynchronously)
158-
*
156+
* @param reportName Name(required)
159157
* @param requestBody Report subscription request payload (required)
160158
* @param merchantConfig (merchant details)
161159
* @param callback The callback to be executed when the API call finishes
@@ -259,6 +257,7 @@ private com.squareup.okhttp.Call deleteSubscriptionValidateBeforeCall(String rep
259257
* Delete subscription of a report name by organization
260258
*
261259
* @param reportName Name of the Report to Delete (required)
260+
* @param merchantConfig (merchant details)
262261
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
263262
*/
264263
public void deleteSubscription(String reportName,MerchantConfig merchantConfig) throws ApiException {
@@ -269,6 +268,7 @@ public void deleteSubscription(String reportName,MerchantConfig merchantConfig)
269268
* Delete subscription of a report name by organization
270269
*
271270
* @param reportName Name of the Report to Delete (required)
271+
* @param merchantConfig (merchant details)
272272
* @return ApiResponse&lt;Void&gt;
273273
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
274274
*/
@@ -281,6 +281,7 @@ public ApiResponse<Void> deleteSubscriptionWithHttpInfo(String reportName,Mercha
281281
* Delete subscription of a report name by organization (asynchronously)
282282
*
283283
* @param reportName Name of the Report to Delete (required)
284+
* @param merchantConfig (merchant details)
284285
* @param callback The callback to be executed when the API call finishes
285286
* @return The request call
286287
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -312,6 +313,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
312313
}
313314
/**
314315
* Build call for getAllSubscriptions
316+
* @param merchantConfig (merchant details)
315317
* @param progressListener Progress listener
316318
* @param progressRequestListener Progress request listener
317319
* @return Call to execute
@@ -372,7 +374,7 @@ private com.squareup.okhttp.Call getAllSubscriptionsValidateBeforeCall(MerchantC
372374

373375
/**
374376
* Retrieve all subscriptions by organization
375-
*
377+
* @param merchantConfig (merchant details)
376378
* @return ReportingV3ReportSubscriptionsGet200Response
377379
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
378380
*/
@@ -383,7 +385,7 @@ public ReportingV3ReportSubscriptionsGet200Response getAllSubscriptions(Merchant
383385

384386
/**
385387
* Retrieve all subscriptions by organization
386-
*
388+
* @param merchantConfig (merchant details)
387389
* @return ApiResponse&lt;ReportingV3ReportSubscriptionsGet200Response&gt;
388390
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
389391
*/
@@ -395,7 +397,7 @@ public ApiResponse<ReportingV3ReportSubscriptionsGet200Response> getAllSubscript
395397

396398
/**
397399
* Retrieve all subscriptions by organization (asynchronously)
398-
*
400+
* @param merchantConfig (merchant details)
399401
* @param callback The callback to be executed when the API call finishes
400402
* @return The request call
401403
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -429,6 +431,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
429431
/**
430432
* Build call for getSubscription
431433
* @param reportName Name of the Report to Retrieve (required)
434+
* @param merchantConfig (merchant details)
432435
* @param progressListener Progress listener
433436
* @param progressRequestListener Progress request listener
434437
* @return Call to execute
@@ -497,6 +500,7 @@ private com.squareup.okhttp.Call getSubscriptionValidateBeforeCall(String report
497500
* Retrieve subscription for a report name by organization
498501
*
499502
* @param reportName Name of the Report to Retrieve (required)
503+
* @param merchantConfig (merchant details)
500504
* @return ReportingV3ReportSubscriptionsGet200ResponseSubscriptions
501505
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
502506
*/
@@ -509,6 +513,7 @@ public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions getSubscription
509513
* Retrieve subscription for a report name by organization
510514
*
511515
* @param reportName Name of the Report to Retrieve (required)
516+
* @param merchantConfig (merchant details)
512517
* @return ApiResponse&lt;ReportingV3ReportSubscriptionsGet200ResponseSubscriptions&gt;
513518
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
514519
*/
@@ -522,6 +527,7 @@ public ApiResponse<ReportingV3ReportSubscriptionsGet200ResponseSubscriptions> ge
522527
* Retrieve subscription for a report name by organization (asynchronously)
523528
*
524529
* @param reportName Name of the Report to Retrieve (required)
530+
* @param merchantConfig (merchant details)
525531
* @param callback The callback to be executed when the API call finishes
526532
* @return The request call
527533
* @throws ApiException If fail to process the API call, e.g. serializing the request body object

src/main/java/Invokers/ApiClient.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,6 +1099,7 @@ public <T> T handleResponse(Response response, Type returnType) throws ApiExcept
10991099
*
11001100
* @param path The sub-path of the HTTP URL
11011101
* @param method The request method, one of "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" and "DELETE"
1102+
* @param merchantConfig (merchant details)
11021103
* @param queryParams The query parameters
11031104
* @param body The request body object
11041105
* @param headerParams The header parameters

src/main/java/Invokers/RequestBodyChild.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ public void writeTo(BufferedSink sink) throws IOException {
2626
/**
2727
* Returns a new request body that transmits {@code content}. If {@code
2828
* contentType} is non-null and lacks a charset, this will use UTF-8.
29+
* @param contentType (required content-type)
30+
* @param content (required body)
31+
* @return RequestBody generated.
2932
*/
3033
public static RequestBody create(MediaType contentType, String content) {
3134
Charset charset = Util.UTF_8;

0 commit comments

Comments
 (0)