Skip to content

Commit 46e353d

Browse files
RettBehrensRettBehrens
committed
regenerate from OAS 2.25.0
1 parent 84aa2c6 commit 46e353d

File tree

531 files changed

+3092
-1120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

531 files changed

+3092
-1120
lines changed

‎docs/accounting/AccountingApi.md‎

Lines changed: 359 additions & 227 deletions
Large diffs are not rendered by default.

‎docs/accounting/BatchPaymentDelete.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# XeroRuby::Accounting::BatchPaymentDelete
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**batch_payment_id** | **String** | The Xero generated unique identifier for the bank transaction (read-only) |
8+
**status** | **String** | The status of the batch payment. | [default to 'DELETED']
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'XeroRuby::Accounting'
14+
15+
instance = XeroRuby::Accounting::BatchPaymentDelete.new(batch_payment_id: null,
16+
status: null)
17+
```
18+
19+

‎docs/accounting/BatchPaymentDeleteByUrlParam.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# XeroRuby::Accounting::BatchPaymentDeleteByUrlParam
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status** | **String** | The status of the batch payment. | [default to 'DELETED']
8+
9+
## Code Sample
10+
11+
```ruby
12+
require 'XeroRuby::Accounting'
13+
14+
instance = XeroRuby::Accounting::BatchPaymentDeleteByUrlParam.new(status: null)
15+
```
16+
17+

‎docs/app_store/AppStoreApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ end
5454

5555
Name | Type | Description | Notes
5656
------------- | ------------- | ------------- | -------------
57-
**subscription_id** | **String**| Unique identifier for Subscription object |
57+
**subscription_id** | [**String**](.md)| Unique identifier for Subscription object |
5858

5959
### Return type
6060

‎docs/app_store/ProblemDetails.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**detail** | **String** | | [optional]
8-
**extensions** | **Object** | | [optional]
8+
**extensions** | [**Object**](.md) | | [optional]
99
**instance** | **String** | | [optional]
1010
**status** | **Integer** | | [optional]
1111
**title** | **String** | | [optional]

‎docs/assets/AssetApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ end
198198
Name | Type | Description | Notes
199199
------------- | ------------- | ------------- | -------------
200200
**xero_tenant_id** | **String**| Xero identifier for Tenant |
201-
**id** | **String**| fixed asset id for single object |
201+
**id** | [**String**](.md)| fixed asset id for single object |
202202

203203
### Return type
204204

@@ -376,15 +376,15 @@ api_instance = xero_client.<api_set>
376376

377377

378378
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
379-
status = # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
379+
status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
380380
opts = {
381381
page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
382382

383383
page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10.
384384

385-
order_by: 'AssetType', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
385+
order_by: 'AssetName', # String | Requests can be ordered by AssetType, AssetName, AssetNumber, PurchaseDate and PurchasePrice. If the asset status is DISPOSED it also allows DisposalDate and DisposalPrice.
386386

387-
sort_direction: 'asc', # String | ASC or DESC
387+
sort_direction: 'ASC', # String | ASC or DESC
388388

389389
filter_by: 'Company Car' # String | A string that can be used to filter the list to only return assets containing the text. Checks it against the AssetName, AssetNumber, Description and AssetTypeName fields.
390390
}

‎docs/files/FilesApi.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ end
7878
Name | Type | Description | Notes
7979
------------- | ------------- | ------------- | -------------
8080
**xero_tenant_id** | **String**| Xero identifier for Tenant |
81-
**file_id** | **String**| File id for single object |
81+
**file_id** | [**String**](.md)| File id for single object |
8282
**association** | [**Association**](Association.md)| | [optional]
8383

8484
### Return type
@@ -213,7 +213,7 @@ end
213213
Name | Type | Description | Notes
214214
------------- | ------------- | ------------- | -------------
215215
**xero_tenant_id** | **String**| Xero identifier for Tenant |
216-
**file_id** | **String**| File id for single object |
216+
**file_id** | [**String**](.md)| File id for single object |
217217

218218
### Return type
219219

@@ -279,8 +279,8 @@ end
279279
Name | Type | Description | Notes
280280
------------- | ------------- | ------------- | -------------
281281
**xero_tenant_id** | **String**| Xero identifier for Tenant |
282-
**file_id** | **String**| File id for single object |
283-
**object_id** | **String**| Object id for single object |
282+
**file_id** | [**String**](.md)| File id for single object |
283+
**object_id** | [**String**](.md)| Object id for single object |
284284

285285
### Return type
286286

@@ -345,7 +345,7 @@ end
345345
Name | Type | Description | Notes
346346
------------- | ------------- | ------------- | -------------
347347
**xero_tenant_id** | **String**| Xero identifier for Tenant |
348-
**folder_id** | **String**| Folder id for single object |
348+
**folder_id** | [**String**](.md)| Folder id for single object |
349349

350350
### Return type
351351

@@ -411,7 +411,7 @@ end
411411
Name | Type | Description | Notes
412412
------------- | ------------- | ------------- | -------------
413413
**xero_tenant_id** | **String**| Xero identifier for Tenant |
414-
**object_id** | **String**| Object id for single object |
414+
**object_id** | [**String**](.md)| Object id for single object |
415415

416416
### Return type
417417

@@ -475,7 +475,7 @@ end
475475
Name | Type | Description | Notes
476476
------------- | ------------- | ------------- | -------------
477477
**xero_tenant_id** | **String**| Xero identifier for Tenant |
478-
**file_id** | **String**| File id for single object |
478+
**file_id** | [**String**](.md)| File id for single object |
479479

480480
### Return type
481481

@@ -541,7 +541,7 @@ end
541541
Name | Type | Description | Notes
542542
------------- | ------------- | ------------- | -------------
543543
**xero_tenant_id** | **String**| Xero identifier for Tenant |
544-
**file_id** | **String**| File id for single object |
544+
**file_id** | [**String**](.md)| File id for single object |
545545

546546
### Return type
547547

@@ -607,7 +607,7 @@ end
607607
Name | Type | Description | Notes
608608
------------- | ------------- | ------------- | -------------
609609
**xero_tenant_id** | **String**| Xero identifier for Tenant |
610-
**file_id** | **String**| File id for single object |
610+
**file_id** | [**String**](.md)| File id for single object |
611611

612612
### Return type
613613

@@ -660,7 +660,7 @@ opts = {
660660

661661
page: 2, # Integer | number of records to skip for pagination
662662

663-
sort: 'Name' # String | values to sort by
663+
sort: 'CreatedDateUTC DESC' # String | values to sort by
664664
}
665665

666666
begin
@@ -746,7 +746,7 @@ end
746746
Name | Type | Description | Notes
747747
------------- | ------------- | ------------- | -------------
748748
**xero_tenant_id** | **String**| Xero identifier for Tenant |
749-
**folder_id** | **String**| Folder id for single object |
749+
**folder_id** | [**String**](.md)| Folder id for single object |
750750

751751
### Return type
752752

@@ -797,7 +797,7 @@ api_instance = xero_client.<api_set>
797797

798798
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
799799
opts = {
800-
sort: 'Name' # String | values to sort by
800+
sort: 'CreatedDateUTC DESC' # String | values to sort by
801801
}
802802

803803
begin
@@ -949,7 +949,7 @@ end
949949
Name | Type | Description | Notes
950950
------------- | ------------- | ------------- | -------------
951951
**xero_tenant_id** | **String**| Xero identifier for Tenant |
952-
**file_id** | **String**| File id for single object |
952+
**file_id** | [**String**](.md)| File id for single object |
953953
**file_object** | [**FileObject**](FileObject.md)| | [optional]
954954

955955
### Return type
@@ -1017,7 +1017,7 @@ end
10171017
Name | Type | Description | Notes
10181018
------------- | ------------- | ------------- | -------------
10191019
**xero_tenant_id** | **String**| Xero identifier for Tenant |
1020-
**folder_id** | **String**| Folder id for single object |
1020+
**folder_id** | [**String**](.md)| Folder id for single object |
10211021
**folder** | [**Folder**](Folder.md)| |
10221022

10231023
### Return type
@@ -1162,7 +1162,7 @@ end
11621162
Name | Type | Description | Notes
11631163
------------- | ------------- | ------------- | -------------
11641164
**xero_tenant_id** | **String**| Xero identifier for Tenant |
1165-
**folder_id** | **String**| pass required folder id to save file to specific folder |
1165+
**folder_id** | [**String**](.md)| pass required folder id to save file to specific folder |
11661166
**body** | **String**| |
11671167
**name** | **String**| exact name of the file you are uploading |
11681168
**filename** | **String**| |

‎docs/files/UploadObject.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# XeroRuby::Files::UploadObject
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**body** | **String** | |
8+
**name** | **String** | exact name of the file you are uploading |
9+
**filename** | **String** | |
10+
**mime_type** | **String** | | [optional]
11+
12+
## Code Sample
13+
14+
```ruby
15+
require 'XeroRuby::Files'
16+
17+
instance = XeroRuby::Files::UploadObject.new(body: null,
18+
name: null,
19+
filename: null,
20+
mime_type: null)
21+
```
22+
23+

‎docs/finance/FinanceApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ api_instance = xero_client.<api_set>
332332

333333

334334
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
335-
bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | string, GUID Bank account Id
335+
bank_account_id = 'bank_account_id_example' # String | string, GUID Bank account Id
336336
from_date = '2020-07-01' # String | date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.
337337
to_date = '2021-06-30' # String | date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected.
338338
opts = {
@@ -354,7 +354,7 @@ end
354354
Name | Type | Description | Notes
355355
------------- | ------------- | ------------- | -------------
356356
**xero_tenant_id** | **String**| Xero identifier for Tenant |
357-
**bank_account_id** | **String**| string, GUID Bank account Id |
357+
**bank_account_id** | [**String**](.md)| string, GUID Bank account Id |
358358
**from_date** | **String**| date, yyyy-MM-dd Specifies the start date of the query period. The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected. |
359359
**to_date** | **String**| date, yyyy-MM-dd Specifies the end date of the query period. If the end date is a future date, the request will be rejected. |
360360
**summary_only** | **Boolean**| boolean, true/false The default value is true if no parameter is provided. In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient. | [optional]
@@ -624,7 +624,7 @@ api_instance = xero_client.<api_set>
624624

625625
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
626626
opts = {
627-
contact_ids: ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"], # Array&lt;String&gt; | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
627+
contact_ids: ['[\"00000000-0000-0000-0000-000000000000\",\"00000000-0000-0000-0000-000000000000\"]'], # Array<String> | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
628628

629629
include_manual_journals: true, # Boolean | Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
630630

@@ -702,7 +702,7 @@ api_instance = xero_client.<api_set>
702702

703703
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
704704
opts = {
705-
contact_ids: ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000"], # Array&lt;String&gt; | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
705+
contact_ids: ['[\"00000000-0000-0000-0000-000000000000\",\"00000000-0000-0000-0000-000000000000\"]'], # Array<String> | Specifies the customer contacts to be included in the report. If no parameter is provided, all customer contacts will be included
706706

707707
include_manual_journals: true, # Boolean | Specifies whether to include the manual journals in the report. If no parameter is provided, manual journals will not be included.
708708

0 commit comments

Comments
 (0)