Class: Phrase::ReleasesApi
- Inherits:
-
Object
- Object
- Phrase::ReleasesApi
- Defined in:
- lib/phrase/api/releases_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) ⇒ ReleasesApi
constructor
A new instance of ReleasesApi.
-
#release_create(account_id, distribution_id, release_create_parameters, opts = {}) ⇒ Release
Create a release Create a new release.
-
#release_create_with_http_info(account_id, distribution_id, release_create_parameters, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Create a release Create a new release.
-
#release_delete(account_id, distribution_id, id, opts = {}) ⇒ nil
Delete a release Delete an existing release.
-
#release_delete_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Delete a release Delete an existing release.
-
#release_publish(account_id, distribution_id, id, opts = {}) ⇒ Release
Publish a release Publish a release for production.
-
#release_publish_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Publish a release Publish a release for production.
-
#release_show(account_id, distribution_id, id, opts = {}) ⇒ Release
Get a single release Get details on a single release.
-
#release_show_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Get a single release Get details on a single release.
-
#release_update(account_id, distribution_id, id, release_update_parameters, opts = {}) ⇒ Release
Update a release Update an existing release.
-
#release_update_with_http_info(account_id, distribution_id, id, release_update_parameters, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Update a release Update an existing release.
-
#releases_list(account_id, distribution_id, opts = {}) ⇒ Array<ReleasePreview>
List releases List all releases for the given distribution.
-
#releases_list_with_http_info(account_id, distribution_id, opts = {}) ⇒ Array<(Response<(Array<ReleasePreview>)>, Integer, Hash)>
List releases List all releases for the given distribution.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ReleasesApi
Returns a new instance of ReleasesApi.
7 8 9 |
# File 'lib/phrase/api/releases_api.rb', line 7 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
5 6 7 |
# File 'lib/phrase/api/releases_api.rb', line 5 def api_client @api_client end |
Instance Method Details
#release_create(account_id, distribution_id, release_create_parameters, opts = {}) ⇒ Release
Create a release Create a new release.
18 19 20 21 |
# File 'lib/phrase/api/releases_api.rb', line 18 def release_create(account_id, distribution_id, release_create_parameters, opts = {}) data, _status_code, _headers = release_create_with_http_info(account_id, distribution_id, release_create_parameters, opts) data end |
#release_create_with_http_info(account_id, distribution_id, release_create_parameters, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Create a release Create a new release.
31 32 33 34 35 36 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 81 82 83 84 85 86 87 88 |
# File 'lib/phrase/api/releases_api.rb', line 31 def release_create_with_http_info(account_id, distribution_id, release_create_parameters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.release_create ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_create" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_create" end # verify the required parameter 'release_create_parameters' is set if @api_client.config.client_side_validation && release_create_parameters.nil? fail ArgumentError, "Missing the required parameter 'release_create_parameters' when calling ReleasesApi.release_create" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)) # 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[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(release_create_parameters) # return_type return_type = opts[:return_type] || 'Release' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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: ReleasesApi#release_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#release_delete(account_id, distribution_id, id, opts = {}) ⇒ nil
Delete a release Delete an existing release.
98 99 100 101 |
# File 'lib/phrase/api/releases_api.rb', line 98 def release_delete(account_id, distribution_id, id, opts = {}) data, _status_code, _headers = release_delete_with_http_info(account_id, distribution_id, id, opts) data end |
#release_delete_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Delete a release Delete an existing release.
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 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/phrase/api/releases_api.rb', line 111 def release_delete_with_http_info(account_id, distribution_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.release_delete ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_delete" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_delete" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_delete" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ReleasesApi#release_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#release_publish(account_id, distribution_id, id, opts = {}) ⇒ Release
Publish a release Publish a release for production.
174 175 176 177 |
# File 'lib/phrase/api/releases_api.rb', line 174 def release_publish(account_id, distribution_id, id, opts = {}) data, _status_code, _headers = release_publish_with_http_info(account_id, distribution_id, id, opts) data end |
#release_publish_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Publish a release Publish a release for production.
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/phrase/api/releases_api.rb', line 187 def release_publish_with_http_info(account_id, distribution_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.release_publish ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_publish" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_publish" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_publish" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # 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[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Release' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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: ReleasesApi#release_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#release_show(account_id, distribution_id, id, opts = {}) ⇒ Release
Get a single release Get details on a single release.
252 253 254 255 |
# File 'lib/phrase/api/releases_api.rb', line 252 def release_show(account_id, distribution_id, id, opts = {}) data, _status_code, _headers = release_show_with_http_info(account_id, distribution_id, id, opts) data end |
#release_show_with_http_info(account_id, distribution_id, id, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Get a single release Get details on a single release.
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/phrase/api/releases_api.rb', line 265 def release_show_with_http_info(account_id, distribution_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.release_show ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_show" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_show" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_show" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # 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[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Release' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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: ReleasesApi#release_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#release_update(account_id, distribution_id, id, release_update_parameters, opts = {}) ⇒ Release
Update a release Update an existing release.
331 332 333 334 |
# File 'lib/phrase/api/releases_api.rb', line 331 def release_update(account_id, distribution_id, id, release_update_parameters, opts = {}) data, _status_code, _headers = release_update_with_http_info(account_id, distribution_id, id, release_update_parameters, opts) data end |
#release_update_with_http_info(account_id, distribution_id, id, release_update_parameters, opts = {}) ⇒ Array<(Response<(Release)>, Integer, Hash)>
Update a release Update an existing release.
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
# File 'lib/phrase/api/releases_api.rb', line 345 def release_update_with_http_info(account_id, distribution_id, id, release_update_parameters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.release_update ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_update" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_update" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_update" end # verify the required parameter 'release_update_parameters' is set if @api_client.config.client_side_validation && release_update_parameters.nil? fail ArgumentError, "Missing the required parameter 'release_update_parameters' when calling ReleasesApi.release_update" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # 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[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(release_update_parameters) # return_type return_type = opts[:return_type] || 'Release' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ReleasesApi#release_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#releases_list(account_id, distribution_id, opts = {}) ⇒ Array<ReleasePreview>
List releases List all releases for the given distribution.
417 418 419 420 |
# File 'lib/phrase/api/releases_api.rb', line 417 def releases_list(account_id, distribution_id, opts = {}) data, _status_code, _headers = releases_list_with_http_info(account_id, distribution_id, opts) data end |
#releases_list_with_http_info(account_id, distribution_id, opts = {}) ⇒ Array<(Response<(Array<ReleasePreview>)>, Integer, Hash)>
List releases List all releases for the given distribution.
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/phrase/api/releases_api.rb', line 431 def releases_list_with_http_info(account_id, distribution_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ReleasesApi.releases_list ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.releases_list" end # verify the required parameter 'distribution_id' is set if @api_client.config.client_side_validation && distribution_id.nil? fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.releases_list" end # resource path local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<ReleasePreview>' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = opts.merge( :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: ReleasesApi#releases_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |