fastpixapi 1.1.0 → 1.1.2

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 (98) hide show
  1. checksums.yaml +4 -4
  2. data/lib/fastpix_client/dimensions.rb +4 -4
  3. data/lib/fastpix_client/drm_configurations.rb +2 -2
  4. data/lib/fastpix_client/errors.rb +1 -1
  5. data/lib/fastpix_client/in_video_ai_features.rb +8 -8
  6. data/lib/fastpix_client/input_video.rb +9 -9
  7. data/lib/fastpix_client/manage_live_stream.rb +9 -9
  8. data/lib/fastpix_client/manage_videos.rb +24 -24
  9. data/lib/fastpix_client/metrics.rb +6 -6
  10. data/lib/fastpix_client/models/components/addtrackrequest.rb +1 -1
  11. data/lib/fastpix_client/models/components/createmediarequest.rb +1 -1
  12. data/lib/fastpix_client/models/components/deletesigningkeyresponse.rb +6 -2
  13. data/lib/fastpix_client/models/components/deletesigningkeyresponsedata.rb +33 -0
  14. data/lib/fastpix_client/models/components/event.rb +35 -8
  15. data/lib/fastpix_client/models/components/pullvideoinput.rb +1 -1
  16. data/lib/fastpix_client/models/components/views.rb +28 -1
  17. data/lib/fastpix_client/models/components/watermarkinput.rb +1 -1
  18. data/lib/fastpix_client/models/components.rb +1 -0
  19. data/lib/fastpix_client/models/operations/add_media_to_playlist_response.rb +1 -1
  20. data/lib/fastpix_client/models/operations/add_media_track_response.rb +1 -1
  21. data/lib/fastpix_client/models/operations/cancel_upload_response.rb +1 -1
  22. data/lib/fastpix_client/models/operations/change_media_order_in_playlist_response.rb +1 -1
  23. data/lib/fastpix_client/models/operations/complete_live_stream_response.rb +1 -1
  24. data/lib/fastpix_client/models/operations/create_a_playlist_response.rb +1 -1
  25. data/lib/fastpix_client/models/operations/create_media_playback_id_response.rb +1 -1
  26. data/lib/fastpix_client/models/operations/create_media_response.rb +1 -1
  27. data/lib/fastpix_client/models/operations/create_new_stream_response.rb +1 -1
  28. data/lib/fastpix_client/models/operations/create_playbackid_of_stream_response.rb +1 -1
  29. data/lib/fastpix_client/models/operations/create_signing_key_response.rb +1 -1
  30. data/lib/fastpix_client/models/operations/create_simulcast_of_stream_response.rb +1 -1
  31. data/lib/fastpix_client/models/operations/delete_a_playlist_response.rb +1 -1
  32. data/lib/fastpix_client/models/operations/delete_live_stream_response.rb +1 -1
  33. data/lib/fastpix_client/models/operations/delete_media_from_playlist_response.rb +1 -1
  34. data/lib/fastpix_client/models/operations/delete_media_playback_id_response.rb +1 -1
  35. data/lib/fastpix_client/models/operations/delete_media_response.rb +1 -1
  36. data/lib/fastpix_client/models/operations/delete_media_track_response.rb +1 -1
  37. data/lib/fastpix_client/models/operations/delete_playbackid_of_stream_response.rb +1 -1
  38. data/lib/fastpix_client/models/operations/delete_signing_key_response.rb +1 -1
  39. data/lib/fastpix_client/models/operations/delete_simulcast_of_stream_response.rb +1 -1
  40. data/lib/fastpix_client/models/operations/direct_upload_video_media_request.rb +1 -1
  41. data/lib/fastpix_client/models/operations/direct_upload_video_media_response.rb +1 -1
  42. data/lib/fastpix_client/models/operations/disable_live_stream_response.rb +1 -1
  43. data/lib/fastpix_client/models/operations/enable_live_stream_response.rb +1 -1
  44. data/lib/fastpix_client/models/operations/generate_subtitle_track_response.rb +1 -1
  45. data/lib/fastpix_client/models/operations/get_all_playlists_response.rb +1 -1
  46. data/lib/fastpix_client/models/operations/get_all_streams_response.rb +1 -1
  47. data/lib/fastpix_client/models/operations/get_live_stream_by_id_response.rb +1 -1
  48. data/lib/fastpix_client/models/operations/get_live_stream_playback_id_response.rb +1 -1
  49. data/lib/fastpix_client/models/operations/get_live_stream_viewer_count_by_id_response.rb +1 -1
  50. data/lib/fastpix_client/models/operations/get_media_clips_response.rb +1 -1
  51. data/lib/fastpix_client/models/operations/get_media_response.rb +1 -1
  52. data/lib/fastpix_client/models/operations/get_media_summary_response.rb +1 -1
  53. data/lib/fastpix_client/models/operations/get_playback_id_response.rb +1 -1
  54. data/lib/fastpix_client/models/operations/get_playlist_by_id_response.rb +1 -1
  55. data/lib/fastpix_client/models/operations/get_signing_key_by_id_response.rb +1 -1
  56. data/lib/fastpix_client/models/operations/get_specific_simulcast_of_stream_response.rb +1 -1
  57. data/lib/fastpix_client/models/operations/get_timeseries_data_response.rb +1 -1
  58. data/lib/fastpix_client/models/operations/get_video_view_details_response.rb +1 -1
  59. data/lib/fastpix_client/models/operations/get_video_view_details_responsebody.rb +7 -0
  60. data/lib/fastpix_client/models/operations/getdrmconfiguration_response.rb +1 -1
  61. data/lib/fastpix_client/models/operations/getdrmconfigurationbyid_response.rb +1 -1
  62. data/lib/fastpix_client/models/operations/list_breakdown_values_response.rb +1 -1
  63. data/lib/fastpix_client/models/operations/list_by_top_content_response.rb +1 -1
  64. data/lib/fastpix_client/models/operations/list_comparison_values_response.rb +1 -1
  65. data/lib/fastpix_client/models/operations/list_dimensions_response.rb +1 -1
  66. data/lib/fastpix_client/models/operations/list_errors_response.rb +1 -1
  67. data/lib/fastpix_client/models/operations/list_filter_values_for_dimension_response.rb +1 -1
  68. data/lib/fastpix_client/models/operations/list_live_clips_response.rb +1 -1
  69. data/lib/fastpix_client/models/operations/list_media_response.rb +1 -1
  70. data/lib/fastpix_client/models/operations/list_overall_values_response.rb +1 -1
  71. data/lib/fastpix_client/models/operations/list_playback_ids_response.rb +1 -1
  72. data/lib/fastpix_client/models/operations/list_signing_keys_response.rb +1 -1
  73. data/lib/fastpix_client/models/operations/list_uploads_response.rb +1 -1
  74. data/lib/fastpix_client/models/operations/list_video_views_response.rb +1 -1
  75. data/lib/fastpix_client/models/operations/push_media_settings.rb +1 -1
  76. data/lib/fastpix_client/models/operations/retrievemediainputinfo_response.rb +1 -1
  77. data/lib/fastpix_client/models/operations/update_a_playlist_response.rb +1 -1
  78. data/lib/fastpix_client/models/operations/update_domain_restrictions_response.rb +1 -1
  79. data/lib/fastpix_client/models/operations/update_live_stream_response.rb +1 -1
  80. data/lib/fastpix_client/models/operations/update_media_chapters_response.rb +1 -1
  81. data/lib/fastpix_client/models/operations/update_media_moderation_response.rb +1 -1
  82. data/lib/fastpix_client/models/operations/update_media_named_entities_response.rb +1 -1
  83. data/lib/fastpix_client/models/operations/update_media_summary_response.rb +1 -1
  84. data/lib/fastpix_client/models/operations/update_media_track_response.rb +1 -1
  85. data/lib/fastpix_client/models/operations/update_specific_simulcast_of_stream_response.rb +1 -1
  86. data/lib/fastpix_client/models/operations/update_user_agent_restrictions_response.rb +1 -1
  87. data/lib/fastpix_client/models/operations/updated_media_response.rb +1 -1
  88. data/lib/fastpix_client/models/operations/updated_mp4support_response.rb +1 -1
  89. data/lib/fastpix_client/models/operations/updated_source_access_response.rb +1 -1
  90. data/lib/fastpix_client/playback.rb +1 -1
  91. data/lib/fastpix_client/playlist.rb +1 -1
  92. data/lib/fastpix_client/sdkconfiguration.rb +3 -3
  93. data/lib/fastpix_client/signing_keys.rb +3 -3
  94. data/lib/fastpix_client/simulcast_stream.rb +4 -4
  95. data/lib/fastpix_client/start_live_stream.rb +3 -3
  96. data/lib/fastpix_client/utils/url.rb +5 -0
  97. data/lib/fastpix_client/views.rb +5 -5
  98. metadata +19 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7a3c437a7561c393c84e02f8ba6cbf46cefbc88d5086b539ba48f6c6af728788
4
- data.tar.gz: a2d2809644b100069e7fa167d81566c86d68295d8ee6e8050de5ab237283641f
3
+ metadata.gz: a790776f18a63ddb3276df17af9a07b0c461501c2201917c636e5730390f23c4
4
+ data.tar.gz: f943cb2c84ff2d2dae2a5507b76d87ed3f40a80ccee85c8c2752051dfbbce109
5
5
  SHA512:
6
- metadata.gz: 6987a3abaafd87e0c3a04d249c21886509cd5ceecfb869c626958411e4e416b717334c5787e3d5e4ca929b86ca4470e6db01568be8ddb302281a189f7c2f51b9
7
- data.tar.gz: 93f166294f695d8db8ca9223150538fec53f904a42caec0e6dc4b771218210185e073344d326a293c3b43b689d6ea9f21a08f2d0a56e2d069a4e7fd699757f7c
6
+ metadata.gz: 9d109a83796f163a35f8ec7b9024ea4f8c1a0ca0344fba82092aa5cf0e8e4c5419e09ad093afb0c5e584c42ae0f7aa262896b0b24fa8a5f8d0bca8c394d46ec4
7
+ data.tar.gz: 81703c836ec11f2080602016f2604cc0e36c7d26481646fb7a903673654672f587262262f7aff7b8ba091f3f76d2740cfb132a095fcd33e6d2fec81ef2ce9834
@@ -44,9 +44,9 @@ module FastpixClient
44
44
  # list_dimensions - List the dimensions
45
45
  # Retrieves a list of dimensions that can be used as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively.
46
46
  #
47
- # The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.io/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.io/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
47
+ # The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://fastpix.com/docs/video-data-api/views/list-video-views">list video views</a> and <a href="https://fastpix.com/docs/video-data-api/views/list-by-top-content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
48
48
  #
49
- # Related guides: <a href="https://docs.fastpix.io/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> , <a href="https://docs.fastpix.io/docs/user-passable-metadata-1">Use passable dimensions</a>
49
+ # Related guides: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture#/">What Video Data do we capture?</a> , <a href="https://fastpix.com/docs/working-with-video-data/pass-custom-metadata-to-metrics">Use passable dimensions</a>
50
50
  #
51
51
  url, params = @sdk_configuration.get_server_details
52
52
  base_url = Utils.template_url(url, params)
@@ -172,14 +172,14 @@ module FastpixClient
172
172
  # This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
173
173
  #
174
174
  #
175
- # In order to use the <a href="https://docs.fastpix.io/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
175
+ # In order to use the <a href="https://fastpix.com/docs/working-with-video-data/use-custom-dimensions">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
176
176
  #
177
177
  # #### Example
178
178
  #
179
179
  # A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.
180
180
  #
181
181
  #
182
- # Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
182
+ # Related guide: <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#filters-and-timeframes">Filters and timespan</a>
183
183
  #
184
184
  request = Models::Operations::ListFilterValuesForDimensionRequest.new(
185
185
  dimensions_id: dimensions_id,
@@ -53,7 +53,7 @@ module FastpixClient
53
53
  # **Example:**
54
54
  # A media service provider may retrieve DRM configuration for a workspace to create DRM content.
55
55
  #
56
- # Related guide: <a href="https://docs.fastpix.io/docs/secure-playback-with-drm">Manage DRM configuration</a>
56
+ # Related guide: <a href="https://fastpix.com/docs/video-security/set-up-drm-encryption">Manage DRM configuration</a>
57
57
  #
58
58
  request = Models::Operations::GetDrmConfigurationRequest.new(
59
59
  offset: offset,
@@ -189,7 +189,7 @@ module FastpixClient
189
189
  # 1. Make a GET request to this endpoint, replacing `{drmConfigurationId}` with the UUID of the DRM configuration.
190
190
  # 2. The response contains the associated DRM configuration ID.
191
191
  #
192
- # Related guide: <a href="https://docs.fastpix.io/docs/secure-playback-with-drm">Manage DRM configuration</a>
192
+ # Related guide: <a href="https://fastpix.com/docs/video-security/set-up-drm-encryption">Manage DRM configuration</a>
193
193
  #
194
194
  request = Models::Operations::GetDrmConfigurationByIdRequest.new(
195
195
  drm_configuration_id: drm_configuration_id
@@ -58,7 +58,7 @@ module FastpixClient
58
58
  # * **code:** The error code associated with the specific error.
59
59
  #
60
60
  #
61
- # Related guide: <a href="https://docs.fastpix.io/docs/track-playback-errors">Troubleshoot errors</a>
61
+ # Related guide: <a href="https://fastpix.com/docs/working-with-video-data/troubleshoot-playback-errors">Troubleshoot errors</a>
62
62
  #
63
63
  request = Models::Operations::ListErrorsRequest.new(
64
64
  timespan: timespan,
@@ -50,7 +50,7 @@ module FastpixClient
50
50
  # 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
51
51
  # 4. The response includes the updated media data and confirmation of the changes applied.
52
52
  #
53
- # You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
53
+ # You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
54
54
  #
55
55
  #
56
56
  #
@@ -58,7 +58,7 @@ module FastpixClient
58
58
  #
59
59
  # **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
60
60
  #
61
- # Related guide: <a href="https://docs.fastpix.io/docs/generate-video-summary">Video summary</a>
61
+ # Related guide: <a href="https://fastpix.com/docs/video-intelligence/generate-a-video-summary">Video summary</a>
62
62
  #
63
63
  request = Models::Operations::UpdateMediaSummaryRequest.new(
64
64
  media_id: media_id,
@@ -209,11 +209,11 @@ module FastpixClient
209
209
  # 2. Include the `chapters` parameter in the request body to enable.
210
210
  # 3. The response contains the updated media data, confirming the changes made.
211
211
  #
212
- # You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
212
+ # You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
213
213
  #
214
214
  # **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
215
215
  #
216
- # Related guide: <a href="https://docs.fastpix.io/docs/generate-video-chapters">Video chapters</a>
216
+ # Related guide: <a href="https://fastpix.com/docs/video-intelligence/generate-video-chapters">Video chapters</a>
217
217
  #
218
218
  request = Models::Operations::UpdateMediaChaptersRequest.new(
219
219
  media_id: media_id,
@@ -369,11 +369,11 @@ module FastpixClient
369
369
  # 2. Include the `namedEntities` parameter in the request body to enable.
370
370
  # 3. Receive a response containing the updated media data, confirming the changes made.
371
371
  #
372
- # You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
372
+ # You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
373
373
  #
374
374
  # **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
375
375
  #
376
- # Related guide: <a href="https://docs.fastpix.io/docs/generate-named-entities">Named entities</a>
376
+ # Related guide: <a href="https://fastpix.com/docs/video-intelligence/extract-named-entities-from-a-video">Named entities</a>
377
377
  #
378
378
  request = Models::Operations::UpdateMediaNamedEntitiesRequest.new(
379
379
  media_id: media_id,
@@ -524,11 +524,11 @@ module FastpixClient
524
524
  # 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
525
525
  # 4. The response contains the updated media data, confirming the changes made.
526
526
  #
527
- # You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
527
+ # You can use the <a href="https://fastpix.com/docs/ai-events/in-video-ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
528
528
  #
529
529
  # **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
530
530
  #
531
- # Related guide: <a href="https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
531
+ # Related guide: <a href="https://fastpix.com/docs/video-intelligence/detect-nsfw-content-and-profanity">Moderate NSFW & Profanity</a>
532
532
  #
533
533
  request = Models::Operations::UpdateMediaModerationRequest.new(
534
534
  media_id: media_id,
@@ -77,14 +77,14 @@ module FastpixClient
77
77
  #
78
78
  # 3. Receive a response containing the unique id for the newly created media item.
79
79
  #
80
- # 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.io/reference/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
80
+ # 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
81
81
  #
82
- # FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://docs.fastpix.io/docs/media-events#videomediacreated">video.media.created</a>.
82
+ # FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://fastpix.com/docs/vod-events/media-events#videomediacreated">video.media.created</a>.
83
83
  #
84
84
  #
85
- # After processing completes, monitor the events <a href="https://docs.fastpix.io/docs/media-events#videomediaready">video.media.ready</a> and <a href="https://docs.fastpix.io/docs/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
85
+ # After processing completes, monitor the events <a href="https://fastpix.com/docs/vod-events/media-events#videomediaready">video.media.ready</a> and <a href="https://fastpix.com/docs/vod-events/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
86
86
  #
87
- # Related guide: <a href="https://docs.fastpix.io/docs/upload-videos-from-url">Upload videos from URL</a>
87
+ # Related guide: <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-a-url">Upload videos from URL</a>
88
88
  #
89
89
  url, params = @sdk_configuration.get_server_details
90
90
  base_url = Utils.template_url(url, params)
@@ -223,7 +223,7 @@ module FastpixClient
223
223
  #
224
224
  # > **NOTE**
225
225
  # >
226
- # > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.io/changelog/api-update-direct-upload-media-from-device).
226
+ # > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://fastpix.com/docs/changelog/release-notes).
227
227
  #
228
228
  # #### How it works
229
229
  #
@@ -231,23 +231,23 @@ module FastpixClient
231
231
  #
232
232
  # 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
233
233
  #
234
- # 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://docs.fastpix.io/docs/upload-videos-directly#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
234
+ # 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
235
235
  #
236
236
  #
237
237
  # 4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this `uploadId` for any future operations related to this upload.
238
238
  #
239
239
  #
240
240
  #
241
- # After uploading, you can use the <a href="https://docs.fastpix.io/reference/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `Ready` status for playback.
241
+ # After uploading, you can use the <a href="https://fastpix.com/docs/video-on-demand-api/manage-videos/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `Ready` status for playback.
242
242
  #
243
- # To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.io/docs/webhooks-collection#media-related-events">media related events</a>.
243
+ # To notify your application about the status of this API request check for the webhooks for <a href="https://fastpix.com/docs/webhooks/webhook-event-reference#media-related-events">media related events</a>.
244
244
  #
245
245
  #
246
246
  # #### Example
247
247
  #
248
248
  # A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.
249
249
  #
250
- # Related guide: <a href="https://docs.fastpix.io/docs/upload-videos-directly">Upload videos directly</a>
250
+ # Related guide: <a href="https://fastpix.com/docs/upload-videos/upload-videos-from-device">Upload videos directly</a>
251
251
  #
252
252
  url, params = @sdk_configuration.get_server_details
253
253
  base_url = Utils.template_url(url, params)
@@ -184,7 +184,7 @@ module FastpixClient
184
184
  #
185
185
  # Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
186
186
  #
187
- # Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
187
+ # Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
188
188
  request = Models::Operations::GetLiveStreamViewerCountByIdRequest.new(
189
189
  stream_id: stream_id
190
190
  )
@@ -320,7 +320,7 @@ module FastpixClient
320
320
  # Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
321
321
  #
322
322
  #
323
- # Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
323
+ # Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
324
324
  request = Models::Operations::GetLiveStreamByIdRequest.new(
325
325
  stream_id: stream_id
326
326
  )
@@ -452,14 +452,14 @@ module FastpixClient
452
452
  # delete_live_stream - Delete a stream
453
453
  # Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.
454
454
  #
455
- # Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.io/docs/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
455
+ # Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
456
456
  #
457
457
  # #### Example
458
458
  #
459
459
  # For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers.
460
460
  #
461
461
  #
462
- # Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
462
+ # Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
463
463
  request = Models::Operations::DeleteLiveStreamRequest.new(
464
464
  stream_id: stream_id
465
465
  )
@@ -592,7 +592,7 @@ module FastpixClient
592
592
  # This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream.
593
593
  #
594
594
  #
595
- # The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.io/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
595
+ # The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://fastpix.com/docs/live-stream-events/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
596
596
  #
597
597
  # #### Example
598
598
  #
@@ -600,7 +600,7 @@ module FastpixClient
600
600
  #
601
601
  #
602
602
  #
603
- # Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
603
+ # Related guide: <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
604
604
  request = Models::Operations::UpdateLiveStreamRequest.new(
605
605
  stream_id: stream_id,
606
606
  body: body
@@ -753,7 +753,7 @@ module FastpixClient
753
753
  #
754
754
  # A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
755
755
  #
756
- # Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
756
+ # Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
757
757
  request = Models::Operations::EnableLiveStreamRequest.new(
758
758
  stream_id: stream_id
759
759
  )
@@ -891,7 +891,7 @@ module FastpixClient
891
891
  #
892
892
  # A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
893
893
  #
894
- # Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
894
+ # Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
895
895
  request = Models::Operations::DisableLiveStreamRequest.new(
896
896
  stream_id: stream_id
897
897
  )
@@ -1031,7 +1031,7 @@ module FastpixClient
1031
1031
  #
1032
1032
  # A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
1033
1033
  #
1034
- # Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
1034
+ # Related guide <a href="https://fastpix.com/docs/manage-live-streams/create-and-manage-live-streams">Manage streams</a>
1035
1035
  request = Models::Operations::CompleteLiveStreamRequest.new(
1036
1036
  stream_id: stream_id
1037
1037
  )
@@ -194,7 +194,7 @@ module FastpixClient
194
194
  # Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.
195
195
  #
196
196
  #
197
- # Related guide: <a href="https://docs.fastpix.io/docs/instant-live-clipping">Instant live clipping</a>
197
+ # Related guide: <a href="https://fastpix.com/docs/edit-and-transform-live-stream/clip-moments-from-a-live-stream">Instant live clipping</a>
198
198
  #
199
199
  request = Models::Operations::ListLiveClipsRequest.new(
200
200
  livestream_id: livestream_id,
@@ -342,7 +342,7 @@ module FastpixClient
342
342
  # - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
343
343
  # - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
344
344
  # You can construct the stream URL as follows:
345
- # `https://stream.fastpix.io/<playbackId>.m3u8`
345
+ # `https://stream.fastpix.com/<playbackId>.m3u8`
346
346
  #
347
347
  # #### Example
348
348
  #
@@ -488,7 +488,7 @@ module FastpixClient
488
488
  #
489
489
  # 3. The response returns the updated media data, confirming the changes.
490
490
  #
491
- # 4. Monitor the <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
491
+ # 4. Monitor the <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
492
492
  #
493
493
  # #### Example
494
494
  # If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.
@@ -645,7 +645,7 @@ module FastpixClient
645
645
  #
646
646
  # 2. This action is irreversible. Make sure you no longer need the media before proceeding. Once deleted, the media can’t be retrieved or played back.
647
647
  #
648
- # 3. Monitor the following webhook event: <a href="https://docs.fastpix.io/docs/media-events#videomediadeleted">video.media.deleted</a>
648
+ # 3. Monitor the following webhook event: <a href="https://fastpix.com/docs/vod-events/media-events#videomediadeleted">video.media.deleted</a>
649
649
  #
650
650
  # #### Example
651
651
  # A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
@@ -793,17 +793,17 @@ module FastpixClient
793
793
  #
794
794
  # #### Webhook events
795
795
  #
796
- # 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
796
+ # 1. After successfully adding a track, your system must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
797
797
  #
798
- # 2. Once the track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
798
+ # 2. Once the track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackready">video.media.track.ready</a>.
799
799
  #
800
- # 3. Finally, an update event <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
800
+ # 3. Finally, an update event <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
801
801
  #
802
802
  #
803
803
  # #### Example
804
- # Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.io/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
804
+ # Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.com/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
805
805
  #
806
- # Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
806
+ # Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
807
807
  #
808
808
  request = Models::Operations::AddMediaTrackRequest.new(
809
809
  media_id: media_id,
@@ -956,7 +956,7 @@ module FastpixClient
956
956
  #
957
957
  # #### Webhook Events
958
958
  #
959
- # Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.io/docs/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
959
+ # Once the upload is cancelled, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
960
960
  #
961
961
  # #### Example
962
962
  #
@@ -1106,11 +1106,11 @@ module FastpixClient
1106
1106
  #
1107
1107
  # After updating a track, your system must receive webhook notifications:
1108
1108
  #
1109
- # 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
1109
+ # 1. After successfully updating a track, your system must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
1110
1110
  #
1111
- # 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
1111
+ # 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediatrackready">video.media.track.ready</a>.
1112
1112
  #
1113
- # 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
1113
+ # 3. Once the media file is updated with the new track details, a <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
1114
1114
  #
1115
1115
  #
1116
1116
  # #### Example
@@ -1119,7 +1119,7 @@ module FastpixClient
1119
1119
  # - The original track file has errors and needs correction.
1120
1120
  # - You want to improve subtitle translations or replace an audio track with a better-quality version.
1121
1121
  #
1122
- # Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
1122
+ # Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
1123
1123
  #
1124
1124
  request = Models::Operations::UpdateMediaTrackRequest.new(
1125
1125
  track_id: track_id,
@@ -1278,7 +1278,7 @@ module FastpixClient
1278
1278
  #
1279
1279
  # 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
1280
1280
  #
1281
- # 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
1281
+ # 2. Once the media file is updated to reflect the track removal, a <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
1282
1282
  #
1283
1283
  #
1284
1284
  # #### Example
@@ -1288,7 +1288,7 @@ module FastpixClient
1288
1288
  # - The content owner requests the removal of a specific subtitle or audio track.
1289
1289
  # - A new version of the track gets uploaded to replace the existing one.
1290
1290
  #
1291
- # Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
1291
+ # Related guides: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-subtitles-to-a-video">Add own subtitle tracks</a>, <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/add-audio-to-a-video">Add own audio tracks</a>
1292
1292
  #
1293
1293
  request = Models::Operations::DeleteMediaTrackRequest.new(
1294
1294
  media_id: media_id,
@@ -1432,11 +1432,11 @@ module FastpixClient
1432
1432
  #
1433
1433
  # #### Webhook Events
1434
1434
  #
1435
- # 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
1435
+ # 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
1436
1436
  #
1437
- # 2. Finally the <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
1437
+ # 2. Finally the <a href="https://fastpix.com/docs/vod-events/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
1438
1438
  #
1439
- # </br> Related guide: <a href="https://docs.fastpix.io/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
1439
+ # </br> Related guide: <a href="https://fastpix.com/docs/manage-audio-and-subtitle-tracks/generate-subtitles-automatically">Add auto-generated subtitles</a>
1440
1440
  #
1441
1441
  request = Models::Operations::GenerateSubtitleTrackRequest.new(
1442
1442
  media_id: media_id,
@@ -1732,7 +1732,7 @@ module FastpixClient
1732
1732
  # 2. Include the updated `sourceAccess` parameter in the request body.
1733
1733
  #
1734
1734
  # 3. You receive a response confirming the update to the media’s source access status.
1735
- # 4. Webhook events: <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
1735
+ # 4. Webhook events: <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
1736
1736
  #
1737
1737
  request = Models::Operations::UpdatedSourceAccessRequest.new(
1738
1738
  media_id: media_id,
@@ -1898,13 +1898,13 @@ module FastpixClient
1898
1898
  #
1899
1899
  # #### Webhook events
1900
1900
  #
1901
- # - <a href="https://docs.fastpix.io/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
1901
+ # - <a href="https://fastpix.com/docs/vod-events/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
1902
1902
  #
1903
1903
  # #### Example
1904
- # Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.io/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.
1904
+ # Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.
1905
1905
  #
1906
1906
  #
1907
- # Related guide: <a href="https://docs.fastpix.io/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
1907
+ # Related guide: <a href="https://fastpix.com/docs/playback-and-delivery/enable-mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
1908
1908
  #
1909
1909
  request = Models::Operations::UpdatedMp4SupportRequest.new(
1910
1910
  media_id: media_id,
@@ -2354,7 +2354,7 @@ module FastpixClient
2354
2354
  #
2355
2355
  # Imagine you’re managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.
2356
2356
  #
2357
- # Related guide: <a href="https://docs.fastpix.io/docs/create-clips-from-existing-media">Create clips from existing media</a>
2357
+ # Related guide: <a href="https://fastpix.com/docs/edit-and-transform-videos/clip-and-trim-videos">Create clips from existing media</a>
2358
2358
  #
2359
2359
  request = Models::Operations::GetMediaClipsRequest.new(
2360
2360
  media_id: media_id,
@@ -46,7 +46,7 @@ module FastpixClient
46
46
  #
47
47
  # #### How it works
48
48
  #
49
- # 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
49
+ # 1. Before using this endpoint, you can call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
50
50
  #
51
51
  # 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
52
52
  #
@@ -72,7 +72,7 @@ module FastpixClient
72
72
  # * **field:** The grouping field value based on the groupBy parameter.
73
73
  #
74
74
  #
75
- # Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
75
+ # Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture">Understand data definitions</a>
76
76
  #
77
77
  url, params = @sdk_configuration.get_server_details
78
78
  base_url = Utils.template_url(url, params)
@@ -206,7 +206,7 @@ module FastpixClient
206
206
  #
207
207
  # #### How it works
208
208
  #
209
- # 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
209
+ # 1. Before using this endpoint, you can call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
210
210
  #
211
211
  # 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
212
212
  #
@@ -228,7 +228,7 @@ module FastpixClient
228
228
  # * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
229
229
  #
230
230
  #
231
- # Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
231
+ # Related guide: <a href="https://fastpix.com/docs/concepts/what-video-data-do-we-capture">Understand data definitions</a>
232
232
  #
233
233
  request = Models::Operations::ListOverallValuesRequest.new(
234
234
  metric_id: metric_id,
@@ -513,14 +513,14 @@ module FastpixClient
513
513
  #
514
514
  # #### How it works
515
515
  #
516
- # 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
516
+ # 1. Before making a request to this endpoint, call the <a href="https://fastpix.com/docs/video-data-api/dimensions/list-dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
517
517
  #
518
518
  # 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
519
519
  #
520
520
  # 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
521
521
  #
522
522
  #
523
- # Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
523
+ # Related guide: <a href="https://fastpix.com/docs/working-with-video-data/explore-the-dashboard#compare-metrics">Compare metrics in dashboard</a>
524
524
  #
525
525
  request = Models::Operations::ListComparisonValuesRequest.new(
526
526
  timespan: timespan,
@@ -22,7 +22,7 @@ module FastpixClient
22
22
  field :language_name, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('languageName') } }
23
23
 
24
24
  sig { params(url: T.nilable(::String), type: T.nilable(Models::Components::AddTrackRequestType), language_code: T.nilable(::String), language_name: T.nilable(::String)).void }
25
- def initialize(url: 'https://static.fastpix.io/music-1.mp3', type: Models::Components::AddTrackRequestType::AUDIO, language_code: 'it', language_name: 'Italian')
25
+ def initialize(url: 'https://static.fastpix.com/music-1.mp3', type: Models::Components::AddTrackRequestType::AUDIO, language_code: 'it', language_name: 'Italian')
26
26
  @url = url
27
27
  @type = type
28
28
  @language_code = language_code
@@ -13,7 +13,7 @@ module FastpixClient
13
13
  include Crystalline::MetadataFields
14
14
 
15
15
  # Add one input object at a time. For example, first add a **VideoInput** object. If you also need a watermark, click **Add item** again and select **WatermarkInput**. Repeat this process for **AudioInput** or **SubtitleInput** as needed. For a complete explanation of how media uploads from URL and processing work, refer to the
16
- # <a href="https://docs.fastpix.io/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
16
+ # <a href="https://fastpix.com/docs/get-started/overview" target="_blank">FastPix Video on Demand Overview</a>.
17
17
  #
18
18
  field :inputs, Crystalline::Array.new(Crystalline::Union.new(Models::Components::PullVideoInput, Models::Components::WatermarkInput, Models::Components::AudioInput, Models::Components::SubtitleInput)), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('inputs'), required: true } }
19
19
  # You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
@@ -14,16 +14,20 @@ module FastpixClient
14
14
 
15
15
  # Shows the request status. Returns true for success and false for failure.
16
16
  field :success, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('success') } }
17
+ # Contains details about the deleted signing key.
18
+ field :data, Crystalline::Nilable.new(Models::Components::DeleteSigningKeyResponseData), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('data') } }
17
19
 
18
- sig { params(success: T.nilable(T::Boolean)).void }
19
- def initialize(success: nil)
20
+ sig { params(success: T.nilable(T::Boolean), data: T.nilable(Models::Components::DeleteSigningKeyResponseData)).void }
21
+ def initialize(success: nil, data: nil)
20
22
  @success = success
23
+ @data = data
21
24
  end
22
25
 
23
26
  sig { params(other: T.untyped).returns(T::Boolean) }
24
27
  def ==(other)
25
28
  return false unless other.is_a? self.class
26
29
  return false unless @success == other.success
30
+ return false unless @data == other.data
27
31
  true
28
32
  end
29
33
  end
@@ -0,0 +1,33 @@
1
+ # Generated code for FastPix API SDK.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module FastpixClient
8
+ module Models
9
+ module Components
10
+
11
+ # DeleteSigningKeyResponseData - Contains details about the deleted signing key.
12
+ class DeleteSigningKeyResponseData
13
+ extend T::Sig
14
+ include Crystalline::MetadataFields
15
+
16
+ # A human-readable confirmation message.
17
+ field :message, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::FastpixClient::Utils.field_name('message') } }
18
+
19
+ sig { params(message: T.nilable(::String)).void }
20
+ def initialize(message: nil)
21
+ @message = message
22
+ end
23
+
24
+ sig { params(other: T.untyped).returns(T::Boolean) }
25
+ def ==(other)
26
+ return false unless other.is_a? self.class
27
+ return false unless @message == other.message
28
+ true
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end