Skip to content

Commit d59a441

Browse files
committed
Fixed javadoc
1 parent a0c3169 commit d59a441

12 files changed

+25
-2
lines changed

client/src/main/java/au/org/consumerdatastandards/client/api/CommonCustomerAPI.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public ResponseCommonCustomer getCustomer() throws ApiException {
9797

9898
/**
9999
* Get Customer
100-
* Obtain basic information on the customer that has authorised the current session\n\n<h3 id='cdr-common-api_get-customer_conventions'>Conventions</h3>\nIn the customer payloads relevant conventions are explained here, in one place.\n\n#### Given Names\n\n`firstName` represents the first of a person's given names.\n\n`middleNames` represents a collection of given names if the person has more than one given name.\n\nWhere a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the `firstName` field to return the single string of given names and an empty `middleNames` array.\n\nFor example, a person whose given names are \"John Paul Winston\" but the data holder cannot determine what is the first name, can return `\"firstName\": \"John Paul Winston\"`.
100+
* Obtain basic information on the customer that has authorised the current session\n\n<h3>Conventions</h3>\nIn the customer payloads relevant conventions are explained here, in one place.\n\n#### Given Names\n\n`firstName` represents the first of a person's given names.\n\n`middleNames` represents a collection of given names if the person has more than one given name.\n\nWhere a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the `firstName` field to return the single string of given names and an empty `middleNames` array.\n\nFor example, a person whose given names are \"John Paul Winston\" but the data holder cannot determine what is the first name, can return `\"firstName\": \"John Paul Winston\"`.
101101
* @return ApiResponse&lt;ResponseCommonCustomer&gt;
102102
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
103103
* http.response.details
@@ -122,7 +122,7 @@ public ApiResponse<ResponseCommonCustomer> getCustomerWithHttpInfo() throws ApiE
122122

123123
/**
124124
* Get Customer (asynchronously)
125-
* Obtain basic information on the customer that has authorised the current session\n\n<h3 id='cdr-common-api_get-customer_conventions'>Conventions</h3>\nIn the customer payloads relevant conventions are explained here, in one place.\n\n#### Given Names\n\n`firstName` represents the first of a person's given names.\n\n`middleNames` represents a collection of given names if the person has more than one given name.\n\nWhere a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the `firstName` field to return the single string of given names and an empty `middleNames` array.\n\nFor example, a person whose given names are \"John Paul Winston\" but the data holder cannot determine what is the first name, can return `\"firstName\": \"John Paul Winston\"`.
125+
* Obtain basic information on the customer that has authorised the current session\n\n<h3>Conventions</h3>\nIn the customer payloads relevant conventions are explained here, in one place.\n\n#### Given Names\n\n`firstName` represents the first of a person's given names.\n\n`middleNames` represents a collection of given names if the person has more than one given name.\n\nWhere a data holder holds a person's given names as a single string in source systems, it may not possible in some situations to reliably split these given names into their component first and middle names. In these situations, data holders MAY use the `firstName` field to return the single string of given names and an empty `middleNames` array.\n\nFor example, a person whose given names are \"John Paul Winston\" but the data holder cannot determine what is the first name, can return `\"firstName\": \"John Paul Winston\"`.
126126
* @param _callback The callback to be executed when the API call finishes
127127
* @return The request call
128128
* @throws ApiException If fail to process the API call, e.g. serializing the request body object

client/src/main/java/au/org/consumerdatastandards/client/api/banking/BankingScheduledPaymentsAPI.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,7 @@ private okhttp3.Call listScheduledPaymentsBulkValidateBeforeCall(BankingProductC
259259
* @param isOwned Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)
260260
* @param page Page of results to request (standard pagination) (optional, default to 1)
261261
* @param pageSize Page size to request. Default is 25 (standard pagination) (optional, default to 25)
262+
* @param <T> Type
262263
* @return ResponseBankingScheduledPaymentsList
263264
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
264265
* http.response.details
@@ -296,6 +297,7 @@ public <T extends BankingScheduledPaymentTo> ResponseBankingScheduledPaymentsLis
296297
* @param isOwned Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts (optional)
297298
* @param page Page of results to request (standard pagination) (optional, default to 1)
298299
* @param pageSize Page size to request. Default is 25 (standard pagination) (optional, default to 25)
300+
* @param <T> Type
299301
* @return ApiResponse&lt;ResponseBankingScheduledPaymentsList&gt;
300302
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
301303
* http.response.details
@@ -421,6 +423,7 @@ private okhttp3.Call listScheduledPaymentsSpecificAccountsValidateBeforeCall(Req
421423
* @param accountIds Array of specific accountIds to obtain scheduled payments for. The accounts specified are the source of funds for the payments returned (required)
422424
* @param page Page of results to request (standard pagination) (optional, default to 1)
423425
* @param pageSize Page size to request. Default is 25 (standard pagination) (optional, default to 25)
426+
* @param version endpoint version
424427
* @return ResponseBankingScheduledPaymentsList
425428
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
426429
* http.response.details

client/src/main/java/au/org/consumerdatastandards/client/model/banking/BankingScheduledPaymentToV1.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,8 @@ protected void writeProperties(StringBuilder sb) {
186186
/**
187187
* Convert the given object to string with each line indented by 4 spaces
188188
* (except the first line).
189+
* @param o Object
190+
* @return Indented string representation of <code>o</code>
189191
*/
190192
protected String toIndentedString(Object o) {
191193
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyAccountDetailBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,8 @@ protected void writeProperties(StringBuilder sb) {
128128
/**
129129
* Convert the given object to string with each line indented by 4 spaces
130130
* (except the first line).
131+
* @param o Object
132+
* @return Indented string representation of <code>o</code>
131133
*/
132134
protected String toIndentedString(Object o) {
133135
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyAccountDetailPlanDetailBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ protected void writeProperties(StringBuilder sb) {
108108
/**
109109
* Convert the given object to string with each line indented by 4 spaces
110110
* (except the first line).
111+
* @param o Object
112+
* @return Indented string representation of <code>o</code>
111113
*/
112114
protected String toIndentedString(Object o) {
113115
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyAccountDetailPlansBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ protected void writeProperties(StringBuilder sb) {
134134
/**
135135
* Convert the given object to string with each line indented by 4 spaces
136136
* (except the first line).
137+
* @param o Object
138+
* @return Indented string representation of <code>o</code>
137139
*/
138140
protected String toIndentedString(Object o) {
139141
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyBillingDemandTransactionV2.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,8 @@ protected void writeProperties(StringBuilder sb) {
317317
/**
318318
* Convert the given object to string with each line indented by 4 spaces
319319
* (except the first line).
320+
* @param o Object
321+
* @return Indented string representation of <code>o</code>
320322
*/
321323
protected String toIndentedString(Object o) {
322324
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyBillingTransactionBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,8 @@ protected void writeProperties(StringBuilder sb) {
205205
/**
206206
* Convert the given object to string with each line indented by 4 spaces
207207
* (except the first line).
208+
* @param o Object
209+
* @return Indented string representation of <code>o</code>
208210
*/
209211
protected String toIndentedString(Object o) {
210212
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyPlanContractBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,8 @@ protected void writeProperties(StringBuilder sb) {
420420
/**
421421
* Convert the given object to string with each line indented by 4 spaces
422422
* (except the first line).
423+
* @param o Object
424+
* @return Indented string representation of <code>o</code>
423425
*/
424426
protected String toIndentedString(Object o) {
425427
if (o == null) {

client/src/main/java/au/org/consumerdatastandards/client/model/energy/EnergyPlanContractSolarFeedInTariffBase.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,8 @@ protected void writeProperties(StringBuilder sb) {
140140
/**
141141
* Convert the given object to string with each line indented by 4 spaces
142142
* (except the first line).
143+
* @param o Object
144+
* @return Indented string representation of <code>o</code>
143145
*/
144146
protected String toIndentedString(Object o) {
145147
if (o == null) {

0 commit comments

Comments
 (0)