/** * 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 { ResourceConfig } from './resourceConfig'; import { NetworkMountRuleConfig } from './networkMountRuleConfig'; export interface _FileShareServiceSpec { /** * The name of the service. This uniquely identifies the service within the organisation. */ name: string; /** * A human readable slug to identify a resource and that is rfc1035 label compliant. The length has been restricted to 20 characters such that this name can be concatenated with other names or slugs. A slug is readOnly as it is generated by the backend resource. */ name_slug?: string; /** * The name of the share as exposed to the Internet. This will be used to build the URI used to mount the share. The share_name is unique among the file shares of the organisation. */ share_name: string; /** * Unique identifier */ org_id: string; /** * The path to the directory to share on the local file system. This should point to a directory, not a file. Use a slash (\'/\', U+002F) to separate directories within the path. */ local_path: string; /** * Unique identifier */ connector_id: string; /** * The index of the FileShareService. This is used to construct a unique URI at which to access this FileShareService. */ share_index?: number; /** * Whether or not the FileShareService encrypts data using the same Transport Layer Security (TLS) session as seen by the client. Setting this to true will cause the FileShareService to provision a Certificate signed by a private key only known to it. All traffic to and from the FileShareService will be encrypted using a TLS session derived from that Certificate. Setting this to false will cause the FileShareService to use a TLS session derived from a Certificate provisioned by the Agilicus Cloud. */ transport_end_to_end_tls?: boolean; /** * The base domain from which to access this share. The file share endpoint will be \"https://share-$(share_index).$(base_domain)\" */ transport_base_domain?: string; /** * Enable file acl permissions on the agent\'s host. This option enables fine grained control of individual files based on a user\'s specific groups and access level */ file_level_access_permissions?: boolean; /** * The configuration to determine where this share should be used automatically. Use this field to set up clients to mount a share automatically. */ client_config?: Array; resource_config?: ResourceConfig; /** * The subpath extending the local file system which is being shared, supporting vars expansion */ sub_path?: string; } export interface FileShareServiceSpec extends _FileShareServiceSpec { _builtin_original?: _FileShareServiceSpec; _remove_builtin_extensions?: () => void; } export declare class FileShareServiceSpecImpl implements _FileShareServiceSpec { _builtin_original?: _FileShareServiceSpec; name: string; name_slug: string | undefined; share_name: string; org_id: string; local_path: string; connector_id: string; share_index: number | undefined; transport_end_to_end_tls: boolean | undefined; transport_base_domain: string | undefined; file_level_access_permissions: boolean | undefined; client_config: Array | undefined; resource_config: ResourceConfig | undefined; sub_path: string | undefined; constructor(base: _FileShareServiceSpec); _remove_builtin_extensions(): void; } export declare function newFileShareServiceSpecImpl(base: _FileShareServiceSpec): FileShareServiceSpecImpl;