Skip to content

Commit f3ca918

Browse files
author
Gustav Lundström
committed
Version 5.0.4
1 parent ca25860 commit f3ca918

7 files changed

Lines changed: 71 additions & 39 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Official Vidispine API client for Python projects.
44

55
- API version: 5.x
6-
- Package version: 5.0.3
6+
- Package version: 5.0.4
77
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
88

99
For more information, please visit [http://support.vidispine.com/](http://support.vidispine.com/)

‎docs/ImportApi.md‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost:8080/API*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**adopt_file**](ImportApi.md#adopt_file) | **POST** /import/placeholder/{item-id}/[container,audio,video,binary]/adopt/{file-id} | Adopt stand-alone files
7+
[**adopt_file**](ImportApi.md#adopt_file) | **POST** /import/placeholder/{item-id}/{component-type}/adopt/{file-id} | Adopt stand-alone files
88
[**create_placeholder**](ImportApi.md#create_placeholder) | **POST** /import/placeholder | Create a placeholder item
99
[**create_placeholder_import_passkey**](ImportApi.md#create_placeholder_import_passkey) | **POST** /import/placeholder/{item-id}/raw-passkey | Create passkey for placeholder item
1010
[**delete_default_access_control_for_group**](ImportApi.md#delete_default_access_control_for_group) | **DELETE** /import/access/group/{group-name} | Remove a group from the default access control list
@@ -19,22 +19,22 @@ Method | HTTP request | Description
1919
[**import_item_raw**](ImportApi.md#import_item_raw) | **POST** /import/raw | Import using the request body
2020
[**import_item_raw_passkey**](ImportApi.md#import_item_raw_passkey) | **POST** /import/raw-passkey | Import using a passkey
2121
[**import_placeholder_bulk**](ImportApi.md#import_placeholder_bulk) | **POST** /import/placeholder/{item-id} | Import to a placeholder item in bulk
22-
[**import_placeholder_raw**](ImportApi.md#import_placeholder_raw) | **POST** /import/placeholder/{item-id}/[container,audio,video,binary]/raw | Import to a placeholder item using the request body
22+
[**import_placeholder_raw**](ImportApi.md#import_placeholder_raw) | **POST** /import/placeholder/{item-id}/{component-type}/raw | Import to a placeholder item using the request body
2323
[**import_project**](ImportApi.md#import_project) | **POST** /import/project | Import a project
2424
[**import_project_sequence**](ImportApi.md#import_project_sequence) | **POST** /import/project/sequence | Import a sequence
2525
[**import_sidecar**](ImportApi.md#import_sidecar) | **POST** /import/sidecar/{item-id} | Import a sidecar file
2626
[**import_sidecar_raw**](ImportApi.md#import_sidecar_raw) | **POST** /import/sidecar/{item-id}/raw | Import a sidecar file
2727
[**import_storage_definition**](ImportApi.md#import_storage_definition) | **POST** /storage/import | Import a storage definition
28-
[**import_to_placeholder**](ImportApi.md#import_to_placeholder) | **POST** /import/placeholder/{item-id}/[container,audio,video,binary] | Import to a placeholder item
28+
[**import_to_placeholder**](ImportApi.md#import_to_placeholder) | **POST** /import/placeholder/{item-id}/{component-type} | Import to a placeholder item
2929
[**update_default_access_control_for_group**](ImportApi.md#update_default_access_control_for_group) | **PUT** /import/access/group/{group-name} | Add a group to the default access control list
3030

3131

3232
# **adopt_file**
33-
> adopt_file(item_id, file_id, index=index, shape_id=shape_id)
33+
> adopt_file(item_id, component_type, file_id, index=index, shape_id=shape_id)
3434
3535
Adopt stand-alone files
3636

37-
Adopt the file as a component in a placeholder item.
37+
Adopt the file as a component in a placeholder item. The value of component-type is one of: `container, audio, video, binary`
3838

3939
### Example
4040

@@ -53,13 +53,14 @@ configuration.password = 'YOUR_PASSWORD'
5353
# create an instance of the API class
5454
api_instance = vidispine.ImportApi(vidispine.ApiClient(configuration))
5555
item_id = 'item_id_example' # str | The item id.
56+
component_type = 'component_type_example' # str | The component type.
5657
file_id = 'file_id_example' # str | The file id.
5758
index = 56 # int | Index (order) of the component. (optional)
5859
shape_id = 'shape_id_example' # str | Shape id for which shape to receive the content. (optional)
5960

6061
try:
6162
# Adopt stand-alone files
62-
api_instance.adopt_file(item_id, file_id, index=index, shape_id=shape_id)
63+
api_instance.adopt_file(item_id, component_type, file_id, index=index, shape_id=shape_id)
6364
except ApiException as e:
6465
print("Exception when calling ImportApi->adopt_file: %s\n" % e)
6566
```
@@ -69,6 +70,7 @@ except ApiException as e:
6970
Name | Type | Description | Notes
7071
------------- | ------------- | ------------- | -------------
7172
**item_id** | **str**| The item id. |
73+
**component_type** | **str**| The component type. |
7274
**file_id** | **str**| The file id. |
7375
**index** | **int**| Index (order) of the component. | [optional]
7476
**shape_id** | **str**| Shape id for which shape to receive the content. | [optional]
@@ -1319,7 +1321,7 @@ Name | Type | Description | Notes
13191321
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
13201322

13211323
# **import_placeholder_raw**
1322-
> JobType import_placeholder_raw(item_id, body, resource_id=resource_id, jobmetadata=jobmetadata, notification_data=notification_data, thumbnail_service=thumbnail_service, tag=tag, transfer_priority=transfer_priority, index=index, require_fast_start=require_fast_start, notification=notification, fast_start_length=fast_start_length, priority=priority, storage_id=storage_id, create_thumbnails=create_thumbnails, create_posters=create_posters, override_fast_start=override_fast_start, original=original, shape_id=shape_id, filename=filename, transfer_id=transfer_id, no_transcode=no_transcode)
1324+
> JobType import_placeholder_raw(item_id, component_type, body, resource_id=resource_id, jobmetadata=jobmetadata, notification_data=notification_data, thumbnail_service=thumbnail_service, tag=tag, transfer_priority=transfer_priority, index=index, require_fast_start=require_fast_start, notification=notification, fast_start_length=fast_start_length, priority=priority, storage_id=storage_id, create_thumbnails=create_thumbnails, create_posters=create_posters, override_fast_start=override_fast_start, original=original, shape_id=shape_id, filename=filename, transfer_id=transfer_id, no_transcode=no_transcode)
13231325
13241326
Import to a placeholder item using the request body
13251327

@@ -1342,6 +1344,7 @@ configuration.password = 'YOUR_PASSWORD'
13421344
# create an instance of the API class
13431345
api_instance = vidispine.ImportApi(vidispine.ApiClient(configuration))
13441346
item_id = 'item_id_example' # str | The item id.
1347+
component_type = 'component_type_example' # str | The component type.
13451348
body = '/path/to/file' # file | The raw data.
13461349
resource_id = 'resource_id_example' # str | The transcoder resource to use to execute the transcode. (optional)
13471350
jobmetadata = ['jobmetadata_example'] # list[str] | Additional information for the job task. (optional)
@@ -1366,7 +1369,7 @@ no_transcode = False # bool | - `true` - Will disable transcoding even if the `t
13661369

13671370
try:
13681371
# Import to a placeholder item using the request body
1369-
api_response = api_instance.import_placeholder_raw(item_id, body, resource_id=resource_id, jobmetadata=jobmetadata, notification_data=notification_data, thumbnail_service=thumbnail_service, tag=tag, transfer_priority=transfer_priority, index=index, require_fast_start=require_fast_start, notification=notification, fast_start_length=fast_start_length, priority=priority, storage_id=storage_id, create_thumbnails=create_thumbnails, create_posters=create_posters, override_fast_start=override_fast_start, original=original, shape_id=shape_id, filename=filename, transfer_id=transfer_id, no_transcode=no_transcode)
1372+
api_response = api_instance.import_placeholder_raw(item_id, component_type, body, resource_id=resource_id, jobmetadata=jobmetadata, notification_data=notification_data, thumbnail_service=thumbnail_service, tag=tag, transfer_priority=transfer_priority, index=index, require_fast_start=require_fast_start, notification=notification, fast_start_length=fast_start_length, priority=priority, storage_id=storage_id, create_thumbnails=create_thumbnails, create_posters=create_posters, override_fast_start=override_fast_start, original=original, shape_id=shape_id, filename=filename, transfer_id=transfer_id, no_transcode=no_transcode)
13701373
pprint(api_response)
13711374
except ApiException as e:
13721375
print("Exception when calling ImportApi->import_placeholder_raw: %s\n" % e)
@@ -1377,6 +1380,7 @@ except ApiException as e:
13771380
Name | Type | Description | Notes
13781381
------------- | ------------- | ------------- | -------------
13791382
**item_id** | **str**| The item id. |
1383+
**component_type** | **str**| The component type. |
13801384
**body** | **file**| The raw data. |
13811385
**resource_id** | **str**| The transcoder resource to use to execute the transcode. | [optional]
13821386
**jobmetadata** | [**list[str]**](str.md)| Additional information for the job task. | [optional]
@@ -1756,7 +1760,7 @@ void (empty response body)
17561760
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
17571761

17581762
# **import_to_placeholder**
1759-
> JobType import_to_placeholder(item_id, uri=uri, no_transcode=no_transcode, original=original, fast_start_length=fast_start_length, create_thumbnails=create_thumbnails, create_posters=create_posters, jobmetadata=jobmetadata, notification_data=notification_data, storage_id=storage_id, require_fast_start=require_fast_start, growing=growing, tag=tag, resource_id=resource_id, thumbnail_service=thumbnail_service, settings=settings, notification=notification, file_id=file_id, shape_id=shape_id, allow_reimport=allow_reimport, index=index, priority=priority, override_fast_start=override_fast_start)
1763+
> JobType import_to_placeholder(item_id, component_type, uri=uri, no_transcode=no_transcode, original=original, fast_start_length=fast_start_length, create_thumbnails=create_thumbnails, create_posters=create_posters, jobmetadata=jobmetadata, notification_data=notification_data, storage_id=storage_id, require_fast_start=require_fast_start, growing=growing, tag=tag, resource_id=resource_id, thumbnail_service=thumbnail_service, settings=settings, notification=notification, file_id=file_id, shape_id=shape_id, allow_reimport=allow_reimport, index=index, priority=priority, override_fast_start=override_fast_start)
17601764
17611765
Import to a placeholder item
17621766

@@ -1779,6 +1783,7 @@ configuration.password = 'YOUR_PASSWORD'
17791783
# create an instance of the API class
17801784
api_instance = vidispine.ImportApi(vidispine.ApiClient(configuration))
17811785
item_id = 'item_id_example' # str | The item id.
1786+
component_type = 'component_type_example' # str | The component type.
17821787
uri = 'uri_example' # str | A URI to the file that will be imported. Make sure to percent encode the URI. Must be specified unless `fileId` is specified. (optional)
17831788
no_transcode = False # bool | - `true` - Will disable transcoding even if the `tags` parameter is set. Rather, the specified tag will be used to determine cropping, scaling etc. of thumbnails. - `false` (default) - Normal transcode. (optional) (default to False)
17841789
original = 'original_example' # str | If specified, should be one of the tags specified in the tag parameter. Specifies that the original shape tag will be reset to the shape created to this tag. (optional)
@@ -1804,7 +1809,7 @@ override_fast_start = True # bool | - `true` (default) - Use transcoder's estima
18041809

18051810
try:
18061811
# Import to a placeholder item
1807-
api_response = api_instance.import_to_placeholder(item_id, uri=uri, no_transcode=no_transcode, original=original, fast_start_length=fast_start_length, create_thumbnails=create_thumbnails, create_posters=create_posters, jobmetadata=jobmetadata, notification_data=notification_data, storage_id=storage_id, require_fast_start=require_fast_start, growing=growing, tag=tag, resource_id=resource_id, thumbnail_service=thumbnail_service, settings=settings, notification=notification, file_id=file_id, shape_id=shape_id, allow_reimport=allow_reimport, index=index, priority=priority, override_fast_start=override_fast_start)
1812+
api_response = api_instance.import_to_placeholder(item_id, component_type, uri=uri, no_transcode=no_transcode, original=original, fast_start_length=fast_start_length, create_thumbnails=create_thumbnails, create_posters=create_posters, jobmetadata=jobmetadata, notification_data=notification_data, storage_id=storage_id, require_fast_start=require_fast_start, growing=growing, tag=tag, resource_id=resource_id, thumbnail_service=thumbnail_service, settings=settings, notification=notification, file_id=file_id, shape_id=shape_id, allow_reimport=allow_reimport, index=index, priority=priority, override_fast_start=override_fast_start)
18081813
pprint(api_response)
18091814
except ApiException as e:
18101815
print("Exception when calling ImportApi->import_to_placeholder: %s\n" % e)
@@ -1815,6 +1820,7 @@ except ApiException as e:
18151820
Name | Type | Description | Notes
18161821
------------- | ------------- | ------------- | -------------
18171822
**item_id** | **str**| The item id. |
1823+
**component_type** | **str**| The component type. |
18181824
**uri** | **str**| A URI to the file that will be imported. Make sure to percent encode the URI. Must be specified unless `fileId` is specified. | [optional]
18191825
**no_transcode** | **bool**| - `true` - Will disable transcoding even if the `tags` parameter is set. Rather, the specified tag will be used to determine cropping, scaling etc. of thumbnails. - `false` (default) - Normal transcode. | [optional] [default to False]
18201826
**original** | **str**| If specified, should be one of the tags specified in the tag parameter. Specifies that the original shape tag will be reset to the shape created to this tag. | [optional]

‎setup.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
from setuptools import setup, find_packages # noqa: H301
1515

1616
NAME = "vidispine"
17-
VERSION = "5.0.3"
17+
VERSION = "5.0.4"
1818
# To install the library, run the following
1919
#
2020
# python setup.py install
@@ -35,8 +35,10 @@
3535
packages=find_packages(exclude=["test", "tests"]),
3636
include_package_data=True,
3737
long_description="""\
38-
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
38+
This is the official Vidispine API client for Python 2.7 and 3.4+.
39+
To get started, please see the [readme on Github](https://github.com/vidispine/vidispine-python-sdk)!
3940
""",
41+
long_description_content_type="text/markdown",
4042
test_suite='nose.collector',
4143
tests_require=['nose']
4244
)

‎vidispine/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
from __future__ import absolute_import
1717

18-
__version__ = "5.0.3"
18+
__version__ = "5.0.4"
1919

2020
# import apis into sdk package
2121
from vidispine.api.access_api import AccessApi

0 commit comments

Comments
 (0)