regenerate from OAS 2.25.0

XeroAPI · Aug 5, 2022 · 46e353d · 46e353d
1 parent 84aa2c6
commit 46e353d
Show file tree

Hide file tree

Showing 531 changed files with 3,092 additions and 1,120 deletions.
diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md
diff --git a/docs/accounting/BatchPaymentDelete.md b/docs/accounting/BatchPaymentDelete.md
@@ -0,0 +1,19 @@
+# XeroRuby::Accounting::BatchPaymentDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batch_payment_id** | **String** | The Xero generated unique identifier for the bank transaction (read-only) | 
+**status** | **String** | The status of the batch payment. | [default to &#39;DELETED&#39;]
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::BatchPaymentDelete.new(batch_payment_id: null,
+                                 status: null)
+```
+
+
diff --git a/docs/accounting/BatchPaymentDeleteByUrlParam.md b/docs/accounting/BatchPaymentDeleteByUrlParam.md
@@ -0,0 +1,17 @@
+# XeroRuby::Accounting::BatchPaymentDeleteByUrlParam
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The status of the batch payment. | [default to &#39;DELETED&#39;]
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Accounting'
+
+instance = XeroRuby::Accounting::BatchPaymentDeleteByUrlParam.new(status: null)
+```
+
+
diff --git a/docs/app_store/AppStoreApi.md b/docs/app_store/AppStoreApi.md
@@ -54,7 +54,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **subscription_id** | **String**| Unique identifier for Subscription object | 
+ **subscription_id** | [**String**](.md)| Unique identifier for Subscription object | 
 
 ### Return type
 

diff --git a/docs/app_store/ProblemDetails.md b/docs/app_store/ProblemDetails.md
@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **detail** | **String** |  | [optional] 
-**extensions** | **Object** |  | [optional] 
+**extensions** | [**Object**](.md) |  | [optional] 
 **instance** | **String** |  | [optional] 
 **status** | **Integer** |  | [optional] 
 **title** | **String** |  | [optional] 

diff --git a/docs/assets/AssetApi.md b/docs/assets/AssetApi.md
@@ -198,7 +198,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **id** | **String**| fixed asset id for single object | 
+ **id** | [**String**](.md)| fixed asset id for single object | 
 
 ### Return type
 
@@ -376,15 +376,15 @@ api_instance = xero_client.<api_set>
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-status =  # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
+status = XeroRuby::Assets::AssetStatusQueryParam.new # AssetStatusQueryParam | Required when retrieving a collection of assets. See Asset Status Codes
 opts = {
   page: 1, # Integer | Results are paged. This specifies which page of the results to return. The default page is 1.
 
   page_size: 5, # Integer | The number of records returned per page. By default the number of records returned is 10.
 
-  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.
+  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.
 
-  sort_direction: 'asc', # String | ASC or DESC
+  sort_direction: 'ASC', # String | ASC or DESC
 
   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.
 }

diff --git a/docs/files/FilesApi.md b/docs/files/FilesApi.md
@@ -78,7 +78,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
  **association** | [**Association**](Association.md)|  | [optional] 
 
 ### Return type
@@ -213,7 +213,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
 
 ### Return type
 
@@ -279,8 +279,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
- **object_id** | **String**| Object id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
+ **object_id** | [**String**](.md)| Object id for single object | 
 
 ### Return type
 
@@ -345,7 +345,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **folder_id** | **String**| Folder id for single object | 
+ **folder_id** | [**String**](.md)| Folder id for single object | 
 
 ### Return type
 
@@ -411,7 +411,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **object_id** | **String**| Object id for single object | 
+ **object_id** | [**String**](.md)| Object id for single object | 
 
 ### Return type
 
@@ -475,7 +475,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
 
 ### Return type
 
@@ -541,7 +541,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
 
 ### Return type
 
@@ -607,7 +607,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
 
 ### Return type
 
@@ -660,7 +660,7 @@ opts = {
 
   page: 2, # Integer | number of records to skip for pagination
 
-  sort: 'Name' # String | values to sort by
+  sort: 'CreatedDateUTC DESC' # String | values to sort by
 }
 
 begin
@@ -746,7 +746,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **folder_id** | **String**| Folder id for single object | 
+ **folder_id** | [**String**](.md)| Folder id for single object | 
 
 ### Return type
 
@@ -797,7 +797,7 @@ api_instance = xero_client.<api_set>
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 opts = {
-  sort: 'Name' # String | values to sort by
+  sort: 'CreatedDateUTC DESC' # String | values to sort by
 }
 
 begin
@@ -949,7 +949,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **file_id** | **String**| File id for single object | 
+ **file_id** | [**String**](.md)| File id for single object | 
  **file_object** | [**FileObject**](FileObject.md)|  | [optional] 
 
 ### Return type
@@ -1017,7 +1017,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **folder_id** | **String**| Folder id for single object | 
+ **folder_id** | [**String**](.md)| Folder id for single object | 
  **folder** | [**Folder**](Folder.md)|  | 
 
 ### Return type
@@ -1162,7 +1162,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **folder_id** | **String**| pass required folder id to save file to specific folder | 
+ **folder_id** | [**String**](.md)| pass required folder id to save file to specific folder | 
  **body** | **String**|  | 
  **name** | **String**| exact name of the file you are uploading | 
  **filename** | **String**|  | 

diff --git a/docs/files/UploadObject.md b/docs/files/UploadObject.md
@@ -0,0 +1,23 @@
+# XeroRuby::Files::UploadObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** |  | 
+**name** | **String** | exact name of the file you are uploading | 
+**filename** | **String** |  | 
+**mime_type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'XeroRuby::Files'
+
+instance = XeroRuby::Files::UploadObject.new(body: null,
+                                 name: null,
+                                 filename: null,
+                                 mime_type: null)
+```
+
+
diff --git a/docs/finance/FinanceApi.md b/docs/finance/FinanceApi.md
@@ -332,7 +332,7 @@ api_instance = xero_client.<api_set>
 
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
-bank_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | string, GUID    Bank account Id
+bank_account_id = 'bank_account_id_example' # String | string, GUID    Bank account Id
 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.
 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.
 opts = {
@@ -354,7 +354,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **xero_tenant_id** | **String**| Xero identifier for Tenant | 
- **bank_account_id** | **String**| string, GUID    Bank account Id | 
+ **bank_account_id** | [**String**](.md)| string, GUID    Bank account Id | 
  **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. | 
  **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. | 
  **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>
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 opts = {
-  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
+  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
 
   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.
 
@@ -702,7 +702,7 @@ api_instance = xero_client.<api_set>
 
 xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
 opts = {
-  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
+  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
 
   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.