Releases: XeroAPI/xero-ruby
2.1.2
2.1.1
Fix docs to show proper BigDecimal types
PR generated from The version of the OpenAPI document: 2.2.14 https://github.com/XeroAPI/Xero-OpenAPI
This change was mainly to validate some the origination template changes did not effect downstream generation
Also added a DELETED Enum to employee, and removed a contact id param from bank transactions
2.1.0
- Large readme usability cleanup
- Fixes #56 - invoice_id serialization
- Fixes and adds examples in readme for #24 - as well as sample app
This issue was mainly fixed by addressing an issue in XeroAPI's IDs convention where openapi-generator does not snake_case properly.. Code manual over-rides the i_ds malformations:
2.0.3
Ruby 2.0.3 release
generated from Xero-OpenAPI version: 2.2.11
BREAKING changes include:
- All monetary fields are now typed as
BigDecimalacross all api sets - examples in readme
changes include:
- re-serialization of params during PUT's and POST's to the XeroAPI to PascalCase from Ruby's preferred snake_case 🐍 related code
SDK does still supports existing functionality of passing camelCase, PascalCase, or some combination.
But now all params can now be snake cased before sent to any SDK method:
invoices = { invoices: [{ type: XeroRuby::Accounting::Invoice::ACCREC, contact: { contact_id: contacts[0].contact_id }, line_items: [{ description: "Acme Tires", quantity: 2.0, unit_amount: BigDecimal("20.99"), account_code: "600", tax_type: XeroRuby::Accounting::TaxType::NONE }], date: "2019-03-11", due_date: "2018-12-10", reference: "Website Design", status: XeroRuby::Accounting::Invoice::DRAFT }]}bug fixes / improvements
- fixing all file download routes based on @wojw5's suggestion in #32
- Download as PDF (#43) also fixed by (https://github.com/XeroAPI/xero-ruby/pull/54/files#diff-c1ed4f733dbf7dd2d5bbba26b23819e5R379)
- Duplicate Constants removed for account.rb & organisation.rb reported in #50
- Upload attachments examples added to readme and sample app
invoice = xero_client.accounting_api.get_invoices(current_user.active_tenant_id).invoices.first
file_name = "an-invoice-filename.png"
opts = {
include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice
}
file = File.read(Rails.root.join('app/assets/images/xero-api.png'))
attachment = xero_client.accounting_api.create_invoice_attachment_by_file_name(current_user.active_tenant_id, invoice.invoice_id, file_name, file, opts)Readme & related sample app updates
- updates readme with PUT/POST examples
- updates to readme showing how to download a file as PDF
- Related updates to the companion sample app showing more comprehensive xero-ruby SDK usage
2.0.1
Ruby 2.0.0 release
generated from Xero-OpenAPI version: 2.2.11
BREAKING changes include:
- All monetary fields are now typed as
BigDecimalacross all api sets - examples in readme
changes include:
- re-serialization of params during PUT's and POST's to the XeroAPI to PascalCase from Ruby's preferred snake_case 🐍 related code
SDK does still supports existing functionality of passing camelCase, PascalCase, or some combination.
But now all params can now be snake cased before sent to any SDK method:
invoices = { invoices: [{ type: XeroRuby::Accounting::Invoice::ACCREC, contact: { contact_id: contacts[0].contact_id }, line_items: [{ description: "Acme Tires", quantity: 2.0, unit_amount: BigDecimal("20.99"), account_code: "600", tax_type: XeroRuby::Accounting::TaxType::NONE }], date: "2019-03-11", due_date: "2018-12-10", reference: "Website Design", status: XeroRuby::Accounting::Invoice::DRAFT }]}bug fixes / improvements
- fixing all file download routes based on @wojw5's suggestion in #32
- Download as PDF (#43) also fixed by (https://github.com/XeroAPI/xero-ruby/pull/54/files#diff-c1ed4f733dbf7dd2d5bbba26b23819e5R379)
- Duplicate Constants removed for account.rb & organisation.rb reported in #50
- Upload attachments examples added to readme and sample app
invoice = xero_client.accounting_api.get_invoices(current_user.active_tenant_id).invoices.first
file_name = "an-invoice-filename.png"
opts = {
include_online: true # Boolean | Allows an attachment to be seen by the end customer within their online invoice
}
file = File.read(Rails.root.join('app/assets/images/xero-api.png'))
attachment = xero_client.accounting_api.create_invoice_attachment_by_file_name(current_user.active_tenant_id, invoice.invoice_id, file_name, file, opts)Readme & related sample app updates
- updates readme with PUT/POST examples
- updates to readme showing how to download a file as PDF
- Related updates to the companion sample app showing more comprehensive xero-ruby SDK usage
1.2.0
- Rspec suite fixed (1227 examples, 0 failures) at PR
- documentation corrected to be ruby specific by adding 2 flags to openapi-spec https://github.com/XeroAPI/Xero-OpenAPI/pull/233/files
- added the Projects API https://developer.xero.com/documentation/projects/overview-projects
- Adds enums in the model
- raises Faraday dependency to
'faraday', '~> 1.0.1', '>= 1.0.1'
1.1.0
Release notes:
This version was generate from Release 2.1.3 · XeroAPI/Xero-OpenAPI · GitHub
Added summarizeErrors to the createPayments method
Added method getPrepaymentAsPdf
Changed JournalNumber from type string to number
Adds statusAttributeString to Payment
Adds assetTypeId to Payment
Adds 2 TaxRates to enum
Adds 4 TaxTypes to enum
1.0
xero-ruby SDK version 1.0 generated against OpenAPI Spec version 2.1.0
IMPORTANT: this major versioning and has breaking changes.
There is now a namespace of Accounting & Asset Models, docs, and specs:
Assets API set now supported, others coming soon: https://developer.xero.com/documentation/
Readme Updated with accurate usage:
creds = {
client_id: ENV['CLIENT_ID'],
client_secret: ENV['CLIENT_SECRET'],
redirect_uri: ENV['REDIRECT_URI'],
scopes: ENV['SCOPES']
}
xero_client = XeroRuby::ApiClient.new(credentials: creds)
xero_client.refresh_token_set(user.token_set)
org = xero_client.accounting_api.get_organisation('your-tenant-id').organisation
assets = xero_client.asset_api.get_assets('your-tenant-id').items0.4.0
Xero Ruby version 0.4.0 generated against OpenAPI Spec version 2.0.9
- Added full OAuth2.0 authorization and token_set callback flow.
- added documentation on using SDK without full client init (passing of access token only)
- Added Faraday http client support (migrated away from Typheous)
- generated via openapi-generator vsn. 4.3.0
- released companion sample app showcasing all new features (https://github.com/XeroAPI/xero-ruby-oauth2-app)
- added token convenience methods (callback, refresh, connections, disconnect)
0.2.4
Xero Ruby version 0.2.4 generated against OpenAPI Spec version 2.0.7
has_attachments is now readonly for following models:
- account.rb
- receipt.rb
- repeating_invoice.rb
- invoice.rb
- manual_journal.rb
- overpayment.rb
- preparyment.rb
- purchase_orders.rb
- bank_transaction.rb
- bank_transfer.rb
- contact.rb
- credit_note.rb
credit_note.rb
- added support for status_attriute_string parameter/option
quote.rb
- updated_date_utc is now a String and readonly
OpenAPI document version update from 2.0.6 to 2.0.7 across all files
SDK version updated to 0.2.4 (patch)

