ionoscloud 5.0.0 → 5.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (174) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AttachedVolumes.md +30 -0
  3. data/docs/BackupUnit.md +26 -0
  4. data/docs/BackupUnitApi.md +595 -0
  5. data/docs/BackupUnitProperties.md +22 -0
  6. data/docs/BackupUnitSSO.md +18 -0
  7. data/docs/BackupUnits.md +24 -0
  8. data/docs/BalancedNics.md +30 -0
  9. data/docs/CHANGELOG.md +1 -0
  10. data/docs/Cdroms.md +30 -0
  11. data/docs/ConnectableDatacenter.md +22 -0
  12. data/docs/Contract.md +20 -0
  13. data/docs/ContractApi.md +89 -0
  14. data/docs/ContractProperties.md +26 -0
  15. data/docs/DataCenterApi.md +517 -0
  16. data/docs/DataCenterEntities.md +24 -0
  17. data/docs/Datacenter.md +28 -0
  18. data/docs/DatacenterElementMetadata.md +32 -0
  19. data/docs/DatacenterProperties.md +28 -0
  20. data/docs/Datacenters.md +30 -0
  21. data/docs/DefaultApi.md +84 -0
  22. data/docs/Error.md +20 -0
  23. data/docs/ErrorMessage.md +20 -0
  24. data/docs/FirewallRule.md +26 -0
  25. data/docs/FirewallRules.md +30 -0
  26. data/docs/FirewallruleProperties.md +34 -0
  27. data/docs/Group.md +26 -0
  28. data/docs/GroupEntities.md +20 -0
  29. data/docs/GroupMembers.md +24 -0
  30. data/docs/GroupProperties.md +36 -0
  31. data/docs/GroupShare.md +24 -0
  32. data/docs/GroupShareProperties.md +20 -0
  33. data/docs/GroupShares.md +24 -0
  34. data/docs/GroupUsers.md +24 -0
  35. data/docs/Groups.md +24 -0
  36. data/docs/IPBlocksApi.md +513 -0
  37. data/docs/IPFailover.md +20 -0
  38. data/docs/Image.md +26 -0
  39. data/docs/ImageApi.md +429 -0
  40. data/docs/ImageProperties.md +50 -0
  41. data/docs/Images.md +24 -0
  42. data/docs/Info.md +22 -0
  43. data/docs/IpBlock.md +26 -0
  44. data/docs/IpBlockProperties.md +26 -0
  45. data/docs/IpBlocks.md +24 -0
  46. data/docs/IpConsumer.md +30 -0
  47. data/docs/KubernetesApi.md +1513 -0
  48. data/docs/KubernetesAutoScaling.md +20 -0
  49. data/docs/KubernetesCluster.md +28 -0
  50. data/docs/KubernetesClusterEntities.md +18 -0
  51. data/docs/KubernetesClusterProperties.md +26 -0
  52. data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
  53. data/docs/KubernetesClusters.md +24 -0
  54. data/docs/KubernetesConfig.md +24 -0
  55. data/docs/KubernetesConfigProperties.md +18 -0
  56. data/docs/KubernetesMaintenanceWindow.md +20 -0
  57. data/docs/KubernetesNode.md +26 -0
  58. data/docs/KubernetesNodeMetadata.md +26 -0
  59. data/docs/KubernetesNodePool.md +26 -0
  60. data/docs/KubernetesNodePoolForPut.md +26 -0
  61. data/docs/KubernetesNodePoolLan.md +18 -0
  62. data/docs/KubernetesNodePoolProperties.md +50 -0
  63. data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
  64. data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
  65. data/docs/KubernetesNodePools.md +24 -0
  66. data/docs/KubernetesNodeProperties.md +22 -0
  67. data/docs/KubernetesNodes.md +24 -0
  68. data/docs/Label.md +26 -0
  69. data/docs/LabelApi.md +2355 -0
  70. data/docs/LabelProperties.md +26 -0
  71. data/docs/LabelResource.md +26 -0
  72. data/docs/LabelResourceProperties.md +20 -0
  73. data/docs/LabelResources.md +30 -0
  74. data/docs/Labels.md +24 -0
  75. data/docs/Lan.md +28 -0
  76. data/docs/LanApi.md +795 -0
  77. data/docs/LanEntities.md +18 -0
  78. data/docs/LanNics.md +30 -0
  79. data/docs/LanPost.md +28 -0
  80. data/docs/LanProperties.md +24 -0
  81. data/docs/LanPropertiesPost.md +24 -0
  82. data/docs/Lans.md +30 -0
  83. data/docs/LoadBalancerApi.md +883 -0
  84. data/docs/Loadbalancer.md +28 -0
  85. data/docs/LoadbalancerEntities.md +18 -0
  86. data/docs/LoadbalancerProperties.md +22 -0
  87. data/docs/Loadbalancers.md +30 -0
  88. data/docs/Location.md +26 -0
  89. data/docs/LocationApi.md +259 -0
  90. data/docs/LocationProperties.md +22 -0
  91. data/docs/Locations.md +24 -0
  92. data/docs/Nic.md +28 -0
  93. data/docs/NicApi.md +1087 -0
  94. data/docs/NicEntities.md +18 -0
  95. data/docs/NicProperties.md +30 -0
  96. data/docs/Nics.md +30 -0
  97. data/docs/NoStateMetaData.md +30 -0
  98. data/docs/PaginationLinks.md +22 -0
  99. data/docs/Peer.md +26 -0
  100. data/docs/PrivateCrossConnect.md +26 -0
  101. data/docs/PrivateCrossConnectApi.md +427 -0
  102. data/docs/PrivateCrossConnectProperties.md +24 -0
  103. data/docs/PrivateCrossConnects.md +24 -0
  104. data/docs/README.md +111 -0
  105. data/docs/Request.md +26 -0
  106. data/docs/RequestApi.md +267 -0
  107. data/docs/RequestMetadata.md +24 -0
  108. data/docs/RequestProperties.md +24 -0
  109. data/docs/RequestStatus.md +24 -0
  110. data/docs/RequestStatusMetadata.md +24 -0
  111. data/docs/RequestTarget.md +20 -0
  112. data/docs/Requests.md +30 -0
  113. data/docs/Resource.md +28 -0
  114. data/docs/ResourceEntities.md +18 -0
  115. data/docs/ResourceGroups.md +24 -0
  116. data/docs/ResourceLimits.md +50 -0
  117. data/docs/ResourceProperties.md +20 -0
  118. data/docs/ResourceReference.md +22 -0
  119. data/docs/Resources.md +24 -0
  120. data/docs/ResourcesUsers.md +24 -0
  121. data/docs/S3Key.md +26 -0
  122. data/docs/S3KeyMetadata.md +20 -0
  123. data/docs/S3KeyProperties.md +20 -0
  124. data/docs/S3Keys.md +24 -0
  125. data/docs/S3ObjectStorageSSO.md +18 -0
  126. data/docs/Server.md +28 -0
  127. data/docs/ServerApi.md +1573 -0
  128. data/docs/ServerEntities.md +22 -0
  129. data/docs/ServerProperties.md +32 -0
  130. data/docs/Servers.md +30 -0
  131. data/docs/Snapshot.md +26 -0
  132. data/docs/SnapshotApi.md +429 -0
  133. data/docs/SnapshotProperties.md +48 -0
  134. data/docs/Snapshots.md +24 -0
  135. data/docs/Type.md +15 -0
  136. data/docs/User.md +28 -0
  137. data/docs/UserManagementApi.md +2547 -0
  138. data/docs/UserMetadata.md +22 -0
  139. data/docs/UserProperties.md +34 -0
  140. data/docs/Users.md +24 -0
  141. data/docs/UsersEntities.md +20 -0
  142. data/docs/Volume.md +26 -0
  143. data/docs/VolumeApi.md +711 -0
  144. data/docs/VolumeProperties.md +54 -0
  145. data/docs/Volumes.md +30 -0
  146. data/docs/summary.md +295 -0
  147. data/gitbook.yaml +4 -0
  148. data/lib/ionoscloud/api/_api.rb +1 -1
  149. data/lib/ionoscloud/api_client.rb +1 -4
  150. data/lib/ionoscloud/models/backup_units.rb +2 -2
  151. data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
  152. data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
  153. data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
  154. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
  155. data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
  156. data/lib/ionoscloud/models/label_resources.rb +2 -2
  157. data/lib/ionoscloud/models/labels.rb +2 -2
  158. data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
  159. data/lib/ionoscloud/models/type.rb +1 -0
  160. data/lib/ionoscloud/models/volume_properties.rb +14 -4
  161. data/lib/ionoscloud/version.rb +1 -1
  162. data/spec/models/backup_units_spec.rb +1 -1
  163. data/spec/models/datacenter_element_metadata_spec.rb +1 -1
  164. data/spec/models/firewallrule_properties_spec.rb +0 -12
  165. data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
  166. data/spec/models/kubernetes_node_spec.rb +1 -1
  167. data/spec/models/kubernetes_nodes_spec.rb +1 -1
  168. data/spec/models/label_resources_spec.rb +1 -1
  169. data/spec/models/labels_spec.rb +1 -1
  170. data/spec/models/loadbalancer_properties_spec.rb +0 -4
  171. data/spec/models/volume_properties_spec.rb +6 -0
  172. metadata +264 -120
  173. data/DOCS.md +0 -14618
  174. data/README.md +0 -55
@@ -0,0 +1,18 @@
1
+ # NicEntities
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **firewallrules** | [**FirewallRules**](FirewallRules.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ionoscloud'
13
+
14
+ instance = Ionoscloud::NicEntities.new(
15
+ firewallrules: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,30 @@
1
+ # NicProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A name of that resource | [optional] |
8
+ | **mac** | **String** | The MAC address of the NIC | [optional][readonly] |
9
+ | **ips** | **Array<String>** | Collection of IP addresses assigned to a nic. Explicitly assigned public IPs need to come from reserved IP blocks, Passing value null or empty array will assign an IP address automatically. | [optional] |
10
+ | **dhcp** | **Boolean** | Indicates if the nic will reserve an IP using DHCP | [optional] |
11
+ | **lan** | **Integer** | The LAN ID the NIC will sit on. If the LAN ID does not exist it will be implicitly created | |
12
+ | **firewall_active** | **Boolean** | Activate or deactivate the firewall. By default an active firewall without any defined rules will block all incoming network traffic except for the firewall rules that explicitly allows certain protocols, ip addresses and ports. | [optional] |
13
+ | **nat** | **Boolean** | Indicates if NAT is enabled on this NIC. This is now deprecated. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::NicProperties.new(
21
+ name: My resource,
22
+ mac: 00:0a:95:9d:68:16,
23
+ ips: null,
24
+ dhcp: true,
25
+ lan: 2,
26
+ firewall_active: false,
27
+ nat: true
28
+ )
29
+ ```
30
+
data/docs/Nics.md ADDED
@@ -0,0 +1,30 @@
1
+ # Nics
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource's unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **items** | [**Array<Nic>**](Nic.md) | Array of items in that collection | [optional] |
11
+ | **offset** | **Float** | the offset (if specified in the request) | [optional] |
12
+ | **limit** | **Float** | the limit (if specified in the request) | [optional] |
13
+ | **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::Nics.new(
21
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
22
+ type: "collection",
23
+ href: <RESOURCE-URI>,
24
+ items: null,
25
+ offset: 0,
26
+ limit: 1000,
27
+ _links: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,30 @@
1
+ # NoStateMetaData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **etag** | **String** | Resource&#39;s Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an &#39;ETag response header to requests which don&#39;t use &#39;depth&#39; parameter. | [optional][readonly] |
8
+ | **created_date** | **Time** | The time the Resource was created | [optional][readonly] |
9
+ | **created_by** | **String** | The user who has created the resource. | [optional][readonly] |
10
+ | **created_by_user_id** | **String** | The user id of the user who has created the resource. | [optional][readonly] |
11
+ | **last_modified_date** | **Time** | The last time the resource has been modified | [optional][readonly] |
12
+ | **last_modified_by** | **String** | The user who last modified the resource. | [optional][readonly] |
13
+ | **last_modified_by_user_id** | **String** | The user id of the user who has last modified the resource. | [optional][readonly] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ionoscloud'
19
+
20
+ instance = Ionoscloud::NoStateMetaData.new(
21
+ etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
22
+ created_date: 2015-12-04T14:34:09.809Z,
23
+ created_by: user@example.com,
24
+ created_by_user_id: user@example.com,
25
+ last_modified_date: 2015-12-04T14:34:09.809Z,
26
+ last_modified_by: user@example.com,
27
+ last_modified_by_user_id: 63cef532-26fe-4a64-a4e0-de7c8a506c90
28
+ )
29
+ ```
30
+
@@ -0,0 +1,22 @@
1
+ # PaginationLinks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **prev** | **String** | URL (with offset and limit parameters) of the previous page; only present if offset is greater than 0 | [optional][readonly] |
8
+ | **_self** | **String** | URL (with offset and limit parameters) of the current page | [optional][readonly] |
9
+ | **_next** | **String** | URL (with offset and limit parameters) of the next page; only present if offset + limit is less than the total number of elements | [optional][readonly] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ionoscloud'
15
+
16
+ instance = Ionoscloud::PaginationLinks.new(
17
+ prev: <PREVIOUS-PAGE-URI>,
18
+ _self: <THIS-PAGE-URI>,
19
+ _next: <NEXT-PAGE-URI>
20
+ )
21
+ ```
22
+
data/docs/Peer.md ADDED
@@ -0,0 +1,26 @@
1
+ # Peer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+ | **datacenter_id** | **String** | | [optional] |
10
+ | **datacenter_name** | **String** | | [optional] |
11
+ | **location** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::Peer.new(
19
+ id: null,
20
+ name: null,
21
+ datacenter_id: null,
22
+ datacenter_name: null,
23
+ location: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # PrivateCrossConnect
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The resource&#39;s unique identifier | [optional][readonly] |
8
+ | **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
11
+ | **properties** | [**PrivateCrossConnectProperties**](PrivateCrossConnectProperties.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::PrivateCrossConnect.new(
19
+ id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
20
+ type: "pcc",
21
+ href: <RESOURCE-URI>,
22
+ metadata: null,
23
+ properties: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,427 @@
1
+ # PrivateCrossConnectApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**pccs_delete**](PrivateCrossConnectApi.md#pccs_delete) | **DELETE** /pccs/{pccId} | Delete a Private Cross-Connect |
8
+ | [**pccs_find_by_id**](PrivateCrossConnectApi.md#pccs_find_by_id) | **GET** /pccs/{pccId} | Retrieve a Private Cross-Connect |
9
+ | [**pccs_get**](PrivateCrossConnectApi.md#pccs_get) | **GET** /pccs | List Private Cross-Connects |
10
+ | [**pccs_patch**](PrivateCrossConnectApi.md#pccs_patch) | **PATCH** /pccs/{pccId} | Partially modify a private cross-connect |
11
+ | [**pccs_post**](PrivateCrossConnectApi.md#pccs_post) | **POST** /pccs | Create a Private Cross-Connect |
12
+
13
+
14
+ ## pccs_delete
15
+
16
+ > Object pccs_delete(pcc_id, opts)
17
+
18
+ Delete a Private Cross-Connect
19
+
20
+ Delete a private cross-connect if no datacenters are joined to the given PCC
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'ionoscloud'
27
+ # setup authorization
28
+ Ionoscloud.configure do |config|
29
+ # Configure HTTP basic authorization: Basic Authentication
30
+ config.username = 'YOUR USERNAME'
31
+ config.password = 'YOUR PASSWORD'
32
+
33
+ # Configure API key authorization: Token Authentication
34
+ config.api_key['Authorization'] = 'YOUR API KEY'
35
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
36
+ # config.api_key_prefix['Authorization'] = 'Bearer'
37
+ end
38
+
39
+ api_instance = Ionoscloud::PrivateCrossConnectApi.new
40
+ pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
41
+ opts = {
42
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
43
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
44
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
45
+ }
46
+
47
+ begin
48
+ # Delete a Private Cross-Connect
49
+ result = api_instance.pccs_delete(pcc_id, opts)
50
+ p result
51
+ rescue Ionoscloud::ApiError => e
52
+ puts "Error when calling PrivateCrossConnectApi->pccs_delete: #{e}"
53
+ end
54
+ ```
55
+
56
+ #### Using the pccs_delete_with_http_info variant
57
+
58
+ This returns an Array which contains the response data, status code and headers.
59
+
60
+ > <Array(Object, Integer, Hash)> pccs_delete_with_http_info(pcc_id, opts)
61
+
62
+ ```ruby
63
+ begin
64
+ # Delete a Private Cross-Connect
65
+ data, status_code, headers = api_instance.pccs_delete_with_http_info(pcc_id, opts)
66
+ p status_code # => 2xx
67
+ p headers # => { ... }
68
+ p data # => Object
69
+ rescue Ionoscloud::ApiError => e
70
+ puts "Error when calling PrivateCrossConnectApi->pccs_delete_with_http_info: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Name | Type | Description | Notes |
77
+ | ---- | ---- | ----------- | ----- |
78
+ | **pcc_id** | **String** | The unique ID of the private cross-connect | |
79
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
80
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
81
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
82
+
83
+ ### Return type
84
+
85
+ **Object**
86
+
87
+ ### Authorization
88
+
89
+ Basic Authentication, Token Authentication
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: Not defined
94
+ - **Accept**: application/json
95
+
96
+
97
+ ## pccs_find_by_id
98
+
99
+ > <PrivateCrossConnect> pccs_find_by_id(pcc_id, opts)
100
+
101
+ Retrieve a Private Cross-Connect
102
+
103
+ You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.
104
+
105
+ ### Examples
106
+
107
+ ```ruby
108
+ require 'time'
109
+ require 'ionoscloud'
110
+ # setup authorization
111
+ Ionoscloud.configure do |config|
112
+ # Configure HTTP basic authorization: Basic Authentication
113
+ config.username = 'YOUR USERNAME'
114
+ config.password = 'YOUR PASSWORD'
115
+
116
+ # Configure API key authorization: Token Authentication
117
+ config.api_key['Authorization'] = 'YOUR API KEY'
118
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
119
+ # config.api_key_prefix['Authorization'] = 'Bearer'
120
+ end
121
+
122
+ api_instance = Ionoscloud::PrivateCrossConnectApi.new
123
+ pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
124
+ opts = {
125
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
126
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
127
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
128
+ }
129
+
130
+ begin
131
+ # Retrieve a Private Cross-Connect
132
+ result = api_instance.pccs_find_by_id(pcc_id, opts)
133
+ p result
134
+ rescue Ionoscloud::ApiError => e
135
+ puts "Error when calling PrivateCrossConnectApi->pccs_find_by_id: #{e}"
136
+ end
137
+ ```
138
+
139
+ #### Using the pccs_find_by_id_with_http_info variant
140
+
141
+ This returns an Array which contains the response data, status code and headers.
142
+
143
+ > <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_find_by_id_with_http_info(pcc_id, opts)
144
+
145
+ ```ruby
146
+ begin
147
+ # Retrieve a Private Cross-Connect
148
+ data, status_code, headers = api_instance.pccs_find_by_id_with_http_info(pcc_id, opts)
149
+ p status_code # => 2xx
150
+ p headers # => { ... }
151
+ p data # => <PrivateCrossConnect>
152
+ rescue Ionoscloud::ApiError => e
153
+ puts "Error when calling PrivateCrossConnectApi->pccs_find_by_id_with_http_info: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ | Name | Type | Description | Notes |
160
+ | ---- | ---- | ----------- | ----- |
161
+ | **pcc_id** | **String** | The unique ID of the private cross-connect | |
162
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
163
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
164
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
165
+
166
+ ### Return type
167
+
168
+ [**PrivateCrossConnect**](PrivateCrossConnect.md)
169
+
170
+ ### Authorization
171
+
172
+ Basic Authentication, Token Authentication
173
+
174
+ ### HTTP request headers
175
+
176
+ - **Content-Type**: Not defined
177
+ - **Accept**: application/json
178
+
179
+
180
+ ## pccs_get
181
+
182
+ > <PrivateCrossConnects> pccs_get(opts)
183
+
184
+ List Private Cross-Connects
185
+
186
+ You can retrieve a complete list of private cross-connects provisioned under your account
187
+
188
+ ### Examples
189
+
190
+ ```ruby
191
+ require 'time'
192
+ require 'ionoscloud'
193
+ # setup authorization
194
+ Ionoscloud.configure do |config|
195
+ # Configure HTTP basic authorization: Basic Authentication
196
+ config.username = 'YOUR USERNAME'
197
+ config.password = 'YOUR PASSWORD'
198
+
199
+ # Configure API key authorization: Token Authentication
200
+ config.api_key['Authorization'] = 'YOUR API KEY'
201
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
202
+ # config.api_key_prefix['Authorization'] = 'Bearer'
203
+ end
204
+
205
+ api_instance = Ionoscloud::PrivateCrossConnectApi.new
206
+ opts = {
207
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
208
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
209
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
210
+ }
211
+
212
+ begin
213
+ # List Private Cross-Connects
214
+ result = api_instance.pccs_get(opts)
215
+ p result
216
+ rescue Ionoscloud::ApiError => e
217
+ puts "Error when calling PrivateCrossConnectApi->pccs_get: #{e}"
218
+ end
219
+ ```
220
+
221
+ #### Using the pccs_get_with_http_info variant
222
+
223
+ This returns an Array which contains the response data, status code and headers.
224
+
225
+ > <Array(<PrivateCrossConnects>, Integer, Hash)> pccs_get_with_http_info(opts)
226
+
227
+ ```ruby
228
+ begin
229
+ # List Private Cross-Connects
230
+ data, status_code, headers = api_instance.pccs_get_with_http_info(opts)
231
+ p status_code # => 2xx
232
+ p headers # => { ... }
233
+ p data # => <PrivateCrossConnects>
234
+ rescue Ionoscloud::ApiError => e
235
+ puts "Error when calling PrivateCrossConnectApi->pccs_get_with_http_info: #{e}"
236
+ end
237
+ ```
238
+
239
+ ### Parameters
240
+
241
+ | Name | Type | Description | Notes |
242
+ | ---- | ---- | ----------- | ----- |
243
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
244
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
245
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
246
+
247
+ ### Return type
248
+
249
+ [**PrivateCrossConnects**](PrivateCrossConnects.md)
250
+
251
+ ### Authorization
252
+
253
+ Basic Authentication, Token Authentication
254
+
255
+ ### HTTP request headers
256
+
257
+ - **Content-Type**: Not defined
258
+ - **Accept**: application/json
259
+
260
+
261
+ ## pccs_patch
262
+
263
+ > <PrivateCrossConnect> pccs_patch(pcc_id, pcc, opts)
264
+
265
+ Partially modify a private cross-connect
266
+
267
+ You can use update private cross-connect to re-name or update its description
268
+
269
+ ### Examples
270
+
271
+ ```ruby
272
+ require 'time'
273
+ require 'ionoscloud'
274
+ # setup authorization
275
+ Ionoscloud.configure do |config|
276
+ # Configure HTTP basic authorization: Basic Authentication
277
+ config.username = 'YOUR USERNAME'
278
+ config.password = 'YOUR PASSWORD'
279
+
280
+ # Configure API key authorization: Token Authentication
281
+ config.api_key['Authorization'] = 'YOUR API KEY'
282
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
+ # config.api_key_prefix['Authorization'] = 'Bearer'
284
+ end
285
+
286
+ api_instance = Ionoscloud::PrivateCrossConnectApi.new
287
+ pcc_id = 'pcc_id_example' # String | The unique ID of the private cross-connect
288
+ pcc = Ionoscloud::PrivateCrossConnectProperties.new # PrivateCrossConnectProperties | Modified properties of private cross-connect
289
+ opts = {
290
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
291
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
292
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
293
+ }
294
+
295
+ begin
296
+ # Partially modify a private cross-connect
297
+ result = api_instance.pccs_patch(pcc_id, pcc, opts)
298
+ p result
299
+ rescue Ionoscloud::ApiError => e
300
+ puts "Error when calling PrivateCrossConnectApi->pccs_patch: #{e}"
301
+ end
302
+ ```
303
+
304
+ #### Using the pccs_patch_with_http_info variant
305
+
306
+ This returns an Array which contains the response data, status code and headers.
307
+
308
+ > <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_patch_with_http_info(pcc_id, pcc, opts)
309
+
310
+ ```ruby
311
+ begin
312
+ # Partially modify a private cross-connect
313
+ data, status_code, headers = api_instance.pccs_patch_with_http_info(pcc_id, pcc, opts)
314
+ p status_code # => 2xx
315
+ p headers # => { ... }
316
+ p data # => <PrivateCrossConnect>
317
+ rescue Ionoscloud::ApiError => e
318
+ puts "Error when calling PrivateCrossConnectApi->pccs_patch_with_http_info: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+ | Name | Type | Description | Notes |
325
+ | ---- | ---- | ----------- | ----- |
326
+ | **pcc_id** | **String** | The unique ID of the private cross-connect | |
327
+ | **pcc** | [**PrivateCrossConnectProperties**](PrivateCrossConnectProperties.md) | Modified properties of private cross-connect | |
328
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
329
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
330
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
331
+
332
+ ### Return type
333
+
334
+ [**PrivateCrossConnect**](PrivateCrossConnect.md)
335
+
336
+ ### Authorization
337
+
338
+ Basic Authentication, Token Authentication
339
+
340
+ ### HTTP request headers
341
+
342
+ - **Content-Type**: application/json
343
+ - **Accept**: application/json
344
+
345
+
346
+ ## pccs_post
347
+
348
+ > <PrivateCrossConnect> pccs_post(pcc, opts)
349
+
350
+ Create a Private Cross-Connect
351
+
352
+ You can use this POST method to create a private cross-connect
353
+
354
+ ### Examples
355
+
356
+ ```ruby
357
+ require 'time'
358
+ require 'ionoscloud'
359
+ # setup authorization
360
+ Ionoscloud.configure do |config|
361
+ # Configure HTTP basic authorization: Basic Authentication
362
+ config.username = 'YOUR USERNAME'
363
+ config.password = 'YOUR PASSWORD'
364
+
365
+ # Configure API key authorization: Token Authentication
366
+ config.api_key['Authorization'] = 'YOUR API KEY'
367
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
368
+ # config.api_key_prefix['Authorization'] = 'Bearer'
369
+ end
370
+
371
+ api_instance = Ionoscloud::PrivateCrossConnectApi.new
372
+ pcc = Ionoscloud::PrivateCrossConnect.new({properties: Ionoscloud::PrivateCrossConnectProperties.new}) # PrivateCrossConnect | Private Cross-Connect to be created
373
+ opts = {
374
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
375
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
376
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
377
+ }
378
+
379
+ begin
380
+ # Create a Private Cross-Connect
381
+ result = api_instance.pccs_post(pcc, opts)
382
+ p result
383
+ rescue Ionoscloud::ApiError => e
384
+ puts "Error when calling PrivateCrossConnectApi->pccs_post: #{e}"
385
+ end
386
+ ```
387
+
388
+ #### Using the pccs_post_with_http_info variant
389
+
390
+ This returns an Array which contains the response data, status code and headers.
391
+
392
+ > <Array(<PrivateCrossConnect>, Integer, Hash)> pccs_post_with_http_info(pcc, opts)
393
+
394
+ ```ruby
395
+ begin
396
+ # Create a Private Cross-Connect
397
+ data, status_code, headers = api_instance.pccs_post_with_http_info(pcc, opts)
398
+ p status_code # => 2xx
399
+ p headers # => { ... }
400
+ p data # => <PrivateCrossConnect>
401
+ rescue Ionoscloud::ApiError => e
402
+ puts "Error when calling PrivateCrossConnectApi->pccs_post_with_http_info: #{e}"
403
+ end
404
+ ```
405
+
406
+ ### Parameters
407
+
408
+ | Name | Type | Description | Notes |
409
+ | ---- | ---- | ----------- | ----- |
410
+ | **pcc** | [**PrivateCrossConnect**](PrivateCrossConnect.md) | Private Cross-Connect to be created | |
411
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
412
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
413
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
414
+
415
+ ### Return type
416
+
417
+ [**PrivateCrossConnect**](PrivateCrossConnect.md)
418
+
419
+ ### Authorization
420
+
421
+ Basic Authentication, Token Authentication
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: application/json
426
+ - **Accept**: application/json
427
+