Skip to content

Commit 626d9fc

Browse files
Build from OAS 5.0.0 (#283)
Co-authored-by: manishT72x <[email protected]>
1 parent 39afb5a commit 626d9fc

36 files changed

+3583
-116
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Sample apps can get you started quickly with simple auth flows to advanced usage
4646
| --- | --- | --- |
4747
| [`xero-ruby-oauth2-starter`](https://github.com/XeroAPI/Xero-ruby-oauth2-starter) | A Sinatra application showing the basic getting started code to work with the sdk | <img src="https://i.imgur.com/9H4F98M.png" alt="drawing" width="300"/>
4848
| [`xero-ruby-oauth2-app`](https://github.com/XeroAPI/Xero-ruby-oauth2-app) | Complete rails app with +95% of api set examples, complex filters, pagination, and user/token management in postgres | <img src="https://i.imgur.com/XsAp9Ww.png" alt="drawing" width="500"/>
49-
| [`xero-ruby-custom-connections-starter`](https://github.com/XeroAPI/xero-ruby-custom-connections-starter) | A getting started Sinatra app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/guides/oauth2/custom-connections) for building M2M integrations to a single org | <img src="https://i.imgur.com/YEkScui.png" alt="drawing" width="300"/>
49+
| [`xero-ruby-custom-connections-starter`](https://github.com/XeroAPI/xero-ruby-custom-connections-starter) | A getting started Sinatra app showing Custom Connections - a Xero [premium option](https://developer.xero.com/documentation/oauth2/custom-connections) for building M2M integrations to a single org | <img src="https://i.imgur.com/YEkScui.png" alt="drawing" width="300"/>
5050
| [`xero-ruby-sso-form`](https://github.com/XeroAPI/xero-ruby-sso-form) | A basic Sinatra app showing how to implement SSU to Lead | <img src="https://i.imgur.com/Nf95GVd.png" alt="drawing" width="300"/>
5151

5252
<hr>

docs/accounting/AccountingApi.md

+46-25
Original file line numberDiff line numberDiff line change
@@ -5795,7 +5795,7 @@ Name | Type | Description | Notes
57955795

57965796
## get_bank_transactions
57975797

5798-
> BankTransactions get_bank_transactions(xero_tenant_id, opts)
5798+
> GetBankTransactionsResponse get_bank_transactions(xero_tenant_id, opts)
57995799

58005800
Retrieves any spent or received money transactions
58015801

@@ -5834,7 +5834,9 @@ opts = {
58345834

58355835
page: 1, # Integer | Up to 100 bank transactions will be returned in a single API call with line items details
58365836

5837-
unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
5837+
unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
5838+
5839+
page_size: 100 # Integer | Number of records to retrieve per page
58385840
}
58395841

58405842
begin
@@ -5857,10 +5859,11 @@ Name | Type | Description | Notes
58575859
**order** | **String**| Order by an any element | [optional]
58585860
**page** | **Integer**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional]
58595861
**unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
5862+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
58605863

58615864
### Return type
58625865

5863-
[**BankTransactions**](BankTransactions.md)
5866+
[**GetBankTransactionsResponse**](GetBankTransactionsResponse.md)
58645867

58655868
### Authorization
58665869

@@ -7465,7 +7468,7 @@ Name | Type | Description | Notes
74657468

74667469
## get_contacts
74677470

7468-
> Contacts get_contacts(xero_tenant_id, opts)
7471+
> GetContactsResponse get_contacts(xero_tenant_id, opts)
74697472

74707473
Retrieves all contacts in a Xero organisation
74717474

@@ -7510,7 +7513,9 @@ opts = {
75107513

75117514
summary_only: false, # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
75127515

7513-
search_term: 'Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7516+
search_term: 'Joe Bloggs', # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
7517+
7518+
page_size: 100 # Integer | Number of records to retrieve per page
75147519
}
75157520

75167521
begin
@@ -7536,10 +7541,11 @@ Name | Type | Description | Notes
75367541
**include_archived** | **Boolean**| e.g. includeArchived&#x3D;true - Contacts with a status of ARCHIVED will be included in the response | [optional]
75377542
**summary_only** | **Boolean**| Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to false]
75387543
**search_term** | **String**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional]
7544+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
75397545

75407546
### Return type
75417547

7542-
[**Contacts**](Contacts.md)
7548+
[**GetContactsResponse**](GetContactsResponse.md)
75437549

75447550
### Authorization
75457551

@@ -7950,7 +7956,7 @@ Name | Type | Description | Notes
79507956

79517957
## get_credit_notes
79527958

7953-
> CreditNotes get_credit_notes(xero_tenant_id, opts)
7959+
> GetCreditNotesResponse get_credit_notes(xero_tenant_id, opts)
79547960

79557961
Retrieves any credit notes
79567962

@@ -7989,7 +7995,9 @@ opts = {
79897995

79907996
page: 1, # Integer | e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
79917997

7992-
unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
7998+
unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
7999+
8000+
page_size: 100 # Integer | Number of records to retrieve per page
79938001
}
79948002

79958003
begin
@@ -8012,10 +8020,11 @@ Name | Type | Description | Notes
80128020
**order** | **String**| Order by an any element | [optional]
80138021
**page** | **Integer**| e.g. page&#x3D;1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note | [optional]
80148022
**unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
8023+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
80158024

80168025
### Return type
80178026

8018-
[**CreditNotes**](CreditNotes.md)
8027+
[**GetCreditNotesResponse**](GetCreditNotesResponse.md)
80198028

80208029
### Authorization
80218030

@@ -8896,7 +8905,7 @@ Name | Type | Description | Notes
88968905

88978906
## get_invoices
88988907

8899-
> Invoices get_invoices(xero_tenant_id, opts)
8908+
> GetInvoicesResponse get_invoices(xero_tenant_id, opts)
89008909

89018910
Retrieves sales invoices or purchase bills
89028911

@@ -8949,7 +8958,9 @@ opts = {
89498958

89508959
unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
89518960

8952-
summary_only: false # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
8961+
summary_only: false, # Boolean | Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
8962+
8963+
page_size: 100 # Integer | Number of records to retrieve per page
89538964
}
89548965

89558966
begin
@@ -8979,10 +8990,11 @@ Name | Type | Description | Notes
89798990
**created_by_my_app** | **Boolean**| When set to true you&#39;ll only retrieve Invoices created by your app | [optional]
89808991
**unitdp** | **Integer**| e.g. unitdp&#x3D;4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional]
89818992
**summary_only** | **Boolean**| Use summaryOnly&#x3D;true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient. | [optional] [default to false]
8993+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
89828994

89838995
### Return type
89848996

8985-
[**Invoices**](Invoices.md)
8997+
[**GetInvoicesResponse**](GetInvoicesResponse.md)
89868998

89878999
### Authorization
89889000

@@ -9816,7 +9828,7 @@ Name | Type | Description | Notes
98169828

98179829
## get_manual_journals
98189830

9819-
> ManualJournals get_manual_journals(xero_tenant_id, opts)
9831+
> GetManualJournalsResponse get_manual_journals(xero_tenant_id, opts)
98209832

98219833
Retrieves manual journals
98229834

@@ -9853,7 +9865,9 @@ opts = {
98539865

98549866
order: 'Date ASC', # String | Order by an any element
98559867

9856-
page: 1 # Integer | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
9868+
page: 1, # Integer | e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
9869+
9870+
page_size: 100 # Integer | Number of records to retrieve per page
98579871
}
98589872

98599873
begin
@@ -9875,10 +9889,11 @@ Name | Type | Description | Notes
98759889
**where** | **String**| Filter by an any element | [optional]
98769890
**order** | **String**| Order by an any element | [optional]
98779891
**page** | **Integer**| e.g. page&#x3D;1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment | [optional]
9892+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
98789893

98799894
### Return type
98809895

9881-
[**ManualJournals**](ManualJournals.md)
9896+
[**GetManualJournalsResponse**](GetManualJournalsResponse.md)
98829897

98839898
### Authorization
98849899

@@ -10336,7 +10351,7 @@ Name | Type | Description | Notes
1033610351

1033710352
## get_overpayments
1033810353

10339-
> Overpayments get_overpayments(xero_tenant_id, opts)
10354+
> GetOverpaymentsResponse get_overpayments(xero_tenant_id, opts)
1034010355

1034110356
Retrieves overpayments
1034210357

@@ -10401,7 +10416,7 @@ Name | Type | Description | Notes
1040110416

1040210417
### Return type
1040310418

10404-
[**Overpayments**](Overpayments.md)
10419+
[**GetOverpaymentsResponse**](GetOverpaymentsResponse.md)
1040510420

1040610421
### Authorization
1040710422

@@ -10605,7 +10620,7 @@ Name | Type | Description | Notes
1060510620

1060610621
## get_payments
1060710622

10608-
> Payments get_payments(xero_tenant_id, opts)
10623+
> GetPaymentsResponse get_payments(xero_tenant_id, opts)
1060910624

1061010625
Retrieves payments for invoices and credit notes
1061110626

@@ -10642,7 +10657,9 @@ opts = {
1064210657

1064310658
order: 'Amount ASC', # String | Order by an any element
1064410659

10645-
page: 1 # Integer | Up to 100 payments will be returned in a single API call
10660+
page: 1, # Integer | Up to 100 payments will be returned in a single API call
10661+
10662+
page_size: 100 # Integer | Number of records to retrieve per page
1064610663
}
1064710664

1064810665
begin
@@ -10664,10 +10681,11 @@ Name | Type | Description | Notes
1066410681
**where** | **String**| Filter by an any element | [optional]
1066510682
**order** | **String**| Order by an any element | [optional]
1066610683
**page** | **Integer**| Up to 100 payments will be returned in a single API call | [optional]
10684+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
1066710685

1066810686
### Return type
1066910687

10670-
[**Payments**](Payments.md)
10688+
[**GetPaymentsResponse**](GetPaymentsResponse.md)
1067110689

1067210690
### Authorization
1067310691

@@ -10809,7 +10827,7 @@ Name | Type | Description | Notes
1080910827

1081010828
## get_prepayments
1081110829

10812-
> Prepayments get_prepayments(xero_tenant_id, opts)
10830+
> GetPrepaymentsResponse get_prepayments(xero_tenant_id, opts)
1081310831

1081410832
Retrieves prepayments
1081510833

@@ -10874,7 +10892,7 @@ Name | Type | Description | Notes
1087410892

1087510893
### Return type
1087610894

10877-
[**Prepayments**](Prepayments.md)
10895+
[**GetPrepaymentsResponse**](GetPrepaymentsResponse.md)
1087810896

1087910897
### Authorization
1088010898

@@ -11344,7 +11362,7 @@ Name | Type | Description | Notes
1134411362

1134511363
## get_purchase_orders
1134611364

11347-
> PurchaseOrders get_purchase_orders(xero_tenant_id, opts)
11365+
> GetPurchaseOrdersResponse get_purchase_orders(xero_tenant_id, opts)
1134811366

1134911367
Retrieves purchase orders
1135011368

@@ -11385,7 +11403,9 @@ opts = {
1138511403

1138611404
order: 'PurchaseOrderNumber ASC', # String | Order by an any element
1138711405

11388-
page: 1 # Integer | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
11406+
page: 1, # Integer | To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
11407+
11408+
page_size: 100 # Integer | Number of records to retrieve per page
1138911409
}
1139011410

1139111411
begin
@@ -11409,10 +11429,11 @@ Name | Type | Description | Notes
1140911429
**date_to** | **String**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom&#x3D;2015-12-01&amp;DateTo&#x3D;2015-12-31 | [optional]
1141011430
**order** | **String**| Order by an any element | [optional]
1141111431
**page** | **Integer**| To specify a page, append the page parameter to the URL e.g. ?page&#x3D;1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page&#x3D;2 and continuing this process until no more results are returned. | [optional]
11432+
**page_size** | **Integer**| Number of records to retrieve per page | [optional]
1141211433

1141311434
### Return type
1141411435

11415-
[**PurchaseOrders**](PurchaseOrders.md)
11436+
[**GetPurchaseOrdersResponse**](GetPurchaseOrdersResponse.md)
1141611437

1141711438
### Authorization
1141811439

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# XeroRuby::Accounting::GetBankTransactionsResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **String** | | [optional]
8+
**status** | **String** | | [optional]
9+
**provider_name** | **String** | | [optional]
10+
**date_time_utc** | **String** | | [optional]
11+
**page_info** | [**PageInfo**](PageInfo.md) | | [optional]
12+
**bank_transactions** | [**Array&lt;BankTransaction&gt;**](BankTransaction.md) | | [optional]
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'XeroRuby::Accounting'
18+
19+
instance = XeroRuby::Accounting::GetBankTransactionsResponse.new(id: null,
20+
status: null,
21+
provider_name: null,
22+
date_time_utc: null,
23+
page_info: null,
24+
bank_transactions: null)
25+
```
26+
27+
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# XeroRuby::Accounting::GetContactsResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **String** | | [optional]
8+
**status** | **String** | | [optional]
9+
**provider_name** | **String** | | [optional]
10+
**date_time_utc** | **String** | | [optional]
11+
**page_info** | [**PageInfo**](PageInfo.md) | | [optional]
12+
**contacts** | [**Array&lt;Contact&gt;**](Contact.md) | | [optional]
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'XeroRuby::Accounting'
18+
19+
instance = XeroRuby::Accounting::GetContactsResponse.new(id: null,
20+
status: null,
21+
provider_name: null,
22+
date_time_utc: null,
23+
page_info: null,
24+
contacts: null)
25+
```
26+
27+
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# XeroRuby::Accounting::GetCreditNotesResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **String** | | [optional]
8+
**status** | **String** | | [optional]
9+
**provider_name** | **String** | | [optional]
10+
**date_time_utc** | **String** | | [optional]
11+
**page_info** | [**PageInfo**](PageInfo.md) | | [optional]
12+
**credit_notes** | [**Array&lt;CreditNote&gt;**](CreditNote.md) | | [optional]
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'XeroRuby::Accounting'
18+
19+
instance = XeroRuby::Accounting::GetCreditNotesResponse.new(id: null,
20+
status: null,
21+
provider_name: null,
22+
date_time_utc: null,
23+
page_info: null,
24+
credit_notes: null)
25+
```
26+
27+
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# XeroRuby::Accounting::GetInvoicesResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **String** | | [optional]
8+
**status** | **String** | | [optional]
9+
**provider_name** | **String** | | [optional]
10+
**date_time_utc** | **String** | | [optional]
11+
**page_info** | [**PageInfo**](PageInfo.md) | | [optional]
12+
**invoices** | [**Array&lt;Invoice&gt;**](Invoice.md) | | [optional]
13+
14+
## Code Sample
15+
16+
```ruby
17+
require 'XeroRuby::Accounting'
18+
19+
instance = XeroRuby::Accounting::GetInvoicesResponse.new(id: null,
20+
status: null,
21+
provider_name: null,
22+
date_time_utc: null,
23+
page_info: null,
24+
invoices: null)
25+
```
26+
27+

0 commit comments

Comments
 (0)