Skip to content

Commit eab865d

Browse files
RettBehrensRettBehrens
committed
generates xero-ruby 3.8.0 from OAS 2.21.0
1 parent ece198e commit eab865d

16 files changed

Lines changed: 675 additions & 636 deletions

File tree

‎docs/accounting/AccountingApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1264,7 +1264,7 @@ api_instance = xero_client.<api_set>
12641264

12651265

12661266
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # String | Xero identifier for Tenant
1267-
contacts = { "Id": "e997d6d7-6dad-4458-beb8-d9c1bf7f2edf", "Status": "OK", "ProviderName": "Xero API Partner", "DateTimeUTC": "/Date(1551399321121)/", "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [], "HasValidationErrors": false } ] } # Contacts | Contacts with an array of Contact objects to create in body of request
1267+
contacts = { "Contacts": [ { "ContactID": "3ff6d40c-af9a-40a3-89ce-3c1556a25591", "ContactStatus": "ACTIVE", "Name": "Foo9987", "EmailAddress": "sid32476@blah.com", "BankAccountDetails": "", "Addresses": [ { "AddressType": "STREET", "City": "", "Region": "", "PostalCode": "", "Country": "" }, { "AddressType": "POBOX", "City": "", "Region": "", "PostalCode": "", "Country": "" } ], "Phones": [ { "PhoneType": "DEFAULT", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "DDI", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "FAX", "PhoneNumber": "", "PhoneAreaCode": "", "PhoneCountryCode": "" }, { "PhoneType": "MOBILE", "PhoneNumber": "555-1212", "PhoneAreaCode": "415", "PhoneCountryCode": "" } ], "UpdatedDateUTC": "/Date(1551399321043+0000)/", "ContactGroups": [], "IsSupplier": false, "IsCustomer": false, "SalesTrackingCategories": [], "PurchasesTrackingCategories": [], "PaymentTerms": { "Bills": { "Day": 15, "Type": "OFCURRENTMONTH" }, "Sales": { "Day": 10, "Type": "DAYSAFTERBILLMONTH" } }, "ContactPersons": [] } ] } # Contacts | Contacts with an array of Contact objects to create in body of request
12681268
opts = {
12691269
summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
12701270
}

‎docs/accounting/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6008,7 +6008,7 @@
60086008
<nav id="scrollingNav">
60096009
<ul class="sidenav nav nav-list">
60106010
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6011-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.7.1</li>
6011+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>3.8.0</li>
60126012
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60136013
<li data-group="Accounting" data-name="createAccount" class="">
60146014
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -9224,7 +9224,7 @@ <h2>Parameters</h2>
92249224
"schema" : {
92259225
"$ref" : "#/components/schemas/Contacts"
92269226
},
9227-
"example" : "{ \"Id\": \"e997d6d7-6dad-4458-beb8-d9c1bf7f2edf\", \"Status\": \"OK\", \"ProviderName\": \"Xero API Partner\", \"DateTimeUTC\": \"/Date(1551399321121)/\", \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"sid32476@blah.com\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [], \"HasValidationErrors\": false } ] }"
9227+
"example" : "{ \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"sid32476@blah.com\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [] } ] }"
92289228
}
92299229
},
92309230
"required" : true

‎docs/app_store/Product.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**id** | **String** | The unique identifier for the product | [optional]
88
**name** | **String** | The name of the product | [optional]
9-
**type** | **String** | The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase | [optional]
109
**seat_unit** | **String** | The unit of the per seat product. e.g. \&quot;user\&quot;, \&quot;organisation\&quot;, \&quot;SMS\&quot;, etc | [optional]
10+
**type** | **String** | The pricing model of the product: * FIXED: Customers are charged a fixed amount for each billing period * PER_SEAT: Customers are charged based on the number of units they purchase * METERED: Customers are charged per use of this product | [optional]
11+
**usage_unit** | **String** | The unit of the usage product. e.g. \&quot;user\&quot;, \&quot;minutes\&quot;, \&quot;SMS\&quot;, etc | [optional]
1112

1213
## Code Sample
1314

@@ -16,8 +17,9 @@ require 'XeroRuby::AppStore'
1617

1718
instance = XeroRuby::AppStore::Product.new(id: null,
1819
name: null,
20+
seat_unit: null,
1921
type: null,
20-
seat_unit: null)
22+
usage_unit: null)
2123
```
2224

2325

‎docs/app_store/SubscriptionItem.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**id** | **String** | The unique identifier of the subscription item. |
99
**price** | [**Price**](Price.md) | |
1010
**product** | [**Product**](Product.md) | |
11+
**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]
1112
**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. |
1213
**status** | **String** | Status of the subscription item. Available statuses are ACTIVE, CANCELED, and PENDING_ACTIVATION. |
1314
**test_mode** | **Boolean** | If the subscription is a test subscription | [optional]
@@ -21,6 +22,7 @@ instance = XeroRuby::AppStore::SubscriptionItem.new(end_date: null,
2122
id: null,
2223
price: null,
2324
product: null,
25+
quantity: null,
2426
start_date: null,
2527
status: null,
2628
test_mode: null)

‎docs/app_store/index.html‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -951,14 +951,18 @@
951951
"type" : "string",
952952
"description" : "The name of the product"
953953
},
954+
"seatUnit" : {
955+
"type" : "string",
956+
"description" : "The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc"
957+
},
954958
"type" : {
955959
"type" : "string",
956-
"description" : "The pricing model of the product:\n* FIXED: Customers are charged a fixed amount for each billing period\n* PER_SEAT: Customers are charged based on the number of units they purchase\n",
957-
"enum" : [ "FIXED", "PER_SEAT" ]
960+
"description" : "The pricing model of the product:\n* FIXED: Customers are charged a fixed amount for each billing period\n* PER_SEAT: Customers are charged based on the number of units they purchase\n* METERED: Customers are charged per use of this product\n",
961+
"enum" : [ "FIXED", "PER_SEAT", "METERED" ]
958962
},
959-
"seatUnit" : {
963+
"usageUnit" : {
960964
"type" : "string",
961-
"description" : "The unit of the per seat product. e.g. \"user\", \"organisation\", \"SMS\", etc"
965+
"description" : "The unit of the usage product. e.g. \"user\", \"minutes\", \"SMS\", etc"
962966
}
963967
},
964968
"description" : ""
@@ -1033,6 +1037,10 @@
10331037
"product" : {
10341038
"$ref" : "#/components/schemas/Product"
10351039
},
1040+
"quantity" : {
1041+
"type" : "integer",
1042+
"description" : "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."
1043+
},
10361044
"startDate" : {
10371045
"type" : "string",
10381046
"description" : "Date the subscription started, or will start. Note: this could be in\nthe future for downgrades or reduced number of seats that haven't taken effect yet.\n",
@@ -1133,7 +1141,7 @@
11331141
<nav id="scrollingNav">
11341142
<ul class="sidenav nav nav-list">
11351143
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1136-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.7.1</li>
1144+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.8.0</li>
11371145
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11381146
<li data-group="AppStore" data-name="getSubscription" class="">
11391147
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/assets/index.html‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,7 +1009,8 @@
10091009
"example" : 33
10101010
}
10111011
},
1012-
"description" : ""
1012+
"description" : "",
1013+
"x-snake" : "asset_type"
10131014
};
10141015
defs["Assets"] = {
10151016
"title" : "",
@@ -1391,7 +1392,7 @@
13911392
<nav id="scrollingNav">
13921393
<ul class="sidenav nav nav-list">
13931394
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1394-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.7.1</li>
1395+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.8.0</li>
13951396
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13961397
<li data-group="Asset" data-name="createAsset" class="">
13971398
<a href="#api-Asset-createAsset">createAsset</a>
@@ -1454,7 +1455,7 @@ <h3>Usage and SDK Samples</h3>
14541455
<div class="tab-pane" id="examples-Asset-createAsset-0-ruby">
14551456
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
14561457

1457-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1458+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
14581459

14591460
asset = {
14601461
asset_name: "Other Computer",
@@ -1463,7 +1464,7 @@ <h3>Usage and SDK Samples</h3>
14631464
}
14641465

14651466
begin
1466-
response = xero_client.accounting_api.create_asset(xeroTenantId, asset)
1467+
response = xero_client.accounting_api.create_asset(xero_tenant_id, asset)
14671468
return response
14681469
rescue XeroRuby::ApiError => e
14691470
puts "Exception when calling create_asset: #{e}"
@@ -1576,25 +1577,25 @@ <h3>Usage and SDK Samples</h3>
15761577
<div class="tab-pane" id="examples-Asset-createAssetType-0-ruby">
15771578
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
15781579

1579-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1580+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
15801581

1581-
bookDepreciationSetting = {
1582+
book_depreciation_setting = {
15821583
depreciation_method: "DiminishingValue100",
15831584
averaging_method: "ActualDays",
15841585
deprecitation_rate: 40,
15851586
depreciation_calculation_method: "None"
15861587
}
15871588

1588-
assetType = {
1589+
asset_type = {
15891590
asset_type_name: "Computer Equipment",
15901591
fixed_asset_account_id: "00000000-0000-0000-0000-000000000000",
15911592
depreciation_expense_account_id: "00000000-0000-0000-0000-000000000000",
15921593
accumulated_depreciation_account_id: "00000000-0000-0000-0000-000000000000",
1593-
bookDepreciationSetting: book_depreciation_setting
1594+
book_depreciation_setting: book_depreciation_setting
15941595
}
15951596

15961597
begin
1597-
response = xero_client.accounting_api.create_asset_type(xeroTenantId, assetType)
1598+
response = xero_client.accounting_api.create_asset_type(xero_tenant_id, assetType)
15981599
return response
15991600
rescue XeroRuby::ApiError => e
16001601
puts "Exception when calling create_asset_type: #{e}"
@@ -1704,11 +1705,11 @@ <h3>Usage and SDK Samples</h3>
17041705
<div class="tab-pane" id="examples-Asset-getAssetById-0-ruby">
17051706
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
17061707

1707-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1708+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
17081709
id = '00000000-0000-0000-0000-000000000000'
17091710

17101711
begin
1711-
response = xero_client.accounting_api.get_asset_by_id(xeroTenantId, id)
1712+
response = xero_client.accounting_api.get_asset_by_id(xero_tenant_id, id)
17121713
return response
17131714
rescue XeroRuby::ApiError => e
17141715
puts "Exception when calling get_asset_by_id: #{e}"
@@ -1822,10 +1823,10 @@ <h3>Usage and SDK Samples</h3>
18221823
<div class="tab-pane" id="examples-Asset-getAssetSettings-0-ruby">
18231824
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
18241825

1825-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1826+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
18261827

18271828
begin
1828-
response = xero_client.accounting_api.get_asset_settings(xeroTenantId)
1829+
response = xero_client.accounting_api.get_asset_settings(xero_tenant_id)
18291830
return response
18301831
rescue XeroRuby::ApiError => e
18311832
puts "Exception when calling get_asset_settings: #{e}"
@@ -1906,10 +1907,10 @@ <h3>Usage and SDK Samples</h3>
19061907
<div class="tab-pane" id="examples-Asset-getAssetTypes-0-ruby">
19071908
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
19081909

1909-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1910+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
19101911

19111912
begin
1912-
response = xero_client.accounting_api.get_asset_types(xeroTenantId)
1913+
response = xero_client.accounting_api.get_asset_types(xero_tenant_id)
19131914
return response
19141915
rescue XeroRuby::ApiError => e
19151916
puts "Exception when calling get_asset_types: #{e}"
@@ -1990,16 +1991,16 @@ <h3>Usage and SDK Samples</h3>
19901991
<div class="tab-pane" id="examples-Asset-getAssets-0-ruby">
19911992
<pre class="prettyprint"><code class="language-ruby">xero_client.set_token_set(user.token_set)
19921993

1993-
xeroTenantId = 'YOUR_XERO_TENANT_ID'
1994+
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
19941995
status =
19951996
page = 1
1996-
pageSize = 5
1997-
orderBy = 'AssetName'
1998-
sortDirection = 'ASC'
1999-
filterBy = 'Company Car'
1997+
page_size = 5
1998+
order_by = 'AssetName'
1999+
sort_direction = 'ASC'
2000+
filter_by = 'Company Car'
20002001

20012002
begin
2002-
response = xero_client.accounting_api.get_assets(xeroTenantId, status, page, pageSize, orderBy, sortDirection, filterBy)
2003+
response = xero_client.accounting_api.get_assets(xero_tenant_id, status, page, page_size, order_by, sort_direction, filter_by)
20032004
return response
20042005
rescue XeroRuby::ApiError => e
20052006
puts "Exception when calling get_assets: #{e}"

0 commit comments

Comments
 (0)