/** * Agilicus API * Agilicus is API-first. Modern software is controlled by other software, is open, is available for you to use the way you want, securely, simply. The OpenAPI Specification in YAML format is available on [www](https://www.agilicus.com/www/api/agilicus-openapi.yaml) for importing to other tools. A rendered, online viewable and usable version of this specification is available at [api](https://www.agilicus.com/api). You may try the API inline directly in the web page. To do so, first obtain an Authentication Token (the simplest way is to install the Python SDK, and then run `agilicus-cli --issuer https://MYISSUER get-token`). You will need an org-id for most calls (and can obtain from `agilicus-cli --issuer https://MYISSUER list-orgs`). The `MYISSUER` will typically be `auth.MYDOMAIN`, and you will see it as you sign-in to the administrative UI. This API releases on Bearer-Token authentication. To obtain a valid bearer token you will need to Authenticate to an Issuer with OpenID Connect (a superset of OAUTH2). Your \"issuer\" will look like https://auth.MYDOMAIN. For example, when you signed-up, if you said \"use my own domain name\" and assigned a CNAME of cloud.example.com, then your issuer would be https://auth.cloud.example.com. If you selected \"use an Agilicus supplied domain name\", your issuer would look like https://auth.myorg.agilicus.cloud. For test purposes you can use our [Python SDK](https://pypi.org/project/agilicus/) and run `agilicus-cli --issuer https://auth.MYDOMAIN get-token`. This API may be used in any language runtime that supports OpenAPI 3.0, or, you may use our [Python SDK](https://pypi.org/project/agilicus/), our [Typescript SDK](https://www.npmjs.com/package/@agilicus/angular), or our [Golang SDK](https://git.agilicus.com/pub/sdk-go). 100% of the activities in our system our API-driven, from our web-admin, through our progressive web applications, to all internals: there is nothing that is not accessible. For more information, see [developer resources](https://www.agilicus.com/developer). * * The version of the OpenAPI document: 2025.12.16 * Contact: dev@agilicus.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { HttpHeaders } from '@angular/common/http'; import { Observable } from 'rxjs'; import { ClearFileAssociationRequest } from '../model/models'; import { ClearFileAssociationResponse } from '../model/models'; import { FileAssociation } from '../model/models'; import { FileSummary } from '../model/models'; import { FileTemplate } from '../model/models'; import { FileTemplateRenderRequest } from '../model/models'; import { FileVisibility } from '../model/models'; import { ListFileAssociationsResponse } from '../model/models'; import { ListFileTemplatesResponse } from '../model/models'; import { ListFilesResponse } from '../model/models'; import { ListPublicFileOrgLinksResponse } from '../model/models'; import { ModelFile } from '../model/models'; import { ObjectOperStatus } from '../model/models'; import { PublicFileOrgLink } from '../model/models'; import { StorageRegion } from '../model/models'; import { Configuration } from '../configuration'; export interface AddFileRequestParams { name: string; file_zip: Blob; org_id?: string; tag?: string; label?: string; region?: StorageRegion; visibility?: FileVisibility; md5_hash?: string; } export interface CreateFileAssociationRequestParams { FileAssociation: FileAssociation; } export interface CreateFileAssociationClearTaskRequestParams { ClearFileAssociationRequest: ClearFileAssociationRequest; } export interface CreateFileTemplateRequestParams { FileTemplate: FileTemplate; } export interface CreatePublicFileOrgLinkRequestParams { PublicFileOrgLink: PublicFileOrgLink; } export interface DeleteFileRequestParams { file_id: string; org_id?: string; } export interface DeleteFileAssociationRequestParams { file_association_id: string; org_id?: string; } export interface DeleteFileTemplateRequestParams { file_template_id: string; org_id?: string; } export interface DeletePublicFileOrgLinkRequestParams { public_file_org_link_id: string; link_org_id?: string; org_id?: string; } export interface GetDownloadRequestParams { file_id: string; org_id?: string; } export interface GetDownloadPublicRequestParams { subdomain?: string; label?: string; tag?: string; file_in_zip?: string; } export interface GetFileRequestParams { file_id: string; org_id?: string; } export interface GetFileAssociationRequestParams { file_association_id: string; org_id?: string; } export interface GetFileTemplateRequestParams { file_template_id: string; org_id?: string; } export interface GetPublicFileOrgLinkRequestParams { public_file_org_link_id: string; link_org_id?: string; org_id?: string; } export interface ListFileAssociationsRequestParams { limit?: number; org_id?: string; file_id?: string; object_id?: string; } export interface ListFileTemplatesRequestParams { limit?: number; page_at_id?: string; org_id?: string; purpose?: string; object_types?: Array; object_ids?: Array; } export interface ListFilesRequestParams { limit?: number; org_id?: string; user_id?: string; tag?: string; file_association_id?: string; object_oper_status?: ObjectOperStatus; has_been_associated?: boolean; } export interface ListPublicFileOrgLinksRequestParams { limit?: number; link_org_id?: string; org_id?: string; tag?: string; page_at_id?: string; } export interface RenderFileTemplateRequestParams { file_template_id: string; FileTemplateRenderRequest: FileTemplateRenderRequest; } export interface ReplaceFileRequestParams { file_id: string; ModelFile: ModelFile; org_id?: string; } export interface ReplaceFileTemplateRequestParams { file_template_id: string; FileTemplate?: FileTemplate; } export interface ReplacePublicFileOrgLinkRequestParams { public_file_org_link_id: string; PublicFileOrgLink: PublicFileOrgLink; link_org_id?: string; org_id?: string; } export interface ReuploadFileRequestParams { file_id: string; org_id: string; file_zip: Blob; } export interface FilesServiceInterface { defaultHeaders: HttpHeaders; configuration: Configuration; /** * upload a file * Upload a file * @param requestParameters */ addFile(requestParameters: AddFileRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * associate a file with an object * associate a file with an objet * @param requestParameters */ createFileAssociation(requestParameters: CreateFileAssociationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Cleans up file associations * Cleans up file associations, potentially marking files for garbage collection * @param requestParameters */ createFileAssociationClearTask(requestParameters: CreateFileAssociationClearTaskRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Add a file template * Adds a new file template. * @param requestParameters */ createFileTemplate(requestParameters: CreateFileTemplateRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * link public files based on org * links public files based on organisation and tag * @param requestParameters */ createPublicFileOrgLink(requestParameters: CreatePublicFileOrgLinkRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Delete a File * Delete a File * @param requestParameters */ deleteFile(requestParameters: DeleteFileRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove an association from a file * Remove an association from a file * @param requestParameters */ deleteFileAssociation(requestParameters: DeleteFileAssociationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Delete a file template * Delete a file template * @param requestParameters */ deleteFileTemplate(requestParameters: DeleteFileTemplateRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Remove a link from an org * Remove a link from an org. Note that link_org_id and org_id are alises for one another in this query. * @param requestParameters */ deletePublicFileOrgLink(requestParameters: DeletePublicFileOrgLinkRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable<{}>; /** * Download File * Download File * @param requestParameters */ getDownload(requestParameters: GetDownloadRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Download public file * Download public file * @param requestParameters */ getDownloadPublic(requestParameters: GetDownloadPublicRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get File metadata * Get File metadata * @param requestParameters */ getFile(requestParameters: GetFileRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a file association * Get a file association * @param requestParameters */ getFileAssociation(requestParameters: GetFileAssociationRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a file template * Get a file template * @param requestParameters */ getFileTemplate(requestParameters: GetFileTemplateRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Get a public file org link * Get a public file org link. Note that link_org_id and org_id are alises for one another in this query. * @param requestParameters */ getPublicFileOrgLink(requestParameters: GetPublicFileOrgLinkRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Query File Associations * Query File Associations * @param requestParameters */ listFileAssociations(requestParameters: ListFileAssociationsRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * List all file templates * List all file templates matching the provided query parameters. Perform keyset pagination by setting the page_at_id parameter to the id for the next page to fetch. Set it to `\"\"` to start from the beginning. * @param requestParameters */ listFileTemplates(requestParameters: ListFileTemplatesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Query Files * Query Files * @param requestParameters */ listFiles(requestParameters: ListFilesRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Query Public File Org Links * Query Public File Org Links. Note that link_org_id and org_id are alises for one another in this query. * @param requestParameters */ listPublicFileOrgLinks(requestParameters: ListPublicFileOrgLinksRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Render a file template * Renders a file template, applying the static and request arguments to the contents of the template. If the backing file does not exist, this will return a 404 indicating so. If the input is missing a required parameter, this will return a 400. * @param requestParameters */ renderFileTemplate(requestParameters: RenderFileTemplateRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Update a file * Update a file * @param requestParameters */ replaceFile(requestParameters: ReplaceFileRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * update a file template * update a file template * @param requestParameters */ replaceFileTemplate(requestParameters: ReplaceFileTemplateRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Replace a public file org link * Replace a public file org link * @param requestParameters */ replacePublicFileOrgLink(requestParameters: ReplacePublicFileOrgLinkRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; /** * Upload a new version of a file * Replace a file entirely by uploading new contents * @param requestParameters */ reuploadFile(requestParameters: ReuploadFileRequestParams, observe?: any, extraHeaders?: HttpHeaders): Observable; }