Skip to content

Commit c58bcf4

Browse files
authored
Merge pull request #219 from XeroAPI/xero-ruby-3.7.0
generates xero-ruby-3.7.0 from OAS 2.19.1
2 parents 53f0118 + fb88166 commit c58bcf4

44 files changed

Lines changed: 4395 additions & 30 deletions

Some content is hidden

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

docs/accounting/LineItem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**account_id** | **String** | The associated account ID related to this line item | [optional]
1414
**tax_type** | **String** | The tax type from TaxRates | [optional]
1515
**tax_amount** | **BigDecimal** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional]
16+
**item** | [**LineItemItem**](LineItemItem.md) | | [optional]
1617
**line_amount** | **BigDecimal** | If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional]
1718
**tracking** | [**Array<LineItemTracking>**](LineItemTracking.md) | Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements. | [optional]
1819
**discount_rate** | **BigDecimal** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
@@ -33,6 +34,7 @@ instance = XeroRuby::Accounting::LineItem.new(line_item_id: 00000000-0000-0000-0
3334
account_id: 00000000-0000-0000-0000-000000000000,
3435
tax_type: null,
3536
tax_amount: null,
37+
item: null,
3638
line_amount: null,
3739
tracking: null,
3840
discount_rate: null,

docs/accounting/LineItemItem.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# XeroRuby::Accounting::LineItemItem
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**code** | **String** | User defined item code (max length = 30) | [optional]
8+
**name** | **String** | The name of the item (max length = 50) | [optional]
9+
**item_id** | **String** | The Xero identifier for an Item | [optional]
10+
11+
## Code Sample
12+
13+
```ruby
14+
require 'XeroRuby::Accounting'
15+
16+
instance = XeroRuby::Accounting::LineItemItem.new(code: null,
17+
name: null,
18+
item_id: null)
19+
```
20+
21+

docs/accounting/index.html

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3535,6 +3535,9 @@
35353535
"format" : "double",
35363536
"x-is-money" : true
35373537
},
3538+
"Item" : {
3539+
"$ref" : "#/components/schemas/LineItemItem"
3540+
},
35383541
"LineAmount" : {
35393542
"type" : "number",
35403543
"description" : "If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)",
@@ -3571,6 +3574,27 @@
35713574
"externalDocs" : {
35723575
"url" : "https://developer.xero.com/documentation/api/invoices#post"
35733576
}
3577+
};
3578+
defs["LineItemItem"] = {
3579+
"title" : "",
3580+
"properties" : {
3581+
"Code" : {
3582+
"maxLength" : 30,
3583+
"type" : "string",
3584+
"description" : "User defined item code (max length = 30)"
3585+
},
3586+
"Name" : {
3587+
"maxLength" : 50,
3588+
"type" : "string",
3589+
"description" : "The name of the item (max length = 50)"
3590+
},
3591+
"ItemID" : {
3592+
"type" : "string",
3593+
"description" : "The Xero identifier for an Item",
3594+
"format" : "uuid"
3595+
}
3596+
},
3597+
"description" : ""
35743598
};
35753599
defs["LineItemTracking"] = {
35763600
"title" : "",
@@ -5984,7 +6008,7 @@
59846008
<nav id="scrollingNav">
59856009
<ul class="sidenav nav nav-list">
59866010
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
5987-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.6.0</li>
6011+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.7.0</li>
59886012
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
59896013
<li data-group="Accounting" data-name="createAccount" class="">
59906014
<a href="#api-Accounting-createAccount">createAccount</a>

docs/app_store/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1133,7 +1133,7 @@
11331133
<nav id="scrollingNav">
11341134
<ul class="sidenav nav nav-list">
11351135
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1136-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.6.0</li>
1136+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.7.0</li>
11371137
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11381138
<li data-group="AppStore" data-name="getSubscription" class="">
11391139
<a href="#api-AppStore-getSubscription">getSubscription</a>

docs/assets/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1391,7 +1391,7 @@
13911391
<nav id="scrollingNav">
13921392
<ul class="sidenav nav nav-list">
13931393
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1394-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.6.0</li>
1394+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.7.0</li>
13951395
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13961396
<li data-group="Asset" data-name="createAsset" class="">
13971397
<a href="#api-Asset-createAsset">createAsset</a>

docs/files/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1155,7 +1155,7 @@
11551155
<nav id="scrollingNav">
11561156
<ul class="sidenav nav nav-list">
11571157
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1158-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>3.6.0</li>
1158+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>3.7.0</li>
11591159
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11601160
<li data-group="Files" data-name="createFileAssociation" class="">
11611161
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# XeroRuby::Finance::BankStatementAccountingResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**bank_account_id** | **String** | Xero Identifier of bank account | [optional]
8+
**bank_account_name** | **String** | Name of bank account | [optional]
9+
**bank_account_currency_code** | **String** | Currency code of the bank account | [optional]
10+
**statements** | [**Array&lt;StatementResponse&gt;**](StatementResponse.md) | List of bank statements and linked accounting data for the requested period | [optional]
11+
12+
## Code Sample
13+
14+
```ruby
15+
require 'XeroRuby::Finance'
16+
17+
instance = XeroRuby::Finance::BankStatementAccountingResponse.new(bank_account_id: null,
18+
bank_account_name: null,
19+
bank_account_currency_code: null,
20+
statements: null)
21+
```
22+
23+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# XeroRuby::Finance::BankTransactionResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**bank_transaction_id** | **String** | Xero Identifier of transaction | [optional]
8+
**batch_payment_id** | **String** | Xero Identifier of batch payment. Present if the transaction is part of a batch. | [optional]
9+
**contact** | [**ContactResponse**](ContactResponse.md) | | [optional]
10+
**date** | **DateTime** | Date of transaction - YYYY-MM-DD | [optional]
11+
**amount** | **BigDecimal** | Amount of transaction | [optional]
12+
**line_items** | [**Array&lt;LineItemResponse&gt;**](LineItemResponse.md) | The LineItems element can contain any number of individual LineItem sub-elements. Not included in summary mode | [optional]
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'XeroRuby::Finance'
18+
19+
instance = XeroRuby::Finance::BankTransactionResponse.new(bank_transaction_id: null,
20+
batch_payment_id: null,
21+
contact: null,
22+
date: null,
23+
amount: null,
24+
line_items: null)
25+
```
26+
27+

docs/finance/ContactResponse.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# XeroRuby::Finance::ContactResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**contact_id** | **String** | Xero Identifier of contact | [optional]
8+
**contact_name** | **String** | Full name of contact/organisation | [optional]
9+
10+
## Code Sample
11+
12+
```ruby
13+
require 'XeroRuby::Finance'
14+
15+
instance = XeroRuby::Finance::ContactResponse.new(contact_id: null,
16+
contact_name: null)
17+
```
18+
19+

docs/finance/CreditNoteResponse.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# XeroRuby::Finance::CreditNoteResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**credit_note_id** | **String** | Xero Identifier of credit note | [optional]
8+
**contact** | [**ContactResponse**](ContactResponse.md) | | [optional]
9+
**total** | **BigDecimal** | Total of Invoice tax inclusive (i.e. SubTotal + TotalTax); Not included in summary mode | [optional]
10+
**line_items** | [**Array&lt;LineItemResponse&gt;**](LineItemResponse.md) | Not included in summary mode | [optional]
11+
12+
## Code Sample
13+
14+
```ruby
15+
require 'XeroRuby::Finance'
16+
17+
instance = XeroRuby::Finance::CreditNoteResponse.new(credit_note_id: null,
18+
contact: null,
19+
total: null,
20+
line_items: null)
21+
```
22+
23+

0 commit comments

Comments
 (0)