Skip to content

FilesApi.md

Latest commit

 

History

History
1231 lines (940 loc) · 44.2 KB

FilesApi.md

File metadata and controls

1231 lines (940 loc) · 44.2 KB
Raw

xero_python.file.FilesApi

All URIs are relative to https://api.xero.com/files.xro/1.0

Method HTTP request Description
create_file_association POST /Files/{FileId}/Associations Creates a new file association
create_folder POST /Folders Creates a new folder
delete_file DELETE /Files/{FileId} Deletes a specific file
delete_file_association DELETE /Files/{FileId}/Associations/{ObjectId} Deletes an existing file association
delete_folder DELETE /Folders/{FolderId} Deletes a folder
get_associations_by_object GET /Associations/{ObjectId} Retrieves an association object using a unique object ID
get_associations_count GET /Associations/Count Retrieves a count of associations for a list of objects.
get_file GET /Files/{FileId} Retrieves a file by a unique file ID
get_file_associations GET /Files/{FileId}/Associations Retrieves a specific file associations
get_file_content GET /Files/{FileId}/Content Retrieves the content of a specific file
get_files GET /Files Retrieves files
get_folder GET /Folders/{FolderId} Retrieves specific folder by using a unique folder ID
get_folders GET /Folders Retrieves folders
get_inbox GET /Inbox Retrieves inbox folder
update_file PUT /Files/{FileId} Update a file
update_folder PUT /Folders/{FolderId} Updates an existing folder
upload_file POST /Files Uploads a File to the inbox
upload_file_to_folder POST /Files/{FolderId} Uploads a File to a specific folder

create_file_association

Association create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key)

Creates a new file association

By passing in the appropriate options, you can create a new folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
association = { "ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectGroup": "Contact", "ObjectType": "Business" } # Association | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
try:
    # Creates a new file association
    api_response = api_instance.create_file_association(xero_tenant_id, file_id, association, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_file_association: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object
association Association
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]

Return type

Association

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_folder

Folder create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key)

Creates a new folder

By passing in the appropriate properties, you can create a new folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
folder = { "Name": "My Docs" } # Folder | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
try:
    # Creates a new folder
    api_response = api_instance.create_folder(xero_tenant_id, folder, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->create_folder: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
folder Folder
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]

Return type

Folder

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_file

delete_file(xero_tenant_id, file_id)

Deletes a specific file

Delete a specific file

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi


# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
try:
    # Deletes a specific file
    api_instance.delete_file(xero_tenant_id, file_id)
except ApiException as e:
    print("Exception when calling FilesApi->delete_file: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_file_association

delete_file_association(xero_tenant_id, file_id, object_id)

Deletes an existing file association

By passing in the appropriate options, you can create a new folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi


# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Object id for single object
try:
    # Deletes an existing file association
    api_instance.delete_file_association(xero_tenant_id, file_id, object_id)
except ApiException as e:
    print("Exception when calling FilesApi->delete_file_association: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object
object_id str Object id for single object

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_folder

delete_folder(xero_tenant_id, folder_id)

Deletes a folder

By passing in the appropriate ID, you can delete a folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi


# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Folder id for single object
try:
    # Deletes a folder
    api_instance.delete_folder(xero_tenant_id, folder_id)
except ApiException as e:
    print("Exception when calling FilesApi->delete_folder: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
folder_id str Folder id for single object

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_associations_by_object

list[Association] get_associations_by_object(xero_tenant_id, object_id, pagesize=pagesize, page=page, sort=sort, direction=direction)

Retrieves an association object using a unique object ID

By passing in the appropriate options, you can retrieve an association

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
object_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Object id for single object
pagesize = 50 # int | pass an optional page size value (optional)
page = 2 # int | number of records to skip for pagination (optional)
sort = 'Associations/{ObjectId}?sort=CreatedDateUtc' # str | values to sort by (optional)
direction = 'Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC' # str | direction to sort by (optional)
try:
    # Retrieves an association object using a unique object ID
    api_response = api_instance.get_associations_by_object(xero_tenant_id, object_id, pagesize=pagesize, page=page, sort=sort, direction=direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_associations_by_object: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
object_id str Object id for single object
pagesize int pass an optional page size value [optional]
page int number of records to skip for pagination [optional]
sort str values to sort by [optional]
direction str direction to sort by [optional]

Return type

list[Association]

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_associations_count

object get_associations_count(xero_tenant_id, object_ids)

Retrieves a count of associations for a list of objects.

By passing in the appropriate options, you can retrieve the association count for objects

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
object_ids = ['object_ids_example'] # list[str] | A comma-separated list of object ids
try:
    # Retrieves a count of associations for a list of objects.
    api_response = api_instance.get_associations_count(xero_tenant_id, object_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_associations_count: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
object_ids list[str] A comma-separated list of object ids

Return type

object

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_file

FileObject get_file(xero_tenant_id, file_id)

Retrieves a file by a unique file ID

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
try:
    # Retrieves a file by a unique file ID
    api_response = api_instance.get_file(xero_tenant_id, file_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object

Return type

FileObject

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_file_associations

list[Association] get_file_associations(xero_tenant_id, file_id)

Retrieves a specific file associations

By passing in the appropriate options,

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
try:
    # Retrieves a specific file associations
    api_response = api_instance.get_file_associations(xero_tenant_id, file_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_associations: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object

Return type

list[Association]

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_file_content

file get_file_content(xero_tenant_id, file_id)

Retrieves the content of a specific file

By passing in the appropriate options, retrieve data for specific file

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
try:
    # Retrieves the content of a specific file
    api_response = api_instance.get_file_content(xero_tenant_id, file_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_file_content: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object

Return type

file

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_files

Files get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort, direction=direction)

Retrieves files

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
pagesize = 50 # int | pass an optional page size value (optional)
page = 2 # int | number of records to skip for pagination (optional)
sort = 'CreatedDateUTC' # str | values to sort by (optional)
direction = 'ASC' # str | sort direction (optional)
try:
    # Retrieves files
    api_response = api_instance.get_files(xero_tenant_id, pagesize=pagesize, page=page, sort=sort, direction=direction)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_files: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
pagesize int pass an optional page size value [optional]
page int number of records to skip for pagination [optional]
sort str values to sort by [optional]
direction str sort direction [optional]

Return type

Files

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_folder

Folder get_folder(xero_tenant_id, folder_id)

Retrieves specific folder by using a unique folder ID

By passing in the appropriate ID, you can search for specific folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Folder id for single object
try:
    # Retrieves specific folder by using a unique folder ID
    api_response = api_instance.get_folder(xero_tenant_id, folder_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_folder: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
folder_id str Folder id for single object

Return type

Folder

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_folders

list[Folder] get_folders(xero_tenant_id, sort=sort)

Retrieves folders

By passing in the appropriate options, you can search for available folders

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
sort = 'CreatedDateUTC DESC' # str | values to sort by (optional)
try:
    # Retrieves folders
    api_response = api_instance.get_folders(xero_tenant_id, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_folders: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
sort str values to sort by [optional]

Return type

list[Folder]

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_inbox

Folder get_inbox(xero_tenant_id)

Retrieves inbox folder

Search for the user inbox

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
try:
    # Retrieves inbox folder
    api_response = api_instance.get_inbox(xero_tenant_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->get_inbox: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant

Return type

Folder

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_file

FileObject update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key)

Update a file

Updates file properties of a single file

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
file_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | File id for single object
file_object = { "FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3" } # FileObject | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
try:
    # Update a file
    api_response = api_instance.update_file(xero_tenant_id, file_id, file_object, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_file: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
file_id str File id for single object
file_object FileObject
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]

Return type

FileObject

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_folder

Folder update_folder(xero_tenant_id, folder_id, folder, idempotency_key=idempotency_key)

Updates an existing folder

By passing in the appropriate ID and properties, you can update a folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | Folder id for single object
folder = { "Name": "Your Docs" } # Folder | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
try:
    # Updates an existing folder
    api_response = api_instance.update_folder(xero_tenant_id, folder_id, folder, idempotency_key=idempotency_key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->update_folder: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
folder_id str Folder id for single object
folder Folder
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]

Return type

Folder

Authorization

OAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_file

FileObject upload_file(xero_tenant_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type)

Uploads a File to the inbox

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
body = 'body_example' # str | 
name = 'name_example' # str | exact name of the file you are uploading
filename = 'filename_example' # str | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
mime_type = 'mime_type_example' # str |  (optional)
try:
    # Uploads a File to the inbox
    api_response = api_instance.upload_file(xero_tenant_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->upload_file: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
body str
name str exact name of the file you are uploading
filename str
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]
mime_type str [optional]

Return type

FileObject

Authorization

OAuth2

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_file_to_folder

FileObject upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type)

Uploads a File to a specific folder

Example

  • OAuth Authentication (OAuth2):
from xero_python.api_client import Configuration, ApiClient
from xero_python.api_client.oauth2 import OAuth2Token
from xero_python.exceptions import ApiException
from xero_python.file import FilesApi
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
# simplified version, `xero_oauth2_token` represents permanent global token storage
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
# create client configuration with client id and client secret for automatic token refresh
api_config = Configuration(oauth2_token=OAuth2Token(
    client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
))
# configure xero-python sdk client
api_client = ApiClient(
    api_config,
    oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
    oauth2_token_getter=lambda : xero_oauth2_token
)
# create an instance of the API class
api_instance = FilesApi(api_client)

xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
folder_id = '4ff1e5cc-9835-40d5-bb18-09fdb118db9c' # str | pass required folder id to save file to specific folder
body = 'body_example' # str | 
name = 'name_example' # str | exact name of the file you are uploading
filename = 'filename_example' # str | 
idempotency_key = 'KEY_VALUE' # str | This allows you to safely retry requests without the risk of duplicate processing. 128 character max. (optional)
mime_type = 'mime_type_example' # str |  (optional)
try:
    # Uploads a File to a specific folder
    api_response = api_instance.upload_file_to_folder(xero_tenant_id, folder_id, body, name, filename, idempotency_key=idempotency_key, mime_type=mime_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilesApi->upload_file_to_folder: %s\n" % e)

Parameters

Name Type Description Notes
xero_tenant_id str Xero identifier for Tenant
folder_id str pass required folder id to save file to specific folder
body str
name str exact name of the file you are uploading
filename str
idempotency_key str This allows you to safely retry requests without the risk of duplicate processing. 128 character max. [optional]
mime_type str [optional]

Return type

FileObject

Authorization

OAuth2

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]