xero-ruby 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +7 -6
- data/docs/AccountingApi.md +57 -59
- data/docs/PaymentDelete.md +17 -0
- data/lib/xero-ruby/api/accounting_api.rb +77 -85
- data/lib/xero-ruby/api_client.rb +1 -1
- data/lib/xero-ruby/api_error.rb +1 -1
- data/lib/xero-ruby/configuration.rb +1 -1
- data/lib/xero-ruby/models/account.rb +1 -1
- data/lib/xero-ruby/models/account_type.rb +1 -1
- data/lib/xero-ruby/models/accounts.rb +1 -1
- data/lib/xero-ruby/models/accounts_payable.rb +1 -1
- data/lib/xero-ruby/models/accounts_receivable.rb +1 -1
- data/lib/xero-ruby/models/address.rb +1 -1
- data/lib/xero-ruby/models/allocation.rb +1 -1
- data/lib/xero-ruby/models/allocations.rb +1 -1
- data/lib/xero-ruby/models/attachment.rb +1 -1
- data/lib/xero-ruby/models/attachments.rb +1 -1
- data/lib/xero-ruby/models/balances.rb +1 -1
- data/lib/xero-ruby/models/bank_transaction.rb +1 -1
- data/lib/xero-ruby/models/bank_transactions.rb +1 -1
- data/lib/xero-ruby/models/bank_transfer.rb +1 -1
- data/lib/xero-ruby/models/bank_transfers.rb +1 -1
- data/lib/xero-ruby/models/batch_payment.rb +1 -1
- data/lib/xero-ruby/models/batch_payment_details.rb +1 -1
- data/lib/xero-ruby/models/batch_payments.rb +1 -1
- data/lib/xero-ruby/models/bill.rb +1 -1
- data/lib/xero-ruby/models/branding_theme.rb +1 -1
- data/lib/xero-ruby/models/branding_themes.rb +1 -1
- data/lib/xero-ruby/models/cis_org_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_setting.rb +1 -1
- data/lib/xero-ruby/models/cis_settings.rb +1 -1
- data/lib/xero-ruby/models/contact.rb +1 -1
- data/lib/xero-ruby/models/contact_group.rb +1 -1
- data/lib/xero-ruby/models/contact_groups.rb +1 -1
- data/lib/xero-ruby/models/contact_person.rb +1 -1
- data/lib/xero-ruby/models/contacts.rb +1 -1
- data/lib/xero-ruby/models/country_code.rb +1 -1
- data/lib/xero-ruby/models/credit_note.rb +1 -1
- data/lib/xero-ruby/models/credit_notes.rb +1 -1
- data/lib/xero-ruby/models/currencies.rb +1 -1
- data/lib/xero-ruby/models/currency.rb +1 -1
- data/lib/xero-ruby/models/currency_code.rb +3 -1
- data/lib/xero-ruby/models/element.rb +1 -1
- data/lib/xero-ruby/models/employee.rb +1 -1
- data/lib/xero-ruby/models/employees.rb +1 -1
- data/lib/xero-ruby/models/error.rb +1 -1
- data/lib/xero-ruby/models/expense_claim.rb +1 -1
- data/lib/xero-ruby/models/expense_claims.rb +1 -1
- data/lib/xero-ruby/models/external_link.rb +1 -1
- data/lib/xero-ruby/models/history_record.rb +1 -1
- data/lib/xero-ruby/models/history_records.rb +1 -1
- data/lib/xero-ruby/models/invoice.rb +3 -3
- data/lib/xero-ruby/models/invoice_reminder.rb +1 -1
- data/lib/xero-ruby/models/invoice_reminders.rb +1 -1
- data/lib/xero-ruby/models/invoices.rb +1 -1
- data/lib/xero-ruby/models/item.rb +1 -1
- data/lib/xero-ruby/models/items.rb +1 -1
- data/lib/xero-ruby/models/journal.rb +1 -1
- data/lib/xero-ruby/models/journal_line.rb +1 -1
- data/lib/xero-ruby/models/journals.rb +1 -1
- data/lib/xero-ruby/models/line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/line_item.rb +1 -1
- data/lib/xero-ruby/models/line_item_tracking.rb +1 -1
- data/lib/xero-ruby/models/linked_transaction.rb +1 -1
- data/lib/xero-ruby/models/linked_transactions.rb +1 -1
- data/lib/xero-ruby/models/manual_journal.rb +1 -1
- data/lib/xero-ruby/models/manual_journal_line.rb +1 -1
- data/lib/xero-ruby/models/manual_journals.rb +1 -1
- data/lib/xero-ruby/models/online_invoice.rb +1 -1
- data/lib/xero-ruby/models/online_invoices.rb +1 -1
- data/lib/xero-ruby/models/organisation.rb +1 -1
- data/lib/xero-ruby/models/organisations.rb +1 -1
- data/lib/xero-ruby/models/overpayment.rb +1 -1
- data/lib/xero-ruby/models/overpayments.rb +1 -1
- data/lib/xero-ruby/models/payment.rb +1 -1
- data/lib/xero-ruby/models/payment_delete.rb +211 -0
- data/lib/xero-ruby/models/payment_service.rb +1 -1
- data/lib/xero-ruby/models/payment_services.rb +1 -1
- data/lib/xero-ruby/models/payment_term.rb +1 -1
- data/lib/xero-ruby/models/payment_term_type.rb +1 -1
- data/lib/xero-ruby/models/payments.rb +1 -1
- data/lib/xero-ruby/models/phone.rb +1 -1
- data/lib/xero-ruby/models/prepayment.rb +1 -1
- data/lib/xero-ruby/models/prepayments.rb +1 -1
- data/lib/xero-ruby/models/purchase.rb +1 -1
- data/lib/xero-ruby/models/purchase_order.rb +1 -1
- data/lib/xero-ruby/models/purchase_orders.rb +1 -1
- data/lib/xero-ruby/models/quote.rb +1 -1
- data/lib/xero-ruby/models/quote_line_amount_types.rb +1 -1
- data/lib/xero-ruby/models/quote_status_codes.rb +1 -1
- data/lib/xero-ruby/models/quotes.rb +1 -1
- data/lib/xero-ruby/models/receipt.rb +1 -1
- data/lib/xero-ruby/models/receipts.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoice.rb +1 -1
- data/lib/xero-ruby/models/repeating_invoices.rb +1 -1
- data/lib/xero-ruby/models/report.rb +1 -1
- data/lib/xero-ruby/models/report_attribute.rb +1 -1
- data/lib/xero-ruby/models/report_cell.rb +1 -1
- data/lib/xero-ruby/models/report_fields.rb +1 -1
- data/lib/xero-ruby/models/report_row.rb +1 -1
- data/lib/xero-ruby/models/report_rows.rb +1 -1
- data/lib/xero-ruby/models/report_with_row.rb +1 -1
- data/lib/xero-ruby/models/report_with_rows.rb +1 -1
- data/lib/xero-ruby/models/reports.rb +1 -1
- data/lib/xero-ruby/models/request_empty.rb +1 -1
- data/lib/xero-ruby/models/row_type.rb +1 -1
- data/lib/xero-ruby/models/sales_tracking_category.rb +1 -1
- data/lib/xero-ruby/models/schedule.rb +1 -1
- data/lib/xero-ruby/models/tax_component.rb +1 -1
- data/lib/xero-ruby/models/tax_rate.rb +1 -1
- data/lib/xero-ruby/models/tax_rates.rb +1 -1
- data/lib/xero-ruby/models/tax_type.rb +1 -1
- data/lib/xero-ruby/models/ten_nintey_nine_contact.rb +1 -1
- data/lib/xero-ruby/models/time_zone.rb +1 -1
- data/lib/xero-ruby/models/tracking_categories.rb +1 -1
- data/lib/xero-ruby/models/tracking_category.rb +1 -1
- data/lib/xero-ruby/models/tracking_option.rb +1 -1
- data/lib/xero-ruby/models/tracking_options.rb +1 -1
- data/lib/xero-ruby/models/user.rb +1 -1
- data/lib/xero-ruby/models/users.rb +1 -1
- data/lib/xero-ruby/models/validation_error.rb +1 -1
- data/lib/xero-ruby/version.rb +2 -2
- data/lib/xero-ruby.rb +2 -1
- data/pkg/xero-ruby-0.2.2.gem +0 -0
- data/pkg/xero-ruby-0.2.3.gem +0 -0
- data/spec/models/payment_delete_spec.rb +41 -0
- data/xero-ruby.gemspec +1 -1
- metadata +7 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8ebb35c8bb528f2a4919b827eb904fe1dea6c3f156ec94624881f7c0cd187752
|
4
|
+
data.tar.gz: 17258df2b7e96ea079f208f268151f90f872bfeefb8a51777baa6872ee1386a0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7eda80fe11676eab602e7d8c96720a5a37ea0083354ed9f6be5bc428bbcf359f078936784615dd9e695dba4c933b151fef1b3b57ef88170ab3734d33b75a6e03
|
7
|
+
data.tar.gz: 5b9dda1c09f0627624fc061da3716cd5f77c0d8a3af86a6ea498a2eb30e21ada20462b2efc8b9a5fafe4df1369651f225a79572c9a2dd373d459ea7bfb6d306d
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -6,8 +6,8 @@ No description provided (generated by Openapi Generator https://github.com/opena
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version: 2.0.
|
10
|
-
- Package version: 0.2.
|
9
|
+
- API version: 2.0.6
|
10
|
+
- Package version: 0.2.3
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developer.xero.com](https://developer.xero.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build xero-ruby.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./xero-ruby-0.2.
|
27
|
+
gem install ./xero-ruby-0.2.3.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./xero-ruby-0.2.
|
30
|
+
(for development, run `gem install --dev ./xero-ruby-0.2.3.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'xero-ruby', '~> 0.2.
|
36
|
+
gem 'xero-ruby', '~> 0.2.3'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -227,6 +227,7 @@ Class | Method | HTTP request | Description
|
|
227
227
|
*XeroRuby::AccountingApi* | [**get_purchase_order_history**](docs/AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to retrieve history for PurchaseOrder
|
228
228
|
*XeroRuby::AccountingApi* | [**get_purchase_orders**](docs/AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders
|
229
229
|
*XeroRuby::AccountingApi* | [**get_quote**](docs/AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Allows you to retrieve a specified quote
|
230
|
+
*XeroRuby::AccountingApi* | [**get_quote_as_pdf**](docs/AccountingApi.md#get_quote_as_pdf) | **GET** /Quotes/{QuotesID}/pdf | Allows you to retrieve quotes as PDF files
|
230
231
|
*XeroRuby::AccountingApi* | [**get_quote_attachment_by_file_name**](docs/AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to retrieve Attachment on Quote by Filename
|
231
232
|
*XeroRuby::AccountingApi* | [**get_quote_attachment_by_id**](docs/AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Quote
|
232
233
|
*XeroRuby::AccountingApi* | [**get_quote_attachments**](docs/AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes
|
@@ -270,7 +271,6 @@ Class | Method | HTTP request | Description
|
|
270
271
|
*XeroRuby::AccountingApi* | [**update_contact_group**](docs/AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group
|
271
272
|
*XeroRuby::AccountingApi* | [**update_credit_note**](docs/AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note
|
272
273
|
*XeroRuby::AccountingApi* | [**update_credit_note_attachment_by_file_name**](docs/AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to update Attachments on CreditNote by file name
|
273
|
-
*XeroRuby::AccountingApi* | [**update_employee**](docs/AccountingApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Allows you to update a specific employee used in Xero payrun
|
274
274
|
*XeroRuby::AccountingApi* | [**update_expense_claim**](docs/AccountingApi.md#update_expense_claim) | **POST** /ExpenseClaims/{ExpenseClaimID} | Allows you to update specified expense claims
|
275
275
|
*XeroRuby::AccountingApi* | [**update_invoice**](docs/AccountingApi.md#update_invoice) | **POST** /Invoices/{InvoiceID} | Allows you to update a specified sales invoices or purchase bills
|
276
276
|
*XeroRuby::AccountingApi* | [**update_invoice_attachment_by_file_name**](docs/AccountingApi.md#update_invoice_attachment_by_file_name) | **POST** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to update Attachment on invoices or purchase bills by it's filename
|
@@ -368,6 +368,7 @@ Class | Method | HTTP request | Description
|
|
368
368
|
- [XeroRuby::Overpayment](docs/Overpayment.md)
|
369
369
|
- [XeroRuby::Overpayments](docs/Overpayments.md)
|
370
370
|
- [XeroRuby::Payment](docs/Payment.md)
|
371
|
+
- [XeroRuby::PaymentDelete](docs/PaymentDelete.md)
|
371
372
|
- [XeroRuby::PaymentService](docs/PaymentService.md)
|
372
373
|
- [XeroRuby::PaymentServices](docs/PaymentServices.md)
|
373
374
|
- [XeroRuby::PaymentTerm](docs/PaymentTerm.md)
|
data/docs/AccountingApi.md
CHANGED
@@ -148,6 +148,7 @@ Method | HTTP request | Description
|
|
148
148
|
[**get_purchase_order_history**](AccountingApi.md#get_purchase_order_history) | **GET** /PurchaseOrders/{PurchaseOrderID}/History | Allows you to retrieve history for PurchaseOrder
|
149
149
|
[**get_purchase_orders**](AccountingApi.md#get_purchase_orders) | **GET** /PurchaseOrders | Allows you to retrieve purchase orders
|
150
150
|
[**get_quote**](AccountingApi.md#get_quote) | **GET** /Quotes/{QuoteID} | Allows you to retrieve a specified quote
|
151
|
+
[**get_quote_as_pdf**](AccountingApi.md#get_quote_as_pdf) | **GET** /Quotes/{QuotesID}/pdf | Allows you to retrieve quotes as PDF files
|
151
152
|
[**get_quote_attachment_by_file_name**](AccountingApi.md#get_quote_attachment_by_file_name) | **GET** /Quotes/{QuoteID}/Attachments/{FileName} | Allows you to retrieve Attachment on Quote by Filename
|
152
153
|
[**get_quote_attachment_by_id**](AccountingApi.md#get_quote_attachment_by_id) | **GET** /Quotes/{QuoteID}/Attachments/{AttachmentID} | Allows you to retrieve specific Attachment on Quote
|
153
154
|
[**get_quote_attachments**](AccountingApi.md#get_quote_attachments) | **GET** /Quotes/{QuoteID}/Attachments | Allows you to retrieve Attachments for Quotes
|
@@ -191,7 +192,6 @@ Method | HTTP request | Description
|
|
191
192
|
[**update_contact_group**](AccountingApi.md#update_contact_group) | **POST** /ContactGroups/{ContactGroupID} | Allows you to update a Contact Group
|
192
193
|
[**update_credit_note**](AccountingApi.md#update_credit_note) | **POST** /CreditNotes/{CreditNoteID} | Allows you to update a specific credit note
|
193
194
|
[**update_credit_note_attachment_by_file_name**](AccountingApi.md#update_credit_note_attachment_by_file_name) | **POST** /CreditNotes/{CreditNoteID}/Attachments/{FileName} | Allows you to update Attachments on CreditNote by file name
|
194
|
-
[**update_employee**](AccountingApi.md#update_employee) | **POST** /Employees/{EmployeeID} | Allows you to update a specific employee used in Xero payrun
|
195
195
|
[**update_expense_claim**](AccountingApi.md#update_expense_claim) | **POST** /ExpenseClaims/{ExpenseClaimID} | Allows you to update specified expense claims
|
196
196
|
[**update_invoice**](AccountingApi.md#update_invoice) | **POST** /Invoices/{InvoiceID} | Allows you to update a specified sales invoices or purchase bills
|
197
197
|
[**update_invoice_attachment_by_file_name**](AccountingApi.md#update_invoice_attachment_by_file_name) | **POST** /Invoices/{InvoiceID}/Attachments/{FileName} | Allows you to update Attachment on invoices or purchase bills by it's filename
|
@@ -3378,7 +3378,7 @@ nil (empty response body)
|
|
3378
3378
|
|
3379
3379
|
## delete_payment
|
3380
3380
|
|
3381
|
-
> Payments delete_payment(xero_tenant_id, payment_id,
|
3381
|
+
> Payments delete_payment(xero_tenant_id, payment_id, payment_delete)
|
3382
3382
|
|
3383
3383
|
Allows you to update a specified payment for invoices and credit notes
|
3384
3384
|
|
@@ -3396,11 +3396,11 @@ end
|
|
3396
3396
|
api_instance = XeroRuby::AccountingApi.new
|
3397
3397
|
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
3398
3398
|
payment_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Payment
|
3399
|
-
|
3399
|
+
payment_delete = { status:"DELETED" } # PaymentDelete |
|
3400
3400
|
|
3401
3401
|
begin
|
3402
3402
|
#Allows you to update a specified payment for invoices and credit notes
|
3403
|
-
result = api_instance.delete_payment(xero_tenant_id, payment_id,
|
3403
|
+
result = api_instance.delete_payment(xero_tenant_id, payment_id, payment_delete)
|
3404
3404
|
p result
|
3405
3405
|
rescue XeroRuby::ApiError => e
|
3406
3406
|
puts "Exception when calling AccountingApi->delete_payment: #{e}"
|
@@ -3414,7 +3414,7 @@ Name | Type | Description | Notes
|
|
3414
3414
|
------------- | ------------- | ------------- | -------------
|
3415
3415
|
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
3416
3416
|
**payment_id** | [**String**](.md)| Unique identifier for a Payment |
|
3417
|
-
**
|
3417
|
+
**payment_delete** | [**PaymentDelete**](PaymentDelete.md)| |
|
3418
3418
|
|
3419
3419
|
### Return type
|
3420
3420
|
|
@@ -8081,6 +8081,58 @@ Name | Type | Description | Notes
|
|
8081
8081
|
- **Accept**: application/json
|
8082
8082
|
|
8083
8083
|
|
8084
|
+
## get_quote_as_pdf
|
8085
|
+
|
8086
|
+
> File get_quote_as_pdf(xero_tenant_id, quote_id)
|
8087
|
+
|
8088
|
+
Allows you to retrieve quotes as PDF files
|
8089
|
+
|
8090
|
+
### Example
|
8091
|
+
|
8092
|
+
```ruby
|
8093
|
+
# load the gem
|
8094
|
+
require 'xero-ruby'
|
8095
|
+
# setup authorization
|
8096
|
+
XeroRuby.configure do |config|
|
8097
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
8098
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
8099
|
+
end
|
8100
|
+
|
8101
|
+
api_instance = XeroRuby::AccountingApi.new
|
8102
|
+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
8103
|
+
quote_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for an Quote
|
8104
|
+
|
8105
|
+
begin
|
8106
|
+
#Allows you to retrieve quotes as PDF files
|
8107
|
+
result = api_instance.get_quote_as_pdf(xero_tenant_id, quote_id)
|
8108
|
+
p result
|
8109
|
+
rescue XeroRuby::ApiError => e
|
8110
|
+
puts "Exception when calling AccountingApi->get_quote_as_pdf: #{e}"
|
8111
|
+
end
|
8112
|
+
```
|
8113
|
+
|
8114
|
+
### Parameters
|
8115
|
+
|
8116
|
+
|
8117
|
+
Name | Type | Description | Notes
|
8118
|
+
------------- | ------------- | ------------- | -------------
|
8119
|
+
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
8120
|
+
**quote_id** | [**String**](.md)| Unique identifier for an Quote |
|
8121
|
+
|
8122
|
+
### Return type
|
8123
|
+
|
8124
|
+
**File**
|
8125
|
+
|
8126
|
+
### Authorization
|
8127
|
+
|
8128
|
+
[OAuth2](../README.md#OAuth2)
|
8129
|
+
|
8130
|
+
### HTTP request headers
|
8131
|
+
|
8132
|
+
- **Content-Type**: Not defined
|
8133
|
+
- **Accept**: application/pdf
|
8134
|
+
|
8135
|
+
|
8084
8136
|
## get_quote_attachment_by_file_name
|
8085
8137
|
|
8086
8138
|
> File get_quote_attachment_by_file_name(xero_tenant_id, quote_id, file_name, content_type)
|
@@ -10494,60 +10546,6 @@ Name | Type | Description | Notes
|
|
10494
10546
|
- **Accept**: application/json
|
10495
10547
|
|
10496
10548
|
|
10497
|
-
## update_employee
|
10498
|
-
|
10499
|
-
> Employees update_employee(xero_tenant_id, employee_id, employees)
|
10500
|
-
|
10501
|
-
Allows you to update a specific employee used in Xero payrun
|
10502
|
-
|
10503
|
-
### Example
|
10504
|
-
|
10505
|
-
```ruby
|
10506
|
-
# load the gem
|
10507
|
-
require 'xero-ruby'
|
10508
|
-
# setup authorization
|
10509
|
-
XeroRuby.configure do |config|
|
10510
|
-
# Configure OAuth2 access token for authorization: OAuth2
|
10511
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
10512
|
-
end
|
10513
|
-
|
10514
|
-
api_instance = XeroRuby::AccountingApi.new
|
10515
|
-
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
|
10516
|
-
employee_id = '00000000-0000-0000-000-000000000000' # String | Unique identifier for a Employee
|
10517
|
-
employees = { employees:[ { employeeID:"00000000-0000-0000-000-000000000000", firstName:"Natasha", lastName:"Romanoff" } ] } # Employees |
|
10518
|
-
|
10519
|
-
begin
|
10520
|
-
#Allows you to update a specific employee used in Xero payrun
|
10521
|
-
result = api_instance.update_employee(xero_tenant_id, employee_id, employees)
|
10522
|
-
p result
|
10523
|
-
rescue XeroRuby::ApiError => e
|
10524
|
-
puts "Exception when calling AccountingApi->update_employee: #{e}"
|
10525
|
-
end
|
10526
|
-
```
|
10527
|
-
|
10528
|
-
### Parameters
|
10529
|
-
|
10530
|
-
|
10531
|
-
Name | Type | Description | Notes
|
10532
|
-
------------- | ------------- | ------------- | -------------
|
10533
|
-
**xero_tenant_id** | **String**| Xero identifier for Tenant |
|
10534
|
-
**employee_id** | [**String**](.md)| Unique identifier for a Employee |
|
10535
|
-
**employees** | [**Employees**](Employees.md)| |
|
10536
|
-
|
10537
|
-
### Return type
|
10538
|
-
|
10539
|
-
[**Employees**](Employees.md)
|
10540
|
-
|
10541
|
-
### Authorization
|
10542
|
-
|
10543
|
-
[OAuth2](../README.md#OAuth2)
|
10544
|
-
|
10545
|
-
### HTTP request headers
|
10546
|
-
|
10547
|
-
- **Content-Type**: application/json
|
10548
|
-
- **Accept**: application/json
|
10549
|
-
|
10550
|
-
|
10551
10549
|
## update_expense_claim
|
10552
10550
|
|
10553
10551
|
> ExpenseClaims update_expense_claim(xero_tenant_id, expense_claim_id, expense_claims)
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# XeroRuby::PaymentDelete
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | The status of the payment. | [default to 'DELETED']
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'XeroRuby'
|
13
|
+
|
14
|
+
instance = XeroRuby::PaymentDelete.new(status: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -4319,21 +4319,21 @@ module XeroRuby
|
|
4319
4319
|
# Allows you to update a specified payment for invoices and credit notes
|
4320
4320
|
# @param xero_tenant_id [String] Xero identifier for Tenant
|
4321
4321
|
# @param payment_id [String] Unique identifier for a Payment
|
4322
|
-
# @param
|
4322
|
+
# @param payment_delete [PaymentDelete]
|
4323
4323
|
# @param [Hash] opts the optional parameters
|
4324
4324
|
# @return [Payments]
|
4325
|
-
def delete_payment(xero_tenant_id, payment_id,
|
4326
|
-
data, _status_code, _headers = delete_payment_with_http_info(xero_tenant_id, payment_id,
|
4325
|
+
def delete_payment(xero_tenant_id, payment_id, payment_delete, opts = {})
|
4326
|
+
data, _status_code, _headers = delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts)
|
4327
4327
|
data
|
4328
4328
|
end
|
4329
4329
|
|
4330
4330
|
# Allows you to update a specified payment for invoices and credit notes
|
4331
4331
|
# @param xero_tenant_id [String] Xero identifier for Tenant
|
4332
4332
|
# @param payment_id [String] Unique identifier for a Payment
|
4333
|
-
# @param
|
4333
|
+
# @param payment_delete [PaymentDelete]
|
4334
4334
|
# @param [Hash] opts the optional parameters
|
4335
4335
|
# @return [Array<(Payments, Integer, Hash)>] Payments data, response status code and response headers
|
4336
|
-
def delete_payment_with_http_info(xero_tenant_id, payment_id,
|
4336
|
+
def delete_payment_with_http_info(xero_tenant_id, payment_id, payment_delete, opts = {})
|
4337
4337
|
if @api_client.config.debugging
|
4338
4338
|
@api_client.config.logger.debug 'Calling API: AccountingApi.delete_payment ...'
|
4339
4339
|
end
|
@@ -4345,9 +4345,9 @@ module XeroRuby
|
|
4345
4345
|
if @api_client.config.client_side_validation && payment_id.nil?
|
4346
4346
|
fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountingApi.delete_payment"
|
4347
4347
|
end
|
4348
|
-
# verify the required parameter '
|
4349
|
-
if @api_client.config.client_side_validation &&
|
4350
|
-
fail ArgumentError, "Missing the required parameter '
|
4348
|
+
# verify the required parameter 'payment_delete' is set
|
4349
|
+
if @api_client.config.client_side_validation && payment_delete.nil?
|
4350
|
+
fail ArgumentError, "Missing the required parameter 'payment_delete' when calling AccountingApi.delete_payment"
|
4351
4351
|
end
|
4352
4352
|
# resource path
|
4353
4353
|
local_var_path = '/Payments/{PaymentID}'.sub('{' + 'PaymentID' + '}', payment_id.to_s)
|
@@ -4367,7 +4367,7 @@ module XeroRuby
|
|
4367
4367
|
form_params = opts[:form_params] || {}
|
4368
4368
|
|
4369
4369
|
# http body (model)
|
4370
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
4370
|
+
post_body = opts[:body] || @api_client.object_to_http_body(payment_delete)
|
4371
4371
|
|
4372
4372
|
# return_type
|
4373
4373
|
return_type = opts[:return_type] || 'Payments'
|
@@ -10406,6 +10406,73 @@ module XeroRuby
|
|
10406
10406
|
return data, status_code, headers
|
10407
10407
|
end
|
10408
10408
|
|
10409
|
+
# Allows you to retrieve quotes as PDF files
|
10410
|
+
# @param xero_tenant_id [String] Xero identifier for Tenant
|
10411
|
+
# @param quote_id [String] Unique identifier for an Quote
|
10412
|
+
# @param [Hash] opts the optional parameters
|
10413
|
+
# @return [File]
|
10414
|
+
def get_quote_as_pdf(xero_tenant_id, quote_id, opts = {})
|
10415
|
+
data, _status_code, _headers = get_quote_as_pdf_with_http_info(xero_tenant_id, quote_id, opts)
|
10416
|
+
data
|
10417
|
+
end
|
10418
|
+
|
10419
|
+
# Allows you to retrieve quotes as PDF files
|
10420
|
+
# @param xero_tenant_id [String] Xero identifier for Tenant
|
10421
|
+
# @param quote_id [String] Unique identifier for an Quote
|
10422
|
+
# @param [Hash] opts the optional parameters
|
10423
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
10424
|
+
def get_quote_as_pdf_with_http_info(xero_tenant_id, quote_id, opts = {})
|
10425
|
+
if @api_client.config.debugging
|
10426
|
+
@api_client.config.logger.debug 'Calling API: AccountingApi.get_quote_as_pdf ...'
|
10427
|
+
end
|
10428
|
+
# verify the required parameter 'xero_tenant_id' is set
|
10429
|
+
if @api_client.config.client_side_validation && xero_tenant_id.nil?
|
10430
|
+
fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_quote_as_pdf"
|
10431
|
+
end
|
10432
|
+
# verify the required parameter 'quote_id' is set
|
10433
|
+
if @api_client.config.client_side_validation && quote_id.nil?
|
10434
|
+
fail ArgumentError, "Missing the required parameter 'quote_id' when calling AccountingApi.get_quote_as_pdf"
|
10435
|
+
end
|
10436
|
+
# resource path
|
10437
|
+
local_var_path = '/Quotes/{QuoteID}'.sub('{' + 'QuoteID' + '}', quote_id.to_s)
|
10438
|
+
|
10439
|
+
# query parameters
|
10440
|
+
query_params = opts[:query_params] || {}
|
10441
|
+
|
10442
|
+
# header parameters
|
10443
|
+
header_params = opts[:header_params] || {}
|
10444
|
+
# HTTP header 'Accept' (if needed)
|
10445
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
10446
|
+
header_params[:'xero-tenant-id'] = xero_tenant_id
|
10447
|
+
|
10448
|
+
# form parameters
|
10449
|
+
form_params = opts[:form_params] || {}
|
10450
|
+
|
10451
|
+
# http body (model)
|
10452
|
+
post_body = opts[:body]
|
10453
|
+
|
10454
|
+
# return_type
|
10455
|
+
return_type = opts[:return_type] || 'File'
|
10456
|
+
|
10457
|
+
# auth_names
|
10458
|
+
auth_names = opts[:auth_names] || ['OAuth2']
|
10459
|
+
|
10460
|
+
new_options = opts.merge(
|
10461
|
+
:header_params => header_params,
|
10462
|
+
:query_params => query_params,
|
10463
|
+
:form_params => form_params,
|
10464
|
+
:body => post_body,
|
10465
|
+
:auth_names => auth_names,
|
10466
|
+
:return_type => return_type
|
10467
|
+
)
|
10468
|
+
|
10469
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
10470
|
+
if @api_client.config.debugging
|
10471
|
+
@api_client.config.logger.debug "API called: AccountingApi#get_quote_as_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10472
|
+
end
|
10473
|
+
return data, status_code, headers
|
10474
|
+
end
|
10475
|
+
|
10409
10476
|
# Allows you to retrieve Attachment on Quote by Filename
|
10410
10477
|
# @param xero_tenant_id [String] Xero identifier for Tenant
|
10411
10478
|
# @param quote_id [String] Unique identifier for Quote object
|
@@ -13572,81 +13639,6 @@ module XeroRuby
|
|
13572
13639
|
return data, status_code, headers
|
13573
13640
|
end
|
13574
13641
|
|
13575
|
-
# Allows you to update a specific employee used in Xero payrun
|
13576
|
-
# @param xero_tenant_id [String] Xero identifier for Tenant
|
13577
|
-
# @param employee_id [String] Unique identifier for a Employee
|
13578
|
-
# @param employees [Employees]
|
13579
|
-
# @param [Hash] opts the optional parameters
|
13580
|
-
# @return [Employees]
|
13581
|
-
def update_employee(xero_tenant_id, employee_id, employees, opts = {})
|
13582
|
-
data, _status_code, _headers = update_employee_with_http_info(xero_tenant_id, employee_id, employees, opts)
|
13583
|
-
data
|
13584
|
-
end
|
13585
|
-
|
13586
|
-
# Allows you to update a specific employee used in Xero payrun
|
13587
|
-
# @param xero_tenant_id [String] Xero identifier for Tenant
|
13588
|
-
# @param employee_id [String] Unique identifier for a Employee
|
13589
|
-
# @param employees [Employees]
|
13590
|
-
# @param [Hash] opts the optional parameters
|
13591
|
-
# @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers
|
13592
|
-
def update_employee_with_http_info(xero_tenant_id, employee_id, employees, opts = {})
|
13593
|
-
if @api_client.config.debugging
|
13594
|
-
@api_client.config.logger.debug 'Calling API: AccountingApi.update_employee ...'
|
13595
|
-
end
|
13596
|
-
# verify the required parameter 'xero_tenant_id' is set
|
13597
|
-
if @api_client.config.client_side_validation && xero_tenant_id.nil?
|
13598
|
-
fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.update_employee"
|
13599
|
-
end
|
13600
|
-
# verify the required parameter 'employee_id' is set
|
13601
|
-
if @api_client.config.client_side_validation && employee_id.nil?
|
13602
|
-
fail ArgumentError, "Missing the required parameter 'employee_id' when calling AccountingApi.update_employee"
|
13603
|
-
end
|
13604
|
-
# verify the required parameter 'employees' is set
|
13605
|
-
if @api_client.config.client_side_validation && employees.nil?
|
13606
|
-
fail ArgumentError, "Missing the required parameter 'employees' when calling AccountingApi.update_employee"
|
13607
|
-
end
|
13608
|
-
# resource path
|
13609
|
-
local_var_path = '/Employees/{EmployeeID}'.sub('{' + 'EmployeeID' + '}', employee_id.to_s)
|
13610
|
-
|
13611
|
-
# query parameters
|
13612
|
-
query_params = opts[:query_params] || {}
|
13613
|
-
|
13614
|
-
# header parameters
|
13615
|
-
header_params = opts[:header_params] || {}
|
13616
|
-
# HTTP header 'Accept' (if needed)
|
13617
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
13618
|
-
# HTTP header 'Content-Type'
|
13619
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
13620
|
-
header_params[:'xero-tenant-id'] = xero_tenant_id
|
13621
|
-
|
13622
|
-
# form parameters
|
13623
|
-
form_params = opts[:form_params] || {}
|
13624
|
-
|
13625
|
-
# http body (model)
|
13626
|
-
post_body = opts[:body] || @api_client.object_to_http_body(employees)
|
13627
|
-
|
13628
|
-
# return_type
|
13629
|
-
return_type = opts[:return_type] || 'Employees'
|
13630
|
-
|
13631
|
-
# auth_names
|
13632
|
-
auth_names = opts[:auth_names] || ['OAuth2']
|
13633
|
-
|
13634
|
-
new_options = opts.merge(
|
13635
|
-
:header_params => header_params,
|
13636
|
-
:query_params => query_params,
|
13637
|
-
:form_params => form_params,
|
13638
|
-
:body => post_body,
|
13639
|
-
:auth_names => auth_names,
|
13640
|
-
:return_type => return_type
|
13641
|
-
)
|
13642
|
-
|
13643
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
13644
|
-
if @api_client.config.debugging
|
13645
|
-
@api_client.config.logger.debug "API called: AccountingApi#update_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
13646
|
-
end
|
13647
|
-
return data, status_code, headers
|
13648
|
-
end
|
13649
|
-
|
13650
13642
|
# Allows you to update specified expense claims
|
13651
13643
|
# @param xero_tenant_id [String] Xero identifier for Tenant
|
13652
13644
|
# @param expense_claim_id [String] Unique identifier for a ExpenseClaim
|
data/lib/xero-ruby/api_client.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
data/lib/xero-ruby/api_error.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2.0.
|
6
|
+
The version of the OpenAPI document: 2.0.6
|
7
7
|
Contact: api@xero.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.2.0
|