Skip to content

Commit 16534ab

Browse files
committed
chore: release v1.1.4 — version alignment and maintainability cleanup
Maintenance release bumping the SDK from 1.1.3 to 1.1.4. Aligns internal version identifiers (__version__ / package version, previously lagging at 1.0.1) with the package version, and updates the User-Agent header to report `fastpix-sdk/python 1.1.4`. Applies behaviour-preserving code-quality cleanup across the SDK, samples, and test harness: bundled request-builder parameters, shared response-handling helpers, extracted duplicated string literals into constants, and merged nested conditionals. Refreshes generated docs. No functional, API, or behavioural changes — fully backward compatible with 1.1.3. No action required beyond upgrading the dependency.
1 parent 6f3f9c4 commit 16534ab

315 files changed

Lines changed: 11179 additions & 10548 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,35 @@
33
All notable changes to this project will be documented in this file.
44

55

6+
---
7+
8+
## [1.1.4]
9+
10+
### Changed
11+
- **SDK version bump: `1.1.3``1.1.4`.**
12+
A maintenance release that aligns the SDK's internal version identifiers and
13+
applies behaviour-preserving code-quality cleanup. It contains no functional,
14+
API, or behavioural changes and is fully backward compatible with `1.1.3`.
15+
16+
Updated identifiers:
17+
- `__version__` / package version — now reports `1.1.4` (the internal
18+
identifiers were previously lagging at `1.0.1`; they are now aligned with
19+
the package version).
20+
- `User-Agent` header — outbound requests now identify as
21+
`fastpix-sdk/python 1.1.4`.
22+
23+
Maintainability:
24+
- Internal static-analysis (SonarQube) cleanup across the SDK, samples, and
25+
test harness — bundled request-builder parameters, shared response-handling
26+
helpers, duplicated string literals extracted into constants, and nested
27+
conditionals merged. No public-surface impact.
28+
29+
### Compatibility
30+
- No changes to public types, method signatures, request/response models,
31+
default server URLs, hooks, or retry logic.
32+
- No action required for existing integrations — upgrade the dependency and
33+
re-run `pip install --upgrade fastpix_python`.
34+
635
---
736

837
## [1.1.3]
@@ -23,7 +52,7 @@ All FastPix-owned hosts, API endpoints, and documentation links are being moved
2352
What this means for users of `fastpix_python`:
2453

2554
- **If you rely on SDK defaults**, no code change is required. The default `server_url` in this release points at `https://api.fastpix.com/v1/`, so bumping to `1.1.3` and re-running `pip install --upgrade fastpix_python` is enough.
26-
- **If you have an explicit `server_url` override** (e.g. `Fastpixpython(server_url="https://api.fastpix.io/v1/")`), change it to `https://api.fastpix.com/v1/`.
55+
- **If you have an explicit `server_url` override** (e.g. `Fastpix(server_url="https://api.fastpix.io/v1/")`), change it to `https://api.fastpix.com/v1/`.
2756
- **If your application code references FastPix asset URLs directly** — playback URLs (`stream.fastpix.io/...`), image CDN (`images.fastpix.io/...`), dashboard deep links, or doc links in your own README — update them to the `.com` equivalents before the `.io` hosts are decommissioned.
2857
- We strongly recommend upgrading **every official FastPix SDK** in your stack to its latest release as part of the same change — every SDK is being rolled out with the same migration.
2958

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Comprehensive Python SDK for FastPix platform integration with full API coverage
190190

191191
Upload, manage, and transform video content with comprehensive media management capabilities.
192192

193-
For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/get-started/overview).
193+
For detailed documentation, see [FastPix Video on Demand Overview](https://fastpix.com/docs/video-on-demand-api/overview).
194194

195195
#### Input Video
196196
- [Create from URL](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/inputvideo/README.md#create_from_url) - Upload video content from external URL
@@ -238,7 +238,7 @@ For detailed documentation, see [FastPix Video on Demand Overview](https://fastp
238238

239239
Stream, manage, and transform live video content with real-time broadcasting capabilities.
240240

241-
For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/get-started/live-overview).
241+
For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.com/docs/live-stream-api/overview).
242242

243243
#### Start Live Stream
244244
- [Create Stream](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/startlivestream/README.md#create_stream) - Initialize new live streaming session with DVR mode support
@@ -269,7 +269,7 @@ For detailed documentation, see [FastPix Live Stream Overview](https://fastpix.c
269269

270270
Monitor video performance and quality with comprehensive analytics and real-time metrics.
271271

272-
For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/concepts/what-video-data-do-we-capture).
272+
For detailed documentation, see [FastPix Video Data Overview](https://fastpix.com/docs/video-data-api/overview).
273273

274274
#### Metrics
275275
- [List Breakdown Values](https://github.com/FastPix/fastpix-python/blob/feature/fixed-missing-parameters/docs/sdks/metrics/README.md#list_breakdown_values) - Get detailed breakdown of metrics by dimension
@@ -647,6 +647,6 @@ We value community contributions and feedback. Feel free to submit pull requests
647647

648648
## Detailed Usage
649649

650-
For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/video-security/secure-media-access-with-jwts).
650+
For comprehensive understanding of each API's functionality, including detailed request and response specifications, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://fastpix.com/docs/product-os-api/overview).
651651

652652
The API reference offers complete documentation for all available endpoints and features, enabling developers to integrate and leverage FastPix APIs effectively.

docs/sdks/dimensions/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Operations involving dimensions
66

77
### Available Operations
88

9-
* [list](#list) - List the dimensions
10-
* [list_filter_values](#list_filter_values) - List the filter values for a dimension
9+
* [list_dimensions](#list_dimensions) - List the dimensions
10+
* [list_filter_values_for_dimension](#list_filter_values_for_dimension) - List the filter values for a dimension
1111

12-
## list
12+
## list_dimensions
1313

1414
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.
1515

@@ -33,7 +33,7 @@ with Fastpix(
3333
),
3434
) as fastpix:
3535

36-
res = fastpix.dimensions.list()
36+
res = fastpix.dimensions.list_dimensions()
3737

3838
# Handle response
3939
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))
@@ -56,7 +56,7 @@ with Fastpix(
5656
| -------------------------- | -------------------------- | -------------------------- |
5757
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
5858

59-
## list_filter_values
59+
## list_filter_values_for_dimension
6060

6161
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).
6262

@@ -84,7 +84,7 @@ with Fastpix(
8484
),
8585
) as fastpix:
8686

87-
res = fastpix.dimensions.list_filter_values(dimensions_id="browser_name", timespan="24:hours", filterby="browser_name:Chrome")
87+
res = fastpix.dimensions.list_filter_values_for_dimension(dimensions_id="browser_name", timespan="24:hours", filterby="browser_name:Chrome")
8888

8989
# Handle response
9090
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

docs/sdks/drmconfigurations/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
### Available Operations
66

7-
* [list](#list) - Get list of DRM configuration IDs
8-
* [get_by_id](#get_by_id) - Get DRM configuration by ID
7+
* [get_drm_configuration](#get_drm_configuration) - Get list of DRM configuration IDs
8+
* [get_drm_configuration_by_id](#get_drm_configuration_by_id) - Get DRM configuration by ID
99

10-
## list
10+
## get_drm_configuration
1111

1212
This endpoint retrieves the DRM configuration (DRM ID) associated with a workspace. It returns a list of DRM configurations, identified by a unique DRM ID, which is used for creating DRM encrypted asset.
1313

@@ -37,7 +37,7 @@ with Fastpix(
3737
),
3838
) as fastpix:
3939

40-
res = fastpix.drm_configurations.list(offset=1, limit=10)
40+
res = fastpix.drm_configurations.get_drm_configuration(offset=1, limit=10)
4141

4242
# Handle response
4343
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))
@@ -62,7 +62,7 @@ with Fastpix(
6262
| -------------------------- | -------------------------- | -------------------------- |
6363
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
6464

65-
## get_by_id
65+
## get_drm_configuration_by_id
6666

6767
This endpoint retrieves a DRM configuration ID. It is used to fetch the DRM-related ID for a workspace, typically required when validating or applying DRM policies to video assets.
6868

@@ -88,7 +88,7 @@ with Fastpix(
8888
),
8989
) as fastpix:
9090

91-
res = fastpix.drm_configurations.get_by_id(drm_configuration_id="your-drm-configuration-id")
91+
res = fastpix.drm_configurations.get_drm_configuration_by_id(drm_configuration_id="your-drm-configuration-id")
9292

9393
# Handle response
9494
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

docs/sdks/errors/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Operations involving errors
66

77
### Available Operations
88

9-
* [list](#list) - List errors
9+
* [list_errors](#list_errors) - List errors
1010

11-
## list
11+
## list_errors
1212

1313
This endpoint returns the total number of playback errors that occurred, along with the total number of views captured, based on the specified timespan and filters. It provides insights into the overall playback quality and helps identify potential issues that may impact viewer experience.
1414

@@ -42,7 +42,7 @@ with Fastpix(
4242
),
4343
) as fastpix:
4444

45-
res = fastpix.errors.list(timespan="24:hours", filterby="browser_name:Chrome", limit=1)
45+
res = fastpix.errors.list_errors(timespan="24:hours", filterby="browser_name:Chrome", limit=1)
4646

4747
# Handle response
4848
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

docs/sdks/inputvideo/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
### Available Operations
66

77
* [create_media](#create_media) - Create media from URL
8-
* [direct_upload](#direct_upload) - Upload media from device
8+
* [direct_upload_video_media](#direct_upload_video_media) - Upload media from device
99

1010
## create_media
1111

@@ -72,9 +72,6 @@ with Fastpix(
7272
metadata={
7373
"key1": "value1",
7474
},
75-
drm_configuration_id="your-drm-id",
76-
title="My Video Title",
77-
creator_id="creator-id",
7875
subtitles={
7976
"language_name": "english",
8077
"metadata": {
@@ -86,7 +83,6 @@ with Fastpix(
8683
source_access=True,
8784
optimize_audio=True,
8885
max_resolution="1080p",
89-
media_quality="standard",
9086
chapters=True,
9187
named_entities=True,
9288
)
@@ -129,7 +125,7 @@ with Fastpix(
129125
| -------------------------- | -------------------------- | -------------------------- |
130126
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
131127

132-
## direct_upload
128+
## direct_upload_video_media
133129

134130
This endpoint enables accelerated uploads of large media files directly from your local device to FastPix for processing and storage.
135131

@@ -173,7 +169,7 @@ with Fastpix(
173169
),
174170
) as fastpix:
175171

176-
res = fastpix.input_video.direct_upload(request={
172+
res = fastpix.input_video.direct_upload_video_media(request={
177173
"push_media_settings": {
178174
"metadata": {
179175
"key1": "value1",

docs/sdks/invideoai/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
### Available Operations
66

7-
* [update_chapters](#update_chapters) - Generate video chapters
7+
* [update_media_chapters](#update_media_chapters) - Generate video chapters
88

9-
## update_chapters
9+
## update_media_chapters
1010

1111
This endpoint enables you to generate chapters for an existing media file.
1212

@@ -38,7 +38,7 @@ with Fastpix(
3838
) as fastpix:
3939

4040

41-
res = fastpix.in_video_ai.update_chapters(media_id="your-media-id", chapters=True )
41+
res = fastpix.in_video_ai_features.update_media_chapters(media_id="your-media-id", chapters=True )
4242

4343
# Handle response (convert datetimes to JSON-serializable strings)
4444
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

docs/sdks/invideoaifeatures/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
### Available Operations
66

7-
* [update_summary](#update_summary) - Generate video summary
8-
* [update_moderation](#update_moderation) - Enable video moderation
9-
* [update_named_entities](#update_named_entities) - Generate named entities
7+
* [update_media_summary](#update_media_summary) - Generate video summary
8+
* [update_media_moderation](#update_media_moderation) - Enable video moderation
9+
* [update_media_named_entities](#update_media_named_entities) - Generate named entities
1010

11-
## update_summary
11+
## update_media_summary
1212

1313
This endpoint allows you to generate the summary for an existing media.
1414

@@ -28,7 +28,7 @@ Related guide: <a href="https://fastpix.com/docs/video-intelligence/generate-a-v
2828

2929
<!-- UsageSnippet language="python" operationID="update-media-summary" method="patch" path="/on-demand/{mediaId}/summary" -->
3030
```python
31-
fimport os
31+
import os
3232
import json
3333

3434
from fastpix_python import Fastpix, models
@@ -41,7 +41,7 @@ with Fastpix(
4141
) as fastpix:
4242

4343

44-
res = fastpix.in_video_ai_features.update_summary(media_id="your-media-id", generate=True, summary_length=100)
44+
res = fastpix.in_video_ai_features.update_media_summary(media_id="your-media-id", generate=True, summary_length=100)
4545

4646

4747
# Handle response (convert datetimes to JSON-serializable strings)
@@ -68,7 +68,7 @@ with Fastpix(
6868
| -------------------------- | -------------------------- | -------------------------- |
6969
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
7070

71-
## update_moderation
71+
## update_media_moderation
7272

7373
This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.
7474

@@ -99,7 +99,7 @@ with Fastpix(
9999
),
100100
) as fastpix:
101101

102-
res = fastpix.in_video_ai_features.update_moderation(media_id="your-media-id", moderation={
102+
res = fastpix.in_video_ai_features.update_media_moderation(media_id="your-media-id", moderation={
103103
"type": "video",
104104
})
105105

@@ -126,7 +126,7 @@ with Fastpix(
126126
| -------------------------- | -------------------------- | -------------------------- |
127127
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
128128

129-
## update_named_entities
129+
## update_media_named_entities
130130

131131
This endpoint allows you to extract named entities from an existing media.
132132
Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories. For instance:
@@ -164,7 +164,7 @@ with Fastpix(
164164

165165

166166

167-
res = fastpix.in_video_ai_features.update_named_entities(media_id="your-media-id", named_entities=True)
167+
res = fastpix.in_video_ai_features.update_media_named_entities(media_id="your-media-id", named_entities=True)
168168

169169
# Handle response (convert datetimes to JSON-serializable strings)
170170
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

docs/sdks/liveplayback/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
### Available Operations
66

7-
* [create_playback_id](#create_playback_id) - Create a playbackId
8-
* [delete_playback_id](#delete_playback_id) - Delete a playbackId
9-
* [get_playback_id_details](#get_playback_id_details) - Get playbackId details
7+
* [create_playback_id_of_stream](#create_playback_id_of_stream) - Create a playbackId
8+
* [delete_playback_id_of_stream](#delete_playback_id_of_stream) - Delete a playbackId
9+
* [get_live_stream_playback_id](#get_live_stream_playback_id) - Get playbackId details
1010

11-
## create_playback_id
11+
## create_playback_id_of_stream
1212

1313
Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.
1414

@@ -34,7 +34,7 @@ with Fastpix(
3434
),
3535
) as fastpix:
3636

37-
res = fastpix.live_playback.create_playback_id(stream_id="your-stream-id", access_policy="public")
37+
res = fastpix.live_playback.create_playback_id_of_stream(stream_id="your-stream-id", access_policy="public")
3838

3939
# Handle response
4040
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))
@@ -59,7 +59,7 @@ with Fastpix(
5959
| -------------------------- | -------------------------- | -------------------------- |
6060
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
6161

62-
## delete_playback_id
62+
## delete_playback_id_of_stream
6363

6464
Deletes a previously created playback ID for a live stream.This prevents new viewers from accessing the stream using the playback ID, while current viewers can continue watching for a short period before the connection ends. FastPix deletes the ID and ensures the new playback request fails.
6565

@@ -82,7 +82,7 @@ with Fastpix(
8282
),
8383
) as fastpix:
8484

85-
res = fastpix.live_playback.delete_playback_id(
85+
res = fastpix.live_playback.delete_playback_id_of_stream(
8686
stream_id="your-stream-id",
8787
playback_id="your-playback-id",
8888
)
@@ -110,7 +110,7 @@ with Fastpix(
110110
| -------------------------- | -------------------------- | -------------------------- |
111111
| errors.FastpixDefaultError | 4XX, 5XX | \*/\* |
112112

113-
## get_playback_id_details
113+
## get_live_stream_playback_id
114114

115115
Retrieves details for an existing playback ID. When you provide the playbackId returned from a previous stream or playback creation request, FastPix returns the associated playback information, including the access policy.
116116

@@ -133,7 +133,7 @@ with Fastpix(
133133
),
134134
) as fastpix:
135135

136-
res = fastpix.live_playback.get_playback_id_details(stream_id="61a264dcc447b63da6fb79ef925cd76d", playback_id="61a264dcc447b63da6fb79ef925cd76d")
136+
res = fastpix.live_playback.get_live_stream_playback_id(stream_id="61a264dcc447b63da6fb79ef925cd76d", playback_id="61a264dcc447b63da6fb79ef925cd76d")
137137

138138
# Handle response
139139
print(json.dumps(res.model_dump(mode="json", by_alias=True), indent=2))

0 commit comments

Comments
 (0)