cloudmersive-configuration-api-client 1.7.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +121 -0
  4. data/Rakefile +8 -0
  5. data/cloudmersive-configuration-api-client.gemspec +45 -0
  6. data/docs/CreateSettingRequest.md +14 -0
  7. data/docs/CreateSettingResponse.md +11 -0
  8. data/docs/HttpFormDataParameter.md +11 -0
  9. data/docs/HttpGetParameter.md +10 -0
  10. data/docs/HttpOrchestrationHeader.md +10 -0
  11. data/docs/HttpOrchestrationRequest.md +8 -0
  12. data/docs/HttpOrchestrationResponse.md +11 -0
  13. data/docs/HttpOrchestrationTask.md +16 -0
  14. data/docs/HttpRawBinaryParameter.md +9 -0
  15. data/docs/HttpRawTextParameter.md +9 -0
  16. data/docs/HttpWwwFormUrlEncodedParameter.md +10 -0
  17. data/docs/ListSettingsRequest.md +9 -0
  18. data/docs/ListSettingsResponse.md +8 -0
  19. data/docs/OrchestratorApi.md +61 -0
  20. data/docs/SettingValue.md +15 -0
  21. data/docs/SettingsApi.md +167 -0
  22. data/docs/TaskOutputReference.md +9 -0
  23. data/docs/UpdateSettingRequest.md +10 -0
  24. data/docs/UpdateSettingResponse.md +9 -0
  25. data/git_push.sh +55 -0
  26. data/lib/cloudmersive-configuration-api-client.rb +58 -0
  27. data/lib/cloudmersive-configuration-api-client/api/orchestrator_api.rb +78 -0
  28. data/lib/cloudmersive-configuration-api-client/api/settings_api.rb +188 -0
  29. data/lib/cloudmersive-configuration-api-client/api_client.rb +389 -0
  30. data/lib/cloudmersive-configuration-api-client/api_error.rb +38 -0
  31. data/lib/cloudmersive-configuration-api-client/configuration.rb +209 -0
  32. data/lib/cloudmersive-configuration-api-client/models/create_setting_request.rb +249 -0
  33. data/lib/cloudmersive-configuration-api-client/models/create_setting_response.rb +219 -0
  34. data/lib/cloudmersive-configuration-api-client/models/http_form_data_parameter.rb +235 -0
  35. data/lib/cloudmersive-configuration-api-client/models/http_get_parameter.rb +209 -0
  36. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_header.rb +209 -0
  37. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_request.rb +191 -0
  38. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_response.rb +235 -0
  39. data/lib/cloudmersive-configuration-api-client/models/http_orchestration_task.rb +277 -0
  40. data/lib/cloudmersive-configuration-api-client/models/http_raw_binary_parameter.rb +215 -0
  41. data/lib/cloudmersive-configuration-api-client/models/http_raw_text_parameter.rb +199 -0
  42. data/lib/cloudmersive-configuration-api-client/models/http_www_form_url_encoded_parameter.rb +209 -0
  43. data/lib/cloudmersive-configuration-api-client/models/list_settings_request.rb +199 -0
  44. data/lib/cloudmersive-configuration-api-client/models/list_settings_response.rb +191 -0
  45. data/lib/cloudmersive-configuration-api-client/models/setting_value.rb +259 -0
  46. data/lib/cloudmersive-configuration-api-client/models/task_output_reference.rb +199 -0
  47. data/lib/cloudmersive-configuration-api-client/models/update_setting_request.rb +206 -0
  48. data/lib/cloudmersive-configuration-api-client/models/update_setting_response.rb +197 -0
  49. data/lib/cloudmersive-configuration-api-client/version.rb +15 -0
  50. data/spec/api/orchestrator_api_spec.rb +47 -0
  51. data/spec/api/settings_api_spec.rb +71 -0
  52. data/spec/api_client_spec.rb +226 -0
  53. data/spec/configuration_spec.rb +42 -0
  54. data/spec/models/create_setting_request_spec.rb +78 -0
  55. data/spec/models/create_setting_response_spec.rb +60 -0
  56. data/spec/models/http_form_data_parameter_spec.rb +60 -0
  57. data/spec/models/http_get_parameter_spec.rb +54 -0
  58. data/spec/models/http_orchestration_header_spec.rb +54 -0
  59. data/spec/models/http_orchestration_request_spec.rb +42 -0
  60. data/spec/models/http_orchestration_response_spec.rb +60 -0
  61. data/spec/models/http_orchestration_task_spec.rb +90 -0
  62. data/spec/models/http_raw_binary_parameter_spec.rb +48 -0
  63. data/spec/models/http_raw_text_parameter_spec.rb +48 -0
  64. data/spec/models/http_www_form_url_encoded_parameter_spec.rb +54 -0
  65. data/spec/models/list_settings_request_spec.rb +48 -0
  66. data/spec/models/list_settings_response_spec.rb +42 -0
  67. data/spec/models/setting_value_spec.rb +84 -0
  68. data/spec/models/task_output_reference_spec.rb +48 -0
  69. data/spec/models/update_setting_request_spec.rb +54 -0
  70. data/spec/models/update_setting_response_spec.rb +48 -0
  71. data/spec/spec_helper.rb +111 -0
  72. metadata +294 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 5e4ef2ce0ba2561cdec92111845c1df36c6ce8615343ec485e8b24c9706a489e
4
+ data.tar.gz: f1836c19831e53718422e6cf3cbafcc935a811749d348859986f3fb4bfcebff4
5
+ SHA512:
6
+ metadata.gz: 7c6731965645aedd8cb90974f517d0c99551d6c2b6ccc69415590f7b49fa08b2756b6fcd894cc1ed8e9a1bb20c07594acff95ed2990ea91e83a0ae956b503e44
7
+ data.tar.gz: 7b28471c9ccd19aa56a9967b491c60616f55f7f1b496c437b645c06574a1a0957eef227a844266fb65d6f0573ad24eec38430c83f0c04d86b726c27ed1a011c0
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
@@ -0,0 +1,121 @@
1
+ # cloudmersive-configuration-api-client
2
+
3
+ CloudmersiveConfigurationApiClient - the Ruby gem for the configapi
4
+
5
+ Config API lets you easily manage configuration at scale.
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: v1
10
+ - Package version: 1.7.2
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build cloudmersive-configuration-api-client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./cloudmersive-configuration-api-client-1.7.2.gem
27
+ ```
28
+ (for development, run `gem install --dev ./cloudmersive-configuration-api-client-1.7.2.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'cloudmersive-configuration-api-client', '~> 1.7.2'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'cloudmersive-configuration-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'cloudmersive-configuration-api-client'
56
+
57
+ # Setup authorization
58
+ CloudmersiveConfigurationApiClient.configure do |config|
59
+ # Configure API key authorization: Apikey
60
+ config.api_key['Apikey'] = 'YOUR API KEY'
61
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
62
+ #config.api_key_prefix['Apikey'] = 'Bearer'
63
+ end
64
+
65
+ api_instance = CloudmersiveConfigurationApiClient::OrchestratorApi.new
66
+
67
+ request = CloudmersiveConfigurationApiClient::HttpOrchestrationRequest.new # HttpOrchestrationRequest |
68
+
69
+
70
+ begin
71
+ #Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
72
+ result = api_instance.orchestrator_http_simple(request)
73
+ p result
74
+ rescue CloudmersiveConfigurationApiClient::ApiError => e
75
+ puts "Exception when calling OrchestratorApi->orchestrator_http_simple: #{e}"
76
+ end
77
+
78
+ ```
79
+
80
+ ## Documentation for API Endpoints
81
+
82
+ All URIs are relative to *https://api.cloudmersive.com*
83
+
84
+ Class | Method | HTTP request | Description
85
+ ------------ | ------------- | ------------- | -------------
86
+ *CloudmersiveConfigurationApiClient::OrchestratorApi* | [**orchestrator_http_simple**](docs/OrchestratorApi.md#orchestrator_http_simple) | **POST** /config/orchestrator/http/simple | Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
87
+ *CloudmersiveConfigurationApiClient::SettingsApi* | [**settings_create_setting**](docs/SettingsApi.md#settings_create_setting) | **POST** /config/settings/create | Create a setting in the specified bucket
88
+ *CloudmersiveConfigurationApiClient::SettingsApi* | [**settings_list_settings**](docs/SettingsApi.md#settings_list_settings) | **POST** /config/settings/list | Enumerate the settings in a bucket
89
+ *CloudmersiveConfigurationApiClient::SettingsApi* | [**settings_update_setting**](docs/SettingsApi.md#settings_update_setting) | **POST** /config/settings/update | Update a setting
90
+
91
+
92
+ ## Documentation for Models
93
+
94
+ - [CloudmersiveConfigurationApiClient::CreateSettingRequest](docs/CreateSettingRequest.md)
95
+ - [CloudmersiveConfigurationApiClient::CreateSettingResponse](docs/CreateSettingResponse.md)
96
+ - [CloudmersiveConfigurationApiClient::HttpFormDataParameter](docs/HttpFormDataParameter.md)
97
+ - [CloudmersiveConfigurationApiClient::HttpGetParameter](docs/HttpGetParameter.md)
98
+ - [CloudmersiveConfigurationApiClient::HttpOrchestrationHeader](docs/HttpOrchestrationHeader.md)
99
+ - [CloudmersiveConfigurationApiClient::HttpOrchestrationRequest](docs/HttpOrchestrationRequest.md)
100
+ - [CloudmersiveConfigurationApiClient::HttpOrchestrationResponse](docs/HttpOrchestrationResponse.md)
101
+ - [CloudmersiveConfigurationApiClient::HttpOrchestrationTask](docs/HttpOrchestrationTask.md)
102
+ - [CloudmersiveConfigurationApiClient::HttpRawBinaryParameter](docs/HttpRawBinaryParameter.md)
103
+ - [CloudmersiveConfigurationApiClient::HttpRawTextParameter](docs/HttpRawTextParameter.md)
104
+ - [CloudmersiveConfigurationApiClient::HttpWwwFormUrlEncodedParameter](docs/HttpWwwFormUrlEncodedParameter.md)
105
+ - [CloudmersiveConfigurationApiClient::ListSettingsRequest](docs/ListSettingsRequest.md)
106
+ - [CloudmersiveConfigurationApiClient::ListSettingsResponse](docs/ListSettingsResponse.md)
107
+ - [CloudmersiveConfigurationApiClient::SettingValue](docs/SettingValue.md)
108
+ - [CloudmersiveConfigurationApiClient::TaskOutputReference](docs/TaskOutputReference.md)
109
+ - [CloudmersiveConfigurationApiClient::UpdateSettingRequest](docs/UpdateSettingRequest.md)
110
+ - [CloudmersiveConfigurationApiClient::UpdateSettingResponse](docs/UpdateSettingResponse.md)
111
+
112
+
113
+ ## Documentation for Authorization
114
+
115
+
116
+ ### Apikey
117
+
118
+ - **Type**: API key
119
+ - **API key parameter name**: Apikey
120
+ - **Location**: HTTP header
121
+
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,45 @@
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ =begin
4
+ #configapi
5
+
6
+ #Config API lets you easily manage configuration at scale.
7
+
8
+ OpenAPI spec version: v1
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 2.3.1
12
+
13
+ =end
14
+
15
+ $:.push File.expand_path("../lib", __FILE__)
16
+ require "cloudmersive-configuration-api-client/version"
17
+
18
+ Gem::Specification.new do |s|
19
+ s.name = "cloudmersive-configuration-api-client"
20
+ s.version = CloudmersiveConfigurationApiClient::VERSION
21
+ s.platform = Gem::Platform::RUBY
22
+ s.authors = ["Cloudmersive"]
23
+ s.email = [""]
24
+ s.homepage = "https://www.cloudmersive.com/convert-api"
25
+ s.summary = "Cloudmersive Configuration API lets you effortlessly roll out configuration and orchestration across your applications."
26
+ s.description = "Share configuration and orchestrate API calls."
27
+ s.license = "Apache 2.0"
28
+ s.required_ruby_version = ">= 1.9"
29
+
30
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
+
33
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
34
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
35
+ s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
36
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
37
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
38
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
39
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
40
+
41
+ s.files = Dir['./**/*']
42
+ s.test_files = `find spec/*`.split("\n")
43
+ s.executables = []
44
+ s.require_paths = ["lib"]
45
+ end
@@ -0,0 +1,14 @@
1
+ # CloudmersiveConfigurationApiClient::CreateSettingRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **bucket_id** | **String** | BucketID of the bucket to place the setting in; you can create a bucket by navigating to account.cloudmersive.com, clicking on Settings > API Configuration > Create Bucket | [optional]
7
+ **bucket_secret_key** | **String** | SecretKey of the bucket to place the setting in; you can create a bucket by navigating to account.cloudmersive.com, clicking on Settings > API Configuration > Create Bucket | [optional]
8
+ **setting_name** | **String** | Name of the setting to create | [optional]
9
+ **setting_type** | **String** | Type of setting to create; possible values are STRING, JSON | [optional]
10
+ **setting_value** | **Object** | Initial value of the setting | [optional]
11
+ **setting_description** | **String** | Description of the setting | [optional]
12
+ **setting_tags** | **String** | Tags to apply to the setting | [optional]
13
+
14
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConfigurationApiClient::CreateSettingResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **setting_definition_id** | **String** | SettingDefinitionID of the setting created | [optional]
8
+ **setting_value_id** | **String** | SettingValueID of the value of the setting | [optional]
9
+ **error_message** | **String** | Error message, if any, when the operation was not successful | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConfigurationApiClient::HttpFormDataParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **parameter_name** | **String** | Name of the parameter | [optional]
7
+ **parameter_text_value** | **String** | Text value of the parameter; if set, do not set ParameterFileContents or UseOutputFromPreviousTask | [optional]
8
+ **parameter_file_contents** | **String** | Binary contents of the parameter; if set, do not set ParameterTextValue or UseOutputFromPreviousTask | [optional]
9
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConfigurationApiClient::HttpGetParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **parameter_name** | **String** | Name of the parameter | [optional]
7
+ **parameter_value** | **String** | Value of the parameter | [optional]
8
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConfigurationApiClient::HttpOrchestrationHeader
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **header_name** | **String** | Name of the HTTP header, e.g. \"Content-Type\" | [optional]
7
+ **header_value** | **String** | Value of the HTTP header | [optional]
8
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveConfigurationApiClient::HttpOrchestrationRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **http_tasks** | [**Array<HttpOrchestrationTask>**](HttpOrchestrationTask.md) | Tasks to perform, in the order you wish to perform them | [optional]
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # CloudmersiveConfigurationApiClient::HttpOrchestrationResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **tasks_completed** | **Integer** | Count of the number of tasks that were completed | [optional]
8
+ **output_string_type** | **String** | Result output in string format | [optional]
9
+ **output_binary_type** | **String** | Result output in binary format | [optional]
10
+
11
+
@@ -0,0 +1,16 @@
1
+ # CloudmersiveConfigurationApiClient::HttpOrchestrationTask
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **task_name** | **String** | An identifier for this task name, e.g. CreateCustomer or ScanForVirus; allows you to refer to this task from other tasks; if not supplied, it will default to a 0-based integer index of the task | [optional]
7
+ **http_method** | **String** | HTTP Method, e.g. GET, PUT, POST, etc. | [optional]
8
+ **url** | **String** | HTTP URL to orchestrate | [optional]
9
+ **http_headers** | [**Array<HttpOrchestrationHeader>**](HttpOrchestrationHeader.md) | Optional; HTTP headers to apply to the request | [optional]
10
+ **query_parameters** | [**Array<HttpGetParameter>**](HttpGetParameter.md) | Optional; query parameters, these query parameters will be incorporated into the URL | [optional]
11
+ **form_data_parameters** | [**Array<HttpFormDataParameter>**](HttpFormDataParameter.md) | Optional; FormData parameters, these parameters will be stored in the body in a multi-part encoding | [optional]
12
+ **www_form_url_encoded_parameters** | [**Array<HttpWwwFormUrlEncodedParameter>**](HttpWwwFormUrlEncodedParameter.md) | Optional; x-www-form-urlencoded paramereters, these parameters will be stored in the body as an application/x-www-form-urlencoded encoding | [optional]
13
+ **raw_text_body** | [**HttpRawTextParameter**](HttpRawTextParameter.md) | Optional; sets the body of the request as raw text, cannot be used with other parameter types in the same request | [optional]
14
+ **raw_binary_body** | [**HttpRawBinaryParameter**](HttpRawBinaryParameter.md) | Optional; set the body of the request as binary, cannot be used with other parameter types in the same request | [optional]
15
+
16
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConfigurationApiClient::HttpRawBinaryParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **parameter_value** | **String** | Binary bytes value of the parameter | [optional]
7
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConfigurationApiClient::HttpRawTextParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **parameter_value** | **String** | Text value of the parameter | [optional]
7
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveConfigurationApiClient::HttpWwwFormUrlEncodedParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **key_name** | **String** | Key name of the parameter | [optional]
7
+ **key_value** | **String** | Key value of the paramer (must be of type text); if set, do not use UseOutputFromPreviousTask | [optional]
8
+ **use_output_from_previous_task** | [**TaskOutputReference**](TaskOutputReference.md) | Optional; use the output from a previous task as the input to this parameter. Set to null (default) to ignore. | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveConfigurationApiClient::ListSettingsRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **bucket_id** | **String** | BucketID of the bucket to enumerate the settings of; you can create a bucket by navigating to account.cloudmersive.com, clicking on Settings > API Configuration > Create Bucket | [optional]
7
+ **bucket_secret_key** | **String** | SecretKey of the bucket enumerate the settings of; you can create a bucket by navigating to account.cloudmersive.com, clicking on Settings > API Configuration > Create Bucket | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveConfigurationApiClient::ListSettingsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **settings** | [**Array<SettingValue>**](SettingValue.md) | Settings in the bucket | [optional]
7
+
8
+
@@ -0,0 +1,61 @@
1
+ # CloudmersiveConfigurationApiClient::OrchestratorApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**orchestrator_http_simple**](OrchestratorApi.md#orchestrator_http_simple) | **POST** /config/orchestrator/http/simple | Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
8
+
9
+
10
+ # **orchestrator_http_simple**
11
+ > HttpOrchestrationResponse orchestrator_http_simple(request)
12
+
13
+ Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'cloudmersive-configuration-api-client'
19
+ # setup authorization
20
+ CloudmersiveConfigurationApiClient.configure do |config|
21
+ # Configure API key authorization: Apikey
22
+ config.api_key['Apikey'] = 'YOUR API KEY'
23
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24
+ #config.api_key_prefix['Apikey'] = 'Bearer'
25
+ end
26
+
27
+ api_instance = CloudmersiveConfigurationApiClient::OrchestratorApi.new
28
+
29
+ request = CloudmersiveConfigurationApiClient::HttpOrchestrationRequest.new # HttpOrchestrationRequest |
30
+
31
+
32
+ begin
33
+ #Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
34
+ result = api_instance.orchestrator_http_simple(request)
35
+ p result
36
+ rescue CloudmersiveConfigurationApiClient::ApiError => e
37
+ puts "Exception when calling OrchestratorApi->orchestrator_http_simple: #{e}"
38
+ end
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **request** | [**HttpOrchestrationRequest**](HttpOrchestrationRequest.md)| |
46
+
47
+ ### Return type
48
+
49
+ [**HttpOrchestrationResponse**](HttpOrchestrationResponse.md)
50
+
51
+ ### Authorization
52
+
53
+ [Apikey](../README.md#Apikey)
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
58
+ - **Accept**: application/json, text/json, application/xml, text/xml
59
+
60
+
61
+
@@ -0,0 +1,15 @@
1
+ # CloudmersiveConfigurationApiClient::SettingValue
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **config_setting_value_id** | **String** | The ID of the setting value | [optional]
7
+ **config_setting_definition_id** | **String** | The ID of the definition of the setting | [optional]
8
+ **config_setting_value** | **Object** | The value of the setting | [optional]
9
+ **config_setting_last_modified** | **DateTime** | The last modified date of the setting | [optional]
10
+ **config_setting_name** | **String** | Name of the setting | [optional]
11
+ **config_setting_description** | **String** | Description of the setting | [optional]
12
+ **config_setting_tags** | **String** | Setting tags | [optional]
13
+ **config_setting_type** | **String** | Possible values are: STRING, JSON | [optional]
14
+
15
+
@@ -0,0 +1,167 @@
1
+ # CloudmersiveConfigurationApiClient::SettingsApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**settings_create_setting**](SettingsApi.md#settings_create_setting) | **POST** /config/settings/create | Create a setting in the specified bucket
8
+ [**settings_list_settings**](SettingsApi.md#settings_list_settings) | **POST** /config/settings/list | Enumerate the settings in a bucket
9
+ [**settings_update_setting**](SettingsApi.md#settings_update_setting) | **POST** /config/settings/update | Update a setting
10
+
11
+
12
+ # **settings_create_setting**
13
+ > CreateSettingResponse settings_create_setting(request)
14
+
15
+ Create a setting in the specified bucket
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'cloudmersive-configuration-api-client'
21
+ # setup authorization
22
+ CloudmersiveConfigurationApiClient.configure do |config|
23
+ # Configure API key authorization: Apikey
24
+ config.api_key['Apikey'] = 'YOUR API KEY'
25
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
26
+ #config.api_key_prefix['Apikey'] = 'Bearer'
27
+ end
28
+
29
+ api_instance = CloudmersiveConfigurationApiClient::SettingsApi.new
30
+
31
+ request = CloudmersiveConfigurationApiClient::CreateSettingRequest.new # CreateSettingRequest | Request to perform the operation on
32
+
33
+
34
+ begin
35
+ #Create a setting in the specified bucket
36
+ result = api_instance.settings_create_setting(request)
37
+ p result
38
+ rescue CloudmersiveConfigurationApiClient::ApiError => e
39
+ puts "Exception when calling SettingsApi->settings_create_setting: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **request** | [**CreateSettingRequest**](CreateSettingRequest.md)| Request to perform the operation on |
48
+
49
+ ### Return type
50
+
51
+ [**CreateSettingResponse**](CreateSettingResponse.md)
52
+
53
+ ### Authorization
54
+
55
+ [Apikey](../README.md#Apikey)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
60
+ - **Accept**: application/json, text/json, application/xml, text/xml
61
+
62
+
63
+
64
+ # **settings_list_settings**
65
+ > ListSettingsResponse settings_list_settings(request)
66
+
67
+ Enumerate the settings in a bucket
68
+
69
+ ### Example
70
+ ```ruby
71
+ # load the gem
72
+ require 'cloudmersive-configuration-api-client'
73
+ # setup authorization
74
+ CloudmersiveConfigurationApiClient.configure do |config|
75
+ # Configure API key authorization: Apikey
76
+ config.api_key['Apikey'] = 'YOUR API KEY'
77
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
78
+ #config.api_key_prefix['Apikey'] = 'Bearer'
79
+ end
80
+
81
+ api_instance = CloudmersiveConfigurationApiClient::SettingsApi.new
82
+
83
+ request = CloudmersiveConfigurationApiClient::ListSettingsRequest.new # ListSettingsRequest | Request to perform the operation on
84
+
85
+
86
+ begin
87
+ #Enumerate the settings in a bucket
88
+ result = api_instance.settings_list_settings(request)
89
+ p result
90
+ rescue CloudmersiveConfigurationApiClient::ApiError => e
91
+ puts "Exception when calling SettingsApi->settings_list_settings: #{e}"
92
+ end
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ Name | Type | Description | Notes
98
+ ------------- | ------------- | ------------- | -------------
99
+ **request** | [**ListSettingsRequest**](ListSettingsRequest.md)| Request to perform the operation on |
100
+
101
+ ### Return type
102
+
103
+ [**ListSettingsResponse**](ListSettingsResponse.md)
104
+
105
+ ### Authorization
106
+
107
+ [Apikey](../README.md#Apikey)
108
+
109
+ ### HTTP request headers
110
+
111
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
112
+ - **Accept**: application/json, text/json, application/xml, text/xml
113
+
114
+
115
+
116
+ # **settings_update_setting**
117
+ > UpdateSettingResponse settings_update_setting(request)
118
+
119
+ Update a setting
120
+
121
+ ### Example
122
+ ```ruby
123
+ # load the gem
124
+ require 'cloudmersive-configuration-api-client'
125
+ # setup authorization
126
+ CloudmersiveConfigurationApiClient.configure do |config|
127
+ # Configure API key authorization: Apikey
128
+ config.api_key['Apikey'] = 'YOUR API KEY'
129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
130
+ #config.api_key_prefix['Apikey'] = 'Bearer'
131
+ end
132
+
133
+ api_instance = CloudmersiveConfigurationApiClient::SettingsApi.new
134
+
135
+ request = CloudmersiveConfigurationApiClient::UpdateSettingRequest.new # UpdateSettingRequest | Request to perform the operation on
136
+
137
+
138
+ begin
139
+ #Update a setting
140
+ result = api_instance.settings_update_setting(request)
141
+ p result
142
+ rescue CloudmersiveConfigurationApiClient::ApiError => e
143
+ puts "Exception when calling SettingsApi->settings_update_setting: #{e}"
144
+ end
145
+ ```
146
+
147
+ ### Parameters
148
+
149
+ Name | Type | Description | Notes
150
+ ------------- | ------------- | ------------- | -------------
151
+ **request** | [**UpdateSettingRequest**](UpdateSettingRequest.md)| Request to perform the operation on |
152
+
153
+ ### Return type
154
+
155
+ [**UpdateSettingResponse**](UpdateSettingResponse.md)
156
+
157
+ ### Authorization
158
+
159
+ [Apikey](../README.md#Apikey)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
164
+ - **Accept**: application/json, text/json, application/xml, text/xml
165
+
166
+
167
+