docs/api/ContractResourcesApi.md in ionoscloud-6.0.0.beta.4 vs docs/api/ContractResourcesApi.md in ionoscloud-6.0.0
- old
+ new
@@ -2,20 +2,20 @@
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
-| [**contracts_get**](ContractResourcesApi.md#contracts_get) | **GET** /contracts | Retrieve a Contract |
+| [**contracts_get**](ContractResourcesApi.md#contracts_get) | **GET** /contracts | Retrieve contracts |
## contracts_get
> <Contracts> contracts_get(opts)
-Retrieve a Contract
+Retrieve contracts
-Retrieves the attributes of user's contract. In this version, the resource became a collection.
+Retrieve the properties of the user's contract. In this version, the resource became a collection.
### Examples
```ruby
require 'time'
@@ -38,11 +38,11 @@
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
}
begin
- # Retrieve a Contract
+ # Retrieve contracts
result = api_instance.contracts_get(opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling ContractResourcesApi->contracts_get: #{e}"
end
@@ -54,11 +54,11 @@
> <Array(<Contracts>, Integer, Hash)> contracts_get_with_http_info(opts)
```ruby
begin
- # Retrieve a Contract
+ # Retrieve contracts
data, status_code, headers = api_instance.contracts_get_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Contracts>
rescue Ionoscloud::ApiError => e
@@ -74,10 +74,10 @@
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
### Return type
-[**Contracts**](Contracts.md)
+[**Contracts**](../models/Contracts.md)
### Authorization
Basic Authentication, Token Authentication