agilicus 1.236.6__py3-none-any.whl → 1.237.1__py3-none-any.whl
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.
- agilicus/.openapi-generator/FILES +9 -0
- agilicus/agilicus_api/__init__.py +3 -0
- agilicus/agilicus_api/api/files_api.py +717 -40
- agilicus/agilicus_api/api/files_api_mock.py +35 -0
- agilicus/agilicus_api/api_client.py +1 -1
- agilicus/agilicus_api/configuration.py +1 -1
- agilicus/agilicus_api/docs/FilesApi.md +447 -0
- agilicus/agilicus_api/docs/ListPublicFileOrgLinksResponse.md +15 -0
- agilicus/agilicus_api/docs/PublicFileOrgLink.md +14 -0
- agilicus/agilicus_api/docs/PublicFileOrgLinkSpec.md +15 -0
- agilicus/agilicus_api/model/list_public_file_org_links_response.py +307 -0
- agilicus/agilicus_api/model/public_file_org_link.py +295 -0
- agilicus/agilicus_api/model/public_file_org_link_spec.py +303 -0
- agilicus/agilicus_api/models/__init__.py +3 -0
- agilicus/agilicus_api/test/test_files_api.py +35 -0
- agilicus/agilicus_api/test/test_list_public_file_org_links_response.py +38 -0
- agilicus/agilicus_api/test/test_public_file_org_link.py +40 -0
- agilicus/agilicus_api/test/test_public_file_org_link_spec.py +36 -0
- agilicus/agilicus_api_README.md +9 -1
- agilicus/files_pkg/files_main.py +50 -0
- agilicus/files_pkg/public_file_org_links.py +60 -0
- agilicus/main.py +2 -0
- {agilicus-1.236.6.dist-info → agilicus-1.237.1.dist-info}/METADATA +2 -2
- {agilicus-1.236.6.dist-info → agilicus-1.237.1.dist-info}/RECORD +27 -16
- {agilicus-1.236.6.dist-info → agilicus-1.237.1.dist-info}/LICENSE.txt +0 -0
- {agilicus-1.236.6.dist-info → agilicus-1.237.1.dist-info}/WHEEL +0 -0
- {agilicus-1.236.6.dist-info → agilicus-1.237.1.dist-info}/entry_points.txt +0 -0
@@ -6,15 +6,20 @@ class FilesApiMock:
|
|
6
6
|
self.mock_add_file = MagicMock()
|
7
7
|
self.mock_create_file_association = MagicMock()
|
8
8
|
self.mock_create_file_association_clear_task = MagicMock()
|
9
|
+
self.mock_create_public_file_org_link = MagicMock()
|
9
10
|
self.mock_delete_file = MagicMock()
|
10
11
|
self.mock_delete_file_association = MagicMock()
|
12
|
+
self.mock_delete_public_file_org_link = MagicMock()
|
11
13
|
self.mock_get_download = MagicMock()
|
12
14
|
self.mock_get_download_public = MagicMock()
|
13
15
|
self.mock_get_file = MagicMock()
|
14
16
|
self.mock_get_file_association = MagicMock()
|
17
|
+
self.mock_get_public_file_org_link = MagicMock()
|
15
18
|
self.mock_list_file_associations = MagicMock()
|
16
19
|
self.mock_list_files = MagicMock()
|
20
|
+
self.mock_list_public_file_org_links = MagicMock()
|
17
21
|
self.mock_replace_file = MagicMock()
|
22
|
+
self.mock_replace_public_file_org_link = MagicMock()
|
18
23
|
self.mock_reupload_file = MagicMock()
|
19
24
|
|
20
25
|
def add_file(self, *args, **kwargs):
|
@@ -35,6 +40,12 @@ class FilesApiMock:
|
|
35
40
|
"""
|
36
41
|
return self.mock_create_file_association_clear_task(self, *args, **kwargs)
|
37
42
|
|
43
|
+
def create_public_file_org_link(self, *args, **kwargs):
|
44
|
+
"""
|
45
|
+
This method mocks the original api FilesApi.create_public_file_org_link with MagicMock.
|
46
|
+
"""
|
47
|
+
return self.mock_create_public_file_org_link(self, *args, **kwargs)
|
48
|
+
|
38
49
|
def delete_file(self, *args, **kwargs):
|
39
50
|
"""
|
40
51
|
This method mocks the original api FilesApi.delete_file with MagicMock.
|
@@ -47,6 +58,12 @@ class FilesApiMock:
|
|
47
58
|
"""
|
48
59
|
return self.mock_delete_file_association(self, *args, **kwargs)
|
49
60
|
|
61
|
+
def delete_public_file_org_link(self, *args, **kwargs):
|
62
|
+
"""
|
63
|
+
This method mocks the original api FilesApi.delete_public_file_org_link with MagicMock.
|
64
|
+
"""
|
65
|
+
return self.mock_delete_public_file_org_link(self, *args, **kwargs)
|
66
|
+
|
50
67
|
def get_download(self, *args, **kwargs):
|
51
68
|
"""
|
52
69
|
This method mocks the original api FilesApi.get_download with MagicMock.
|
@@ -71,6 +88,12 @@ class FilesApiMock:
|
|
71
88
|
"""
|
72
89
|
return self.mock_get_file_association(self, *args, **kwargs)
|
73
90
|
|
91
|
+
def get_public_file_org_link(self, *args, **kwargs):
|
92
|
+
"""
|
93
|
+
This method mocks the original api FilesApi.get_public_file_org_link with MagicMock.
|
94
|
+
"""
|
95
|
+
return self.mock_get_public_file_org_link(self, *args, **kwargs)
|
96
|
+
|
74
97
|
def list_file_associations(self, *args, **kwargs):
|
75
98
|
"""
|
76
99
|
This method mocks the original api FilesApi.list_file_associations with MagicMock.
|
@@ -83,12 +106,24 @@ class FilesApiMock:
|
|
83
106
|
"""
|
84
107
|
return self.mock_list_files(self, *args, **kwargs)
|
85
108
|
|
109
|
+
def list_public_file_org_links(self, *args, **kwargs):
|
110
|
+
"""
|
111
|
+
This method mocks the original api FilesApi.list_public_file_org_links with MagicMock.
|
112
|
+
"""
|
113
|
+
return self.mock_list_public_file_org_links(self, *args, **kwargs)
|
114
|
+
|
86
115
|
def replace_file(self, *args, **kwargs):
|
87
116
|
"""
|
88
117
|
This method mocks the original api FilesApi.replace_file with MagicMock.
|
89
118
|
"""
|
90
119
|
return self.mock_replace_file(self, *args, **kwargs)
|
91
120
|
|
121
|
+
def replace_public_file_org_link(self, *args, **kwargs):
|
122
|
+
"""
|
123
|
+
This method mocks the original api FilesApi.replace_public_file_org_link with MagicMock.
|
124
|
+
"""
|
125
|
+
return self.mock_replace_public_file_org_link(self, *args, **kwargs)
|
126
|
+
|
92
127
|
def reupload_file(self, *args, **kwargs):
|
93
128
|
"""
|
94
129
|
This method mocks the original api FilesApi.reupload_file with MagicMock.
|
@@ -77,7 +77,7 @@ class ApiClient(object):
|
|
77
77
|
self.default_headers[header_name] = header_value
|
78
78
|
self.cookie = cookie
|
79
79
|
# Set default User-Agent.
|
80
|
-
self.user_agent = 'OpenAPI-Generator/1.
|
80
|
+
self.user_agent = 'OpenAPI-Generator/1.237.1/python'
|
81
81
|
|
82
82
|
def __enter__(self):
|
83
83
|
return self
|
@@ -387,7 +387,7 @@ class Configuration(object):
|
|
387
387
|
"OS: {env}\n"\
|
388
388
|
"Python Version: {pyversion}\n"\
|
389
389
|
"Version of the API: 2024.01.18\n"\
|
390
|
-
"SDK Package Version: 1.
|
390
|
+
"SDK Package Version: 1.237.1".\
|
391
391
|
format(env=sys.platform, pyversion=sys.version)
|
392
392
|
|
393
393
|
def get_host_settings(self):
|
@@ -7,15 +7,20 @@ Method | HTTP request | Description
|
|
7
7
|
[**add_file**](FilesApi.md#add_file) | **POST** /v1/files | upload a file
|
8
8
|
[**create_file_association**](FilesApi.md#create_file_association) | **POST** /v1/file_associations | associate a file with an object
|
9
9
|
[**create_file_association_clear_task**](FilesApi.md#create_file_association_clear_task) | **POST** /v1/file_association_clear | Cleans up file associations
|
10
|
+
[**create_public_file_org_link**](FilesApi.md#create_public_file_org_link) | **POST** /v1/public_file_org_links | link public files based on org
|
10
11
|
[**delete_file**](FilesApi.md#delete_file) | **DELETE** /v1/files/{file_id} | Delete a File
|
11
12
|
[**delete_file_association**](FilesApi.md#delete_file_association) | **DELETE** /v1/file_associations/{file_association_id} | Remove an association from a file
|
13
|
+
[**delete_public_file_org_link**](FilesApi.md#delete_public_file_org_link) | **DELETE** /v1/public_file_org_links/{public_file_org_link_id} | Remove a link from an org
|
12
14
|
[**get_download**](FilesApi.md#get_download) | **GET** /v1/files_download/{file_id} | Download File
|
13
15
|
[**get_download_public**](FilesApi.md#get_download_public) | **GET** /v1/files_public | Download public file
|
14
16
|
[**get_file**](FilesApi.md#get_file) | **GET** /v1/files/{file_id} | Get File metadata
|
15
17
|
[**get_file_association**](FilesApi.md#get_file_association) | **GET** /v1/file_associations/{file_association_id} | Get a file association
|
18
|
+
[**get_public_file_org_link**](FilesApi.md#get_public_file_org_link) | **GET** /v1/public_file_org_links/{public_file_org_link_id} | Get a public file org link
|
16
19
|
[**list_file_associations**](FilesApi.md#list_file_associations) | **GET** /v1/file_associations | Query File Associations
|
17
20
|
[**list_files**](FilesApi.md#list_files) | **GET** /v1/files | Query Files
|
21
|
+
[**list_public_file_org_links**](FilesApi.md#list_public_file_org_links) | **GET** /v1/public_file_org_links | Query Public File Org Links
|
18
22
|
[**replace_file**](FilesApi.md#replace_file) | **PUT** /v1/files/{file_id} | Update a file
|
23
|
+
[**replace_public_file_org_link**](FilesApi.md#replace_public_file_org_link) | **PUT** /v1/public_file_org_links/{public_file_org_link_id} | Replace a public file org link
|
19
24
|
[**reupload_file**](FilesApi.md#reupload_file) | **PUT** /v1/files/{file_id}/upload | Upload a new version of a file
|
20
25
|
|
21
26
|
|
@@ -287,6 +292,91 @@ Name | Type | Description | Notes
|
|
287
292
|
|
288
293
|
[[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)
|
289
294
|
|
295
|
+
# **create_public_file_org_link**
|
296
|
+
> PublicFileOrgLink create_public_file_org_link(public_file_org_link)
|
297
|
+
|
298
|
+
link public files based on org
|
299
|
+
|
300
|
+
links public files based on organisation and tag
|
301
|
+
|
302
|
+
### Example
|
303
|
+
|
304
|
+
* Bearer (JWT) Authentication (token-valid):
|
305
|
+
```python
|
306
|
+
import time
|
307
|
+
import agilicus_api
|
308
|
+
from agilicus_api.api import files_api
|
309
|
+
from agilicus_api.model.public_file_org_link import PublicFileOrgLink
|
310
|
+
from agilicus_api.model.error_message import ErrorMessage
|
311
|
+
from pprint import pprint
|
312
|
+
# Defining the host is optional and defaults to https://api.agilicus.com
|
313
|
+
# See configuration.py for a list of all supported configuration parameters.
|
314
|
+
configuration = agilicus_api.Configuration(
|
315
|
+
host = "https://api.agilicus.com"
|
316
|
+
)
|
317
|
+
|
318
|
+
# The client must configure the authentication and authorization parameters
|
319
|
+
# in accordance with the API server security policy.
|
320
|
+
# Examples for each auth method are provided below, use the example that
|
321
|
+
# satisfies your auth use case.
|
322
|
+
|
323
|
+
# Configure Bearer authorization (JWT): token-valid
|
324
|
+
configuration = agilicus_api.Configuration(
|
325
|
+
access_token = 'YOUR_BEARER_TOKEN'
|
326
|
+
)
|
327
|
+
|
328
|
+
# Enter a context with an instance of the API client
|
329
|
+
with agilicus_api.ApiClient(configuration) as api_client:
|
330
|
+
# Create an instance of the API class
|
331
|
+
api_instance = files_api.FilesApi(api_client)
|
332
|
+
public_file_org_link = PublicFileOrgLink(
|
333
|
+
metadata=MetadataWithId(),
|
334
|
+
spec=PublicFileOrgLinkSpec(
|
335
|
+
file_tag="theme",
|
336
|
+
link_org_id=None,
|
337
|
+
target_org_id=None,
|
338
|
+
),
|
339
|
+
) # PublicFileOrgLink | The link to create
|
340
|
+
|
341
|
+
# example passing only required values which don't have defaults set
|
342
|
+
try:
|
343
|
+
# link public files based on org
|
344
|
+
api_response = api_instance.create_public_file_org_link(public_file_org_link)
|
345
|
+
pprint(api_response)
|
346
|
+
except agilicus_api.ApiException as e:
|
347
|
+
print("Exception when calling FilesApi->create_public_file_org_link: %s\n" % e)
|
348
|
+
```
|
349
|
+
|
350
|
+
|
351
|
+
### Parameters
|
352
|
+
|
353
|
+
Name | Type | Description | Notes
|
354
|
+
------------- | ------------- | ------------- | -------------
|
355
|
+
**public_file_org_link** | [**PublicFileOrgLink**](PublicFileOrgLink.md)| The link to create |
|
356
|
+
|
357
|
+
### Return type
|
358
|
+
|
359
|
+
[**PublicFileOrgLink**](PublicFileOrgLink.md)
|
360
|
+
|
361
|
+
### Authorization
|
362
|
+
|
363
|
+
[token-valid](../README.md#token-valid)
|
364
|
+
|
365
|
+
### HTTP request headers
|
366
|
+
|
367
|
+
- **Content-Type**: application/json
|
368
|
+
- **Accept**: application/json
|
369
|
+
|
370
|
+
|
371
|
+
### HTTP response details
|
372
|
+
| Status code | Description | Response headers |
|
373
|
+
|-------------|-------------|------------------|
|
374
|
+
**201** | Successfully created link | - |
|
375
|
+
**400** | The link was invalid. This could be because it was improperly formatted. | - |
|
376
|
+
**409** | A link for this org_id and file_tag already exists | - |
|
377
|
+
|
378
|
+
[[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)
|
379
|
+
|
290
380
|
# **delete_file**
|
291
381
|
> delete_file(file_id)
|
292
382
|
|
@@ -455,6 +545,92 @@ void (empty response body)
|
|
455
545
|
|
456
546
|
[[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)
|
457
547
|
|
548
|
+
# **delete_public_file_org_link**
|
549
|
+
> delete_public_file_org_link(public_file_org_link_id)
|
550
|
+
|
551
|
+
Remove a link from an org
|
552
|
+
|
553
|
+
Remove a link from an org. Note that link_org_id and org_id are alises for one another in this query.
|
554
|
+
|
555
|
+
### Example
|
556
|
+
|
557
|
+
* Bearer (JWT) Authentication (token-valid):
|
558
|
+
```python
|
559
|
+
import time
|
560
|
+
import agilicus_api
|
561
|
+
from agilicus_api.api import files_api
|
562
|
+
from pprint import pprint
|
563
|
+
# Defining the host is optional and defaults to https://api.agilicus.com
|
564
|
+
# See configuration.py for a list of all supported configuration parameters.
|
565
|
+
configuration = agilicus_api.Configuration(
|
566
|
+
host = "https://api.agilicus.com"
|
567
|
+
)
|
568
|
+
|
569
|
+
# The client must configure the authentication and authorization parameters
|
570
|
+
# in accordance with the API server security policy.
|
571
|
+
# Examples for each auth method are provided below, use the example that
|
572
|
+
# satisfies your auth use case.
|
573
|
+
|
574
|
+
# Configure Bearer authorization (JWT): token-valid
|
575
|
+
configuration = agilicus_api.Configuration(
|
576
|
+
access_token = 'YOUR_BEARER_TOKEN'
|
577
|
+
)
|
578
|
+
|
579
|
+
# Enter a context with an instance of the API client
|
580
|
+
with agilicus_api.ApiClient(configuration) as api_client:
|
581
|
+
# Create an instance of the API class
|
582
|
+
api_instance = files_api.FilesApi(api_client)
|
583
|
+
public_file_org_link_id = "1234" # str | public file org link id in path
|
584
|
+
link_org_id = "1234" # str | Search for the Organisation that is linked to another (optional)
|
585
|
+
org_id = "1234" # str | Organisation Unique identifier (optional)
|
586
|
+
|
587
|
+
# example passing only required values which don't have defaults set
|
588
|
+
try:
|
589
|
+
# Remove a link from an org
|
590
|
+
api_instance.delete_public_file_org_link(public_file_org_link_id)
|
591
|
+
except agilicus_api.ApiException as e:
|
592
|
+
print("Exception when calling FilesApi->delete_public_file_org_link: %s\n" % e)
|
593
|
+
|
594
|
+
# example passing only required values which don't have defaults set
|
595
|
+
# and optional values
|
596
|
+
try:
|
597
|
+
# Remove a link from an org
|
598
|
+
api_instance.delete_public_file_org_link(public_file_org_link_id, link_org_id=link_org_id, org_id=org_id)
|
599
|
+
except agilicus_api.ApiException as e:
|
600
|
+
print("Exception when calling FilesApi->delete_public_file_org_link: %s\n" % e)
|
601
|
+
```
|
602
|
+
|
603
|
+
|
604
|
+
### Parameters
|
605
|
+
|
606
|
+
Name | Type | Description | Notes
|
607
|
+
------------- | ------------- | ------------- | -------------
|
608
|
+
**public_file_org_link_id** | **str**| public file org link id in path |
|
609
|
+
**link_org_id** | **str**| Search for the Organisation that is linked to another | [optional]
|
610
|
+
**org_id** | **str**| Organisation Unique identifier | [optional]
|
611
|
+
|
612
|
+
### Return type
|
613
|
+
|
614
|
+
void (empty response body)
|
615
|
+
|
616
|
+
### Authorization
|
617
|
+
|
618
|
+
[token-valid](../README.md#token-valid)
|
619
|
+
|
620
|
+
### HTTP request headers
|
621
|
+
|
622
|
+
- **Content-Type**: Not defined
|
623
|
+
- **Accept**: Not defined
|
624
|
+
|
625
|
+
|
626
|
+
### HTTP response details
|
627
|
+
| Status code | Description | Response headers |
|
628
|
+
|-------------|-------------|------------------|
|
629
|
+
**204** | Link was deleted | - |
|
630
|
+
**404** | Link does not exist | - |
|
631
|
+
|
632
|
+
[[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)
|
633
|
+
|
458
634
|
# **get_download**
|
459
635
|
> file_type get_download(file_id)
|
460
636
|
|
@@ -785,6 +961,94 @@ Name | Type | Description | Notes
|
|
785
961
|
|
786
962
|
[[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)
|
787
963
|
|
964
|
+
# **get_public_file_org_link**
|
965
|
+
> PublicFileOrgLink get_public_file_org_link(public_file_org_link_id)
|
966
|
+
|
967
|
+
Get a public file org link
|
968
|
+
|
969
|
+
Get a public file org link. Note that link_org_id and org_id are alises for one another in this query.
|
970
|
+
|
971
|
+
### Example
|
972
|
+
|
973
|
+
* Bearer (JWT) Authentication (token-valid):
|
974
|
+
```python
|
975
|
+
import time
|
976
|
+
import agilicus_api
|
977
|
+
from agilicus_api.api import files_api
|
978
|
+
from agilicus_api.model.public_file_org_link import PublicFileOrgLink
|
979
|
+
from pprint import pprint
|
980
|
+
# Defining the host is optional and defaults to https://api.agilicus.com
|
981
|
+
# See configuration.py for a list of all supported configuration parameters.
|
982
|
+
configuration = agilicus_api.Configuration(
|
983
|
+
host = "https://api.agilicus.com"
|
984
|
+
)
|
985
|
+
|
986
|
+
# The client must configure the authentication and authorization parameters
|
987
|
+
# in accordance with the API server security policy.
|
988
|
+
# Examples for each auth method are provided below, use the example that
|
989
|
+
# satisfies your auth use case.
|
990
|
+
|
991
|
+
# Configure Bearer authorization (JWT): token-valid
|
992
|
+
configuration = agilicus_api.Configuration(
|
993
|
+
access_token = 'YOUR_BEARER_TOKEN'
|
994
|
+
)
|
995
|
+
|
996
|
+
# Enter a context with an instance of the API client
|
997
|
+
with agilicus_api.ApiClient(configuration) as api_client:
|
998
|
+
# Create an instance of the API class
|
999
|
+
api_instance = files_api.FilesApi(api_client)
|
1000
|
+
public_file_org_link_id = "1234" # str | public file org link id in path
|
1001
|
+
link_org_id = "1234" # str | Search for the Organisation that is linked to another (optional)
|
1002
|
+
org_id = "1234" # str | Organisation Unique identifier (optional)
|
1003
|
+
|
1004
|
+
# example passing only required values which don't have defaults set
|
1005
|
+
try:
|
1006
|
+
# Get a public file org link
|
1007
|
+
api_response = api_instance.get_public_file_org_link(public_file_org_link_id)
|
1008
|
+
pprint(api_response)
|
1009
|
+
except agilicus_api.ApiException as e:
|
1010
|
+
print("Exception when calling FilesApi->get_public_file_org_link: %s\n" % e)
|
1011
|
+
|
1012
|
+
# example passing only required values which don't have defaults set
|
1013
|
+
# and optional values
|
1014
|
+
try:
|
1015
|
+
# Get a public file org link
|
1016
|
+
api_response = api_instance.get_public_file_org_link(public_file_org_link_id, link_org_id=link_org_id, org_id=org_id)
|
1017
|
+
pprint(api_response)
|
1018
|
+
except agilicus_api.ApiException as e:
|
1019
|
+
print("Exception when calling FilesApi->get_public_file_org_link: %s\n" % e)
|
1020
|
+
```
|
1021
|
+
|
1022
|
+
|
1023
|
+
### Parameters
|
1024
|
+
|
1025
|
+
Name | Type | Description | Notes
|
1026
|
+
------------- | ------------- | ------------- | -------------
|
1027
|
+
**public_file_org_link_id** | **str**| public file org link id in path |
|
1028
|
+
**link_org_id** | **str**| Search for the Organisation that is linked to another | [optional]
|
1029
|
+
**org_id** | **str**| Organisation Unique identifier | [optional]
|
1030
|
+
|
1031
|
+
### Return type
|
1032
|
+
|
1033
|
+
[**PublicFileOrgLink**](PublicFileOrgLink.md)
|
1034
|
+
|
1035
|
+
### Authorization
|
1036
|
+
|
1037
|
+
[token-valid](../README.md#token-valid)
|
1038
|
+
|
1039
|
+
### HTTP request headers
|
1040
|
+
|
1041
|
+
- **Content-Type**: Not defined
|
1042
|
+
- **Accept**: application/json
|
1043
|
+
|
1044
|
+
|
1045
|
+
### HTTP response details
|
1046
|
+
| Status code | Description | Response headers |
|
1047
|
+
|-------------|-------------|------------------|
|
1048
|
+
**200** | link found | - |
|
1049
|
+
|
1050
|
+
[[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)
|
1051
|
+
|
788
1052
|
# **list_file_associations**
|
789
1053
|
> ListFileAssociationsResponse list_file_associations()
|
790
1054
|
|
@@ -956,6 +1220,90 @@ Name | Type | Description | Notes
|
|
956
1220
|
|
957
1221
|
[[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)
|
958
1222
|
|
1223
|
+
# **list_public_file_org_links**
|
1224
|
+
> ListPublicFileOrgLinksResponse list_public_file_org_links()
|
1225
|
+
|
1226
|
+
Query Public File Org Links
|
1227
|
+
|
1228
|
+
Query Public File Org Links. Note that link_org_id and org_id are alises for one another in this query.
|
1229
|
+
|
1230
|
+
### Example
|
1231
|
+
|
1232
|
+
* Bearer (JWT) Authentication (token-valid):
|
1233
|
+
```python
|
1234
|
+
import time
|
1235
|
+
import agilicus_api
|
1236
|
+
from agilicus_api.api import files_api
|
1237
|
+
from agilicus_api.model.list_public_file_org_links_response import ListPublicFileOrgLinksResponse
|
1238
|
+
from pprint import pprint
|
1239
|
+
# Defining the host is optional and defaults to https://api.agilicus.com
|
1240
|
+
# See configuration.py for a list of all supported configuration parameters.
|
1241
|
+
configuration = agilicus_api.Configuration(
|
1242
|
+
host = "https://api.agilicus.com"
|
1243
|
+
)
|
1244
|
+
|
1245
|
+
# The client must configure the authentication and authorization parameters
|
1246
|
+
# in accordance with the API server security policy.
|
1247
|
+
# Examples for each auth method are provided below, use the example that
|
1248
|
+
# satisfies your auth use case.
|
1249
|
+
|
1250
|
+
# Configure Bearer authorization (JWT): token-valid
|
1251
|
+
configuration = agilicus_api.Configuration(
|
1252
|
+
access_token = 'YOUR_BEARER_TOKEN'
|
1253
|
+
)
|
1254
|
+
|
1255
|
+
# Enter a context with an instance of the API client
|
1256
|
+
with agilicus_api.ApiClient(configuration) as api_client:
|
1257
|
+
# Create an instance of the API class
|
1258
|
+
api_instance = files_api.FilesApi(api_client)
|
1259
|
+
limit = 1 # int | limit the number of rows in the response (optional) if omitted the server will use the default value of 500
|
1260
|
+
link_org_id = "1234" # str | Search for the Organisation that is linked to another (optional)
|
1261
|
+
org_id = "1234" # str | Organisation Unique identifier (optional)
|
1262
|
+
tag = "theme" # str | Search files based on tag (optional)
|
1263
|
+
page_at_id = "foo@example.com" # str | Pagination based query with the id as the key. To get the initial entries supply an empty string. On subsequent requests, supply the `page_at_id` field from the list response. (optional)
|
1264
|
+
|
1265
|
+
# example passing only required values which don't have defaults set
|
1266
|
+
# and optional values
|
1267
|
+
try:
|
1268
|
+
# Query Public File Org Links
|
1269
|
+
api_response = api_instance.list_public_file_org_links(limit=limit, link_org_id=link_org_id, org_id=org_id, tag=tag, page_at_id=page_at_id)
|
1270
|
+
pprint(api_response)
|
1271
|
+
except agilicus_api.ApiException as e:
|
1272
|
+
print("Exception when calling FilesApi->list_public_file_org_links: %s\n" % e)
|
1273
|
+
```
|
1274
|
+
|
1275
|
+
|
1276
|
+
### Parameters
|
1277
|
+
|
1278
|
+
Name | Type | Description | Notes
|
1279
|
+
------------- | ------------- | ------------- | -------------
|
1280
|
+
**limit** | **int**| limit the number of rows in the response | [optional] if omitted the server will use the default value of 500
|
1281
|
+
**link_org_id** | **str**| Search for the Organisation that is linked to another | [optional]
|
1282
|
+
**org_id** | **str**| Organisation Unique identifier | [optional]
|
1283
|
+
**tag** | **str**| Search files based on tag | [optional]
|
1284
|
+
**page_at_id** | **str**| Pagination based query with the id as the key. To get the initial entries supply an empty string. On subsequent requests, supply the `page_at_id` field from the list response. | [optional]
|
1285
|
+
|
1286
|
+
### Return type
|
1287
|
+
|
1288
|
+
[**ListPublicFileOrgLinksResponse**](ListPublicFileOrgLinksResponse.md)
|
1289
|
+
|
1290
|
+
### Authorization
|
1291
|
+
|
1292
|
+
[token-valid](../README.md#token-valid)
|
1293
|
+
|
1294
|
+
### HTTP request headers
|
1295
|
+
|
1296
|
+
- **Content-Type**: Not defined
|
1297
|
+
- **Accept**: application/json
|
1298
|
+
|
1299
|
+
|
1300
|
+
### HTTP response details
|
1301
|
+
| Status code | Description | Response headers |
|
1302
|
+
|-------------|-------------|------------------|
|
1303
|
+
**200** | Return matching file associations | - |
|
1304
|
+
|
1305
|
+
[[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)
|
1306
|
+
|
959
1307
|
# **replace_file**
|
960
1308
|
> FileSummary replace_file(file_id, file)
|
961
1309
|
|
@@ -1054,6 +1402,105 @@ Name | Type | Description | Notes
|
|
1054
1402
|
|
1055
1403
|
[[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)
|
1056
1404
|
|
1405
|
+
# **replace_public_file_org_link**
|
1406
|
+
> PublicFileOrgLink replace_public_file_org_link(public_file_org_link_id, public_file_org_link)
|
1407
|
+
|
1408
|
+
Replace a public file org link
|
1409
|
+
|
1410
|
+
Replace a public file org link
|
1411
|
+
|
1412
|
+
### Example
|
1413
|
+
|
1414
|
+
* Bearer (JWT) Authentication (token-valid):
|
1415
|
+
```python
|
1416
|
+
import time
|
1417
|
+
import agilicus_api
|
1418
|
+
from agilicus_api.api import files_api
|
1419
|
+
from agilicus_api.model.public_file_org_link import PublicFileOrgLink
|
1420
|
+
from agilicus_api.model.error_message import ErrorMessage
|
1421
|
+
from pprint import pprint
|
1422
|
+
# Defining the host is optional and defaults to https://api.agilicus.com
|
1423
|
+
# See configuration.py for a list of all supported configuration parameters.
|
1424
|
+
configuration = agilicus_api.Configuration(
|
1425
|
+
host = "https://api.agilicus.com"
|
1426
|
+
)
|
1427
|
+
|
1428
|
+
# The client must configure the authentication and authorization parameters
|
1429
|
+
# in accordance with the API server security policy.
|
1430
|
+
# Examples for each auth method are provided below, use the example that
|
1431
|
+
# satisfies your auth use case.
|
1432
|
+
|
1433
|
+
# Configure Bearer authorization (JWT): token-valid
|
1434
|
+
configuration = agilicus_api.Configuration(
|
1435
|
+
access_token = 'YOUR_BEARER_TOKEN'
|
1436
|
+
)
|
1437
|
+
|
1438
|
+
# Enter a context with an instance of the API client
|
1439
|
+
with agilicus_api.ApiClient(configuration) as api_client:
|
1440
|
+
# Create an instance of the API class
|
1441
|
+
api_instance = files_api.FilesApi(api_client)
|
1442
|
+
public_file_org_link_id = "1234" # str | public file org link id in path
|
1443
|
+
public_file_org_link = PublicFileOrgLink(
|
1444
|
+
metadata=MetadataWithId(),
|
1445
|
+
spec=PublicFileOrgLinkSpec(
|
1446
|
+
file_tag="theme",
|
1447
|
+
link_org_id=None,
|
1448
|
+
target_org_id=None,
|
1449
|
+
),
|
1450
|
+
) # PublicFileOrgLink | The link to update
|
1451
|
+
link_org_id = "1234" # str | Search for the Organisation that is linked to another (optional)
|
1452
|
+
org_id = "1234" # str | Organisation Unique identifier (optional)
|
1453
|
+
|
1454
|
+
# example passing only required values which don't have defaults set
|
1455
|
+
try:
|
1456
|
+
# Replace a public file org link
|
1457
|
+
api_response = api_instance.replace_public_file_org_link(public_file_org_link_id, public_file_org_link)
|
1458
|
+
pprint(api_response)
|
1459
|
+
except agilicus_api.ApiException as e:
|
1460
|
+
print("Exception when calling FilesApi->replace_public_file_org_link: %s\n" % e)
|
1461
|
+
|
1462
|
+
# example passing only required values which don't have defaults set
|
1463
|
+
# and optional values
|
1464
|
+
try:
|
1465
|
+
# Replace a public file org link
|
1466
|
+
api_response = api_instance.replace_public_file_org_link(public_file_org_link_id, public_file_org_link, link_org_id=link_org_id, org_id=org_id)
|
1467
|
+
pprint(api_response)
|
1468
|
+
except agilicus_api.ApiException as e:
|
1469
|
+
print("Exception when calling FilesApi->replace_public_file_org_link: %s\n" % e)
|
1470
|
+
```
|
1471
|
+
|
1472
|
+
|
1473
|
+
### Parameters
|
1474
|
+
|
1475
|
+
Name | Type | Description | Notes
|
1476
|
+
------------- | ------------- | ------------- | -------------
|
1477
|
+
**public_file_org_link_id** | **str**| public file org link id in path |
|
1478
|
+
**public_file_org_link** | [**PublicFileOrgLink**](PublicFileOrgLink.md)| The link to update |
|
1479
|
+
**link_org_id** | **str**| Search for the Organisation that is linked to another | [optional]
|
1480
|
+
**org_id** | **str**| Organisation Unique identifier | [optional]
|
1481
|
+
|
1482
|
+
### Return type
|
1483
|
+
|
1484
|
+
[**PublicFileOrgLink**](PublicFileOrgLink.md)
|
1485
|
+
|
1486
|
+
### Authorization
|
1487
|
+
|
1488
|
+
[token-valid](../README.md#token-valid)
|
1489
|
+
|
1490
|
+
### HTTP request headers
|
1491
|
+
|
1492
|
+
- **Content-Type**: application/json
|
1493
|
+
- **Accept**: application/json
|
1494
|
+
|
1495
|
+
|
1496
|
+
### HTTP response details
|
1497
|
+
| Status code | Description | Response headers |
|
1498
|
+
|-------------|-------------|------------------|
|
1499
|
+
**200** | link updated | - |
|
1500
|
+
**404** | link not found | - |
|
1501
|
+
|
1502
|
+
[[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)
|
1503
|
+
|
1057
1504
|
# **reupload_file**
|
1058
1505
|
> FileSummary reupload_file(file_id, org_id, file_zip)
|
1059
1506
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# ListPublicFileOrgLinksResponse
|
2
|
+
|
3
|
+
The matching public file org links
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
Name | Type | Description | Notes
|
7
|
+
------------ | ------------- | ------------- | -------------
|
8
|
+
**public_file_org_links** | [**[PublicFileOrgLink]**](PublicFileOrgLink.md) | Matching links |
|
9
|
+
**limit** | **int** | Limit of entries in response |
|
10
|
+
**page_at_id** | **str** | The id to request in the pagination query to get the next page. | [optional]
|
11
|
+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
|
12
|
+
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# PublicFileOrgLink
|
2
|
+
|
3
|
+
An link configuring one organisation to use another as a source of truth for public file lookups. File lookups against `link_org_id` and the tag specified in `file_tag` will use the matching file for `target_org_d`. Note that if `target_org_id` also has a link, it will be recursively searched.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
Name | Type | Description | Notes
|
7
|
+
------------ | ------------- | ------------- | -------------
|
8
|
+
**spec** | [**PublicFileOrgLinkSpec**](PublicFileOrgLinkSpec.md) | |
|
9
|
+
**metadata** | [**MetadataWithId**](MetadataWithId.md) | | [optional]
|
10
|
+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
|
11
|
+
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# PublicFileOrgLinkSpec
|
2
|
+
|
3
|
+
Configuration for a PublicFileOrgLink
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
Name | Type | Description | Notes
|
7
|
+
------------ | ------------- | ------------- | -------------
|
8
|
+
**file_tag** | **str** | A file tag |
|
9
|
+
**link_org_id** | **bool, date, datetime, dict, float, int, list, str, none_type** | requests for this org id will be linked to `target_org_id` |
|
10
|
+
**target_org_id** | **bool, date, datetime, dict, float, int, list, str, none_type** | requests for `link_org_id` will be linked to this. |
|
11
|
+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
|
12
|
+
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
14
|
+
|
15
|
+
|