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: docs/Addresses.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,12 +237,12 @@ var apiInstance = new OrderCloud.Addresses();
237
237
var buyerID ="buyerID_example"; // String | ID of the buyer.
238
238
239
239
var opts = {
240
-
'search':"search_example", // String | Word or phrase to search for.
241
-
'searchOn':"searchOn_example", // String | Comma-delimited list of fields to search on.
242
-
'sortBy':"sortBy_example", // String | Comma-delimited list of fields to sort by.
243
-
'page':56, // Number | Page of results to return. Default: 1
244
-
'pageSize':56, // Number | Number of results to return per page. Default: 20, max: 100.
245
-
'filters': {key:"filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
240
+
'search':"search_example", // String | Search of the address.
241
+
'searchOn':["searchOn_example"], //[String] | Search on of the address.
242
+
'sortBy':["sortBy_example"], //[String] | Sort by of the address.
243
+
'page':56, // Number | Page of the address.
244
+
'pageSize':56, // Number | Page size of the address.
245
+
'filters': {key:"filters_example"} // {String: String} | Filters of the address.
**search** | **String**| Word or phrase to search for. | [optional]
261
-
**searchOn** | **String**| Comma-delimited list of fields to search on. | [optional]
262
-
**sortBy** | **String**| Comma-delimited list of fields to sort by. | [optional]
263
-
**page** | **Number**| Page of results to return. Default: 1 | [optional]
264
-
**pageSize** | **Number**| Number of results to return per page. Default: 20, max: 100. | [optional]
265
-
**filters** | [**{String: String}**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' | [optional]
260
+
**search** | **String**| Search of the address. | [optional]
261
+
**searchOn** | [**[String]**](String.md)| Search on of the address. | [optional]
262
+
**sortBy** | [**[String]**](String.md)| Sort by of the address. | [optional]
263
+
**page** | **Number**| Page of the address. | [optional]
264
+
**pageSize** | **Number**| Page size of the address. | [optional]
265
+
**filters** | [**{String: String}**](String.md)| Filters of the address. | [optional]
266
266
267
267
### Return type
268
268
@@ -303,8 +303,8 @@ var opts = {
303
303
'level':"level_example", // String | Level of the address.
304
304
'isShipping':true, // Boolean | Is shipping of the address.
305
305
'isBilling':true, // Boolean | Is billing of the address.
306
-
'page':56, // Number | Page of results to return. Default: 1
307
-
'pageSize':56// Number | Number of results to return per page. Default: 20, max: 100.
306
+
'page':56, // Number | Page of the address.
307
+
'pageSize':56// Number | Page size of the address.
'search':"search_example", // String | Word or phrase to search for.
172
-
'searchOn':"searchOn_example", // String | Comma-delimited list of fields to search on.
173
-
'sortBy':"sortBy_example", // String | Comma-delimited list of fields to sort by.
174
-
'page':56, // Number | Page of results to return. Default: 1
175
-
'pageSize':56, // Number | Number of results to return per page. Default: 20, max: 100.
176
-
'filters': {key:"filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
171
+
'search':"search_example", // String | Search of the admin address.
172
+
'searchOn':["searchOn_example"], //[String] | Search on of the admin address.
173
+
'sortBy':["sortBy_example"], //[String] | Sort by of the admin address.
174
+
'page':56, // Number | Page of the admin address.
175
+
'pageSize':56, // Number | Page size of the admin address.
176
+
'filters': {key:"filters_example"} // {String: String} | Filters of the admin address.
177
177
};
178
178
apiInstance.List(opts).then(function(data) {
179
179
console.log('API called successfully. Returned data: '+ data);
**search** | **String**| Word or phrase to search for. | [optional]
191
-
**searchOn** | **String**| Comma-delimited list of fields to search on. | [optional]
192
-
**sortBy** | **String**| Comma-delimited list of fields to sort by. | [optional]
193
-
**page** | **Number**| Page of results to return. Default: 1 | [optional]
194
-
**pageSize** | **Number**| Number of results to return per page. Default: 20, max: 100. | [optional]
195
-
**filters** | [**{String: String}**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' | [optional]
190
+
**search** | **String**| Search of the admin address. | [optional]
191
+
**searchOn** | [**[String]**](String.md)| Search on of the admin address. | [optional]
192
+
**sortBy** | [**[String]**](String.md)| Sort by of the admin address. | [optional]
193
+
**page** | **Number**| Page of the admin address. | [optional]
194
+
**pageSize** | **Number**| Page size of the admin address. | [optional]
195
+
**filters** | [**{String: String}**](String.md)| Filters of the admin address. | [optional]
'search':"search_example", // String | Word or phrase to search for.
224
-
'searchOn':"searchOn_example", // String | Comma-delimited list of fields to search on.
225
-
'sortBy':"sortBy_example", // String | Comma-delimited list of fields to sort by.
226
-
'page':56, // Number | Page of results to return. Default: 1
227
-
'pageSize':56, // Number | Number of results to return per page. Default: 20, max: 100.
228
-
'filters': {key:"filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
223
+
'search':"search_example", // String | Search of the admin user group.
224
+
'searchOn':["searchOn_example"], //[String] | Search on of the admin user group.
225
+
'sortBy':["sortBy_example"], //[String] | Sort by of the admin user group.
226
+
'page':56, // Number | Page of the admin user group.
227
+
'pageSize':56, // Number | Page size of the admin user group.
228
+
'filters': {key:"filters_example"} // {String: String} | Filters of the admin user group.
229
229
};
230
230
apiInstance.List(opts).then(function(data) {
231
231
console.log('API called successfully. Returned data: '+ data);
**search** | **String**| Word or phrase to search for. | [optional]
243
-
**searchOn** | **String**| Comma-delimited list of fields to search on. | [optional]
244
-
**sortBy** | **String**| Comma-delimited list of fields to sort by. | [optional]
245
-
**page** | **Number**| Page of results to return. Default: 1 | [optional]
246
-
**pageSize** | **Number**| Number of results to return per page. Default: 20, max: 100. | [optional]
247
-
**filters** | [**{String: String}**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' | [optional]
242
+
**search** | **String**| Search of the admin user group. | [optional]
243
+
**searchOn** | [**[String]**](String.md)| Search on of the admin user group. | [optional]
244
+
**sortBy** | [**[String]**](String.md)| Sort by of the admin user group. | [optional]
245
+
**page** | **Number**| Page of the admin user group. | [optional]
246
+
**pageSize** | **Number**| Page size of the admin user group. | [optional]
247
+
**filters** | [**{String: String}**](String.md)| Filters of the admin user group. | [optional]
248
248
249
249
### Return type
250
250
@@ -279,8 +279,8 @@ var apiInstance = new OrderCloud.AdminUserGroups();
279
279
var opts = {
280
280
'userGroupID':"userGroupID_example", // String | ID of the user group.
281
281
'userID':"userID_example", // String | ID of the user.
282
-
'page':56, // Number | Page of results to return. Default: 1
283
-
'pageSize':56// Number | Number of results to return per page. Default: 20, max: 100.
282
+
'page':56, // Number | Page of the admin user group.
283
+
'pageSize':56// Number | Page size of the admin user group.
0 commit comments