sources-api-client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +70 -0
  4. data/LICENSE.txt +202 -0
  5. data/README.md +151 -0
  6. data/Rakefile +10 -0
  7. data/docs/Application.md +31 -0
  8. data/docs/ApplicationType.md +31 -0
  9. data/docs/ApplicationTypesCollection.md +21 -0
  10. data/docs/ApplicationsCollection.md +21 -0
  11. data/docs/Authentication.md +41 -0
  12. data/docs/AuthenticationExtra.md +17 -0
  13. data/docs/AuthenticationExtraAzure.md +17 -0
  14. data/docs/AuthenticationsCollection.md +21 -0
  15. data/docs/CollectionLinks.md +23 -0
  16. data/docs/CollectionMetadata.md +21 -0
  17. data/docs/DefaultApi.md +1945 -0
  18. data/docs/Endpoint.md +47 -0
  19. data/docs/EndpointsCollection.md +21 -0
  20. data/docs/ErrorNotFound.md +17 -0
  21. data/docs/ErrorNotFoundErrors.md +19 -0
  22. data/docs/GraphQLRequest.md +21 -0
  23. data/docs/GraphQLResponse.md +19 -0
  24. data/docs/Source.md +37 -0
  25. data/docs/SourceType.md +31 -0
  26. data/docs/SourceTypesCollection.md +21 -0
  27. data/docs/SourcesCollection.md +21 -0
  28. data/docs/Tenant.md +21 -0
  29. data/git_push.sh +58 -0
  30. data/lib/sources-api-client.rb +61 -0
  31. data/lib/sources-api-client/api/default_api.rb +2523 -0
  32. data/lib/sources-api-client/api_client.rb +386 -0
  33. data/lib/sources-api-client/api_error.rb +57 -0
  34. data/lib/sources-api-client/configuration.rb +268 -0
  35. data/lib/sources-api-client/models/application.rb +323 -0
  36. data/lib/sources-api-client/models/application_type.rb +287 -0
  37. data/lib/sources-api-client/models/application_types_collection.rb +226 -0
  38. data/lib/sources-api-client/models/applications_collection.rb +226 -0
  39. data/lib/sources-api-client/models/authentication.rb +350 -0
  40. data/lib/sources-api-client/models/authentication_extra.rb +206 -0
  41. data/lib/sources-api-client/models/authentication_extra_azure.rb +206 -0
  42. data/lib/sources-api-client/models/authentications_collection.rb +226 -0
  43. data/lib/sources-api-client/models/collection_links.rb +233 -0
  44. data/lib/sources-api-client/models/collection_metadata.rb +224 -0
  45. data/lib/sources-api-client/models/endpoint.rb +384 -0
  46. data/lib/sources-api-client/models/endpoints_collection.rb +226 -0
  47. data/lib/sources-api-client/models/error_not_found.rb +208 -0
  48. data/lib/sources-api-client/models/error_not_found_errors.rb +215 -0
  49. data/lib/sources-api-client/models/graph_ql_request.rb +237 -0
  50. data/lib/sources-api-client/models/graph_ql_response.rb +219 -0
  51. data/lib/sources-api-client/models/source.rb +332 -0
  52. data/lib/sources-api-client/models/source_type.rb +287 -0
  53. data/lib/sources-api-client/models/source_types_collection.rb +226 -0
  54. data/lib/sources-api-client/models/sources_collection.rb +226 -0
  55. data/lib/sources-api-client/models/tenant.rb +224 -0
  56. data/lib/sources-api-client/version.rb +15 -0
  57. data/pkg/sources-api-client-1.0.0.gem +0 -0
  58. data/sources-api-client.gemspec +39 -0
  59. data/spec/api/default_api_spec.rb +487 -0
  60. data/spec/api_client_spec.rb +226 -0
  61. data/spec/configuration_spec.rb +42 -0
  62. data/spec/models/application_spec.rb +83 -0
  63. data/spec/models/application_type_spec.rb +83 -0
  64. data/spec/models/application_types_collection_spec.rb +53 -0
  65. data/spec/models/applications_collection_spec.rb +53 -0
  66. data/spec/models/authentication_extra_azure_spec.rb +41 -0
  67. data/spec/models/authentication_extra_spec.rb +41 -0
  68. data/spec/models/authentication_spec.rb +113 -0
  69. data/spec/models/authentications_collection_spec.rb +53 -0
  70. data/spec/models/collection_links_spec.rb +59 -0
  71. data/spec/models/collection_metadata_spec.rb +53 -0
  72. data/spec/models/endpoint_spec.rb +131 -0
  73. data/spec/models/endpoints_collection_spec.rb +53 -0
  74. data/spec/models/error_not_found_errors_spec.rb +47 -0
  75. data/spec/models/error_not_found_spec.rb +41 -0
  76. data/spec/models/graph_ql_request_spec.rb +53 -0
  77. data/spec/models/graph_ql_response_spec.rb +47 -0
  78. data/spec/models/source_spec.rb +101 -0
  79. data/spec/models/source_type_spec.rb +83 -0
  80. data/spec/models/source_types_collection_spec.rb +53 -0
  81. data/spec/models/sources_collection_spec.rb +53 -0
  82. data/spec/models/tenant_spec.rb +53 -0
  83. data/spec/spec_helper.rb +111 -0
  84. metadata +210 -0
@@ -0,0 +1,31 @@
1
+ # SourcesApiClient::Application
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **application_type_id** | **String** | ID of the resource | [optional] [readonly]
8
+ **availability_status** | **String** | | [optional]
9
+ **availability_status_error** | **String** | | [optional]
10
+ **created_at** | **DateTime** | | [optional] [readonly]
11
+ **id** | **String** | ID of the resource | [optional] [readonly]
12
+ **source_id** | **String** | ID of the resource | [optional] [readonly]
13
+ **tenant** | **String** | | [optional] [readonly]
14
+ **updated_at** | **DateTime** | | [optional] [readonly]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'SourcesApiClient'
20
+
21
+ instance = SourcesApiClient::Application.new(application_type_id: null,
22
+ availability_status: null,
23
+ availability_status_error: null,
24
+ created_at: null,
25
+ id: null,
26
+ source_id: null,
27
+ tenant: null,
28
+ updated_at: null)
29
+ ```
30
+
31
+
@@ -0,0 +1,31 @@
1
+ # SourcesApiClient::ApplicationType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **created_at** | **DateTime** | | [optional] [readonly]
8
+ **dependent_applications** | [**Object**](.md) | | [optional]
9
+ **display_name** | **String** | | [optional]
10
+ **id** | **String** | ID of the resource | [optional] [readonly]
11
+ **name** | **String** | | [optional]
12
+ **supported_authentication_types** | [**Object**](.md) | | [optional]
13
+ **supported_source_types** | [**Object**](.md) | | [optional]
14
+ **updated_at** | **DateTime** | | [optional] [readonly]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'SourcesApiClient'
20
+
21
+ instance = SourcesApiClient::ApplicationType.new(created_at: null,
22
+ dependent_applications: null,
23
+ display_name: null,
24
+ id: null,
25
+ name: null,
26
+ supported_authentication_types: null,
27
+ supported_source_types: null,
28
+ updated_at: null)
29
+ ```
30
+
31
+
@@ -0,0 +1,21 @@
1
+ # SourcesApiClient::ApplicationTypesCollection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **meta** | [**CollectionMetadata**](CollectionMetadata.md) | | [optional]
8
+ **links** | [**CollectionLinks**](CollectionLinks.md) | | [optional]
9
+ **data** | [**Array<ApplicationType>**](ApplicationType.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SourcesApiClient'
15
+
16
+ instance = SourcesApiClient::ApplicationTypesCollection.new(meta: null,
17
+ links: null,
18
+ data: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,21 @@
1
+ # SourcesApiClient::ApplicationsCollection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **meta** | [**CollectionMetadata**](CollectionMetadata.md) | | [optional]
8
+ **links** | [**CollectionLinks**](CollectionLinks.md) | | [optional]
9
+ **data** | [**Array<Application>**](Application.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SourcesApiClient'
15
+
16
+ instance = SourcesApiClient::ApplicationsCollection.new(meta: null,
17
+ links: null,
18
+ data: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,41 @@
1
+ # SourcesApiClient::Authentication
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **authtype** | **String** | | [optional]
8
+ **availability_status** | **String** | | [optional]
9
+ **availability_status_error** | **String** | | [optional]
10
+ **extra** | [**AuthenticationExtra**](AuthenticationExtra.md) | | [optional]
11
+ **id** | **String** | ID of the resource | [optional] [readonly]
12
+ **name** | **String** | | [optional]
13
+ **password** | **String** | | [optional]
14
+ **resource_id** | **String** | ID of the resource | [optional] [readonly]
15
+ **resource_type** | **String** | | [optional]
16
+ **status** | **String** | | [optional]
17
+ **status_details** | **String** | | [optional]
18
+ **tenant** | **String** | | [optional] [readonly]
19
+ **username** | **String** | | [optional]
20
+
21
+ ## Code Sample
22
+
23
+ ```ruby
24
+ require 'SourcesApiClient'
25
+
26
+ instance = SourcesApiClient::Authentication.new(authtype: openshift_default,
27
+ availability_status: null,
28
+ availability_status_error: null,
29
+ extra: null,
30
+ id: null,
31
+ name: OpenShift default,
32
+ password: null,
33
+ resource_id: null,
34
+ resource_type: Endpoint,
35
+ status: valid,
36
+ status_details: null,
37
+ tenant: null,
38
+ username: user@example.com)
39
+ ```
40
+
41
+
@@ -0,0 +1,17 @@
1
+ # SourcesApiClient::AuthenticationExtra
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **azure** | [**AuthenticationExtraAzure**](AuthenticationExtraAzure.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SourcesApiClient'
13
+
14
+ instance = SourcesApiClient::AuthenticationExtra.new(azure: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # SourcesApiClient::AuthenticationExtraAzure
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **tenant_id** | **String** | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'SourcesApiClient'
13
+
14
+ instance = SourcesApiClient::AuthenticationExtraAzure.new(tenant_id: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,21 @@
1
+ # SourcesApiClient::AuthenticationsCollection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **meta** | [**CollectionMetadata**](CollectionMetadata.md) | | [optional]
8
+ **links** | [**CollectionLinks**](CollectionLinks.md) | | [optional]
9
+ **data** | [**Array<Authentication>**](Authentication.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SourcesApiClient'
15
+
16
+ instance = SourcesApiClient::AuthenticationsCollection.new(meta: null,
17
+ links: null,
18
+ data: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,23 @@
1
+ # SourcesApiClient::CollectionLinks
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **first** | **String** | | [optional]
8
+ **last** | **String** | | [optional]
9
+ **_next** | **String** | | [optional]
10
+ **prev** | **String** | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'SourcesApiClient'
16
+
17
+ instance = SourcesApiClient::CollectionLinks.new(first: null,
18
+ last: null,
19
+ _next: null,
20
+ prev: null)
21
+ ```
22
+
23
+
@@ -0,0 +1,21 @@
1
+ # SourcesApiClient::CollectionMetadata
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **count** | **Integer** | | [optional]
8
+ **limit** | **Integer** | | [optional]
9
+ **offset** | **Integer** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'SourcesApiClient'
15
+
16
+ instance = SourcesApiClient::CollectionMetadata.new(count: null,
17
+ limit: null,
18
+ offset: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,1945 @@
1
+ # SourcesApiClient::DefaultApi
2
+
3
+ All URIs are relative to *https://cloud.redhat.com//api/sources/v1.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**check_availability_source**](DefaultApi.md#check_availability_source) | **POST** /sources/{id}/check_availability | Checks Availability of a Source
8
+ [**create_application**](DefaultApi.md#create_application) | **POST** /applications | Create a new Application
9
+ [**create_authentication**](DefaultApi.md#create_authentication) | **POST** /authentications | Create a new Authentication
10
+ [**create_endpoint**](DefaultApi.md#create_endpoint) | **POST** /endpoints | Create a new Endpoint
11
+ [**create_source**](DefaultApi.md#create_source) | **POST** /sources | Create a new Source
12
+ [**create_source_type**](DefaultApi.md#create_source_type) | **POST** /source_types | Create a new SourceType
13
+ [**delete_application**](DefaultApi.md#delete_application) | **DELETE** /applications/{id} | Delete an existing Application
14
+ [**delete_authentication**](DefaultApi.md#delete_authentication) | **DELETE** /authentications/{id} | Delete an existing Authentication
15
+ [**delete_endpoint**](DefaultApi.md#delete_endpoint) | **DELETE** /endpoints/{id} | Delete an existing Endpoint
16
+ [**delete_source**](DefaultApi.md#delete_source) | **DELETE** /sources/{id} | Delete an existing Source
17
+ [**get_documentation**](DefaultApi.md#get_documentation) | **GET** /openapi.json | Return this API document in JSON format
18
+ [**list_application_type_sources**](DefaultApi.md#list_application_type_sources) | **GET** /application_types/{id}/sources | List Sources for ApplicationType
19
+ [**list_application_types**](DefaultApi.md#list_application_types) | **GET** /application_types | List ApplicationTypes
20
+ [**list_applications**](DefaultApi.md#list_applications) | **GET** /applications | List Applications
21
+ [**list_authentications**](DefaultApi.md#list_authentications) | **GET** /authentications | List Authentications
22
+ [**list_endpoint_authentications**](DefaultApi.md#list_endpoint_authentications) | **GET** /endpoints/{id}/authentications | List Authentications for Endpoint
23
+ [**list_endpoints**](DefaultApi.md#list_endpoints) | **GET** /endpoints | List Endpoints
24
+ [**list_source_application_types**](DefaultApi.md#list_source_application_types) | **GET** /sources/{id}/application_types | List ApplicationTypes for Source
25
+ [**list_source_applications**](DefaultApi.md#list_source_applications) | **GET** /sources/{id}/applications | List Applications for Source
26
+ [**list_source_endpoints**](DefaultApi.md#list_source_endpoints) | **GET** /sources/{id}/endpoints | List Endpoints for Source
27
+ [**list_source_type_sources**](DefaultApi.md#list_source_type_sources) | **GET** /source_types/{id}/sources | List Sources for SourceType
28
+ [**list_source_types**](DefaultApi.md#list_source_types) | **GET** /source_types | List SourceTypes
29
+ [**list_sources**](DefaultApi.md#list_sources) | **GET** /sources | List Sources
30
+ [**post_graph_ql**](DefaultApi.md#post_graph_ql) | **POST** /graphql | Perform a GraphQL Query
31
+ [**show_application**](DefaultApi.md#show_application) | **GET** /applications/{id} | Show an existing Application
32
+ [**show_application_type**](DefaultApi.md#show_application_type) | **GET** /application_types/{id} | Show an existing ApplicationType
33
+ [**show_authentication**](DefaultApi.md#show_authentication) | **GET** /authentications/{id} | Show an existing Authentication
34
+ [**show_endpoint**](DefaultApi.md#show_endpoint) | **GET** /endpoints/{id} | Show an existing Endpoint
35
+ [**show_source**](DefaultApi.md#show_source) | **GET** /sources/{id} | Show an existing Source
36
+ [**show_source_type**](DefaultApi.md#show_source_type) | **GET** /source_types/{id} | Show an existing SourceType
37
+ [**update_application**](DefaultApi.md#update_application) | **PATCH** /applications/{id} | Update an existing Application
38
+ [**update_authentication**](DefaultApi.md#update_authentication) | **PATCH** /authentications/{id} | Update an existing Authentication
39
+ [**update_endpoint**](DefaultApi.md#update_endpoint) | **PATCH** /endpoints/{id} | Update an existing Endpoint
40
+ [**update_source**](DefaultApi.md#update_source) | **PATCH** /sources/{id} | Update an existing Source
41
+
42
+
43
+
44
+ ## check_availability_source
45
+
46
+ > check_availability_source(id)
47
+
48
+ Checks Availability of a Source
49
+
50
+ Checks Availability of a Source
51
+
52
+ ### Example
53
+
54
+ ```ruby
55
+ # load the gem
56
+ require 'sources-api-client'
57
+ # setup authorization
58
+ SourcesApiClient.configure do |config|
59
+ # Configure HTTP basic authorization: UserSecurity
60
+ config.username = 'YOUR USERNAME'
61
+ config.password = 'YOUR PASSWORD'
62
+ end
63
+
64
+ api_instance = SourcesApiClient::DefaultApi.new
65
+ id = 'id_example' # String | ID of the resource
66
+
67
+ begin
68
+ #Checks Availability of a Source
69
+ api_instance.check_availability_source(id)
70
+ rescue SourcesApiClient::ApiError => e
71
+ puts "Exception when calling DefaultApi->check_availability_source: #{e}"
72
+ end
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+
78
+ Name | Type | Description | Notes
79
+ ------------- | ------------- | ------------- | -------------
80
+ **id** | **String**| ID of the resource |
81
+
82
+ ### Return type
83
+
84
+ nil (empty response body)
85
+
86
+ ### Authorization
87
+
88
+ [UserSecurity](../README.md#UserSecurity)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: Not defined
93
+ - **Accept**: application/json
94
+
95
+
96
+ ## create_application
97
+
98
+ > Application create_application(application)
99
+
100
+ Create a new Application
101
+
102
+ Creates a Application object
103
+
104
+ ### Example
105
+
106
+ ```ruby
107
+ # load the gem
108
+ require 'sources-api-client'
109
+ # setup authorization
110
+ SourcesApiClient.configure do |config|
111
+ # Configure HTTP basic authorization: UserSecurity
112
+ config.username = 'YOUR USERNAME'
113
+ config.password = 'YOUR PASSWORD'
114
+ end
115
+
116
+ api_instance = SourcesApiClient::DefaultApi.new
117
+ application = SourcesApiClient::Application.new # Application | Application attributes to create
118
+
119
+ begin
120
+ #Create a new Application
121
+ result = api_instance.create_application(application)
122
+ p result
123
+ rescue SourcesApiClient::ApiError => e
124
+ puts "Exception when calling DefaultApi->create_application: #{e}"
125
+ end
126
+ ```
127
+
128
+ ### Parameters
129
+
130
+
131
+ Name | Type | Description | Notes
132
+ ------------- | ------------- | ------------- | -------------
133
+ **application** | [**Application**](Application.md)| Application attributes to create |
134
+
135
+ ### Return type
136
+
137
+ [**Application**](Application.md)
138
+
139
+ ### Authorization
140
+
141
+ [UserSecurity](../README.md#UserSecurity)
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: application/json
146
+ - **Accept**: application/json
147
+
148
+
149
+ ## create_authentication
150
+
151
+ > Authentication create_authentication(authentication)
152
+
153
+ Create a new Authentication
154
+
155
+ Creates a Authentication object
156
+
157
+ ### Example
158
+
159
+ ```ruby
160
+ # load the gem
161
+ require 'sources-api-client'
162
+ # setup authorization
163
+ SourcesApiClient.configure do |config|
164
+ # Configure HTTP basic authorization: UserSecurity
165
+ config.username = 'YOUR USERNAME'
166
+ config.password = 'YOUR PASSWORD'
167
+ end
168
+
169
+ api_instance = SourcesApiClient::DefaultApi.new
170
+ authentication = SourcesApiClient::Authentication.new # Authentication | Authentication attributes to create
171
+
172
+ begin
173
+ #Create a new Authentication
174
+ result = api_instance.create_authentication(authentication)
175
+ p result
176
+ rescue SourcesApiClient::ApiError => e
177
+ puts "Exception when calling DefaultApi->create_authentication: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+
184
+ Name | Type | Description | Notes
185
+ ------------- | ------------- | ------------- | -------------
186
+ **authentication** | [**Authentication**](Authentication.md)| Authentication attributes to create |
187
+
188
+ ### Return type
189
+
190
+ [**Authentication**](Authentication.md)
191
+
192
+ ### Authorization
193
+
194
+ [UserSecurity](../README.md#UserSecurity)
195
+
196
+ ### HTTP request headers
197
+
198
+ - **Content-Type**: application/json
199
+ - **Accept**: application/json
200
+
201
+
202
+ ## create_endpoint
203
+
204
+ > Endpoint create_endpoint(endpoint)
205
+
206
+ Create a new Endpoint
207
+
208
+ Creates a Endpoint object
209
+
210
+ ### Example
211
+
212
+ ```ruby
213
+ # load the gem
214
+ require 'sources-api-client'
215
+ # setup authorization
216
+ SourcesApiClient.configure do |config|
217
+ # Configure HTTP basic authorization: UserSecurity
218
+ config.username = 'YOUR USERNAME'
219
+ config.password = 'YOUR PASSWORD'
220
+ end
221
+
222
+ api_instance = SourcesApiClient::DefaultApi.new
223
+ endpoint = SourcesApiClient::Endpoint.new # Endpoint | Endpoint attributes to create
224
+
225
+ begin
226
+ #Create a new Endpoint
227
+ result = api_instance.create_endpoint(endpoint)
228
+ p result
229
+ rescue SourcesApiClient::ApiError => e
230
+ puts "Exception when calling DefaultApi->create_endpoint: #{e}"
231
+ end
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+
237
+ Name | Type | Description | Notes
238
+ ------------- | ------------- | ------------- | -------------
239
+ **endpoint** | [**Endpoint**](Endpoint.md)| Endpoint attributes to create |
240
+
241
+ ### Return type
242
+
243
+ [**Endpoint**](Endpoint.md)
244
+
245
+ ### Authorization
246
+
247
+ [UserSecurity](../README.md#UserSecurity)
248
+
249
+ ### HTTP request headers
250
+
251
+ - **Content-Type**: application/json
252
+ - **Accept**: application/json
253
+
254
+
255
+ ## create_source
256
+
257
+ > Source create_source(source)
258
+
259
+ Create a new Source
260
+
261
+ Creates a Source object
262
+
263
+ ### Example
264
+
265
+ ```ruby
266
+ # load the gem
267
+ require 'sources-api-client'
268
+ # setup authorization
269
+ SourcesApiClient.configure do |config|
270
+ # Configure HTTP basic authorization: UserSecurity
271
+ config.username = 'YOUR USERNAME'
272
+ config.password = 'YOUR PASSWORD'
273
+ end
274
+
275
+ api_instance = SourcesApiClient::DefaultApi.new
276
+ source = SourcesApiClient::Source.new # Source | Source attributes to create
277
+
278
+ begin
279
+ #Create a new Source
280
+ result = api_instance.create_source(source)
281
+ p result
282
+ rescue SourcesApiClient::ApiError => e
283
+ puts "Exception when calling DefaultApi->create_source: #{e}"
284
+ end
285
+ ```
286
+
287
+ ### Parameters
288
+
289
+
290
+ Name | Type | Description | Notes
291
+ ------------- | ------------- | ------------- | -------------
292
+ **source** | [**Source**](Source.md)| Source attributes to create |
293
+
294
+ ### Return type
295
+
296
+ [**Source**](Source.md)
297
+
298
+ ### Authorization
299
+
300
+ [UserSecurity](../README.md#UserSecurity)
301
+
302
+ ### HTTP request headers
303
+
304
+ - **Content-Type**: application/json
305
+ - **Accept**: application/json
306
+
307
+
308
+ ## create_source_type
309
+
310
+ > SourceType create_source_type(source_type)
311
+
312
+ Create a new SourceType
313
+
314
+ Creates a SourceType object
315
+
316
+ ### Example
317
+
318
+ ```ruby
319
+ # load the gem
320
+ require 'sources-api-client'
321
+ # setup authorization
322
+ SourcesApiClient.configure do |config|
323
+ # Configure HTTP basic authorization: UserSecurity
324
+ config.username = 'YOUR USERNAME'
325
+ config.password = 'YOUR PASSWORD'
326
+ end
327
+
328
+ api_instance = SourcesApiClient::DefaultApi.new
329
+ source_type = SourcesApiClient::SourceType.new # SourceType | SourceType attributes to create
330
+
331
+ begin
332
+ #Create a new SourceType
333
+ result = api_instance.create_source_type(source_type)
334
+ p result
335
+ rescue SourcesApiClient::ApiError => e
336
+ puts "Exception when calling DefaultApi->create_source_type: #{e}"
337
+ end
338
+ ```
339
+
340
+ ### Parameters
341
+
342
+
343
+ Name | Type | Description | Notes
344
+ ------------- | ------------- | ------------- | -------------
345
+ **source_type** | [**SourceType**](SourceType.md)| SourceType attributes to create |
346
+
347
+ ### Return type
348
+
349
+ [**SourceType**](SourceType.md)
350
+
351
+ ### Authorization
352
+
353
+ [UserSecurity](../README.md#UserSecurity)
354
+
355
+ ### HTTP request headers
356
+
357
+ - **Content-Type**: application/json
358
+ - **Accept**: application/json
359
+
360
+
361
+ ## delete_application
362
+
363
+ > delete_application(id)
364
+
365
+ Delete an existing Application
366
+
367
+ Deletes a Application object
368
+
369
+ ### Example
370
+
371
+ ```ruby
372
+ # load the gem
373
+ require 'sources-api-client'
374
+ # setup authorization
375
+ SourcesApiClient.configure do |config|
376
+ # Configure HTTP basic authorization: UserSecurity
377
+ config.username = 'YOUR USERNAME'
378
+ config.password = 'YOUR PASSWORD'
379
+ end
380
+
381
+ api_instance = SourcesApiClient::DefaultApi.new
382
+ id = 'id_example' # String | ID of the resource
383
+
384
+ begin
385
+ #Delete an existing Application
386
+ api_instance.delete_application(id)
387
+ rescue SourcesApiClient::ApiError => e
388
+ puts "Exception when calling DefaultApi->delete_application: #{e}"
389
+ end
390
+ ```
391
+
392
+ ### Parameters
393
+
394
+
395
+ Name | Type | Description | Notes
396
+ ------------- | ------------- | ------------- | -------------
397
+ **id** | **String**| ID of the resource |
398
+
399
+ ### Return type
400
+
401
+ nil (empty response body)
402
+
403
+ ### Authorization
404
+
405
+ [UserSecurity](../README.md#UserSecurity)
406
+
407
+ ### HTTP request headers
408
+
409
+ - **Content-Type**: Not defined
410
+ - **Accept**: application/json
411
+
412
+
413
+ ## delete_authentication
414
+
415
+ > delete_authentication(id)
416
+
417
+ Delete an existing Authentication
418
+
419
+ Deletes a Authentication object
420
+
421
+ ### Example
422
+
423
+ ```ruby
424
+ # load the gem
425
+ require 'sources-api-client'
426
+ # setup authorization
427
+ SourcesApiClient.configure do |config|
428
+ # Configure HTTP basic authorization: UserSecurity
429
+ config.username = 'YOUR USERNAME'
430
+ config.password = 'YOUR PASSWORD'
431
+ end
432
+
433
+ api_instance = SourcesApiClient::DefaultApi.new
434
+ id = 'id_example' # String | ID of the resource
435
+
436
+ begin
437
+ #Delete an existing Authentication
438
+ api_instance.delete_authentication(id)
439
+ rescue SourcesApiClient::ApiError => e
440
+ puts "Exception when calling DefaultApi->delete_authentication: #{e}"
441
+ end
442
+ ```
443
+
444
+ ### Parameters
445
+
446
+
447
+ Name | Type | Description | Notes
448
+ ------------- | ------------- | ------------- | -------------
449
+ **id** | **String**| ID of the resource |
450
+
451
+ ### Return type
452
+
453
+ nil (empty response body)
454
+
455
+ ### Authorization
456
+
457
+ [UserSecurity](../README.md#UserSecurity)
458
+
459
+ ### HTTP request headers
460
+
461
+ - **Content-Type**: Not defined
462
+ - **Accept**: application/json
463
+
464
+
465
+ ## delete_endpoint
466
+
467
+ > delete_endpoint(id)
468
+
469
+ Delete an existing Endpoint
470
+
471
+ Deletes a Endpoint object
472
+
473
+ ### Example
474
+
475
+ ```ruby
476
+ # load the gem
477
+ require 'sources-api-client'
478
+ # setup authorization
479
+ SourcesApiClient.configure do |config|
480
+ # Configure HTTP basic authorization: UserSecurity
481
+ config.username = 'YOUR USERNAME'
482
+ config.password = 'YOUR PASSWORD'
483
+ end
484
+
485
+ api_instance = SourcesApiClient::DefaultApi.new
486
+ id = 'id_example' # String | ID of the resource
487
+
488
+ begin
489
+ #Delete an existing Endpoint
490
+ api_instance.delete_endpoint(id)
491
+ rescue SourcesApiClient::ApiError => e
492
+ puts "Exception when calling DefaultApi->delete_endpoint: #{e}"
493
+ end
494
+ ```
495
+
496
+ ### Parameters
497
+
498
+
499
+ Name | Type | Description | Notes
500
+ ------------- | ------------- | ------------- | -------------
501
+ **id** | **String**| ID of the resource |
502
+
503
+ ### Return type
504
+
505
+ nil (empty response body)
506
+
507
+ ### Authorization
508
+
509
+ [UserSecurity](../README.md#UserSecurity)
510
+
511
+ ### HTTP request headers
512
+
513
+ - **Content-Type**: Not defined
514
+ - **Accept**: application/json
515
+
516
+
517
+ ## delete_source
518
+
519
+ > delete_source(id)
520
+
521
+ Delete an existing Source
522
+
523
+ Deletes a Source object
524
+
525
+ ### Example
526
+
527
+ ```ruby
528
+ # load the gem
529
+ require 'sources-api-client'
530
+ # setup authorization
531
+ SourcesApiClient.configure do |config|
532
+ # Configure HTTP basic authorization: UserSecurity
533
+ config.username = 'YOUR USERNAME'
534
+ config.password = 'YOUR PASSWORD'
535
+ end
536
+
537
+ api_instance = SourcesApiClient::DefaultApi.new
538
+ id = 'id_example' # String | ID of the resource
539
+
540
+ begin
541
+ #Delete an existing Source
542
+ api_instance.delete_source(id)
543
+ rescue SourcesApiClient::ApiError => e
544
+ puts "Exception when calling DefaultApi->delete_source: #{e}"
545
+ end
546
+ ```
547
+
548
+ ### Parameters
549
+
550
+
551
+ Name | Type | Description | Notes
552
+ ------------- | ------------- | ------------- | -------------
553
+ **id** | **String**| ID of the resource |
554
+
555
+ ### Return type
556
+
557
+ nil (empty response body)
558
+
559
+ ### Authorization
560
+
561
+ [UserSecurity](../README.md#UserSecurity)
562
+
563
+ ### HTTP request headers
564
+
565
+ - **Content-Type**: Not defined
566
+ - **Accept**: application/json
567
+
568
+
569
+ ## get_documentation
570
+
571
+ > Object get_documentation
572
+
573
+ Return this API document in JSON format
574
+
575
+ ### Example
576
+
577
+ ```ruby
578
+ # load the gem
579
+ require 'sources-api-client'
580
+ # setup authorization
581
+ SourcesApiClient.configure do |config|
582
+ # Configure HTTP basic authorization: UserSecurity
583
+ config.username = 'YOUR USERNAME'
584
+ config.password = 'YOUR PASSWORD'
585
+ end
586
+
587
+ api_instance = SourcesApiClient::DefaultApi.new
588
+
589
+ begin
590
+ #Return this API document in JSON format
591
+ result = api_instance.get_documentation
592
+ p result
593
+ rescue SourcesApiClient::ApiError => e
594
+ puts "Exception when calling DefaultApi->get_documentation: #{e}"
595
+ end
596
+ ```
597
+
598
+ ### Parameters
599
+
600
+ This endpoint does not need any parameter.
601
+
602
+ ### Return type
603
+
604
+ **Object**
605
+
606
+ ### Authorization
607
+
608
+ [UserSecurity](../README.md#UserSecurity)
609
+
610
+ ### HTTP request headers
611
+
612
+ - **Content-Type**: Not defined
613
+ - **Accept**: application/json
614
+
615
+
616
+ ## list_application_type_sources
617
+
618
+ > SourcesCollection list_application_type_sources(id, opts)
619
+
620
+ List Sources for ApplicationType
621
+
622
+ Returns an array of Source objects
623
+
624
+ ### Example
625
+
626
+ ```ruby
627
+ # load the gem
628
+ require 'sources-api-client'
629
+ # setup authorization
630
+ SourcesApiClient.configure do |config|
631
+ # Configure HTTP basic authorization: UserSecurity
632
+ config.username = 'YOUR USERNAME'
633
+ config.password = 'YOUR PASSWORD'
634
+ end
635
+
636
+ api_instance = SourcesApiClient::DefaultApi.new
637
+ id = 'id_example' # String | ID of the resource
638
+ opts = {
639
+ limit: 100, # Integer | The numbers of items to return per page.
640
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
641
+ filter: nil, # Object | Filter for querying collections.
642
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
643
+ }
644
+
645
+ begin
646
+ #List Sources for ApplicationType
647
+ result = api_instance.list_application_type_sources(id, opts)
648
+ p result
649
+ rescue SourcesApiClient::ApiError => e
650
+ puts "Exception when calling DefaultApi->list_application_type_sources: #{e}"
651
+ end
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+
657
+ Name | Type | Description | Notes
658
+ ------------- | ------------- | ------------- | -------------
659
+ **id** | **String**| ID of the resource |
660
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
661
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
662
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
663
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
664
+
665
+ ### Return type
666
+
667
+ [**SourcesCollection**](SourcesCollection.md)
668
+
669
+ ### Authorization
670
+
671
+ [UserSecurity](../README.md#UserSecurity)
672
+
673
+ ### HTTP request headers
674
+
675
+ - **Content-Type**: Not defined
676
+ - **Accept**: application/json
677
+
678
+
679
+ ## list_application_types
680
+
681
+ > ApplicationTypesCollection list_application_types(opts)
682
+
683
+ List ApplicationTypes
684
+
685
+ Returns an array of ApplicationType objects
686
+
687
+ ### Example
688
+
689
+ ```ruby
690
+ # load the gem
691
+ require 'sources-api-client'
692
+ # setup authorization
693
+ SourcesApiClient.configure do |config|
694
+ # Configure HTTP basic authorization: UserSecurity
695
+ config.username = 'YOUR USERNAME'
696
+ config.password = 'YOUR PASSWORD'
697
+ end
698
+
699
+ api_instance = SourcesApiClient::DefaultApi.new
700
+ opts = {
701
+ limit: 100, # Integer | The numbers of items to return per page.
702
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
703
+ filter: nil, # Object | Filter for querying collections.
704
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
705
+ }
706
+
707
+ begin
708
+ #List ApplicationTypes
709
+ result = api_instance.list_application_types(opts)
710
+ p result
711
+ rescue SourcesApiClient::ApiError => e
712
+ puts "Exception when calling DefaultApi->list_application_types: #{e}"
713
+ end
714
+ ```
715
+
716
+ ### Parameters
717
+
718
+
719
+ Name | Type | Description | Notes
720
+ ------------- | ------------- | ------------- | -------------
721
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
722
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
723
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
724
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
725
+
726
+ ### Return type
727
+
728
+ [**ApplicationTypesCollection**](ApplicationTypesCollection.md)
729
+
730
+ ### Authorization
731
+
732
+ [UserSecurity](../README.md#UserSecurity)
733
+
734
+ ### HTTP request headers
735
+
736
+ - **Content-Type**: Not defined
737
+ - **Accept**: application/json
738
+
739
+
740
+ ## list_applications
741
+
742
+ > ApplicationsCollection list_applications(opts)
743
+
744
+ List Applications
745
+
746
+ Returns an array of Application objects
747
+
748
+ ### Example
749
+
750
+ ```ruby
751
+ # load the gem
752
+ require 'sources-api-client'
753
+ # setup authorization
754
+ SourcesApiClient.configure do |config|
755
+ # Configure HTTP basic authorization: UserSecurity
756
+ config.username = 'YOUR USERNAME'
757
+ config.password = 'YOUR PASSWORD'
758
+ end
759
+
760
+ api_instance = SourcesApiClient::DefaultApi.new
761
+ opts = {
762
+ limit: 100, # Integer | The numbers of items to return per page.
763
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
764
+ filter: nil, # Object | Filter for querying collections.
765
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
766
+ }
767
+
768
+ begin
769
+ #List Applications
770
+ result = api_instance.list_applications(opts)
771
+ p result
772
+ rescue SourcesApiClient::ApiError => e
773
+ puts "Exception when calling DefaultApi->list_applications: #{e}"
774
+ end
775
+ ```
776
+
777
+ ### Parameters
778
+
779
+
780
+ Name | Type | Description | Notes
781
+ ------------- | ------------- | ------------- | -------------
782
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
783
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
784
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
785
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
786
+
787
+ ### Return type
788
+
789
+ [**ApplicationsCollection**](ApplicationsCollection.md)
790
+
791
+ ### Authorization
792
+
793
+ [UserSecurity](../README.md#UserSecurity)
794
+
795
+ ### HTTP request headers
796
+
797
+ - **Content-Type**: Not defined
798
+ - **Accept**: application/json
799
+
800
+
801
+ ## list_authentications
802
+
803
+ > AuthenticationsCollection list_authentications(opts)
804
+
805
+ List Authentications
806
+
807
+ Returns an array of Authentication objects
808
+
809
+ ### Example
810
+
811
+ ```ruby
812
+ # load the gem
813
+ require 'sources-api-client'
814
+ # setup authorization
815
+ SourcesApiClient.configure do |config|
816
+ # Configure HTTP basic authorization: UserSecurity
817
+ config.username = 'YOUR USERNAME'
818
+ config.password = 'YOUR PASSWORD'
819
+ end
820
+
821
+ api_instance = SourcesApiClient::DefaultApi.new
822
+ opts = {
823
+ limit: 100, # Integer | The numbers of items to return per page.
824
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
825
+ filter: nil, # Object | Filter for querying collections.
826
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
827
+ }
828
+
829
+ begin
830
+ #List Authentications
831
+ result = api_instance.list_authentications(opts)
832
+ p result
833
+ rescue SourcesApiClient::ApiError => e
834
+ puts "Exception when calling DefaultApi->list_authentications: #{e}"
835
+ end
836
+ ```
837
+
838
+ ### Parameters
839
+
840
+
841
+ Name | Type | Description | Notes
842
+ ------------- | ------------- | ------------- | -------------
843
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
844
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
845
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
846
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
847
+
848
+ ### Return type
849
+
850
+ [**AuthenticationsCollection**](AuthenticationsCollection.md)
851
+
852
+ ### Authorization
853
+
854
+ [UserSecurity](../README.md#UserSecurity)
855
+
856
+ ### HTTP request headers
857
+
858
+ - **Content-Type**: Not defined
859
+ - **Accept**: application/json
860
+
861
+
862
+ ## list_endpoint_authentications
863
+
864
+ > AuthenticationsCollection list_endpoint_authentications(id, opts)
865
+
866
+ List Authentications for Endpoint
867
+
868
+ Returns an array of Authentication objects
869
+
870
+ ### Example
871
+
872
+ ```ruby
873
+ # load the gem
874
+ require 'sources-api-client'
875
+ # setup authorization
876
+ SourcesApiClient.configure do |config|
877
+ # Configure HTTP basic authorization: UserSecurity
878
+ config.username = 'YOUR USERNAME'
879
+ config.password = 'YOUR PASSWORD'
880
+ end
881
+
882
+ api_instance = SourcesApiClient::DefaultApi.new
883
+ id = 'id_example' # String | ID of the resource
884
+ opts = {
885
+ limit: 100, # Integer | The numbers of items to return per page.
886
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
887
+ filter: nil, # Object | Filter for querying collections.
888
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
889
+ }
890
+
891
+ begin
892
+ #List Authentications for Endpoint
893
+ result = api_instance.list_endpoint_authentications(id, opts)
894
+ p result
895
+ rescue SourcesApiClient::ApiError => e
896
+ puts "Exception when calling DefaultApi->list_endpoint_authentications: #{e}"
897
+ end
898
+ ```
899
+
900
+ ### Parameters
901
+
902
+
903
+ Name | Type | Description | Notes
904
+ ------------- | ------------- | ------------- | -------------
905
+ **id** | **String**| ID of the resource |
906
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
907
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
908
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
909
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
910
+
911
+ ### Return type
912
+
913
+ [**AuthenticationsCollection**](AuthenticationsCollection.md)
914
+
915
+ ### Authorization
916
+
917
+ [UserSecurity](../README.md#UserSecurity)
918
+
919
+ ### HTTP request headers
920
+
921
+ - **Content-Type**: Not defined
922
+ - **Accept**: application/json
923
+
924
+
925
+ ## list_endpoints
926
+
927
+ > EndpointsCollection list_endpoints(opts)
928
+
929
+ List Endpoints
930
+
931
+ Returns an array of Endpoint objects
932
+
933
+ ### Example
934
+
935
+ ```ruby
936
+ # load the gem
937
+ require 'sources-api-client'
938
+ # setup authorization
939
+ SourcesApiClient.configure do |config|
940
+ # Configure HTTP basic authorization: UserSecurity
941
+ config.username = 'YOUR USERNAME'
942
+ config.password = 'YOUR PASSWORD'
943
+ end
944
+
945
+ api_instance = SourcesApiClient::DefaultApi.new
946
+ opts = {
947
+ limit: 100, # Integer | The numbers of items to return per page.
948
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
949
+ filter: nil, # Object | Filter for querying collections.
950
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
951
+ }
952
+
953
+ begin
954
+ #List Endpoints
955
+ result = api_instance.list_endpoints(opts)
956
+ p result
957
+ rescue SourcesApiClient::ApiError => e
958
+ puts "Exception when calling DefaultApi->list_endpoints: #{e}"
959
+ end
960
+ ```
961
+
962
+ ### Parameters
963
+
964
+
965
+ Name | Type | Description | Notes
966
+ ------------- | ------------- | ------------- | -------------
967
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
968
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
969
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
970
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
971
+
972
+ ### Return type
973
+
974
+ [**EndpointsCollection**](EndpointsCollection.md)
975
+
976
+ ### Authorization
977
+
978
+ [UserSecurity](../README.md#UserSecurity)
979
+
980
+ ### HTTP request headers
981
+
982
+ - **Content-Type**: Not defined
983
+ - **Accept**: application/json
984
+
985
+
986
+ ## list_source_application_types
987
+
988
+ > ApplicationTypesCollection list_source_application_types(id, opts)
989
+
990
+ List ApplicationTypes for Source
991
+
992
+ Returns an array of ApplicationType objects
993
+
994
+ ### Example
995
+
996
+ ```ruby
997
+ # load the gem
998
+ require 'sources-api-client'
999
+ # setup authorization
1000
+ SourcesApiClient.configure do |config|
1001
+ # Configure HTTP basic authorization: UserSecurity
1002
+ config.username = 'YOUR USERNAME'
1003
+ config.password = 'YOUR PASSWORD'
1004
+ end
1005
+
1006
+ api_instance = SourcesApiClient::DefaultApi.new
1007
+ id = 'id_example' # String | ID of the resource
1008
+ opts = {
1009
+ limit: 100, # Integer | The numbers of items to return per page.
1010
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1011
+ filter: nil, # Object | Filter for querying collections.
1012
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1013
+ }
1014
+
1015
+ begin
1016
+ #List ApplicationTypes for Source
1017
+ result = api_instance.list_source_application_types(id, opts)
1018
+ p result
1019
+ rescue SourcesApiClient::ApiError => e
1020
+ puts "Exception when calling DefaultApi->list_source_application_types: #{e}"
1021
+ end
1022
+ ```
1023
+
1024
+ ### Parameters
1025
+
1026
+
1027
+ Name | Type | Description | Notes
1028
+ ------------- | ------------- | ------------- | -------------
1029
+ **id** | **String**| ID of the resource |
1030
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1031
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1032
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1033
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1034
+
1035
+ ### Return type
1036
+
1037
+ [**ApplicationTypesCollection**](ApplicationTypesCollection.md)
1038
+
1039
+ ### Authorization
1040
+
1041
+ [UserSecurity](../README.md#UserSecurity)
1042
+
1043
+ ### HTTP request headers
1044
+
1045
+ - **Content-Type**: Not defined
1046
+ - **Accept**: application/json
1047
+
1048
+
1049
+ ## list_source_applications
1050
+
1051
+ > ApplicationsCollection list_source_applications(id, opts)
1052
+
1053
+ List Applications for Source
1054
+
1055
+ Returns an array of Application objects
1056
+
1057
+ ### Example
1058
+
1059
+ ```ruby
1060
+ # load the gem
1061
+ require 'sources-api-client'
1062
+ # setup authorization
1063
+ SourcesApiClient.configure do |config|
1064
+ # Configure HTTP basic authorization: UserSecurity
1065
+ config.username = 'YOUR USERNAME'
1066
+ config.password = 'YOUR PASSWORD'
1067
+ end
1068
+
1069
+ api_instance = SourcesApiClient::DefaultApi.new
1070
+ id = 'id_example' # String | ID of the resource
1071
+ opts = {
1072
+ limit: 100, # Integer | The numbers of items to return per page.
1073
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1074
+ filter: nil, # Object | Filter for querying collections.
1075
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1076
+ }
1077
+
1078
+ begin
1079
+ #List Applications for Source
1080
+ result = api_instance.list_source_applications(id, opts)
1081
+ p result
1082
+ rescue SourcesApiClient::ApiError => e
1083
+ puts "Exception when calling DefaultApi->list_source_applications: #{e}"
1084
+ end
1085
+ ```
1086
+
1087
+ ### Parameters
1088
+
1089
+
1090
+ Name | Type | Description | Notes
1091
+ ------------- | ------------- | ------------- | -------------
1092
+ **id** | **String**| ID of the resource |
1093
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1094
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1095
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1096
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1097
+
1098
+ ### Return type
1099
+
1100
+ [**ApplicationsCollection**](ApplicationsCollection.md)
1101
+
1102
+ ### Authorization
1103
+
1104
+ [UserSecurity](../README.md#UserSecurity)
1105
+
1106
+ ### HTTP request headers
1107
+
1108
+ - **Content-Type**: Not defined
1109
+ - **Accept**: application/json
1110
+
1111
+
1112
+ ## list_source_endpoints
1113
+
1114
+ > EndpointsCollection list_source_endpoints(id, opts)
1115
+
1116
+ List Endpoints for Source
1117
+
1118
+ Returns an array of Endpoint objects
1119
+
1120
+ ### Example
1121
+
1122
+ ```ruby
1123
+ # load the gem
1124
+ require 'sources-api-client'
1125
+ # setup authorization
1126
+ SourcesApiClient.configure do |config|
1127
+ # Configure HTTP basic authorization: UserSecurity
1128
+ config.username = 'YOUR USERNAME'
1129
+ config.password = 'YOUR PASSWORD'
1130
+ end
1131
+
1132
+ api_instance = SourcesApiClient::DefaultApi.new
1133
+ id = 'id_example' # String | ID of the resource
1134
+ opts = {
1135
+ limit: 100, # Integer | The numbers of items to return per page.
1136
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1137
+ filter: nil, # Object | Filter for querying collections.
1138
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1139
+ }
1140
+
1141
+ begin
1142
+ #List Endpoints for Source
1143
+ result = api_instance.list_source_endpoints(id, opts)
1144
+ p result
1145
+ rescue SourcesApiClient::ApiError => e
1146
+ puts "Exception when calling DefaultApi->list_source_endpoints: #{e}"
1147
+ end
1148
+ ```
1149
+
1150
+ ### Parameters
1151
+
1152
+
1153
+ Name | Type | Description | Notes
1154
+ ------------- | ------------- | ------------- | -------------
1155
+ **id** | **String**| ID of the resource |
1156
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1157
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1158
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1159
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1160
+
1161
+ ### Return type
1162
+
1163
+ [**EndpointsCollection**](EndpointsCollection.md)
1164
+
1165
+ ### Authorization
1166
+
1167
+ [UserSecurity](../README.md#UserSecurity)
1168
+
1169
+ ### HTTP request headers
1170
+
1171
+ - **Content-Type**: Not defined
1172
+ - **Accept**: application/json
1173
+
1174
+
1175
+ ## list_source_type_sources
1176
+
1177
+ > SourcesCollection list_source_type_sources(id, opts)
1178
+
1179
+ List Sources for SourceType
1180
+
1181
+ Returns an array of Source objects
1182
+
1183
+ ### Example
1184
+
1185
+ ```ruby
1186
+ # load the gem
1187
+ require 'sources-api-client'
1188
+ # setup authorization
1189
+ SourcesApiClient.configure do |config|
1190
+ # Configure HTTP basic authorization: UserSecurity
1191
+ config.username = 'YOUR USERNAME'
1192
+ config.password = 'YOUR PASSWORD'
1193
+ end
1194
+
1195
+ api_instance = SourcesApiClient::DefaultApi.new
1196
+ id = 'id_example' # String | ID of the resource
1197
+ opts = {
1198
+ limit: 100, # Integer | The numbers of items to return per page.
1199
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1200
+ filter: nil, # Object | Filter for querying collections.
1201
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1202
+ }
1203
+
1204
+ begin
1205
+ #List Sources for SourceType
1206
+ result = api_instance.list_source_type_sources(id, opts)
1207
+ p result
1208
+ rescue SourcesApiClient::ApiError => e
1209
+ puts "Exception when calling DefaultApi->list_source_type_sources: #{e}"
1210
+ end
1211
+ ```
1212
+
1213
+ ### Parameters
1214
+
1215
+
1216
+ Name | Type | Description | Notes
1217
+ ------------- | ------------- | ------------- | -------------
1218
+ **id** | **String**| ID of the resource |
1219
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1220
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1221
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1222
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1223
+
1224
+ ### Return type
1225
+
1226
+ [**SourcesCollection**](SourcesCollection.md)
1227
+
1228
+ ### Authorization
1229
+
1230
+ [UserSecurity](../README.md#UserSecurity)
1231
+
1232
+ ### HTTP request headers
1233
+
1234
+ - **Content-Type**: Not defined
1235
+ - **Accept**: application/json
1236
+
1237
+
1238
+ ## list_source_types
1239
+
1240
+ > SourceTypesCollection list_source_types(opts)
1241
+
1242
+ List SourceTypes
1243
+
1244
+ Returns an array of SourceType objects
1245
+
1246
+ ### Example
1247
+
1248
+ ```ruby
1249
+ # load the gem
1250
+ require 'sources-api-client'
1251
+ # setup authorization
1252
+ SourcesApiClient.configure do |config|
1253
+ # Configure HTTP basic authorization: UserSecurity
1254
+ config.username = 'YOUR USERNAME'
1255
+ config.password = 'YOUR PASSWORD'
1256
+ end
1257
+
1258
+ api_instance = SourcesApiClient::DefaultApi.new
1259
+ opts = {
1260
+ limit: 100, # Integer | The numbers of items to return per page.
1261
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1262
+ filter: nil, # Object | Filter for querying collections.
1263
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1264
+ }
1265
+
1266
+ begin
1267
+ #List SourceTypes
1268
+ result = api_instance.list_source_types(opts)
1269
+ p result
1270
+ rescue SourcesApiClient::ApiError => e
1271
+ puts "Exception when calling DefaultApi->list_source_types: #{e}"
1272
+ end
1273
+ ```
1274
+
1275
+ ### Parameters
1276
+
1277
+
1278
+ Name | Type | Description | Notes
1279
+ ------------- | ------------- | ------------- | -------------
1280
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1281
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1282
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1283
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1284
+
1285
+ ### Return type
1286
+
1287
+ [**SourceTypesCollection**](SourceTypesCollection.md)
1288
+
1289
+ ### Authorization
1290
+
1291
+ [UserSecurity](../README.md#UserSecurity)
1292
+
1293
+ ### HTTP request headers
1294
+
1295
+ - **Content-Type**: Not defined
1296
+ - **Accept**: application/json
1297
+
1298
+
1299
+ ## list_sources
1300
+
1301
+ > SourcesCollection list_sources(opts)
1302
+
1303
+ List Sources
1304
+
1305
+ Returns an array of Source objects
1306
+
1307
+ ### Example
1308
+
1309
+ ```ruby
1310
+ # load the gem
1311
+ require 'sources-api-client'
1312
+ # setup authorization
1313
+ SourcesApiClient.configure do |config|
1314
+ # Configure HTTP basic authorization: UserSecurity
1315
+ config.username = 'YOUR USERNAME'
1316
+ config.password = 'YOUR PASSWORD'
1317
+ end
1318
+
1319
+ api_instance = SourcesApiClient::DefaultApi.new
1320
+ opts = {
1321
+ limit: 100, # Integer | The numbers of items to return per page.
1322
+ offset: 0, # Integer | The number of items to skip before starting to collect the result set.
1323
+ filter: nil, # Object | Filter for querying collections.
1324
+ sort_by: SourcesApiClient::OneOfstringarray.new # OneOfstringarray | The list of attribute and order to sort the result set by.
1325
+ }
1326
+
1327
+ begin
1328
+ #List Sources
1329
+ result = api_instance.list_sources(opts)
1330
+ p result
1331
+ rescue SourcesApiClient::ApiError => e
1332
+ puts "Exception when calling DefaultApi->list_sources: #{e}"
1333
+ end
1334
+ ```
1335
+
1336
+ ### Parameters
1337
+
1338
+
1339
+ Name | Type | Description | Notes
1340
+ ------------- | ------------- | ------------- | -------------
1341
+ **limit** | **Integer**| The numbers of items to return per page. | [optional] [default to 100]
1342
+ **offset** | **Integer**| The number of items to skip before starting to collect the result set. | [optional] [default to 0]
1343
+ **filter** | [**Object**](.md)| Filter for querying collections. | [optional]
1344
+ **sort_by** | [**OneOfstringarray**](.md)| The list of attribute and order to sort the result set by. | [optional]
1345
+
1346
+ ### Return type
1347
+
1348
+ [**SourcesCollection**](SourcesCollection.md)
1349
+
1350
+ ### Authorization
1351
+
1352
+ [UserSecurity](../README.md#UserSecurity)
1353
+
1354
+ ### HTTP request headers
1355
+
1356
+ - **Content-Type**: Not defined
1357
+ - **Accept**: application/json
1358
+
1359
+
1360
+ ## post_graph_ql
1361
+
1362
+ > GraphQLResponse post_graph_ql(graph_ql_request)
1363
+
1364
+ Perform a GraphQL Query
1365
+
1366
+ Performs a GraphQL Query
1367
+
1368
+ ### Example
1369
+
1370
+ ```ruby
1371
+ # load the gem
1372
+ require 'sources-api-client'
1373
+ # setup authorization
1374
+ SourcesApiClient.configure do |config|
1375
+ # Configure HTTP basic authorization: UserSecurity
1376
+ config.username = 'YOUR USERNAME'
1377
+ config.password = 'YOUR PASSWORD'
1378
+ end
1379
+
1380
+ api_instance = SourcesApiClient::DefaultApi.new
1381
+ graph_ql_request = SourcesApiClient::GraphQLRequest.new # GraphQLRequest | GraphQL Query Request
1382
+
1383
+ begin
1384
+ #Perform a GraphQL Query
1385
+ result = api_instance.post_graph_ql(graph_ql_request)
1386
+ p result
1387
+ rescue SourcesApiClient::ApiError => e
1388
+ puts "Exception when calling DefaultApi->post_graph_ql: #{e}"
1389
+ end
1390
+ ```
1391
+
1392
+ ### Parameters
1393
+
1394
+
1395
+ Name | Type | Description | Notes
1396
+ ------------- | ------------- | ------------- | -------------
1397
+ **graph_ql_request** | [**GraphQLRequest**](GraphQLRequest.md)| GraphQL Query Request |
1398
+
1399
+ ### Return type
1400
+
1401
+ [**GraphQLResponse**](GraphQLResponse.md)
1402
+
1403
+ ### Authorization
1404
+
1405
+ [UserSecurity](../README.md#UserSecurity)
1406
+
1407
+ ### HTTP request headers
1408
+
1409
+ - **Content-Type**: application/json
1410
+ - **Accept**: application/json
1411
+
1412
+
1413
+ ## show_application
1414
+
1415
+ > Application show_application(id)
1416
+
1417
+ Show an existing Application
1418
+
1419
+ Returns a Application object
1420
+
1421
+ ### Example
1422
+
1423
+ ```ruby
1424
+ # load the gem
1425
+ require 'sources-api-client'
1426
+ # setup authorization
1427
+ SourcesApiClient.configure do |config|
1428
+ # Configure HTTP basic authorization: UserSecurity
1429
+ config.username = 'YOUR USERNAME'
1430
+ config.password = 'YOUR PASSWORD'
1431
+ end
1432
+
1433
+ api_instance = SourcesApiClient::DefaultApi.new
1434
+ id = 'id_example' # String | ID of the resource
1435
+
1436
+ begin
1437
+ #Show an existing Application
1438
+ result = api_instance.show_application(id)
1439
+ p result
1440
+ rescue SourcesApiClient::ApiError => e
1441
+ puts "Exception when calling DefaultApi->show_application: #{e}"
1442
+ end
1443
+ ```
1444
+
1445
+ ### Parameters
1446
+
1447
+
1448
+ Name | Type | Description | Notes
1449
+ ------------- | ------------- | ------------- | -------------
1450
+ **id** | **String**| ID of the resource |
1451
+
1452
+ ### Return type
1453
+
1454
+ [**Application**](Application.md)
1455
+
1456
+ ### Authorization
1457
+
1458
+ [UserSecurity](../README.md#UserSecurity)
1459
+
1460
+ ### HTTP request headers
1461
+
1462
+ - **Content-Type**: Not defined
1463
+ - **Accept**: application/json
1464
+
1465
+
1466
+ ## show_application_type
1467
+
1468
+ > ApplicationType show_application_type(id)
1469
+
1470
+ Show an existing ApplicationType
1471
+
1472
+ Returns a ApplicationType object
1473
+
1474
+ ### Example
1475
+
1476
+ ```ruby
1477
+ # load the gem
1478
+ require 'sources-api-client'
1479
+ # setup authorization
1480
+ SourcesApiClient.configure do |config|
1481
+ # Configure HTTP basic authorization: UserSecurity
1482
+ config.username = 'YOUR USERNAME'
1483
+ config.password = 'YOUR PASSWORD'
1484
+ end
1485
+
1486
+ api_instance = SourcesApiClient::DefaultApi.new
1487
+ id = 'id_example' # String | ID of the resource
1488
+
1489
+ begin
1490
+ #Show an existing ApplicationType
1491
+ result = api_instance.show_application_type(id)
1492
+ p result
1493
+ rescue SourcesApiClient::ApiError => e
1494
+ puts "Exception when calling DefaultApi->show_application_type: #{e}"
1495
+ end
1496
+ ```
1497
+
1498
+ ### Parameters
1499
+
1500
+
1501
+ Name | Type | Description | Notes
1502
+ ------------- | ------------- | ------------- | -------------
1503
+ **id** | **String**| ID of the resource |
1504
+
1505
+ ### Return type
1506
+
1507
+ [**ApplicationType**](ApplicationType.md)
1508
+
1509
+ ### Authorization
1510
+
1511
+ [UserSecurity](../README.md#UserSecurity)
1512
+
1513
+ ### HTTP request headers
1514
+
1515
+ - **Content-Type**: Not defined
1516
+ - **Accept**: application/json
1517
+
1518
+
1519
+ ## show_authentication
1520
+
1521
+ > Authentication show_authentication(id)
1522
+
1523
+ Show an existing Authentication
1524
+
1525
+ Returns a Authentication object
1526
+
1527
+ ### Example
1528
+
1529
+ ```ruby
1530
+ # load the gem
1531
+ require 'sources-api-client'
1532
+ # setup authorization
1533
+ SourcesApiClient.configure do |config|
1534
+ # Configure HTTP basic authorization: UserSecurity
1535
+ config.username = 'YOUR USERNAME'
1536
+ config.password = 'YOUR PASSWORD'
1537
+ end
1538
+
1539
+ api_instance = SourcesApiClient::DefaultApi.new
1540
+ id = 'id_example' # String | ID of the resource
1541
+
1542
+ begin
1543
+ #Show an existing Authentication
1544
+ result = api_instance.show_authentication(id)
1545
+ p result
1546
+ rescue SourcesApiClient::ApiError => e
1547
+ puts "Exception when calling DefaultApi->show_authentication: #{e}"
1548
+ end
1549
+ ```
1550
+
1551
+ ### Parameters
1552
+
1553
+
1554
+ Name | Type | Description | Notes
1555
+ ------------- | ------------- | ------------- | -------------
1556
+ **id** | **String**| ID of the resource |
1557
+
1558
+ ### Return type
1559
+
1560
+ [**Authentication**](Authentication.md)
1561
+
1562
+ ### Authorization
1563
+
1564
+ [UserSecurity](../README.md#UserSecurity)
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: Not defined
1569
+ - **Accept**: application/json
1570
+
1571
+
1572
+ ## show_endpoint
1573
+
1574
+ > Endpoint show_endpoint(id)
1575
+
1576
+ Show an existing Endpoint
1577
+
1578
+ Returns a Endpoint object
1579
+
1580
+ ### Example
1581
+
1582
+ ```ruby
1583
+ # load the gem
1584
+ require 'sources-api-client'
1585
+ # setup authorization
1586
+ SourcesApiClient.configure do |config|
1587
+ # Configure HTTP basic authorization: UserSecurity
1588
+ config.username = 'YOUR USERNAME'
1589
+ config.password = 'YOUR PASSWORD'
1590
+ end
1591
+
1592
+ api_instance = SourcesApiClient::DefaultApi.new
1593
+ id = 'id_example' # String | ID of the resource
1594
+
1595
+ begin
1596
+ #Show an existing Endpoint
1597
+ result = api_instance.show_endpoint(id)
1598
+ p result
1599
+ rescue SourcesApiClient::ApiError => e
1600
+ puts "Exception when calling DefaultApi->show_endpoint: #{e}"
1601
+ end
1602
+ ```
1603
+
1604
+ ### Parameters
1605
+
1606
+
1607
+ Name | Type | Description | Notes
1608
+ ------------- | ------------- | ------------- | -------------
1609
+ **id** | **String**| ID of the resource |
1610
+
1611
+ ### Return type
1612
+
1613
+ [**Endpoint**](Endpoint.md)
1614
+
1615
+ ### Authorization
1616
+
1617
+ [UserSecurity](../README.md#UserSecurity)
1618
+
1619
+ ### HTTP request headers
1620
+
1621
+ - **Content-Type**: Not defined
1622
+ - **Accept**: application/json
1623
+
1624
+
1625
+ ## show_source
1626
+
1627
+ > Source show_source(id)
1628
+
1629
+ Show an existing Source
1630
+
1631
+ Returns a Source object
1632
+
1633
+ ### Example
1634
+
1635
+ ```ruby
1636
+ # load the gem
1637
+ require 'sources-api-client'
1638
+ # setup authorization
1639
+ SourcesApiClient.configure do |config|
1640
+ # Configure HTTP basic authorization: UserSecurity
1641
+ config.username = 'YOUR USERNAME'
1642
+ config.password = 'YOUR PASSWORD'
1643
+ end
1644
+
1645
+ api_instance = SourcesApiClient::DefaultApi.new
1646
+ id = 'id_example' # String | ID of the resource
1647
+
1648
+ begin
1649
+ #Show an existing Source
1650
+ result = api_instance.show_source(id)
1651
+ p result
1652
+ rescue SourcesApiClient::ApiError => e
1653
+ puts "Exception when calling DefaultApi->show_source: #{e}"
1654
+ end
1655
+ ```
1656
+
1657
+ ### Parameters
1658
+
1659
+
1660
+ Name | Type | Description | Notes
1661
+ ------------- | ------------- | ------------- | -------------
1662
+ **id** | **String**| ID of the resource |
1663
+
1664
+ ### Return type
1665
+
1666
+ [**Source**](Source.md)
1667
+
1668
+ ### Authorization
1669
+
1670
+ [UserSecurity](../README.md#UserSecurity)
1671
+
1672
+ ### HTTP request headers
1673
+
1674
+ - **Content-Type**: Not defined
1675
+ - **Accept**: application/json
1676
+
1677
+
1678
+ ## show_source_type
1679
+
1680
+ > SourceType show_source_type(id)
1681
+
1682
+ Show an existing SourceType
1683
+
1684
+ Returns a SourceType object
1685
+
1686
+ ### Example
1687
+
1688
+ ```ruby
1689
+ # load the gem
1690
+ require 'sources-api-client'
1691
+ # setup authorization
1692
+ SourcesApiClient.configure do |config|
1693
+ # Configure HTTP basic authorization: UserSecurity
1694
+ config.username = 'YOUR USERNAME'
1695
+ config.password = 'YOUR PASSWORD'
1696
+ end
1697
+
1698
+ api_instance = SourcesApiClient::DefaultApi.new
1699
+ id = 'id_example' # String | ID of the resource
1700
+
1701
+ begin
1702
+ #Show an existing SourceType
1703
+ result = api_instance.show_source_type(id)
1704
+ p result
1705
+ rescue SourcesApiClient::ApiError => e
1706
+ puts "Exception when calling DefaultApi->show_source_type: #{e}"
1707
+ end
1708
+ ```
1709
+
1710
+ ### Parameters
1711
+
1712
+
1713
+ Name | Type | Description | Notes
1714
+ ------------- | ------------- | ------------- | -------------
1715
+ **id** | **String**| ID of the resource |
1716
+
1717
+ ### Return type
1718
+
1719
+ [**SourceType**](SourceType.md)
1720
+
1721
+ ### Authorization
1722
+
1723
+ [UserSecurity](../README.md#UserSecurity)
1724
+
1725
+ ### HTTP request headers
1726
+
1727
+ - **Content-Type**: Not defined
1728
+ - **Accept**: application/json
1729
+
1730
+
1731
+ ## update_application
1732
+
1733
+ > update_application(id, application)
1734
+
1735
+ Update an existing Application
1736
+
1737
+ Updates a Application object
1738
+
1739
+ ### Example
1740
+
1741
+ ```ruby
1742
+ # load the gem
1743
+ require 'sources-api-client'
1744
+ # setup authorization
1745
+ SourcesApiClient.configure do |config|
1746
+ # Configure HTTP basic authorization: UserSecurity
1747
+ config.username = 'YOUR USERNAME'
1748
+ config.password = 'YOUR PASSWORD'
1749
+ end
1750
+
1751
+ api_instance = SourcesApiClient::DefaultApi.new
1752
+ id = 'id_example' # String | ID of the resource
1753
+ application = SourcesApiClient::Application.new # Application | Application attributes to update
1754
+
1755
+ begin
1756
+ #Update an existing Application
1757
+ api_instance.update_application(id, application)
1758
+ rescue SourcesApiClient::ApiError => e
1759
+ puts "Exception when calling DefaultApi->update_application: #{e}"
1760
+ end
1761
+ ```
1762
+
1763
+ ### Parameters
1764
+
1765
+
1766
+ Name | Type | Description | Notes
1767
+ ------------- | ------------- | ------------- | -------------
1768
+ **id** | **String**| ID of the resource |
1769
+ **application** | [**Application**](Application.md)| Application attributes to update |
1770
+
1771
+ ### Return type
1772
+
1773
+ nil (empty response body)
1774
+
1775
+ ### Authorization
1776
+
1777
+ [UserSecurity](../README.md#UserSecurity)
1778
+
1779
+ ### HTTP request headers
1780
+
1781
+ - **Content-Type**: application/json
1782
+ - **Accept**: application/json
1783
+
1784
+
1785
+ ## update_authentication
1786
+
1787
+ > update_authentication(id, authentication)
1788
+
1789
+ Update an existing Authentication
1790
+
1791
+ Updates a Authentication object
1792
+
1793
+ ### Example
1794
+
1795
+ ```ruby
1796
+ # load the gem
1797
+ require 'sources-api-client'
1798
+ # setup authorization
1799
+ SourcesApiClient.configure do |config|
1800
+ # Configure HTTP basic authorization: UserSecurity
1801
+ config.username = 'YOUR USERNAME'
1802
+ config.password = 'YOUR PASSWORD'
1803
+ end
1804
+
1805
+ api_instance = SourcesApiClient::DefaultApi.new
1806
+ id = 'id_example' # String | ID of the resource
1807
+ authentication = SourcesApiClient::Authentication.new # Authentication | Authentication attributes to update
1808
+
1809
+ begin
1810
+ #Update an existing Authentication
1811
+ api_instance.update_authentication(id, authentication)
1812
+ rescue SourcesApiClient::ApiError => e
1813
+ puts "Exception when calling DefaultApi->update_authentication: #{e}"
1814
+ end
1815
+ ```
1816
+
1817
+ ### Parameters
1818
+
1819
+
1820
+ Name | Type | Description | Notes
1821
+ ------------- | ------------- | ------------- | -------------
1822
+ **id** | **String**| ID of the resource |
1823
+ **authentication** | [**Authentication**](Authentication.md)| Authentication attributes to update |
1824
+
1825
+ ### Return type
1826
+
1827
+ nil (empty response body)
1828
+
1829
+ ### Authorization
1830
+
1831
+ [UserSecurity](../README.md#UserSecurity)
1832
+
1833
+ ### HTTP request headers
1834
+
1835
+ - **Content-Type**: application/json
1836
+ - **Accept**: application/json
1837
+
1838
+
1839
+ ## update_endpoint
1840
+
1841
+ > update_endpoint(id, endpoint)
1842
+
1843
+ Update an existing Endpoint
1844
+
1845
+ Updates a Endpoint object
1846
+
1847
+ ### Example
1848
+
1849
+ ```ruby
1850
+ # load the gem
1851
+ require 'sources-api-client'
1852
+ # setup authorization
1853
+ SourcesApiClient.configure do |config|
1854
+ # Configure HTTP basic authorization: UserSecurity
1855
+ config.username = 'YOUR USERNAME'
1856
+ config.password = 'YOUR PASSWORD'
1857
+ end
1858
+
1859
+ api_instance = SourcesApiClient::DefaultApi.new
1860
+ id = 'id_example' # String | ID of the resource
1861
+ endpoint = SourcesApiClient::Endpoint.new # Endpoint | Endpoint attributes to update
1862
+
1863
+ begin
1864
+ #Update an existing Endpoint
1865
+ api_instance.update_endpoint(id, endpoint)
1866
+ rescue SourcesApiClient::ApiError => e
1867
+ puts "Exception when calling DefaultApi->update_endpoint: #{e}"
1868
+ end
1869
+ ```
1870
+
1871
+ ### Parameters
1872
+
1873
+
1874
+ Name | Type | Description | Notes
1875
+ ------------- | ------------- | ------------- | -------------
1876
+ **id** | **String**| ID of the resource |
1877
+ **endpoint** | [**Endpoint**](Endpoint.md)| Endpoint attributes to update |
1878
+
1879
+ ### Return type
1880
+
1881
+ nil (empty response body)
1882
+
1883
+ ### Authorization
1884
+
1885
+ [UserSecurity](../README.md#UserSecurity)
1886
+
1887
+ ### HTTP request headers
1888
+
1889
+ - **Content-Type**: application/json
1890
+ - **Accept**: application/json
1891
+
1892
+
1893
+ ## update_source
1894
+
1895
+ > update_source(id, source)
1896
+
1897
+ Update an existing Source
1898
+
1899
+ Updates a Source object
1900
+
1901
+ ### Example
1902
+
1903
+ ```ruby
1904
+ # load the gem
1905
+ require 'sources-api-client'
1906
+ # setup authorization
1907
+ SourcesApiClient.configure do |config|
1908
+ # Configure HTTP basic authorization: UserSecurity
1909
+ config.username = 'YOUR USERNAME'
1910
+ config.password = 'YOUR PASSWORD'
1911
+ end
1912
+
1913
+ api_instance = SourcesApiClient::DefaultApi.new
1914
+ id = 'id_example' # String | ID of the resource
1915
+ source = SourcesApiClient::Source.new # Source | Source attributes to update
1916
+
1917
+ begin
1918
+ #Update an existing Source
1919
+ api_instance.update_source(id, source)
1920
+ rescue SourcesApiClient::ApiError => e
1921
+ puts "Exception when calling DefaultApi->update_source: #{e}"
1922
+ end
1923
+ ```
1924
+
1925
+ ### Parameters
1926
+
1927
+
1928
+ Name | Type | Description | Notes
1929
+ ------------- | ------------- | ------------- | -------------
1930
+ **id** | **String**| ID of the resource |
1931
+ **source** | [**Source**](Source.md)| Source attributes to update |
1932
+
1933
+ ### Return type
1934
+
1935
+ nil (empty response body)
1936
+
1937
+ ### Authorization
1938
+
1939
+ [UserSecurity](../README.md#UserSecurity)
1940
+
1941
+ ### HTTP request headers
1942
+
1943
+ - **Content-Type**: application/json
1944
+ - **Accept**: application/json
1945
+