UNPKG

files.com

Version:
81 lines (56 loc) 1.19 kB
# Style ## Example Style Object ``` { "id": 1, "path": "example", "logo": "https://mysite.files.com/...", "thumbnail": { "name": "My logo", "uri": "https://mysite.files.com/.../my_image.png" } } ``` * `id` (int64): Style ID * `path` (string): Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters. * `logo` (Image): Logo * `thumbnail` (Image): Logo thumbnail * `file` (file): Logo for custom branding. --- ## Show Style ``` await Style.find(path) ``` ### Parameters * `path` (string): Required - Style path. --- ## Update Style ``` const style = await Style.find(path) await style.update({ 'file': "file", }) ``` ### Parameters * `path` (string): Required - Style path. * `file` (file): Required - Logo for custom branding. ### Example Response ```json { "id": 1, "path": "example", "logo": "https://mysite.files.com/...", "thumbnail": { "name": "My logo", "uri": "https://mysite.files.com/.../my_image.png" } } ``` --- ## Delete Style ``` const style = await Style.find(path) await style.delete() ``` ### Parameters * `path` (string): Required - Style path.