Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update xero-ruby-4.3.2 built against new OAS for openapi-generator 5.4.0 #268

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2,532 changes: 1,581 additions & 951 deletions docs/accounting/AccountingApi.md

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion docs/accounting/Allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**allocation_id** | **String** | Xero generated unique identifier | [optional]
**invoice** | [**Invoice**](Invoice.md) | |
**overpayment** | [**Overpayment**](Overpayment.md) | | [optional]
**prepayment** | [**Prepayment**](Prepayment.md) | | [optional]
**credit_note** | [**CreditNote**](CreditNote.md) | | [optional]
**amount** | **BigDecimal** | the amount being applied to the invoice |
**date** | **Date** | the date the allocation is applied YYYY-MM-DD. |
**is_deleted** | **Boolean** | A flag that returns true when the allocation is succesfully deleted | [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]

Expand All @@ -18,12 +20,14 @@ Name | Type | Description | Notes
```ruby
require 'XeroRuby::Accounting'

instance = XeroRuby::Accounting::Allocation.new(invoice: null,
instance = XeroRuby::Accounting::Allocation.new(allocation_id: null,
invoice: null,
overpayment: null,
prepayment: null,
credit_note: null,
amount: null,
date: null,
is_deleted: null,
status_attribute_string: null,
validation_errors: null)
```
Expand Down
2 changes: 0 additions & 2 deletions docs/accounting/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Name | Type | Description | Notes
**last_name** | **String** | Last name of contact person (max length = 255) | [optional]
**company_number** | **String** | Company registration number (max length = 50) | [optional]
**email_address** | **String** | Email address of contact person (umlauts not supported) (max length = 255) | [optional]
**skype_user_name** | **String** | Skype user name of contact | [optional]
**contact_persons** | [**Array<ContactPerson>**](ContactPerson.md) | See contact persons | [optional]
**bank_account_details** | **String** | Bank account number of contact | [optional]
**tax_number** | **String** | Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50) | [optional]
Expand Down Expand Up @@ -63,7 +62,6 @@ instance = XeroRuby::Accounting::Contact.new(contact_id: null,
last_name: null,
company_number: null,
email_address: null,
skype_user_name: null,
contact_persons: null,
bank_account_details: null,
tax_number: null,
Expand Down
8 changes: 7 additions & 1 deletion docs/accounting/TenNinetyNineContact.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Name | Type | Description | Notes
**street_address** | **String** | Contact address on 1099 Form | [optional]
**tax_id** | **String** | Contact tax id on 1099 Form | [optional]
**contact_id** | **String** | Contact contact id | [optional]
**legal_name** | **String** | Contact legal name | [optional]
**business_name** | **String** | Contact business name | [optional]
**federal_tax_classification** | **String** | Contact federal tax classification | [optional]

## Code Sample

Expand Down Expand Up @@ -53,7 +56,10 @@ instance = XeroRuby::Accounting::TenNinetyNineContact.new(box1: null,
email: null,
street_address: null,
tax_id: null,
contact_id: null)
contact_id: null,
legal_name: null,
business_name: null,
federal_tax_classification: null)
```


43,976 changes: 0 additions & 43,976 deletions docs/accounting/index.html

This file was deleted.

46 changes: 28 additions & 18 deletions docs/app_store/AppStoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ api_instance = xero_client.<api_set>



subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object
begin
#Retrieves a subscription for a given subscriptionId
result = api_instance.get_subscription(subscription_id)
Expand All @@ -57,7 +57,7 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subscription_id** | [**String**](.md)| Unique identifier for Subscription object |
**subscription_id** | **String**| Unique identifier for Subscription object |

### Return type

Expand Down Expand Up @@ -104,7 +104,7 @@ api_instance = xero_client.<api_set>



subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object
begin
#Gets all usage records related to the subscription
result = api_instance.get_usage_records(subscription_id)
Expand All @@ -119,7 +119,7 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subscription_id** | [**String**](.md)| Unique identifier for Subscription object |
**subscription_id** | **String**| Unique identifier for Subscription object |

### Return type

Expand All @@ -137,7 +137,7 @@ Name | Type | Description | Notes

## post_usage_records

> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record)
> UsageRecord post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts)

Send metered usage belonging to this subscription and subscription item

Expand Down Expand Up @@ -166,12 +166,16 @@ api_instance = xero_client.<api_set>



subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object
subscription_item_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the subscriptionItem
create_usage_record = { "timestamp": "2022-01-21T13:01:00", "quantity": 10 } # CreateUsageRecord | Contains the quantity for the usage record to create
opts = {
idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}

begin
#Send metered usage belonging to this subscription and subscription item
result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record)
result = api_instance.post_usage_records(subscription_id, subscription_item_id, create_usage_record, opts)
p result
rescue XeroRuby::AppStore::ApiError => e
puts "Exception when calling AppStoreApi->post_usage_records: #{e}"
Expand All @@ -183,9 +187,10 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subscription_id** | [**String**](.md)| Unique identifier for Subscription object |
**subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem |
**subscription_id** | **String**| Unique identifier for Subscription object |
**subscription_item_id** | **String**| The unique identifier of the subscriptionItem |
**create_usage_record** | [**CreateUsageRecord**](CreateUsageRecord.md)| Contains the quantity for the usage record to create |
**idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional]

### Return type

Expand All @@ -203,7 +208,7 @@ Name | Type | Description | Notes

## put_usage_records

> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record)
> UsageRecord put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts)

Update and existing metered usage belonging to this subscription and subscription item

Expand Down Expand Up @@ -232,13 +237,17 @@ api_instance = xero_client.<api_set>



subscription_id = '00000000-0000-0000-0000-000000000000' # String | Unique identifier for Subscription object
subscription_item_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the subscriptionItem
usage_record_id = '00000000-0000-0000-0000-000000000000' # String | The unique identifier of the usage record
subscription_id = 00000000-0000-0000-0000-000000000000 # String | Unique identifier for Subscription object
subscription_item_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the subscriptionItem
usage_record_id = 00000000-0000-0000-0000-000000000000 # String | The unique identifier of the usage record
update_usage_record = { "quantity": 10 } # UpdateUsageRecord | Contains the quantity for the usage record to update
opts = {
idempotency_key: KEY_VALUE # String | This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
}

begin
#Update and existing metered usage belonging to this subscription and subscription item
result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record)
result = api_instance.put_usage_records(subscription_id, subscription_item_id, usage_record_id, update_usage_record, opts)
p result
rescue XeroRuby::AppStore::ApiError => e
puts "Exception when calling AppStoreApi->put_usage_records: #{e}"
Expand All @@ -250,10 +259,11 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**subscription_id** | [**String**](.md)| Unique identifier for Subscription object |
**subscription_item_id** | [**String**](.md)| The unique identifier of the subscriptionItem |
**usage_record_id** | [**String**](.md)| The unique identifier of the usage record |
**subscription_id** | **String**| Unique identifier for Subscription object |
**subscription_item_id** | **String**| The unique identifier of the subscriptionItem |
**usage_record_id** | **String**| The unique identifier of the usage record |
**update_usage_record** | [**UpdateUsageRecord**](UpdateUsageRecord.md)| Contains the quantity for the usage record to update |
**idempotency_key** | **String**| This allows you to safely retry requests without the risk of duplicate processing. 128 character max. | [optional]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/app_store/CreateUsageRecord.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**quantity** | **Integer** | The initial quantity for the usage record. Must be a whole number that is greater than or equal to 0 |
**timestamp** | **DateTime** | DateTime in UTC of when the the product was consumed/used |
**timestamp** | **Time** | DateTime in UTC of when the the product was consumed/used |

## Code Sample

Expand Down
2 changes: 1 addition & 1 deletion docs/app_store/ProblemDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detail** | **String** | | [optional]
**extensions** | [**Object**](.md) | | [optional]
**extensions** | **Object** | | [optional]
**instance** | **String** | | [optional]
**status** | **Integer** | | [optional]
**title** | **String** | | [optional]
Expand Down
6 changes: 3 additions & 3 deletions docs/app_store/Subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**current_period_end** | **DateTime** | End of the current period that the subscription has been invoiced for. |
**end_date** | **DateTime** | If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled | [optional]
**current_period_end** | **Time** | End of the current period that the subscription has been invoiced for. |
**end_date** | **Time** | If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled | [optional]
**id** | **String** | The unique identifier of the subscription |
**organisation_id** | **String** | The Xero generated unique identifier for the organisation |
**plans** | [**Array&lt;Plan&gt;**](Plan.md) | List of plans for the subscription. |
**start_date** | **DateTime** | Date when the subscription was first created. |
**start_date** | **Time** | Date when the subscription was first created. |
**status** | **String** | Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE. |
**test_mode** | **Boolean** | Boolean used to indicate if the subscription is in test mode | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/app_store/SubscriptionItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**end_date** | **DateTime** | Date when the subscription to this product will end | [optional]
**end_date** | **Time** | Date when the subscription to this product will end | [optional]
**id** | **String** | The unique identifier of the subscription item. |
**price** | [**Price**](Price.md) | |
**product** | [**Product**](Product.md) | |
**quantity** | **Integer** | The quantity of the item. For a fixed product, it is 1. For a per-seat product, it is a positive integer. For metered products, it is always null. | [optional]
**start_date** | **DateTime** | Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven&#39;t taken effect yet. |
**start_date** | **Time** | Date the subscription started, or will start. Note: this could be in the future for downgrades or reduced number of seats that haven&#39;t taken effect yet. |
**status** | **String** | Status of the subscription item. Available statuses are ACTIVE, CANCELED, and PENDING_ACTIVATION. |
**test_mode** | **Boolean** | If the subscription is a test subscription | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/app_store/UsageRecord.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**subscription_id** | **String** | The unique identifier of the Subscription. |
**subscription_item_id** | **String** | The unique identifier of the SubscriptionItem. |
**test_mode** | **Boolean** | If the subscription is a test subscription |
**recorded_at** | **DateTime** | The time when this usage was recorded in UTC |
**recorded_at** | **Time** | The time when this usage was recorded in UTC |
**usage_record_id** | **String** | The unique identifier of the usageRecord. |
**price_per_unit** | **Float** | The price per unit |
**product_id** | **String** | The unique identifier of the linked Product |
Expand Down
3,514 changes: 0 additions & 3,514 deletions docs/app_store/index.html

This file was deleted.

Loading