Class: Svix::EnvironmentApi
- Inherits:
-
Object
- Object
- Svix::EnvironmentApi
- Defined in:
- lib/svix/api/environment_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ EnvironmentApi
constructor
A new instance of EnvironmentApi.
-
#v1_environment_export(opts = {}) ⇒ EnvironmentOut
Export Environment Configuration Download a JSON file containing all org-settings and event types.
-
#v1_environment_export_get(opts = {}) ⇒ EnvironmentOut
Export Environment Configuration Download a JSON file containing all org-settings and event types.
-
#v1_environment_export_get_with_http_info(opts = {}) ⇒ Array<(EnvironmentOut, Integer, Hash)>
Export Environment Configuration Download a JSON file containing all org-settings and event types.
-
#v1_environment_export_with_http_info(opts = {}) ⇒ Array<(EnvironmentOut, Integer, Hash)>
Export Environment Configuration Download a JSON file containing all org-settings and event types.
-
#v1_environment_import(environment_in, opts = {}) ⇒ nil
Import Environment Configuration Import a configuration into the active organization.
-
#v1_environment_import_with_http_info(environment_in, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Import Environment Configuration Import a configuration into the active organization.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ EnvironmentApi
Returns a new instance of EnvironmentApi.
19 20 21 |
# File 'lib/svix/api/environment_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/svix/api/environment_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#v1_environment_export(opts = {}) ⇒ EnvironmentOut
Export Environment Configuration Download a JSON file containing all org-settings and event types
27 28 29 30 |
# File 'lib/svix/api/environment_api.rb', line 27 def v1_environment_export(opts = {}) data, _status_code, _headers = v1_environment_export_with_http_info(opts) data end |
#v1_environment_export_get(opts = {}) ⇒ EnvironmentOut
Export Environment Configuration Download a JSON file containing all org-settings and event types
86 87 88 89 |
# File 'lib/svix/api/environment_api.rb', line 86 def v1_environment_export_get(opts = {}) data, _status_code, _headers = v1_environment_export_get_with_http_info(opts) data end |
#v1_environment_export_get_with_http_info(opts = {}) ⇒ Array<(EnvironmentOut, Integer, Hash)>
Export Environment Configuration Download a JSON file containing all org-settings and event types
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/svix/api/environment_api.rb', line 95 def v1_environment_export_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_export_get ...' end # resource path local_var_path = '/api/v1/environment/export' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'EnvironmentOut' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"EnvironmentApi.v1_environment_export_get", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: EnvironmentApi#v1_environment_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#v1_environment_export_with_http_info(opts = {}) ⇒ Array<(EnvironmentOut, Integer, Hash)>
Export Environment Configuration Download a JSON file containing all org-settings and event types
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/svix/api/environment_api.rb', line 37 def v1_environment_export_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_export ...' end # resource path local_var_path = '/api/v1/environment/export' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'EnvironmentOut' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"EnvironmentApi.v1_environment_export", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: EnvironmentApi#v1_environment_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#v1_environment_import(environment_in, opts = {}) ⇒ nil
Import Environment Configuration Import a configuration into the active organization. It doesn’t delete anything, only adds/updates what was passed to it.
145 146 147 148 |
# File 'lib/svix/api/environment_api.rb', line 145 def v1_environment_import(environment_in, opts = {}) v1_environment_import_with_http_info(environment_in, opts) nil end |
#v1_environment_import_with_http_info(environment_in, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Import Environment Configuration Import a configuration into the active organization. It doesn't delete anything, only adds/updates what was passed to it.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/svix/api/environment_api.rb', line 156 def v1_environment_import_with_http_info(environment_in, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_import ...' end # verify the required parameter 'environment_in' is set if @api_client.config.client_side_validation && environment_in.nil? fail ArgumentError, "Missing the required parameter 'environment_in' when calling EnvironmentApi.v1_environment_import" end # resource path local_var_path = '/api/v1/environment/import' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(environment_in) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"EnvironmentApi.v1_environment_import", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: EnvironmentApi#v1_environment_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |