prawn 0.1.0

Rust Client for the Tidal API providing comprehensive API coverag, and easy OAuth management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

# \TrackSourceFilesApi

All URIs are relative to *https://openapi.tidal.com/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_track_source_file**](TrackSourceFilesApi.md#create_track_source_file) | **POST** /trackSourceFiles | Create single trackSourceFile.
[**get_track_source_file**](TrackSourceFilesApi.md#get_track_source_file) | **GET** /trackSourceFiles/{id} | Get single trackSourceFile.
[**get_track_source_file_owners**](TrackSourceFilesApi.md#get_track_source_file_owners) | **GET** /trackSourceFiles/{id}/relationships/owners | Get owners relationship (\"to-many\").
[**get_track_source_files**](TrackSourceFilesApi.md#get_track_source_files) | **GET** /trackSourceFiles | Get multiple trackSourceFiles.



## create_track_source_file

> models::TrackSourceFilesSingleResourceDataDocument create_track_source_file(track_source_file_create_operation_payload)
Create single trackSourceFile.

Create a track source file. <p/> The response contains a upload link that must be used to upload the actual content.<p/> The headers in the upload link response must be sent doing the actual upload. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**track_source_file_create_operation_payload** | Option<[**TrackSourceFileCreateOperationPayload**](TrackSourceFileCreateOperationPayload.md)> |  |  |

### Return type

[**models::TrackSourceFilesSingleResourceDataDocument**](TrackSourceFiles_Single_Resource_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## get_track_source_file

> models::TrackSourceFilesSingleResourceDataDocument get_track_source_file(id, include)
Get single trackSourceFile.

Retrieves single trackSourceFile by id.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Track source file id | [required] |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: owners |  |

### Return type

[**models::TrackSourceFilesSingleResourceDataDocument**](TrackSourceFiles_Single_Resource_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## get_track_source_file_owners

> models::TrackSourceFilesMultiRelationshipDataDocument get_track_source_file_owners(id, include, page_cursor)
Get owners relationship (\"to-many\").

Retrieves owners relationship.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | Track source file id | [required] |
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: owners |  |
**page_cursor** | Option<**String**> | Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified |  |

### Return type

[**models::TrackSourceFilesMultiRelationshipDataDocument**](TrackSourceFiles_Multi_Relationship_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## get_track_source_files

> models::TrackSourceFilesMultiResourceDataDocument get_track_source_files(include, filter_left_square_bracket_id_right_square_bracket)
Get multiple trackSourceFiles.

Retrieves multiple trackSourceFiles by available filters, or without if applicable.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**include** | Option<[**Vec<String>**](String.md)> | Allows the client to customize which related resources should be returned. Available options: owners |  |
**filter_left_square_bracket_id_right_square_bracket** | Option<[**Vec<String>**](String.md)> | Track source file id |  |

### Return type

[**models::TrackSourceFilesMultiResourceDataDocument**](TrackSourceFiles_Multi_Resource_Data_Document.md)

### Authorization

[Authorization_Code_PKCE](../README.md#Authorization_Code_PKCE)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)