From 884e91a71aa06d1e82750a37c3a8605519ff4248 Mon Sep 17 00:00:00 2001 From: manishT72x Date: Mon, 1 Jul 2024 13:45:01 +0530 Subject: [PATCH] Build from OAS 5.0.0 --- README.md | 2 +- docs/accounting/AccountingApi.md | 71 ++- .../accounting/GetBankTransactionsResponse.md | 27 ++ docs/accounting/GetContactsResponse.md | 27 ++ docs/accounting/GetCreditNotesResponse.md | 27 ++ docs/accounting/GetInvoicesResponse.md | 27 ++ docs/accounting/GetManualJournalsResponse.md | 27 ++ docs/accounting/GetOverpaymentsResponse.md | 27 ++ docs/accounting/GetPaymentsResponse.md | 27 ++ docs/accounting/GetPrepaymentsResponse.md | 27 ++ docs/accounting/GetPurchaseOrdersResponse.md | 27 ++ docs/accounting/PageInfo.md | 23 + docs/accounting/index.html | 443 +++++++++++++++++- docs/app_store/index.html | 2 +- docs/assets/index.html | 2 +- docs/files/index.html | 2 +- docs/finance/DataSourceResponse.md | 30 +- docs/finance/index.html | 35 +- docs/payroll_au/index.html | 2 +- docs/payroll_nz/index.html | 2 +- docs/payroll_uk/index.html | 2 +- docs/projects/index.html | 2 +- lib/xero-ruby.rb | 10 + lib/xero-ruby/api/accounting_api.rb | 75 +-- .../get_bank_transactions_response.rb | 274 +++++++++++ .../accounting/get_contacts_response.rb | 274 +++++++++++ .../accounting/get_credit_notes_response.rb | 274 +++++++++++ .../accounting/get_invoices_response.rb | 274 +++++++++++ .../get_manual_journals_response.rb | 274 +++++++++++ .../accounting/get_overpayments_response.rb | 274 +++++++++++ .../accounting/get_payments_response.rb | 274 +++++++++++ .../accounting/get_prepayments_response.rb | 274 +++++++++++ .../get_purchase_orders_response.rb | 274 +++++++++++ lib/xero-ruby/models/accounting/page_info.rb | 253 ++++++++++ .../models/finance/data_source_response.rb | 30 +- lib/xero-ruby/version.rb | 4 +- 36 files changed, 3583 insertions(+), 116 deletions(-) create mode 100644 docs/accounting/GetBankTransactionsResponse.md create mode 100644 docs/accounting/GetContactsResponse.md create mode 100644 docs/accounting/GetCreditNotesResponse.md create mode 100644 docs/accounting/GetInvoicesResponse.md create mode 100644 docs/accounting/GetManualJournalsResponse.md create mode 100644 docs/accounting/GetOverpaymentsResponse.md create mode 100644 docs/accounting/GetPaymentsResponse.md create mode 100644 docs/accounting/GetPrepaymentsResponse.md create mode 100644 docs/accounting/GetPurchaseOrdersResponse.md create mode 100644 docs/accounting/PageInfo.md create mode 100644 lib/xero-ruby/models/accounting/get_bank_transactions_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_contacts_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_credit_notes_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_invoices_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_manual_journals_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_overpayments_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_payments_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_prepayments_response.rb create mode 100644 lib/xero-ruby/models/accounting/get_purchase_orders_response.rb create mode 100644 lib/xero-ruby/models/accounting/page_info.rb diff --git a/README.md b/README.md index 074b1e15..d443aeb8 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Sample apps can get you started quickly with simple auth flows to advanced usage | --- | --- | --- | | [`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 | drawing | [`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 | drawing -| [`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 | drawing +| [`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 | drawing | [`xero-ruby-sso-form`](https://github.com/XeroAPI/xero-ruby-sso-form) | A basic Sinatra app showing how to implement SSU to Lead | drawing
diff --git a/docs/accounting/AccountingApi.md b/docs/accounting/AccountingApi.md index c51bd7c2..228ef4d2 100644 --- a/docs/accounting/AccountingApi.md +++ b/docs/accounting/AccountingApi.md @@ -5795,7 +5795,7 @@ Name | Type | Description | Notes ## get_bank_transactions -> BankTransactions get_bank_transactions(xero_tenant_id, opts) +> GetBankTransactionsResponse get_bank_transactions(xero_tenant_id, opts) Retrieves any spent or received money transactions @@ -5834,7 +5834,9 @@ opts = { page: 1, # Integer | Up to 100 bank transactions will be returned in a single API call with line items details - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -5857,10 +5859,11 @@ Name | Type | Description | Notes **order** | **String**| Order by an any element | [optional] **page** | **Integer**| Up to 100 bank transactions will be returned in a single API call with line items details | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**BankTransactions**](BankTransactions.md) +[**GetBankTransactionsResponse**](GetBankTransactionsResponse.md) ### Authorization @@ -7465,7 +7468,7 @@ Name | Type | Description | Notes ## get_contacts -> Contacts get_contacts(xero_tenant_id, opts) +> GetContactsResponse get_contacts(xero_tenant_id, opts) Retrieves all contacts in a Xero organisation @@ -7510,7 +7513,9 @@ opts = { 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. - search_term: 'Joe Bloggs' # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + search_term: 'Joe Bloggs', # String | Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -7536,10 +7541,11 @@ Name | Type | Description | Notes **include_archived** | **Boolean**| e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response | [optional] **summary_only** | **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. | [optional] [default to false] **search_term** | **String**| Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**Contacts**](Contacts.md) +[**GetContactsResponse**](GetContactsResponse.md) ### Authorization @@ -7950,7 +7956,7 @@ Name | Type | Description | Notes ## get_credit_notes -> CreditNotes get_credit_notes(xero_tenant_id, opts) +> GetCreditNotesResponse get_credit_notes(xero_tenant_id, opts) Retrieves any credit notes @@ -7989,7 +7995,9 @@ opts = { 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 - unitdp: 4 # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -8012,10 +8020,11 @@ Name | Type | Description | Notes **order** | **String**| Order by an any element | [optional] **page** | **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 | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**CreditNotes**](CreditNotes.md) +[**GetCreditNotesResponse**](GetCreditNotesResponse.md) ### Authorization @@ -8896,7 +8905,7 @@ Name | Type | Description | Notes ## get_invoices -> Invoices get_invoices(xero_tenant_id, opts) +> GetInvoicesResponse get_invoices(xero_tenant_id, opts) Retrieves sales invoices or purchase bills @@ -8949,7 +8958,9 @@ opts = { unitdp: 4, # Integer | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts - 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. + 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. + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -8979,10 +8990,11 @@ Name | Type | Description | Notes **created_by_my_app** | **Boolean**| When set to true you'll only retrieve Invoices created by your app | [optional] **unitdp** | **Integer**| e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts | [optional] **summary_only** | **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. | [optional] [default to false] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**Invoices**](Invoices.md) +[**GetInvoicesResponse**](GetInvoicesResponse.md) ### Authorization @@ -9816,7 +9828,7 @@ Name | Type | Description | Notes ## get_manual_journals -> ManualJournals get_manual_journals(xero_tenant_id, opts) +> GetManualJournalsResponse get_manual_journals(xero_tenant_id, opts) Retrieves manual journals @@ -9853,7 +9865,9 @@ opts = { order: 'Date ASC', # String | Order by an any element - 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 + 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 + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -9875,10 +9889,11 @@ Name | Type | Description | Notes **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **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 | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**ManualJournals**](ManualJournals.md) +[**GetManualJournalsResponse**](GetManualJournalsResponse.md) ### Authorization @@ -10336,7 +10351,7 @@ Name | Type | Description | Notes ## get_overpayments -> Overpayments get_overpayments(xero_tenant_id, opts) +> GetOverpaymentsResponse get_overpayments(xero_tenant_id, opts) Retrieves overpayments @@ -10401,7 +10416,7 @@ Name | Type | Description | Notes ### Return type -[**Overpayments**](Overpayments.md) +[**GetOverpaymentsResponse**](GetOverpaymentsResponse.md) ### Authorization @@ -10605,7 +10620,7 @@ Name | Type | Description | Notes ## get_payments -> Payments get_payments(xero_tenant_id, opts) +> GetPaymentsResponse get_payments(xero_tenant_id, opts) Retrieves payments for invoices and credit notes @@ -10642,7 +10657,9 @@ opts = { order: 'Amount ASC', # String | Order by an any element - page: 1 # Integer | Up to 100 payments will be returned in a single API call + page: 1, # Integer | Up to 100 payments will be returned in a single API call + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -10664,10 +10681,11 @@ Name | Type | Description | Notes **where** | **String**| Filter by an any element | [optional] **order** | **String**| Order by an any element | [optional] **page** | **Integer**| Up to 100 payments will be returned in a single API call | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**Payments**](Payments.md) +[**GetPaymentsResponse**](GetPaymentsResponse.md) ### Authorization @@ -10809,7 +10827,7 @@ Name | Type | Description | Notes ## get_prepayments -> Prepayments get_prepayments(xero_tenant_id, opts) +> GetPrepaymentsResponse get_prepayments(xero_tenant_id, opts) Retrieves prepayments @@ -10874,7 +10892,7 @@ Name | Type | Description | Notes ### Return type -[**Prepayments**](Prepayments.md) +[**GetPrepaymentsResponse**](GetPrepaymentsResponse.md) ### Authorization @@ -11344,7 +11362,7 @@ Name | Type | Description | Notes ## get_purchase_orders -> PurchaseOrders get_purchase_orders(xero_tenant_id, opts) +> GetPurchaseOrdersResponse get_purchase_orders(xero_tenant_id, opts) Retrieves purchase orders @@ -11385,7 +11403,9 @@ opts = { order: 'PurchaseOrderNumber ASC', # String | Order by an any element - 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. + 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. + + page_size: 100 # Integer | Number of records to retrieve per page } begin @@ -11409,10 +11429,11 @@ Name | Type | Description | Notes **date_to** | **String**| Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 | [optional] **order** | **String**| Order by an any element | [optional] **page** | **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. | [optional] + **page_size** | **Integer**| Number of records to retrieve per page | [optional] ### Return type -[**PurchaseOrders**](PurchaseOrders.md) +[**GetPurchaseOrdersResponse**](GetPurchaseOrdersResponse.md) ### Authorization diff --git a/docs/accounting/GetBankTransactionsResponse.md b/docs/accounting/GetBankTransactionsResponse.md new file mode 100644 index 00000000..9985f457 --- /dev/null +++ b/docs/accounting/GetBankTransactionsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetBankTransactionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**bank_transactions** | [**Array<BankTransaction>**](BankTransaction.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetBankTransactionsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + bank_transactions: null) +``` + + diff --git a/docs/accounting/GetContactsResponse.md b/docs/accounting/GetContactsResponse.md new file mode 100644 index 00000000..2756d909 --- /dev/null +++ b/docs/accounting/GetContactsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetContactsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**contacts** | [**Array<Contact>**](Contact.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetContactsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + contacts: null) +``` + + diff --git a/docs/accounting/GetCreditNotesResponse.md b/docs/accounting/GetCreditNotesResponse.md new file mode 100644 index 00000000..944a57aa --- /dev/null +++ b/docs/accounting/GetCreditNotesResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetCreditNotesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**credit_notes** | [**Array<CreditNote>**](CreditNote.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetCreditNotesResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + credit_notes: null) +``` + + diff --git a/docs/accounting/GetInvoicesResponse.md b/docs/accounting/GetInvoicesResponse.md new file mode 100644 index 00000000..850c7954 --- /dev/null +++ b/docs/accounting/GetInvoicesResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetInvoicesResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**invoices** | [**Array<Invoice>**](Invoice.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetInvoicesResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + invoices: null) +``` + + diff --git a/docs/accounting/GetManualJournalsResponse.md b/docs/accounting/GetManualJournalsResponse.md new file mode 100644 index 00000000..fec599a3 --- /dev/null +++ b/docs/accounting/GetManualJournalsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetManualJournalsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**manual_journals** | [**Array<ManualJournal>**](ManualJournal.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetManualJournalsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + manual_journals: null) +``` + + diff --git a/docs/accounting/GetOverpaymentsResponse.md b/docs/accounting/GetOverpaymentsResponse.md new file mode 100644 index 00000000..be1ae285 --- /dev/null +++ b/docs/accounting/GetOverpaymentsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetOverpaymentsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**overpayments** | [**Array<Overpayment>**](Overpayment.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetOverpaymentsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + overpayments: null) +``` + + diff --git a/docs/accounting/GetPaymentsResponse.md b/docs/accounting/GetPaymentsResponse.md new file mode 100644 index 00000000..66d92ce7 --- /dev/null +++ b/docs/accounting/GetPaymentsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetPaymentsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**payments** | [**Array<Payment>**](Payment.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetPaymentsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + payments: null) +``` + + diff --git a/docs/accounting/GetPrepaymentsResponse.md b/docs/accounting/GetPrepaymentsResponse.md new file mode 100644 index 00000000..1fa92e8c --- /dev/null +++ b/docs/accounting/GetPrepaymentsResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetPrepaymentsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**prepayments** | [**Array<Prepayment>**](Prepayment.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetPrepaymentsResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + prepayments: null) +``` + + diff --git a/docs/accounting/GetPurchaseOrdersResponse.md b/docs/accounting/GetPurchaseOrdersResponse.md new file mode 100644 index 00000000..638d57b6 --- /dev/null +++ b/docs/accounting/GetPurchaseOrdersResponse.md @@ -0,0 +1,27 @@ +# XeroRuby::Accounting::GetPurchaseOrdersResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**status** | **String** | | [optional] +**provider_name** | **String** | | [optional] +**date_time_utc** | **String** | | [optional] +**page_info** | [**PageInfo**](PageInfo.md) | | [optional] +**purchase_orders** | [**Array<PurchaseOrder>**](PurchaseOrder.md) | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::GetPurchaseOrdersResponse.new(id: null, + status: null, + provider_name: null, + date_time_utc: null, + page_info: null, + purchase_orders: null) +``` + + diff --git a/docs/accounting/PageInfo.md b/docs/accounting/PageInfo.md new file mode 100644 index 00000000..501deb21 --- /dev/null +++ b/docs/accounting/PageInfo.md @@ -0,0 +1,23 @@ +# XeroRuby::Accounting::PageInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **Integer** | | [optional] +**page_size** | **Integer** | | [optional] +**total_pages** | **Integer** | | [optional] +**total_rows** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'XeroRuby::Accounting' + +instance = XeroRuby::Accounting::PageInfo.new(page: null, + page_size: null, + total_pages: null, + total_rows: null) +``` + + diff --git a/docs/accounting/index.html b/docs/accounting/index.html index 8402476e..9cf9f0db 100644 --- a/docs/accounting/index.html +++ b/docs/accounting/index.html @@ -2859,6 +2859,267 @@ "externalDocs" : { "url" : "http://developer.xero.com/documentation/api/organisation/" } +}; + defs["GetBankTransactionsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "BankTransactions" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/BankTransaction" + } + } + }, + "description" : "" +}; + defs["GetContactsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Contacts" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Contact" + } + } + }, + "description" : "" +}; + defs["GetCreditNotesResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "CreditNotes" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CreditNote" + } + } + }, + "description" : "" +}; + defs["GetInvoicesResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Invoices" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Invoice" + } + } + }, + "description" : "" +}; + defs["GetManualJournalsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "ManualJournals" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ManualJournal" + } + } + }, + "description" : "" +}; + defs["GetOverpaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Overpayments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Overpayment" + } + } + }, + "description" : "" +}; + defs["GetPaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Payments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Payment" + } + } + }, + "description" : "" +}; + defs["GetPrepaymentsResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "Prepayments" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Prepayment" + } + } + }, + "description" : "" +}; + defs["GetPurchaseOrdersResponse"] = { + "title" : "", + "type" : "object", + "properties" : { + "Id" : { + "type" : "string" + }, + "Status" : { + "type" : "string" + }, + "ProviderName" : { + "type" : "string" + }, + "DateTimeUTC" : { + "type" : "string" + }, + "PageInfo" : { + "$ref" : "#/components/schemas/PageInfo" + }, + "PurchaseOrders" : { + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PurchaseOrder" + } + } + }, + "description" : "" }; defs["HistoryRecord"] = { "title" : "", @@ -4247,6 +4508,25 @@ }, "description" : "", "x-isObjectArray" : true +}; + defs["PageInfo"] = { + "title" : "", + "type" : "object", + "properties" : { + "Page" : { + "type" : "integer" + }, + "PageSize" : { + "type" : "integer" + }, + "TotalPages" : { + "type" : "integer" + }, + "TotalRows" : { + "type" : "integer" + } + }, + "description" : "Pagination information" }; defs["Payment"] = { "title" : "", @@ -6100,7 +6380,7 @@