Skip to content

Commit

Permalink
Merge pull request #20 from XeroAPI/regenerated-against-OAS-v2-0-1
Browse files Browse the repository at this point in the history
Regenerated against oas v2 0 1

See release notes for changes.
  • Loading branch information
jenksguo authored Feb 21, 2020
2 parents 1d145c1 + 4797e40 commit 59633b4
Show file tree
Hide file tree
Showing 267 changed files with 6,938 additions and 4,616 deletions.
2 changes: 1 addition & 1 deletion accounting/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.3
4.2.0
4 changes: 2 additions & 2 deletions accounting/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
AllCops:
TargetRubyVersion: 2.4
TargetRubyVersion: 2.2
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
# to ignore them, so only the ones explicitly set in this file are enabled.
DisabledByDefault: true
Expand Down Expand Up @@ -46,7 +46,7 @@ Layout/EmptyLinesAroundMethodBody:
Layout/EmptyLinesAroundModuleBody:
Enabled: true

Layout/IndentFirstArgument:
Layout/FirstParameterIndentation:
Enabled: true

# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
Expand Down
2 changes: 1 addition & 1 deletion accounting/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ script:
- bundle install --path vendor/bundle
- bundle exec rspec
- gem build xero-ruby.gemspec
- gem install ./xero-ruby-0.1.2.gem
- gem install ./xero-ruby-0.1.3.gem
79 changes: 0 additions & 79 deletions accounting/Gemfile.lock

This file was deleted.

79 changes: 44 additions & 35 deletions accounting/README.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion accounting/docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Name | Type | Description | Notes
**reporting_code_name** | **String** | Shown if set | [optional]
**has_attachments** | **Boolean** | boolean to indicate if an account has an attachment (read only) | [optional]
**updated_date_utc** | **DateTime** | Last modified date UTC format | [optional]
**add_to_watchlist** | **Boolean** | Boolean – describes whether the account is shown in the watchlist widget on the dashboard | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]

## Code Sample
Expand All @@ -31,7 +32,7 @@ require 'XeroRuby'

instance = XeroRuby::Account.new(code: 4400,
name: Food Sales,
account_id: null,
account_id: 00000000-0000-0000-0000-000000000000,
type: null,
bank_account_number: null,
status: null,
Expand All @@ -47,6 +48,7 @@ instance = XeroRuby::Account.new(code: 4400,
reporting_code_name: null,
has_attachments: null,
updated_date_utc: null,
add_to_watchlist: null,
validation_errors: null)
```

Expand Down
4,990 changes: 2,667 additions & 2,323 deletions accounting/docs/AccountingApi.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions accounting/docs/Attachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Name | Type | Description | Notes
```ruby
require 'XeroRuby'

instance = XeroRuby::Attachment.new(attachment_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
file_name: sample5.jpg,
instance = XeroRuby::Attachment.new(attachment_id: 00000000-0000-0000-0000-000000000000,
file_name: xero-dev.jpg,
url: https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg,
mime_type: image/jpg,
content_length: null,
Expand Down
6 changes: 3 additions & 3 deletions accounting/docs/BankTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ instance = XeroRuby::BankTransaction.new(type: null,
sub_total: null,
total_tax: null,
total: null,
bank_transaction_id: null,
prepayment_id: null,
overpayment_id: null,
bank_transaction_id: 00000000-0000-0000-0000-000000000000,
prepayment_id: 00000000-0000-0000-0000-000000000000,
overpayment_id: 00000000-0000-0000-0000-000000000000,
updated_date_utc: null,
has_attachments: null,
status_attribute_string: null,
Expand Down
4 changes: 4 additions & 0 deletions accounting/docs/BrandingTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branding_theme_id** | **String** | Xero identifier | [optional]
**name** | **String** | Name of branding theme | [optional]
**logo_url** | **String** | The location of the image file used as the logo on this branding theme | [optional]
**type** | **String** | Always INVOICE | [optional]
**sort_order** | **Integer** | Integer – ranked order of branding theme. The default branding theme has a value of 0 | [optional]
**created_date_utc** | **DateTime** | UTC timestamp of creation date of branding theme | [optional]

Expand All @@ -16,6 +18,8 @@ require 'XeroRuby'

instance = XeroRuby::BrandingTheme.new(branding_theme_id: null,
name: null,
logo_url: null,
type: null,
sort_order: null,
created_date_utc: null)
```
Expand Down
4 changes: 3 additions & 1 deletion accounting/docs/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Name | Type | Description | Notes
**has_attachments** | **Boolean** | A boolean to indicate if a contact has an attachment | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays validation errors returned from the API | [optional]
**has_validation_errors** | **Boolean** | A boolean to indicate if a contact has an validation errors | [optional]
**status_attribute_string** | **String** | Status of object | [optional]

## Code Sample

Expand Down Expand Up @@ -85,7 +86,8 @@ instance = XeroRuby::Contact.new(contact_id: null,
attachments: null,
has_attachments: null,
validation_errors: null,
has_validation_errors: null)
has_validation_errors: null,
status_attribute_string: null)
```


2 changes: 2 additions & 0 deletions accounting/docs/CreditNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Name | Type | Description | Notes
**payments** | [**Array<Payment>**](Payment.md) | See Payments | [optional]
**branding_theme_id** | **String** | See BrandingThemes | [optional]
**has_attachments** | **Boolean** | boolean to indicate if a credit note has an attachment | [optional]
**has_errors** | **Boolean** | A boolean to indicate if a credit note has an validation errors | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]

## Code Sample
Expand Down Expand Up @@ -55,6 +56,7 @@ instance = XeroRuby::CreditNote.new(type: null,
payments: null,
branding_theme_id: null,
has_attachments: null,
has_errors: null,
validation_errors: null)
```

Expand Down
16 changes: 15 additions & 1 deletion accounting/docs/Element.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,27 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Array of Validation Error message | [optional]
**batch_payment_id** | **String** | Unique ID for batch payment object with validation error | [optional]
**bank_transaction_id** | **String** | | [optional]
**credit_note_id** | **String** | | [optional]
**contact_id** | **String** | | [optional]
**invoice_id** | **String** | | [optional]
**item_id** | **String** | | [optional]
**purchase_order_id** | **String** | | [optional]

## Code Sample

```ruby
require 'XeroRuby'

instance = XeroRuby::Element.new(validation_errors: null)
instance = XeroRuby::Element.new(validation_errors: null,
batch_payment_id: null,
bank_transaction_id: null,
credit_note_id: null,
contact_id: null,
invoice_id: null,
item_id: null,
purchase_order_id: null)
```


6 changes: 5 additions & 1 deletion accounting/docs/Employee.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Name | Type | Description | Notes
**last_name** | **String** | Last name of an employee (max length = 255) | [optional]
**external_link** | [**ExternalLink**](ExternalLink.md) | | [optional]
**updated_date_utc** | **DateTime** | | [optional]
**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]

## Code Sample

Expand All @@ -21,7 +23,9 @@ instance = XeroRuby::Employee.new(employee_id: null,
first_name: null,
last_name: null,
external_link: null,
updated_date_utc: null)
updated_date_utc: null,
status_attribute_string: ERROR,
validation_errors: null)
```


10 changes: 6 additions & 4 deletions accounting/docs/Invoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **String** | See Invoice Types |
**contact** | [**Contact**](Contact.md) | |
**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems |
**type** | **String** | See Invoice Types | [optional]
**contact** | [**Contact**](Contact.md) | | [optional]
**line_items** | [**Array<LineItem>**](LineItem.md) | See LineItems | [optional]
**date** | **Date** | Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation | [optional]
**due_date** | **Date** | Date invoice is due – YYYY-MM-DD | [optional]
**line_amount_types** | [**LineAmountTypes**](LineAmountTypes.md) | | [optional]
Expand Down Expand Up @@ -41,6 +41,7 @@ Name | Type | Description | Notes
**has_errors** | **Boolean** | A boolean to indicate if a invoice has an validation errors | [optional]
**status_attribute_string** | **String** | A string to indicate if a invoice status | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]
**warnings** | [**Array<ValidationError>**](ValidationError.md) | Displays array of warning messages from the API | [optional]

## Code Sample

Expand Down Expand Up @@ -83,7 +84,8 @@ instance = XeroRuby::Invoice.new(type: null,
attachments: null,
has_errors: null,
status_attribute_string: null,
validation_errors: null)
validation_errors: null,
warnings: null)
```


4 changes: 3 additions & 1 deletion accounting/docs/Item.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | User defined item code (max length = 30) |
**inventory_asset_account_code** | **String** | The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item |
**inventory_asset_account_code** | **String** | The inventory asset account for the item. The account must be of type INVENTORY. The COGSAccountCode in PurchaseDetails is also required to create a tracked item | [optional]
**name** | **String** | The name of the item (max length = 50) | [optional]
**is_sold** | **Boolean** | Boolean value, defaults to true. When IsSold is true the item will be available on sales transactions in the Xero UI. If IsSold is updated to false then Description and SalesDetails values will be nulled. | [optional]
**is_purchased** | **Boolean** | Boolean value, defaults to true. When IsPurchased is true the item is available for purchase transactions in the Xero UI. If IsPurchased is updated to false then PurchaseDescription and PurchaseDetails values will be nulled. | [optional]
Expand All @@ -18,6 +18,7 @@ Name | Type | Description | Notes
**quantity_on_hand** | **Float** | The quantity of the item on hand | [optional]
**updated_date_utc** | **DateTime** | Last modified date in UTC format | [optional]
**item_id** | **String** | The Xero identifier for an Item | [optional]
**status_attribute_string** | **String** | Status of object | [optional]
**validation_errors** | [**Array<ValidationError>**](ValidationError.md) | Displays array of validation error messages from the API | [optional]

## Code Sample
Expand All @@ -39,6 +40,7 @@ instance = XeroRuby::Item.new(code: null,
quantity_on_hand: null,
updated_date_utc: null,
item_id: null,
status_attribute_string: null,
validation_errors: null)
```

Expand Down
8 changes: 4 additions & 4 deletions accounting/docs/LineItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ Name | Type | Description | Notes
**tax_amount** | **Float** | The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct. | [optional]
**line_amount** | **Float** | If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100) | [optional]
**tracking** | [**Array<LineItemTracking>**](LineItemTracking.md) | Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements. | [optional]
**discount_rate** | **String** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
**discount_rate** | **Float** | Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts | [optional]
**discount_amount** | **Float** | Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts. | [optional]
**repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoicee.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
**repeating_invoice_id** | **String** | The Xero identifier for a Repeating Invoice | [optional]

## Code Sample

```ruby
require 'XeroRuby'

instance = XeroRuby::LineItem.new(line_item_id: null,
instance = XeroRuby::LineItem.new(line_item_id: 00000000-0000-0000-0000-000000000000,
description: null,
quantity: null,
unit_amount: null,
Expand All @@ -35,7 +35,7 @@ instance = XeroRuby::LineItem.new(line_item_id: null,
tracking: null,
discount_rate: null,
discount_amount: null,
repeating_invoice_id: null)
repeating_invoice_id: 00000000-0000-0000-0000-000000000000)
```


4 changes: 3 additions & 1 deletion accounting/docs/LineItemTracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tracking_category_id** | **String** | The Xero identifier for a tracking category | [optional]
**tracking_option_id** | **String** | The Xero identifier for a tracking category option | [optional]
**name** | **String** | The name of the tracking category | [optional]
**option** | **String** | See Tracking Options | [optional]

Expand All @@ -13,7 +14,8 @@ Name | Type | Description | Notes
```ruby
require 'XeroRuby'

instance = XeroRuby::LineItemTracking.new(tracking_category_id: 297c2dc5-cc47-4afd-8ec8-74990b8761e9,
instance = XeroRuby::LineItemTracking.new(tracking_category_id: 00000000-0000-0000-0000-000000000000,
tracking_option_id: 00000000-0000-0000-0000-000000000000,
name: Region,
option: North)
```
Expand Down
4 changes: 2 additions & 2 deletions accounting/docs/LinkedTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_transaction_id** | **String** | Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice | [optional]
**source_line_item_id** | **String** | The line item identifier from the source transaction. |
**source_line_item_id** | **String** | The line item identifier from the source transaction. | [optional]
**contact_id** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional]
**target_transaction_id** | **String** | Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice | [optional]
**target_line_item_id** | **String** | The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID. | [optional]
**linked_transaction_id** | **String** | The Xero identifier for an Linked Transaction e.g. /LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
**linked_transaction_id** | **String** | The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9 | [optional]
**status** | **String** | Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED. | [optional]
**type** | **String** | This will always be BILLABLEEXPENSE. More types may be added in future. | [optional]
**updated_date_utc** | **DateTime** | The last modified date in UTC format | [optional]
Expand Down
Loading

0 comments on commit 59633b4

Please sign in to comment.