mux_ruby 3.3.0 → 3.5.0

data/docs/PlaybackRestrictionsApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.mux.com*
 
 ## create_playback_restriction
 
-> <PlaybackRestriction> create_playback_restriction(create_playback_restriction_request)
+> <PlaybackRestrictionResponse> create_playback_restriction(create_playback_restriction_request)
 
 Create a Playback Restriction
 
@@ -47,7 +47,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<PlaybackRestriction>, Integer, Hash)> create_playback_restriction_with_http_info(create_playback_restriction_request)
+> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> create_playback_restriction_with_http_info(create_playback_restriction_request)
 
 ```ruby
 begin
@@ -55,7 +55,7 @@ begin
   data, status_code, headers = api_instance.create_playback_restriction_with_http_info(create_playback_restriction_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PlaybackRestriction>
+  p data # => <PlaybackRestrictionResponse>
 rescue MuxRuby::ApiError => e
   puts "Error when calling PlaybackRestrictionsApi->create_playback_restriction_with_http_info: #{e}"
 end
@@ -69,7 +69,7 @@ end
 
 ### Return type
 
-[**PlaybackRestriction**](PlaybackRestriction.md)
+[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
 
 ### Authorization
 
@@ -152,7 +152,7 @@ nil (empty response body)
 
 ## get_playback_restriction
 
-> <PlaybackRestriction> get_playback_restriction(playback_restriction_id)
+> <PlaybackRestrictionResponse> get_playback_restriction(playback_restriction_id)
 
 Retrieve a Playback Restriction
 
@@ -186,7 +186,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<PlaybackRestriction>, Integer, Hash)> get_playback_restriction_with_http_info(playback_restriction_id)
+> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> get_playback_restriction_with_http_info(playback_restriction_id)
 
 ```ruby
 begin
@@ -194,7 +194,7 @@ begin
   data, status_code, headers = api_instance.get_playback_restriction_with_http_info(playback_restriction_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PlaybackRestriction>
+  p data # => <PlaybackRestrictionResponse>
 rescue MuxRuby::ApiError => e
   puts "Error when calling PlaybackRestrictionsApi->get_playback_restriction_with_http_info: #{e}"
 end
@@ -208,7 +208,7 @@ end
 
 ### Return type
 
-[**PlaybackRestriction**](PlaybackRestriction.md)
+[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
 
 ### Authorization
 
@@ -222,7 +222,7 @@ end
 
 ## list_playback_restrictions
 
-> <Array<PlaybackRestriction>> list_playback_restrictions(opts)
+> <ListPlaybackRestrictionsResponse> list_playback_restrictions(opts)
 
 List Playback Restrictions
 
@@ -259,7 +259,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<PlaybackRestriction>>, Integer, Hash)> list_playback_restrictions_with_http_info(opts)
+> <Array(<ListPlaybackRestrictionsResponse>, Integer, Hash)> list_playback_restrictions_with_http_info(opts)
 
 ```ruby
 begin
@@ -267,7 +267,7 @@ begin
   data, status_code, headers = api_instance.list_playback_restrictions_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<PlaybackRestriction>>
+  p data # => <ListPlaybackRestrictionsResponse>
 rescue MuxRuby::ApiError => e
   puts "Error when calling PlaybackRestrictionsApi->list_playback_restrictions_with_http_info: #{e}"
 end
@@ -282,7 +282,7 @@ end
 
 ### Return type
 
-[**Array&lt;PlaybackRestriction&gt;**](PlaybackRestriction.md)
+[**ListPlaybackRestrictionsResponse**](ListPlaybackRestrictionsResponse.md)
 
 ### Authorization
 
@@ -296,11 +296,11 @@ end
 
 ## update_referrer_domain_restriction
 
-> <PlaybackRestriction> update_referrer_domain_restriction(playback_restriction_id, body)
+> <PlaybackRestrictionResponse> update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
 
 Update the Referrer Playback Restriction
 
-Allows you to modify the list of domians or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
+Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.
 
 ### Examples
 
@@ -316,11 +316,11 @@ end
 
 api_instance = MuxRuby::PlaybackRestrictionsApi.new
 playback_restriction_id = 'playback_restriction_id_example' # String | ID of the Playback Restriction.
-body = {"allowed_domains":["*.example.com"],"allow_no_referrer":true} # ReferrerDomainRestriction | 
+update_referrer_domain_restriction_request = MuxRuby::ReferrerDomainRestriction.new # UpdateReferrerDomainRestrictionRequest | 
 
 begin
   # Update the Referrer Playback Restriction
-  result = api_instance.update_referrer_domain_restriction(playback_restriction_id, body)
+  result = api_instance.update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request)
   p result
 rescue MuxRuby::ApiError => e
   puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction: #{e}"
@@ -331,15 +331,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<PlaybackRestriction>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
+> <Array(<PlaybackRestrictionResponse>, Integer, Hash)> update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
 
 ```ruby
 begin
   # Update the Referrer Playback Restriction
-  data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, body)
+  data, status_code, headers = api_instance.update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <PlaybackRestriction>
+  p data # => <PlaybackRestrictionResponse>
 rescue MuxRuby::ApiError => e
   puts "Error when calling PlaybackRestrictionsApi->update_referrer_domain_restriction_with_http_info: #{e}"
 end
@@ -350,11 +350,11 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **playback_restriction_id** | **String** | ID of the Playback Restriction. |  |
-| **body** | **ReferrerDomainRestriction** |  |  |
+| **update_referrer_domain_restriction_request** | [**UpdateReferrerDomainRestrictionRequest**](UpdateReferrerDomainRestrictionRequest.md) |  |  |
 
 ### Return type
 
-[**PlaybackRestriction**](PlaybackRestriction.md)
+[**PlaybackRestrictionResponse**](PlaybackRestrictionResponse.md)
 
 ### Authorization
 

data/docs/SigningKeyResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**SigningKey**](.md) |  | [optional] |
+| **data** | [**SigningKey**](SigningKey.md) |  | [optional] |
 
 ## Example
 

data/docs/SimulcastTargetResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**SimulcastTarget**](.md) |  | [optional] |
+| **data** | [**SimulcastTarget**](SimulcastTarget.md) |  | [optional] |
 
 ## Example
 

data/docs/Space.md

@@ -0,0 +1,30 @@
+# MuxRuby::Space
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the space. Max 255 characters. |  |
+| **created_at** | **String** | Time the space was created, defined as a Unix timestamp (seconds since epoch). |  |
+| **type** | [**SpaceType**](SpaceType.md) |  | [default to 'server'] |
+| **status** | [**SpaceStatus**](SpaceStatus.md) |  |  |
+| **passthrough** | **String** | Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters. | [optional] |
+| **broadcasts** | [**Array<Broadcast>**](Broadcast.md) | An array of broadcast destinations. | [optional] |
+| **active_session_id** | **String** | Unique identifier for the current lifecycle of the space. Only set when the space is `active` and is set to a new value each time the space transitions from `idle` to `active`. This value is useful for logging and debugging issues. Max 255 characters. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Space.new(
+  id: null,
+  created_at: null,
+  type: null,
+  status: null,
+  passthrough: null,
+  broadcasts: null,
+  active_session_id: null
+)
+```
+

data/docs/SpaceResponse.md

@@ -0,0 +1,18 @@
+# MuxRuby::SpaceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Space**](Space.md) |  |  |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::SpaceResponse.new(
+  data: null
+)
+```
+

data/docs/SpaceStatus.md

@@ -0,0 +1,15 @@
+# MuxRuby::SpaceStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::SpaceStatus.new()
+```
+

data/docs/SpaceType.md

@@ -0,0 +1,15 @@
+# MuxRuby::SpaceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::SpaceType.new()
+```
+