swagger

package module

v0.0.0-...-2b143c3 Latest Latest Go to latest Published: Aug 27, 2020 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kimonocloud/evapi-go

README ¶

Go API client for swagger

Introduction Welcome to the ExaVault API documentation. Our API lets you control nearly all aspects of your ExaVault account programatically, from uploading and downloading files to creating and managing shares and notifications. Capabilities of the API include - Uploading and downloading files. - Managing files and folders, including standard operations like move, copy and delete. - Getting information about activity occuring in your account. - Creating, updating and deleting users. - Creating and managing shares, including download-only shares and receive folders. - Setting up and managing notifications. The ExaVault API v2.0 is a RESTful API using JSON. ## The API URL You will access your account from your server address. For example, if your account is available at exampleaccount.exavault.com, you'll connect to the API at https://exampleaccount.exavault.com/api/v2 # Obtaining Your API Key and Access Token Account admins can create API Keys and personal access tokens within the ExaVault File Manager web application. ## Create an API Key 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 2. Click on the My Account option in the left-hand sidebar 3. Click on the Developer tab 4. Click the + button next to the table of API Keys to create a new key 5. Enter a name that will uniquely identify connections using this key. This name will appear in your activity session logs. 6. Enter a description with any other information that you need to track the purpose of your API key 7. Save the new key As soon as you save a new API key, you'll be prompted to create a personal access token which will allow a specific user to connect via the API using that API key (jump to step 5 in the instructions below) ## Generate an Access Token 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 1. Click on the My Account option in the left-hand sidebar 1. Click on the Developer tab 1. Click the + button next to the table of Access Tokens to create a new token 1. Select the API Key from the first dropdown. 1. Select the user who will use this token from the second dropdown. 1. Click the GENERATE TOKEN button The confirmation popup will display your API key and your access token. Copy this access token to a safe location (such as a password vault) immediately. Once you close this popup, you will not be able to see the token again. After you have saved your token securely, click CLOSE to close the popup. The access token you have created will allow any program using that token and its API key to masquerade as the associated user. You should keep the token safe. # Authentication The ExaVault API uses the combination of an API key and a persistent access token to authenticate a user. Both the API key and the access token can be created by an admin-level user Each request made to the API must include 2 headers | Header Name | Contains | | --- | :---: | | ev-api-key | Your API key | | ev-access-token | Your access token | The access token uniquely identifies the user account for the connection. You should keep this token secure. # HTTP Status Codes The ExaVault API v2.0 is RESTful and returns appropriate HTTP status codes in its responses Success Statuses: | Status | Notes | | --- | :---: | | 200 | Successful operation | | 201 | Successful creation operation | | 207 | Multiple operation status | Request Error Statuses: | Status | Notes | | --- | :---: | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found* | | 429 | Too many requests | Server Error Statuses: | Status | Notes | | --- | --- | | 500 | Server Error | | 503 | Service unavailable | # Response Format Nearly every response from the server will be a JSON object, which will contain a `responseStatus` attribute that matches the HTTP status of the response. Most succesful responses will also include a `data` attribute that contains the data related to your request. For instance using GET /account will return the information for the account associated with your API key and access token. ## Error Responses Error responses will have a similar format. The response will contain a `responseStatus` which contains the HTTP status code and an `errors` array, which will contain pertinent errors for the request. Each object in the `errors` array will contain a human-readable `code` and some explanatory `detail` text. ## Common Errors As you work with our suite of APIs, you'll likely encounter one or more of these error codes throughout the process. Let's take a look at some of the most common errors and how to resolve them quickly and painlessly. ### 400 Error - Bad Request: `json { \"responseStatus\":400, \"errors\":[ { \"code\":\"ERROR_INVALID_PARAMETER\", \"detail\":\"Destination path cannot be an existing folder.\" } ] }` `json { \"responseStatus\": 400, \"errors\": [ { \"code\": \"ERROR_INVALID_PASSWORD\", \"detail\": \"Password must be longer than eight (8) characters and contain one uppercase letter, one lowercase letter, and one number.\" } ] }` This error will generally mean a paramater or body element is invalid or missing. We suggest taking another look at the documentation of the API endpoint you're hitting to double check for; missing required fields in the request, spelling errors, invalid values be used. The error messaging returned should point you exactly to what you need to correct to avoid going through trial and error. ### 401 Error - Unauthorized `json { \"responseStatus\": 401, \"errors\": [ { \"code\": \"ERROR_INVALID_CREDENTIALS\", \"detail\": \"HTTP_UNAUTHORIZED\" } ] }` If you encounter a 401, it means we're not recognizing the credentials you're attempting to authenticate with. To resolve the issue; 1. Double check that your credenitals (API Key and Access Token) are correct. 2. Creating a second set of credentials (see "Obtaining Your API Key and Access Token" above) and attempt the call again. 3. If you're able to successfully make a call, regenerate the Access Token of the first user and try the call one last time. If you're still encountering a 401, contact us for help. ### 403 Error - Forbidden `json { \"responseStatus\": 403, \"errors\": [ { \"code\": \"ERROR_INSUFFICIENT_PRIVILEGES\", \"detail\": \"An error occurred\" } ] }` Similarly to a 401, you'll be unable to complete an API call if you encounter this error. Unlike a 401, your credentials were authenticated, but the authenticated user does not have permission to perform the action you're attempting. To resolve the issue you can either; - Execute the call using an master user's credentials. - Log in to the ExaVault File Manager OR use the PATCH /updateUser endpoint to update the user's permissions. ### 404 Error - Not Found `json { \"responseStatus\": 404, \"errors\": [ { \"code\": \"ERROR_SHARE_NOT_FOUND\", \"detail\": \"Share not found\" } ] }` Encountering a 404 error means whatever type of resource you're attempting to find or update; isn't being found. Usually, this is just a case of using the wrong ID when using a call, and can be resolved by fixing the ID on your call. If the ID on the call appears to be correct we recommend taking the following steps: - Attempt a more generic GET call to get a list of the type of resource you're looking for to see if you can find the ID you're looking for. - Check your activity logs to see if what you're looking for was recently deleted. # Identifying Resources Many API methods require you to provide one or more resources, which may be expressed as paths, ids, hashes, or some combination of the three (for calls that act upon multiple resources). To specify a resource by path, provide a fully qualified string to the resource relative to the associated user's home directory. This path will always begin with a forward slash. Only forward slash characters may be used to separate the folders within a path string. To specify a resource by ID, you'll need to obtain that ID from some other API method first. For example, GET /resources/list will return a list of resources in your account along with their IDs. Once you have the ID of that resource, append it to the string "id:" to specify that resource, such as `id:124447`. IDs are always whole-number numeric values. To specify a resource by hash, first obtain the hash from another API method. Once you have the hash representing the resource, append it to the string "hash:" to specify that resource, such as `hash:3a1597ca982231f6666c75bcc2bd9c85` to indicate the resource with the hash value 3a1597ca982231f6666c75bcc2bd9c85. Hashes are always an alphanumeric sequence without any special characters or punctuation. ## Paths and Home Folders Users with different home folders will use different paths to refer to the same resource. As an example, suppose there is a file located at _/Data/Production/Inbound/1595978053_G12.xml. For an admin-level user, or any user whose home folder permits them access to the entire account, the path for that resource is _/Data/Production/Inbound/1595978053_G12.xml. For a user whose home folder is /Data/Production/, the path to the file becomes _/Inbound/1595978053_G12.xml # Transaction Limits The daily transaction limit restricts the overall number of operations you can perform in a 24-hour period in your ExaVault account. Those transactions could be file uploads, file downloads, making a shared folder, creating a user, deleting files, to name a few examples. All operations performed in your account count against the total daily transactions for your account, including: - FTP/SFTP operations - Actions by users who are logged into your web interface - Interacting with Receive folders - Receiving files through Send files and Shared Folders - Accessing files shared through direct links - API access from any user using any of the API keys for your account Each request sent to the API is one transaction. When your account has exceeded its rolling 24-hour rate limit, new operations will become available once the number of operations in the past 24-hours is below your daily rate limit. The response status of rate-limited API operations will be 429. ## Rate Limit Headers To monitor your daily account transaction usage, the response object returned by the server for all API requests will include these custom headers: - X-RateLimit-Limit indicates the total number of operations permitted within a rolling 24-hour period across your entire account. This number is dependent upon the plan your account is subscribed to, and whether you have an enterprise agreement in place. - X-RateLimit-Remaining indicates the number of operations currently remaning to you at that moment in time. # Webhooks ExaVault provides a webhook system for notifying you of changes to your account. The webhook sender will send a POST request to an endpoint you have specified whenever certain actions happen within your account. Account administrators can change these settings within the ExaVault File Manager. Webhooks will attempt to send a message up to 8 times with increasing timeouts between each attempt. All webhook requests are tracked in the webhooks log within the ExaVault File Manager web interface. ## Configuring Webhooks 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password. 1. Click on the My Account option in the left-hand sidebar. 1. Click on the Developer tab 1. Add the URL where your webhook listener can receive requests 1. Check the boxes for the actions which should trigger your webhook. 1. Scroll to the bottom of the page to click SAVE SETTINGS. ## Verification Signature When you configure a webhook endpoint and triggering actions, a Verification Token will be displayed below the webhook endpoint URL. You may use this token in combination with the X-Exavault-Signature header to verify that ExaVault is the sender of the webhook request. ## Comparing the Signature You'll can use this 3-step procedure to validate an individual webhook request to ensure it was sent by ExaVault. 1: Get Verification Token In order to verify the X-Exavault-Signature header value, you'll first need to obtain the Verification Token for your account: 1. Click on the My Account option in the left-hand sidebar. 1. Click on the Developer tab 1. Copy the Verification Token that appears below the Webhooks Endpoint url field. Every webhook request sent to your endpoint URL will use the same verification token. This token won't change for your account. 2: Concatenate Token and Request Once you have the verification token, you'll concatenate that token along with the raw string representing the request body that was received. Do not convert the request body to any other type of object; if the library you're using automatically converts the request body to an object, look for a method to obtain the raw request body as text. 3: Calculate MD5 Hash Calculate the md5 hash of that concatenation. The result should match the contents of your X-Exavault-Signature header. ## Webhook Request Examples The following examples demonstrate the structure of webhook requests and how to validate the verification signature for an individual request. All of these examples will use the same verification token; you'll need to use the token for your account to do the same checks on your own webhook requests. User Connect Example | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | 6e13eb14edfd0bd54feff96be131e155 | `json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Connect\",\"protocol\":\"web\",\"path\":\"\",\"sourcepath\":\"\",\"attempt\":1}` User Disconnect Example | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | 186e8c73793666c8b5cfa0b55eee691d | `json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Disconnect\",\"protocol\":\"web\",\"path\":\"\",\"sourcepath\":\"\",\"attempt\":1}` File Upload Example | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | e86119ce1b679c7b6010d9ac9a843a36 | `json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Upload\",\"protocol\":\"web\",\"path\":\"/7df2beb1c50a8a066493ee47669a4319.jpg\",\"sourcepath\":\"\",\"attempt\":1}` ## Webhooks Logs Account administrators can track all of the webhook requests sent for your account within the ExaVault File Manager web interface. To access Webhook logs: 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 1. Click on the Activity option in the left-hand sidebar 1. Click on Webhooks Logs The webhook logs will show each time a webhook request was sent to your endpoint URL. The following information is recorded for each request: - date and time - when the system sent the request - endpoint url - where the webhook request was sent - event - what triggered the webhook - status - HTTP status or curl error code returned by the webhook endpoint - attempt - how many times this request has been sent - response size - size of the response from your webhook endpoint - details - the response body returned from your webhook endpoint

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://accountname.exavault.com/api/v2

Class	Method	HTTP request	Description
AccountApi	GetAccount	Get /account	Get account settings
AccountApi	PatchAccount	Patch /account	Update account settings
ActivityApi	GetActivityLogs	Get /activity/session	Get activity logs
ActivityApi	GetWebhookLogs	Get /activity/webhooks	Get webhook logs
EmailApi	PostEmailReferral	Post /email/referral	Send referral email to a given address
EmailApi	PostEmailWelcomeUsername	Post /email/welcome/{username}	Resend welcome email to specific user
EmailListsApi	DeleteEmailList	Delete /email-lists/{id}	Delete an email list with given id
EmailListsApi	GetEmailLists	Get /email-lists	Get all email groups
EmailListsApi	GetEmailListsId	Get /email-lists/{id}	Get individual email list
EmailListsApi	PatchEmailList	Patch /email-lists/{id}	Update an email list
EmailListsApi	PostEmailLists	Post /email-lists	Create new email list
FormApi	AddFormMessage	Post /forms/entries/{shareHash}/{entryId}/{nodeId}	Add a form submission
FormApi	FormEntries	Post /forms/{shareHash}/entries	Add user data to a form
FormApi	FormsEntriesCompleteEntryIdPost	Post /forms/entries/complete-entry/{id}
FormApi	FormsEntriesIdDelete	Delete /forms/entries/{id}
FormApi	FormsEntriesIdGet	Get /forms/entries/{id}
FormApi	GetForms	Get /forms	Get form data for a receive folder
FormApi	GetFormsId	Get /forms/{id}	Get form details
FormApi	UpdateForm	Patch /forms/{id}	Updates a form with given parameters
NotificationsApi	NotificationsGet	Get /notifications	Get a list of notifications
NotificationsApi	NotificationsIdDelete	Delete /notifications/{id}	Delete a notification
NotificationsApi	NotificationsIdGet	Get /notifications/{id}	Get a notification's metadata
NotificationsApi	NotificationsIdPatch	Patch /notifications/{id}	Update a notification
NotificationsApi	NotificationsPost	Post /notifications	Create a new notification
NotificationsApi	NotificationsUnsubscribePost	Post /notifications/unsubscribe	Unsubscribe an email from a notification
RecipientsApi	DeleteRecipientsSharesEmail	Delete /recipients/shares/{email}	Delete a share recipient from all shares
RecipientsApi	DeleteRecipientsSharesShareIdEmail	Delete /recipients/shares/{shareId}/{email}	Delete a share recipient from a single share
RecipientsApi	GetRecipients	Get /recipients	Get share recipient emails
RecipientsApi	PostRecipientsSharesInvitesShareId	Post /recipients/shares/invites/{shareId}	Resend invitations to share recipients
ResourcesApi	CompressFiles	Post /resources/compress	Compress resources
ResourcesApi	CopyResources	Post /resources/copy	Copy resources
ResourcesApi	CreateFolder	Post /resources	Create a folder
ResourcesApi	DeleteResource	Delete /resources/{id}	Delete a Resource
ResourcesApi	DeleteResources	Delete /resources	Delete Resources
ResourcesApi	Download	Get /resources/download	Download a file
ResourcesApi	ExtractFiles	Post /resources/extract	Extract resources
ResourcesApi	GetResourceList	Get /resources/list	Get a list of all resources
ResourcesApi	GetResourceProperties	Get /resources/{id}	Get resource metadata
ResourcesApi	GetResourceProperties_0	Get /resources	Get Resource Properties
ResourcesApi	MoveResources	Post /resources/move	Move resources
ResourcesApi	Preview	Get /resources/preview	Preview a file
ResourcesApi	ResourcesIdPatch	Patch /resources/{id}	Rename a resource.
ResourcesApi	ResourcesListIdGet	Get /resources/list/{id}	Get a list of resources
ResourcesApi	Upload	Post /resources/upload	Upload a file
ShareApi	GetShares	Get /shares	Get a list of shares
SharesApi	DeleteSharesId	Delete /shares/{id}	Deactivate a share
SharesApi	GetSharesId	Get /shares/{id}	Get a share
SharesApi	PatchSharesId	Patch /shares/{id}	Update a share
SharesApi	PostShares	Post /shares	Creates a share
SharesApi	PostSharesCompleteSendId	Post /shares/complete-send/{id}	Complete send files
UsersApi	CreateUser	Post /users	Create a user
UsersApi	DeleteUser	Delete /users/{id}	Delete a user
UsersApi	GetUser	Get /users/{id}	Get info for a user
UsersApi	GetUsers	Get /users	Get a list of users
UsersApi	UpdateUser	Patch /users/{id}	Update a user
WebhooksApi	GetWebhookLogs	Get /activity/webhooks	Get webhook logs

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Overview ¶

* ExaVault API * * # Introduction Welcome to the ExaVault API documentation. Our API lets you control nearly all aspects of your ExaVault account programatically, from uploading and downloading files to creating and managing shares and notifications. Capabilities of the API include - Uploading and downloading files. - Managing files and folders, including standard operations like move, copy and delete. - Getting information about activity occuring in your account. - Creating, updating and deleting users. - Creating and managing shares, including download-only shares and receive folders. - Setting up and managing notifications. The ExaVault API v2.0 is a RESTful API using JSON. ## The API URL You will access your account from your server address. For example, if your account is available at exampleaccount.exavault.com, you'll connect to the API at https://exampleaccount.exavault.com/api/v2 # Obtaining Your API Key and Access Token Account admins can create API Keys and personal access tokens within the ExaVault File Manager web application. ## Create an API Key 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 2. Click on the **My Account** option in the left-hand sidebar 3. Click on the **Developer** tab 4. Click the + button next to the table of API Keys to create a new key 5. Enter a name that will uniquely identify connections using this key. This name will appear in your activity session logs. 6. Enter a description with any other information that you need to track the purpose of your API key 7. Save the new key As soon as you save a new API key, you'll be prompted to create a personal access token which will allow a specific user to connect via the API using that API key (jump to step 5 in the instructions below) ## Generate an Access Token 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 1. Click on the **My Account** option in the left-hand sidebar 1. Click on the **Developer** tab 1. Click the + button next to the table of Access Tokens to create a new token 1. Select the API Key from the first dropdown. 1. Select the user who will use this token from the second dropdown. 1. Click the **GENERATE TOKEN** button The confirmation popup will display your API key and your access token. **Copy this access token to a safe location (such as a password vault) immediately.** Once you close this popup, you will not be able to see the token again. After you have saved your token securely, click CLOSE to close the popup. The access token you have created will allow any program using that token and its API key to masquerade as the associated user. You should keep the token safe. # Authentication The ExaVault API uses the combination of an API key and a persistent access token to authenticate a user. Both the API key and the access token can be created by an admin-level user Each request made to the API must include 2 headers | Header Name | Contains | | --- | :---: | | **ev-api-key** | Your API key | | **ev-access-token** | Your access token | The access token uniquely identifies the user account for the connection. You should keep this token secure. # HTTP Status Codes The ExaVault API v2.0 is RESTful and returns appropriate HTTP status codes in its responses **Success Statuses:** | Status | Notes | | --- | :---: | | 200 | Successful operation | | 201 | Successful creation operation | | 207 | Multiple operation status | **Request Error Statuses:** | Status | Notes | | --- | :---: | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found* | | 429 | Too many requests | **Server Error Statuses:** | Status | Notes | | --- | --- | | 500 | Server Error | | 503 | Service unavailable | # Response Format Nearly every response from the server will be a JSON object, which will contain a `responseStatus` attribute that matches the HTTP status of the response. Most succesful responses will also include a `data` attribute that contains the data related to your request. For instance using GET /account will return the information for the account associated with your API key and access token. ## Error Responses Error responses will have a similar format. The response will contain a `responseStatus` which contains the HTTP status code and an `errors` array, which will contain pertinent errors for the request. Each object in the `errors` array will contain a human-readable `code` and some explanatory `detail` text. ## Common Errors As you work with our suite of APIs, you'll likely encounter one or more of these error codes throughout the process. Let's take a look at some of the most common errors and how to resolve them quickly and painlessly. ### 400 Error - Bad Request: ```json { \"responseStatus\":400, \"errors\":[ { \"code\":\"ERROR_INVALID_PARAMETER\", \"detail\":\"Destination path cannot be an existing folder.\" } ] } ``` ```json { \"responseStatus\": 400, \"errors\": [ { \"code\": \"ERROR_INVALID_PASSWORD\", \"detail\": \"Password must be longer than eight (8) characters and contain one uppercase letter, one lowercase letter, and one number.\" } ] } ``` This error will generally mean a paramater or body element is invalid or missing. We suggest taking another look at the documentation of the API endpoint you're hitting to double check for; missing required fields in the request, spelling errors, invalid values be used. The error messaging returned should point you exactly to what you need to correct to avoid going through trial and error. ### 401 Error - Unauthorized ```json { \"responseStatus\": 401, \"errors\": [ { \"code\": \"ERROR_INVALID_CREDENTIALS\", \"detail\": \"HTTP_UNAUTHORIZED\" } ] } ``` If you encounter a 401, it means we're not recognizing the credentials you're attempting to authenticate with. To resolve the issue; 1. Double check that your credenitals (API Key and Access Token) are correct. 2. Creating a second set of credentials (see \"Obtaining Your API Key and Access Token\" above) and attempt the call again. 3. If you're able to successfully make a call, regenerate the Access Token of the first user and try the call one last time. If you're still encountering a 401, contact us for help. ### 403 Error - Forbidden ```json { \"responseStatus\": 403, \"errors\": [ { \"code\": \"ERROR_INSUFFICIENT_PRIVILEGES\", \"detail\": \"An error occurred\" } ] } ``` Similarly to a 401, you'll be unable to complete an API call if you encounter this error. Unlike a 401, your credentials were authenticated, but the authenticated user does not have permission to perform the action you're attempting. To resolve the issue you can either; - Execute the call using an master user's credentials. - Log in to the ExaVault File Manager OR use the **PATCH /updateUser** endpoint to update the user's permissions. ### 404 Error - Not Found ```json { \"responseStatus\": 404, \"errors\": [ { \"code\": \"ERROR_SHARE_NOT_FOUND\", \"detail\": \"Share not found\" } ] } ``` Encountering a 404 error means whatever type of resource you're attempting to find or update; isn't being found. Usually, this is just a case of using the wrong ID when using a call, and can be resolved by fixing the ID on your call. If the ID on the call appears to be correct we recommend taking the following steps: - Attempt a more generic GET call to get a list of the type of resource you're looking for to see if you can find the ID you're looking for. - Check your activity logs to see if what you're looking for was recently deleted. # Identifying Resources Many API methods require you to provide one or more resources, which may be expressed as paths, ids, hashes, or some combination of the three (for calls that act upon multiple resources). To specify a resource by path, provide a fully qualified string to the resource _relative to the associated user's home directory_. This path will always begin with a forward slash. Only forward slash characters may be used to separate the folders within a path string. To specify a resource by ID, you'll need to obtain that ID from some other API method first. For example, **GET /resources/list** will return a list of resources in your account along with their IDs. Once you have the ID of that resource, append it to the string \"id:\" to specify that resource, such as `id:124447`. IDs are always whole-number numeric values. To specify a resource by hash, first obtain the hash from another API method. Once you have the hash representing the resource, append it to the string \"hash:\" to specify that resource, such as `hash:3a1597ca982231f6666c75bcc2bd9c85` to indicate the resource with the hash value **3a1597ca982231f6666c75bcc2bd9c85**. Hashes are always an alphanumeric sequence without any special characters or punctuation. ## Paths and Home Folders Users with different home folders will use different paths to refer to the same resource. As an example, suppose there is a file located at **_/Data/Production/Inbound/1595978053_G12.xml**. For an admin-level user, or any user whose home folder permits them access to the entire account, the path for that resource is **_/Data/Production/Inbound/1595978053_G12.xml**. For a user whose home folder is **_/Data/Production/_**, the path to the file becomes **_/Inbound/1595978053_G12.xml** # Transaction Limits The daily transaction limit restricts the overall number of operations you can perform in a 24-hour period in your ExaVault account. Those transactions could be file uploads, file downloads, making a shared folder, creating a user, deleting files, to name a few examples. All operations performed in your account count against the total daily transactions for your account, including: - FTP/SFTP operations - Actions by users who are logged into your web interface - Interacting with Receive folders - Receiving files through Send files and Shared Folders - Accessing files shared through direct links - API access from any user using any of the API keys for your account Each request sent to the API is one transaction. When your account has exceeded its rolling 24-hour rate limit, new operations will become available once the number of operations in the past 24-hours is below your daily rate limit. The response status of rate-limited API operations will be **429**. ## Rate Limit Headers To monitor your daily account transaction usage, the response object returned by the server for all API requests will include these custom headers: - **X-RateLimit-Limit** indicates the total number of operations permitted within a rolling 24-hour period across your entire account. This number is dependent upon the plan your account is subscribed to, and whether you have an enterprise agreement in place. - **X-RateLimit-Remaining** indicates the number of operations currently remaning to you at that moment in time. # Webhooks ExaVault provides a webhook system for notifying you of changes to your account. The webhook sender will send a POST request to an endpoint you have specified whenever certain actions happen within your account. Account administrators can change these settings within the ExaVault File Manager. Webhooks will attempt to send a message up to 8 times with increasing timeouts between each attempt. All webhook requests are tracked in the webhooks log within the ExaVault File Manager web interface. ## Configuring Webhooks 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password. 1. Click on the **My Account** option in the left-hand sidebar. 1. Click on the **Developer** tab 1. Add the URL where your webhook listener can receive requests 1. Check the boxes for the actions which should trigger your webhook. 1. Scroll to the bottom of the page to click SAVE SETTINGS. ## Verification Signature When you configure a webhook endpoint and triggering actions, a Verification Token will be displayed below the webhook endpoint URL. You may use this token in combination with the X-Exavault-Signature header to verify that ExaVault is the sender of the webhook request. ## Comparing the Signature You'll can use this 3-step procedure to validate an individual webhook request to ensure it was sent by ExaVault. **1: Get Verification Token** In order to verify the X-Exavault-Signature header value, you'll first need to obtain the Verification Token for your account: 1. Click on the **My Account** option in the left-hand sidebar. 1. Click on the **Developer** tab 1. Copy the Verification Token that appears below the Webhooks Endpoint url field. Every webhook request sent to your endpoint URL will use the same verification token. This token won't change for your account. **2: Concatenate Token and Request** Once you have the verification token, you'll concatenate that token along with the raw string representing the request body that was received. **Do not convert the request body to any other type** of object; if the library you're using automatically converts the request body to an object, look for a method to obtain the raw request body as text. **3: Calculate MD5 Hash** Calculate the md5 hash of that concatenation. The result should match the contents of your X-Exavault-Signature header. ## Webhook Request Examples The following examples demonstrate the structure of webhook requests and how to validate the verification signature for an individual request. All of these examples will use the same verification token; you'll need to use the token for your account to do the same checks on your own webhook requests. **User Connect Example** | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | 6e13eb14edfd0bd54feff96be131e155 | ```json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Connect\",\"protocol\":\"web\",\"path\":\"\",\"sourcepath\":\"\",\"attempt\":1} ``` **User Disconnect Example** | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | 186e8c73793666c8b5cfa0b55eee691d | ```json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Disconnect\",\"protocol\":\"web\",\"path\":\"\",\"sourcepath\":\"\",\"attempt\":1} ``` **File Upload Example** | Verification Token | X-Exavault-Signature header value | | --- | --- | | efb7e0030e6cef1b45d3d74a67881a2b | e86119ce1b679c7b6010d9ac9a843a36 | ```json {\"accountname\":\"exampleaccount\",\"username\":\"exampleaccount\",\"operation\":\"Upload\",\"protocol\":\"web\",\"path\":\"/7df2beb1c50a8a066493ee47669a4319.jpg\",\"sourcepath\":\"\",\"attempt\":1} ``` ## Webhooks Logs Account administrators can track all of the webhook requests sent for your account within the ExaVault File Manager web interface. To access Webhook logs: 1. Log into the ExaVault File Manager at your account name address. i.e., if your account is exampleaccount.exavault.com, go to https://exampleaccount.exavault.com and log in with your username and password 1. Click on the **Activity** option in the left-hand sidebar 1. Click on **Webhooks Logs** The webhook logs will show each time a webhook request was sent to your endpoint URL. The following information is recorded for each request: - date and time - when the system sent the request - endpoint url - where the webhook request was sent - event - what triggered the webhook - status - HTTP status or curl error code returned by the webhook endpoint - attempt - how many times this request has been sent - response size - size of the response from your webhook endpoint - details - the response body returned from your webhook endpoint * * API version: 2.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Account
type Account1
type Account1Attributes
type Account1Relationships
type Account1RelationshipsMasterUser
type Account2
type Account2Attributes
type Account2Relationships
type Account2RelationshipsMasterUser
type AccountAllowedIpRanges
type AccountApiPatchAccountOpts
type AccountApiService
- func (a *AccountApiService) GetAccount(ctx context.Context, evApiKey string, evAccessToken string) (InlineResponse20019, *http.Response, error)
- func (a *AccountApiService) PatchAccount(ctx context.Context, evApiKey string, evAccessToken string, ...) (AccountPublicResponse, *http.Response, error)
type AccountAttributes
type AccountAttributesQuota
type AccountAttributesTrial
type AccountExtendedResponse
type AccountPublic
type AccountPublicAttributes
type AccountPublicResponse
type AccountPublicResponseData
type AccountPublicResponseDataAttributes
type AccountRelationships
type AccountRelationshipsMasterUser
type AccountRelationshipsMasterUserData
type AccountResponse
type ActivityApiGetActivityLogsOpts
type ActivityApiGetWebhookLogsOpts
type ActivityApiService
- func (a *ActivityApiService) GetActivityLogs(ctx context.Context, evApiKey string, evAccessToken string, ...) (SessionActivityResponse, *http.Response, error)
- func (a *ActivityApiService) GetWebhookLogs(ctx context.Context, evApiKey string, evAccessToken string, ...) (WebhooksActivityResponse, *http.Response, error)
type AllOfResourceDeleteMultiResponseObjectResponsesItems
type AllOfResourceMultiResponseDeleteResponsesItems
type AllOfResourceMultiResponseObjectResponsesItems
type AllOfResourceMultiResponseResponsesItems
type AnyOfDirectFileExtendedResponseIncludedItems
type AnyOfFormAttributesElementsItems
type AnyOfFormExtendedResponseAttributesElementsItems
type AnyOfFormResponseAttributesElementsItems
type AnyOfShareExtendedResponseIncludedItems
type AvailableUser
type AvailableUser1
type AvailableUserResponse
type BasicAuth
type Body
type Body1
type Body10
type Body11
type Body12
type Body13
type Body14
type Body15
type Body16
type Body2
type Body3
type Body4
type Body5
type Body6
type Body7
type Body8
type Body9
type BrandingSettings
type BrandingSettings1
type BrandingSettings2
type CallbackSettings
type CallbackSettings1
type CallbackSettings2
type CallbackSettingsTriggers
type Configuration
- func NewConfiguration(pathPrefix string) *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type DirectFile
type DirectFile1
type DirectFile2
type DirectFile2Attributes
type DirectFile2Relationships
type DirectFile2RelationshipsOwnerAccount
type DirectFile2RelationshipsResource
type DirectFile3
type DirectFile3Relationships
type DirectFile3RelationshipsOwnerAccount
type DirectFileAttributes
type DirectFileCollectionExtendedResponse
type DirectFileCollectionResponse
type DirectFileExtendedResponse
type DirectFileRelationships
type DirectFileRelationshipsOwner
type DirectFileRelationshipsResource
type DirectFileResponse
type DownloadPolling
type DownloadPolling1
type DownloadPollingResponse
type DownloadWithPollingResponseObject
type EmailApiPostEmailReferralOpts
type EmailApiService
- func (a *EmailApiService) PostEmailReferral(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse2014, *http.Response, error)
- func (a *EmailApiService) PostEmailWelcomeUsername(ctx context.Context, evAccessToken string, username string, evApiKey string) (InlineResponse2014, *http.Response, error)
type EmailList
type EmailList1
type EmailList2
type EmailList2Attributes
type EmailListAttributes
type EmailListRelationships
type EmailListRelationshipsOwner
type EmailListRelationshipsOwnerData
type EmailListResponse
type EmailListResponse1
type EmailListsApiGetEmailListsOpts
type EmailListsApiPatchEmailListOpts
type EmailListsApiPostEmailListsOpts
type EmailListsApiService
- func (a *EmailListsApiService) DeleteEmailList(ctx context.Context, evAccessToken string, id string, evApiKey string) (InlineResponse2001, *http.Response, error)
- func (a *EmailListsApiService) GetEmailLists(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse200, *http.Response, error)
- func (a *EmailListsApiService) GetEmailListsId(ctx context.Context, evAccessToken string, id string, evApiKey string) (EmailListResponse1, *http.Response, error)
- func (a *EmailListsApiService) PatchEmailList(ctx context.Context, evAccessToken string, evApiKey string, id string, ...) (EmailListsResponse2, *http.Response, error)
- func (a *EmailListsApiService) PostEmailLists(ctx context.Context, evAccessToken string, evApiKey string, ...) (EmailListsResponse1, *http.Response, error)
type EmailListsIncludedResponse
type EmailListsIncludedResponseAttributes
type EmailListsIncludedResponseAttributes1
type EmailListsIncludedResponseRelationships
type EmailListsIncludedResponseRelationships1
type EmailListsIncludedResponseRelationships1HomeResource
type EmailListsIncludedResponseRelationships1OwnerAccount
type EmailListsIncludedResponseRelationshipsOwnerUser
type EmailListsIncludedResponseRelationshipsOwnerUserData
type EmailListsResponse
type EmailListsResponse1
type EmailListsResponse2
type EmailListsResponseAttributes
type EmailListsResponseRelationships
type EmailListsResponseRelationshipsOwnerUser
type EmailListsResponseRelationshipsOwnerUserData
type Error401
type Error401Errors
type Error403
type Error403Errors
type Form
type FormApiFormEntriesOpts
type FormApiFormsEntriesIdGetOpts
type FormApiGetFormsIdOpts
type FormApiGetFormsOpts
type FormApiService
- func (a *FormApiService) AddFormMessage(ctx context.Context, evApiKey string, evAccessToken string, entryId string, ...) (InlineResponse2011, *http.Response, error)
- func (a *FormApiService) FormEntries(ctx context.Context, evApiKey string, shareHash string, ...) (InlineResponse201, *http.Response, error)
- func (a *FormApiService) FormsEntriesCompleteEntryIdPost(ctx context.Context, evApiKey string, id string) (InlineResponse2004, *http.Response, error)
- func (a *FormApiService) FormsEntriesIdDelete(ctx context.Context, evAccessToken string, id string, evApiKey string) (*http.Response, error)
- func (a *FormApiService) FormsEntriesIdGet(ctx context.Context, evAccessToken string, formId string, evApiKey string, ...) (FormDataResponse, *http.Response, error)
- func (a *FormApiService) GetForms(ctx context.Context, evApiKey string, shareHash string, evAccessToken string, ...) (InlineResponse2002, *http.Response, error)
- func (a *FormApiService) GetFormsId(ctx context.Context, evApiKey string, id int32, evAccessToken string, ...) (InlineResponse2003, *http.Response, error)
- func (a *FormApiService) UpdateForm(ctx context.Context, evAccessToken string, evApiKey string, id string, ...) (RegularFormResponse, *http.Response, error)
type FormApiUpdateFormOpts
type FormAttributes
type FormDataResponse
type FormExtendedResponse
type FormExtendedResponseAttributes
type FormField
type FormFieldData
type FormFieldData1
type FormFieldSettings
type FormRelationships
type FormRelationshipsShare
type FormRelationshipsShareData
type FormResponse
type FormResponseAttributes
type FormResponseRelationships
type FormResponseRelationshipsShare
type FormResponseRelationshipsShareData
type FormsidElements
type FormsidSettings
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type InlineResponse200
type InlineResponse2001
type InlineResponse20010
type InlineResponse20011
type InlineResponse20012
type InlineResponse20013
type InlineResponse20014
type InlineResponse20014Data
type InlineResponse20014DataMeta
type InlineResponse20015
type InlineResponse20016
type InlineResponse20017
type InlineResponse20017Meta
type InlineResponse20018
type InlineResponse20018Meta
type InlineResponse20019
type InlineResponse2002
type InlineResponse20020
type InlineResponse20021
type InlineResponse20022
type InlineResponse20023
type InlineResponse2003
type InlineResponse2004
type InlineResponse2005
type InlineResponse2006
type InlineResponse2007
type InlineResponse2008
type InlineResponse2009
type InlineResponse201
type InlineResponse2011
type InlineResponse2012
type InlineResponse2013
type InlineResponse2014
type InlineResponse2015
type InlineResponse2015Data
type InlineResponse201Data
type Message
type Message1
type MessageAttributes
type ModelError
type NotificartionRecipient
type Notification
type Notification1
type NotificationCollectionExtendedResponse
type NotificationCollectionExtendedResponseAttributes
type NotificationCollectionExtendedResponseRelationships
type NotificationCollectionExtendedResponseRelationshipsNode
type NotificationCollectionExtendedResponseRelationshipsOwner
type NotificationCollectionExtendedResponseRelationshipsShare
type NotificationCollectionResponse
type NotificationExtendedResponse
type NotificationRecipient
type NotificationResponse
type NotificationResponseAttributes
type NotificationResponseObject
type NotificationResponseObject1
type NotificationResponseRelationships
type NotificationResponseRelationshipsOwnerUser
type NotificationResponseRelationshipsResource
type NotificationResponseRelationshipsShare
type NotificationsApiNotificationsGetOpts
type NotificationsApiNotificationsIdGetOpts
type NotificationsApiNotificationsIdPatchOpts
type NotificationsApiNotificationsPostOpts
type NotificationsApiNotificationsUnsubscribePostOpts
type NotificationsApiService
- func (a *NotificationsApiService) NotificationsGet(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse2007, *http.Response, error)
- func (a *NotificationsApiService) NotificationsIdDelete(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse2006, *http.Response, error)
- func (a *NotificationsApiService) NotificationsIdGet(ctx context.Context, evAccessToken string, id int32, evApiKey string, ...) (InlineResponse2005, *http.Response, error)
- func (a *NotificationsApiService) NotificationsIdPatch(ctx context.Context, evAccessToken string, evApiKey string, id int32, ...) (NotificationResponseObject, *http.Response, error)
- func (a *NotificationsApiService) NotificationsPost(ctx context.Context, evAccessToken string, evApiKey string, resource string, ...) (NotificationResponseObject1, *http.Response, error)
- func (a *NotificationsApiService) NotificationsUnsubscribePost(ctx context.Context, evApiKey string, evAccessToken string, ...) (*http.Response, error)
type OneOfinlineResponse200
type OneOfinlineResponse2002
type OneOfinlineResponse20020
type OneOfinlineResponse20021
type OneOfinlineResponse2003
type OneOfinlineResponse2005
type OneOfinlineResponse2007
type OneOfinlineResponse2008
type OneOfinlineResponse2009
type PreivewFileResponseObject
type PreviewFile
type PreviewFile1
type PreviewFile1Attributes
type PreviewFile2
type PreviewFileResponse
type RecipientsApiService
- func (a *RecipientsApiService) DeleteRecipientsSharesEmail(ctx context.Context, evAccessToken string, email string, evApiKey string) (InlineResponse20023, *http.Response, error)
- func (a *RecipientsApiService) DeleteRecipientsSharesShareIdEmail(ctx context.Context, evAccessToken string, shareId int32, email string, ...) (InlineResponse20023, *http.Response, error)
- func (a *RecipientsApiService) GetRecipients(ctx context.Context, evAccessToken string, evApiKey string) (InlineResponse20022, *http.Response, error)
- func (a *RecipientsApiService) PostRecipientsSharesInvitesShareId(ctx context.Context, evAccessToken string, shareId int32, evApiKey string) (InlineResponse2015, *http.Response, error)
type RegularFormResponse
type RegularShareResponse
type RegularShareResponse1
type RegularShareResponse2
type ReportResponse
type Resource
type Resource1
type Resource2
type Resource2Attributes
type ResourceAttributes
type ResourceCollectionExtendedResponse
type ResourceCollectionExtendedResponseAttributes
type ResourceCollectionExtendedResponseRelationships
type ResourceCollectionExtendedResponseRelationshipsDirectFile
type ResourceCollectionExtendedResponseRelationshipsNotification
type ResourceCollectionExtendedResponseRelationshipsParentNode
type ResourceCollectionExtendedResponseRelationshipsShare
type ResourceCollectionMetaResponse
type ResourceCollectionMetaResponseMeta
type ResourceCollectionResponse
type ResourceDeleteMultiResponseObject
type ResourceDeleteResponse
type ResourceDeleteResponseData
type ResourceExtendedResponse
type ResourceMultiResponse
type ResourceMultiResponseDelete
type ResourceMultiResponseObject
type ResourceResponse
type ResourceResponseAttributes
type ResourceResponseObject
type ResourceResponseObject1
type ResourceResponseRelationships
type ResourceResponseRelationshipsDirectFile
type ResourceResponseRelationshipsNotification
type ResourceResponseRelationshipsOwnerAccount
type ResourceResponseRelationshipsOwnerUser
type ResourceResponseRelationshipsParentResource
type ResourceResponseRelationshipsShare
type ResourcesApiCompressFilesOpts
type ResourcesApiCreateFolderOpts
type ResourcesApiDownloadOpts
type ResourcesApiGetResourceListOpts
type ResourcesApiGetResourcePropertiesOpts
type ResourcesApiGetResourceProperties_1Opts
type ResourcesApiMoveResourcesOpts
type ResourcesApiPreviewOpts
type ResourcesApiResourcesIdPatchOpts
type ResourcesApiResourcesListIdGetOpts
type ResourcesApiService
- func (a *ResourcesApiService) CompressFiles(ctx context.Context, evAccessToken string, evApiKey string, resources string, ...) (InlineResponse2012, *http.Response, error)
- func (a *ResourcesApiService) CopyResources(ctx context.Context, evAccessToken string, evApiKey string, resources string, ...) (InlineResponse20017, *http.Response, error)
- func (a *ResourcesApiService) CreateFolder(ctx context.Context, evAccessToken string, evApiKey string, ...) (ResourceResponseObject1, *http.Response, error)
- func (a *ResourcesApiService) DeleteResource(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse20014, *http.Response, error)
- func (a *ResourcesApiService) DeleteResources(ctx context.Context, evApiKey string, evAccessToken string, filePaths []string, ...) (InlineResponse20014, *http.Response, error)
- func (a *ResourcesApiService) Download(ctx context.Context, evAccessToken string, resources string, evApiKey string, ...) (*http.Response, error)
- func (a *ResourcesApiService) ExtractFiles(ctx context.Context, evAccessToken string, evApiKey string, resource string, ...) (InlineResponse2013, *http.Response, error)
- func (a *ResourcesApiService) GetResourceList(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse20012, *http.Response, error)
- func (a *ResourcesApiService) GetResourceProperties(ctx context.Context, evAccessToken string, id int32, evApiKey string, ...) (InlineResponse20013, *http.Response, error)
- func (a *ResourcesApiService) GetResourceProperties_1(ctx context.Context, evAccessToken string, path string, hash string, ...) (InlineResponse20015, *http.Response, error)
- func (a *ResourcesApiService) MoveResources(ctx context.Context, evAccessToken string, evApiKey string, resources string, ...) (InlineResponse20018, *http.Response, error)
- func (a *ResourcesApiService) Preview(ctx context.Context, evApiKey string, evAccessToken string, resource string, ...) (PreivewFileResponseObject, *http.Response, error)
- func (a *ResourcesApiService) ResourcesIdPatch(ctx context.Context, evAccessToken string, evApiKey string, id int32, ...) (ResourceResponseObject, *http.Response, error)
- func (a *ResourcesApiService) ResourcesListIdGet(ctx context.Context, evAccessToken string, id int32, evApiKey string, ...) (InlineResponse20016, *http.Response, error)
- func (a *ResourcesApiService) Upload(ctx context.Context, evAccessToken string, evApiKey string, path string, ...) (ResourceResponseObject, *http.Response, error)
type ResourcesApiUploadOpts
type SessionActivityEntry
type SessionActivityResponse
type SessionActivityResponseAttributes
type Share
type Share1
type Share1Attributes
type Share1Relationships
type Share1RelationshipsMessages
type Share1RelationshipsNotifications
type Share1RelationshipsOwner
type Share1RelationshipsResource
type Share2
type Share3
type Share4
type ShareApiGetSharesOpts
type ShareApiService
- func (a *ShareApiService) GetShares(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse20020, *http.Response, error)
type ShareAttributes
type ShareCollectionExtendedResponse
type ShareCollectionExtendedResponseAttributes
type ShareCollectionExtendedResponseRelationships
type ShareCollectionExtendedResponseRelationshipsResource
type ShareCollectionResponse
type ShareCollectionResponseRelationships
type ShareCollectionResponseRelationshipsNotifications
type ShareCollectionResponseRelationshipsOwner
type ShareCollectionResponseRelationshipsResource
type ShareExtendedResponse
type ShareRecipient
type ShareRecipient1
type ShareRelationship
type ShareRelationships
type ShareRelationshipsMessages
type ShareRelationshipsNotifications
type ShareRelationshipsResource
type ShareResponse
type ShareResponseRelationships
type ShareResponseRelationshipsMessages
type ShareResponseRelationshipsNotifications
type ShareResponseRelationshipsOwner
type ShareResponseRelationshipsResources
type SharesApiGetSharesIdOpts
type SharesApiPostSharesOpts
type SharesApiService
- func (a *SharesApiService) DeleteSharesId(ctx context.Context, evAccessToken string, id int32, evApiKey string) (*http.Response, error)
- func (a *SharesApiService) GetSharesId(ctx context.Context, evApiKey string, evAccessToken string, id int32, ...) (InlineResponse20021, *http.Response, error)
- func (a *SharesApiService) PatchSharesId(ctx context.Context, body Body16, evApiKey string, evAccessToken string, ...) (RegularShareResponse1, *http.Response, error)
- func (a *SharesApiService) PostShares(ctx context.Context, evAccessToken string, evApiKey string, ...) (RegularShareResponse, *http.Response, error)
- func (a *SharesApiService) PostSharesCompleteSendId(ctx context.Context, evApiKey string, evAccessToken string, id int32) (RegularShareResponse2, *http.Response, error)
type SingleEntryOfSessionActivity
type SingleEntryOfSessionActivity1
type User
type User1
type User2
type User3
type UserAttributes
type UserAttributesPermissions
type UserCollectionExtendedResponse
type UserCollectionExtendedResponseAttributes
type UserCollectionExtendedResponseAttributesPermissions
type UserCollectionExtendedResponseRelationships
type UserCollectionExtendedResponseRelationshipsAccount
type UserCollectionResponse
type UserCollectionResponseAttributes
type UserCollectionResponseRelationships
type UserCollectionResponseRelationshipsHomeResource
type UserCollectionResponseRelationshipsOwnerAccount
type UserExtendedResponse
type UserPermissions
type UserRelationships
type UserRelationshipsHomeResource
type UserRelationshipsHomeResourceData
type UserRelationshipsOwnerAccount
type UserRelationshipsOwnerAccountData
type UserResponse
type UserResponseAttributes
type UserResponseObject
type UserResponseRelationships
type UserResponseRelationshipsHomeResource
type UserResponseRelationshipsOwnerAccount
type UsersApiCreateUserOpts
type UsersApiGetUserOpts
type UsersApiGetUsersOpts
type UsersApiService
- func (a *UsersApiService) CreateUser(ctx context.Context, evAccessToken string, evApiKey string, ...) (UserResponseObject, *http.Response, error)
- func (a *UsersApiService) DeleteUser(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse20010, *http.Response, error)
- func (a *UsersApiService) GetUser(ctx context.Context, evAccessToken string, id int32, evApiKey string, ...) (InlineResponse2009, *http.Response, error)
- func (a *UsersApiService) GetUsers(ctx context.Context, evAccessToken string, evApiKey string, ...) (InlineResponse2008, *http.Response, error)
- func (a *UsersApiService) UpdateUser(ctx context.Context, evAccessToken string, evApiKey string, id int32, ...) (InlineResponse20011, *http.Response, error)
type UsersApiUpdateUserOpts
type WebhooksActivityEntry
type WebhooksActivityEntryAttributes
type WebhooksActivityResponse
type WebhooksActivityResponseAttributes
type WebhooksApiGetWebhookLogsOpts
type WebhooksApiService
- func (a *WebhooksApiService) GetWebhookLogs(ctx context.Context, evApiKey string, evAccessToken string, ...) (WebhooksActivityResponse, *http.Response, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AccountApi *AccountApiService

	ActivityApi *ActivityApiService

	EmailApi *EmailApiService

	EmailListsApi *EmailListsApiService

	FormApi *FormApiService

	NotificationsApi *NotificationsApiService

	RecipientsApi *RecipientsApiService

	ResourcesApi *ResourcesApiService

	ShareApi *ShareApiService

	SharesApi *SharesApiService

	UsersApi *UsersApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the ExaVault API API v2.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Account ¶

type Account struct {
	// Account ID
	Id int32 `json:"id,omitempty"`
	// Type of item. \"account\"
	Type_         string                `json:"type,omitempty"`
	Attributes    *AccountAttributes    `json:"attributes,omitempty"`
	Relationships *AccountRelationships `json:"relationships,omitempty"`
}

Object contains all account properties.

type Account1 ¶

type Account1 struct {
	// ID of the account.
	Id int32 `json:"id,omitempty"`
	// Type is account.
	Type_         string                 `json:"type,omitempty"`
	Attributes    *Account1Attributes    `json:"attributes,omitempty"`
	Relationships *Account1Relationships `json:"relationships,omitempty"`
}

Object contains all account properties.

type Account1Attributes ¶

type Account1Attributes struct {
	// Name of the account.
	AccountName string `json:"accountName,omitempty"`
	// Name of the master user of the account.
	Username string `json:"username,omitempty"`
	// Maximum number of users the account can have. This can be increased by upgrading your account.
	MaxUsers int32 `json:"maxUsers,omitempty"`
	// Current number of users on the account.
	UserCount int32 `json:"userCount,omitempty"`
	// Account status flag. A one (1) means the account is active; zero (0) means it is suspended.
	Status int32 `json:"status,omitempty"`
	// Branding flag. Set to `true` if the account has branding functionality enabled.
	Branding bool `json:"branding,omitempty"`
	// Custom domain flag. Set to `true` if account type allows custom domain functionality.
	CustomDomain bool `json:"customDomain,omitempty"`
	// (ExaVault Use Only) Code of the plan account is signed up for.
	PlanCode string `json:"planCode,omitempty"`
	// (ExaVault Use Only) Internal ID of the service in CMS.
	WhmcsPlanId int32                   `json:"whmcsPlanId,omitempty"`
	Quota       *AccountAttributesQuota `json:"quota,omitempty"`
	// Flag to indicate whether the account disables connections via insecure protocols (e.g. FTP). Set to `true` to disable all traffic over port 21.
	SecureOnly bool `json:"secureOnly,omitempty"`
	// Flag to indicate whether the account requires complex passwords. Set to `true` to require complex passwords on all users and shares.
	ComplexPasswords bool `json:"complexPasswords,omitempty"`
	// Flag to indicate showing of referrals links in the account. Set to `true` to include marketing messages in share invitations.
	ShowReferralLinks bool `json:"showReferralLinks,omitempty"`
	// Custom domain used to brand this account.
	ExternalDomains string `json:"externalDomains,omitempty"`
	// Range of IP addresses allowed to access this account.
	AllowedIp string `json:"allowedIp,omitempty"`
	// Callback settings (Webhooks) of the account.
	CallbackSettings []CallbackSettings2     `json:"callbackSettings,omitempty"`
	BrandingSettings *BrandingSettings2      `json:"brandingSettings,omitempty"`
	Trial            *AccountAttributesTrial `json:"trial,omitempty"`
	// (ExaVault Use Only) Internal ID of the account in CMS.
	ClientId int32 `json:"clientId,omitempty"`
	// Content of welcome email each new user will receive.
	WelcomeEmailContent string `json:"welcomeEmailContent,omitempty"`
	// Subject of welcome email each new user will receive.
	WelcomeEmailSubject string `json:"welcomeEmailSubject,omitempty"`
	// Custom signature for all account emails users or recipients will receive.
	CustomSignature string `json:"customSignature,omitempty"`
	// Whether the web application onboarding help is enabled for new users in the account.
	AccountOnboarding bool `json:"accountOnboarding,omitempty"`
	// Timestamp of account creation.
	Created string `json:"created,omitempty"`
	// Timestamp of account modification.
	Modified string `json:"modified,omitempty"`
}

type Account1Relationships ¶

type Account1Relationships struct {
	MasterUser *Account1RelationshipsMasterUser `json:"masterUser,omitempty"`
}

type Account1RelationshipsMasterUser ¶

type Account1RelationshipsMasterUser struct {
	// Type is user.
	Type_ string `json:"type,omitempty"`
	// ID of the user.
	Id int32 `json:"id,omitempty"`
}

type Account2 ¶

type Account2 struct {
	// (ExaVault Use Only) Internal ID of the account.
	Id            int32                  `json:"id,omitempty"`
	Type_         string                 `json:"type,omitempty"`
	Attributes    *Account2Attributes    `json:"attributes,omitempty"`
	Relationships *Account2Relationships `json:"relationships,omitempty"`
}

Object contains all account properties.

type Account2Attributes ¶

type Account2Attributes struct {
	// PLACEHOLDER
	AccountName string `json:"accountName,omitempty"`
	// Name of the account.
	Username string `json:"username,omitempty"`
	// Maximum number of users the account can have. This can be increased by contacting ExaVault Support.
	MaxUsers int32 `json:"maxUsers,omitempty"`
	// Current number of users on the account.
	UserCount int32 `json:"userCount,omitempty"`
	// Account status flag. A one (1) means the account is active; zero (0) means it is suspended.
	Status int32 `json:"status,omitempty"`
	// Branding flag. Set to `true` if the account has branding functionality enabled.
	Branding bool `json:"branding,omitempty"`
	// Custom domain flag. Set to `true` if account type allows custom domain functionality.
	CustomDomain bool `json:"customDomain,omitempty"`
	// (ExaVault Use Only) Code of the plan account is signed up for.
	PlanCode string `json:"planCode,omitempty"`
	// (ExaVault Use Only) Internal ID of the service in CMS.
	WhmcsPlanId int32                   `json:"whmcsPlanId,omitempty"`
	Quota       *AccountAttributesQuota `json:"quota,omitempty"`
	// Flag to indicate whether the account disables connections via insecure protocols (e.g. FTP). Set to `true` to disable all traffic over port 21.
	SecureOnly bool `json:"secureOnly,omitempty"`
	// Flag to indicate whether the account requires complex passwords. Set to `true` to require complex passwords on all users and shares.
	ComplexPasswords bool `json:"complexPasswords,omitempty"`
	// Flag to indicate showing of referrals links in the account. Set to `true` to include marketing messages in share invitations.
	ShowReferralLinks bool `json:"showReferralLinks,omitempty"`
	// Custom domain used to brand this account.
	ExternalDomains string `json:"externalDomains,omitempty"`
	// Range of IP addresses allowed to access this account.
	AllowedIp string `json:"allowedIp,omitempty"`
	// Callback settings (Webhooks) of the account.
	CallbackSettings []CallbackSettings2     `json:"callbackSettings,omitempty"`
	BrandingSettings *BrandingSettings2      `json:"brandingSettings,omitempty"`
	Trial            *AccountAttributesTrial `json:"trial,omitempty"`
	// (ExaVault Use Only) Internal ID of the account in CMS.
	ClientId int32 `json:"clientId,omitempty"`
	// Content of welcome email each new user will receive.
	WelcomeEmailContent string `json:"welcomeEmailContent,omitempty"`
	// Subject of welcome email each new user will receive.
	WelcomeEmailSubject string `json:"welcomeEmailSubject,omitempty"`
	// Custom signature for all account emails users or recipients will receive.
	CustomSignature string `json:"customSignature,omitempty"`
	// Whether the web application onboarding help is enabled for new users in the account.
	AccountOnboarding bool `json:"accountOnboarding,omitempty"`
	// Timestamp of account creation.
	Created string `json:"created,omitempty"`
	// Timestamp of account modification.
	Modified string `json:"modified,omitempty"`
}

type Account2Relationships ¶

type Account2Relationships struct {
	MasterUser *Account2RelationshipsMasterUser `json:"masterUser,omitempty"`
}

type Account2RelationshipsMasterUser ¶

type Account2RelationshipsMasterUser struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type AccountAllowedIpRanges ¶

type AccountAllowedIpRanges struct {
	IpStart string `json:"ip_start,omitempty"`
	IpEnd   string `json:"ip_end,omitempty"`
}

type AccountApiPatchAccountOpts ¶

type AccountApiPatchAccountOpts struct {
	Body optional.Interface
}

type AccountApiService ¶

type AccountApiService service

func (*AccountApiService) GetAccount ¶

func (a *AccountApiService) GetAccount(ctx context.Context, evApiKey string, evAccessToken string) (InlineResponse20019, *http.Response, error)

AccountApiService Get account settings Get information about the an account At least one of the headers **ev-api-key** and **ev-access-token** are required. If both headers are specified, only information about the the account associated with the key/token is returned. If only one of the headers is provided, you must also provide an **accountName** parameter with the name of the desired account, which will provide more limited information.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evApiKey Optional if seeking limited info about account, and ev-access-token is provided.
@param evAccessToken Optional if seeking limited info about account, and ev-api-key is present

@return InlineResponse20019

func (*AccountApiService) PatchAccount ¶

func (a *AccountApiService) PatchAccount(ctx context.Context, evApiKey string, evAccessToken string, localVarOptionals *AccountApiPatchAccountOpts) (AccountPublicResponse, *http.Response, error)

type AccountAttributes ¶

type AccountAttributes struct {
	// Name of the account
	AccountName string `json:"accountName,omitempty"`
	// Name of account's master user
	Username string `json:"username,omitempty"`
	// Maximum number of users the account can have. This can be increased by contacting ExaVault Support.
	MaxUsers int32 `json:"maxUsers,omitempty"`
	// Current number of users on the account.
	UserCount int32 `json:"userCount,omitempty"`
	// Account status flag. A one (1) means the account is active; zero (0) means it is suspended.
	Status int32 `json:"status,omitempty"`
	// Branding flag. Set to `true` if the account has branding functionality enabled.
	Branding bool `json:"branding,omitempty"`
	// Custom domain flag. Set to `true` if account type allows custom domain functionality.
	CustomDomain bool `json:"customDomain,omitempty"`
	// (ExaVault Use Only) Code of the plan account is signed up for.
	PlanCode string `json:"planCode,omitempty"`
	// (ExaVault Use Only) Internal ID of the service in CMS.
	WhmcsPlanId int32                   `json:"whmcsPlanId,omitempty"`
	Quota       *AccountAttributesQuota `json:"quota,omitempty"`
	// Flag to indicate whether the account disables connections via insecure protocols (e.g. FTP). Set to `true` to disable all traffic over port 21.
	SecureOnly bool `json:"secureOnly,omitempty"`
	// Flag to indicate whether the account requires complex passwords. Set to `true` to require complex passwords on all users and shares.
	ComplexPasswords bool `json:"complexPasswords,omitempty"`
	// Flag to indicate showing of referrals links in the account. Set to `true` to include marketing messages in share invitations.
	ShowReferralLinks bool `json:"showReferralLinks,omitempty"`
	// Custom domain used to brand this account.
	ExternalDomains string `json:"externalDomains,omitempty"`
	// Range of IP addresses allowed to access this account.
	AllowedIp string `json:"allowedIp,omitempty"`
	// Callback settings (Webhooks) of the account.
	CallbackSettings []CallbackSettings2     `json:"callbackSettings,omitempty"`
	BrandingSettings *BrandingSettings2      `json:"brandingSettings,omitempty"`
	Trial            *AccountAttributesTrial `json:"trial,omitempty"`
	// (ExaVault Use Only) Internal ID of the account in CMS.
	ClientId int32 `json:"clientId,omitempty"`
	// Content of welcome email each new user will receive.
	WelcomeEmailContent string `json:"welcomeEmailContent,omitempty"`
	// Subject of welcome email each new user will receive.
	WelcomeEmailSubject string `json:"welcomeEmailSubject,omitempty"`
	// Custom signature for all account emails users or recipients will receive.
	CustomSignature string `json:"customSignature,omitempty"`
	// Whether the web application onboarding help is enabled for new users in the account.
	AccountOnboarding bool `json:"accountOnboarding,omitempty"`
	// Timestamp of account creation.
	Created string `json:"created,omitempty"`
	// Timestamp of account modification.
	Modified string `json:"modified,omitempty"`
}

type AccountAttributesQuota ¶

type AccountAttributesQuota struct {
	// Amount of disk space that the account has available to it. This may be increased by upgrading to a larger plan.
	DiskLimit int64 `json:"diskLimit,omitempty"`
	// Amount of bandwidth that the account has available before a warning is generated. All ExaVault accounts include unlimited bandwidth, but we flag high-bandwidth users.
	BandwidthLimit int64 `json:"bandwidthLimit,omitempty"`
	// Amount of disk space currently in use.
	DiskUsed int64 `json:"diskUsed,omitempty"`
	// Amount of bandwidth used by this account in the last billing period.
	BandwidthUsed int64 `json:"bandwidthUsed,omitempty"`
	// Should a quota warning be sent to the account owner when a threshold level of space utilization is reached?
	NoticeEnabled int32 `json:"noticeEnabled,omitempty"`
	// Treshold that triggers a quota notification. This represents the \"percent full\" your account must be before the quota notification is generated.
	NoticeThreshold int32 `json:"noticeThreshold,omitempty"`
}

type AccountAttributesTrial ¶

type AccountAttributesTrial struct {
	// Flag indicates if free trial enabled.
	Free bool `json:"free,omitempty"`
	// (ExaVault Use Only) Internal tracking code representing type of free trial for account.
	Code string `json:"code,omitempty"`
	// (ExaVault Use Only) Internal tracking code representing whether trial has ended or is still in progress.
	Status string `json:"status,omitempty"`
	// (ExaVault Use Only) Date that free trial period began.
	Start string `json:"start,omitempty"`
	// (ExaVault Use Only) Date that free trial period ends.
	End string `json:"end,omitempty"`
}

type AccountExtendedResponse ¶

type AccountExtendedResponse struct {
	Included []User1 `json:"included,omitempty"`
}

PLACEHOLDER

type AccountPublic ¶

type AccountPublic struct {
	// PLACEHOLDER
	Id         int32                    `json:"id,omitempty"`
	Type_      string                   `json:"type,omitempty"`
	Attributes *AccountPublicAttributes `json:"attributes,omitempty"`
}

Public account's information available when only ev-api-key provided

type AccountPublicAttributes ¶

type AccountPublicAttributes struct {
	// PLACEHOLDER
	AccountName string `json:"accountName,omitempty"`
	// PLACEHOLDER
	Theme string `json:"theme,omitempty"`
	// PLACEHOLDER
	CompanyName string `json:"companyName,omitempty"`
	// PLACEHOLDER
	Logo string `json:"logo,omitempty"`
	// PLACEHOLDER
	CustomEmail string `json:"customEmail,omitempty"`
	// PLACEHOLDER
	VerifiedDomain string `json:"verifiedDomain,omitempty"`
	// PLACEHOLDER
	VerifiedDomainId int32 `json:"verifiedDomainId,omitempty"`
	// PLACEHOLDER
	VerifiedDomainValid bool   `json:"verifiedDomainValid,omitempty"`
	Created             string `json:"created,omitempty"`
	Modified            string `json:"modified,omitempty"`
}

type AccountPublicResponse ¶

type AccountPublicResponse struct {
	// Http status code of the response.
	ResponseStautus int32                      `json:"responseStautus,omitempty"`
	Data            *AccountPublicResponseData `json:"data,omitempty"`
}

Response object for the account.

type AccountPublicResponseData ¶

type AccountPublicResponseData struct {
	// PLACEHOLDER
	Id int32 `json:"id,omitempty"`
	// Type is account.
	Type_      string                               `json:"type,omitempty"`
	Attributes *AccountPublicResponseDataAttributes `json:"attributes,omitempty"`
}

Public account's information available when only ev-api-key provided

type AccountPublicResponseDataAttributes ¶

type AccountPublicResponseDataAttributes struct {
	// Name of the account.
	AccountName string `json:"accountName,omitempty"`
	// Current theme colors of the web UI.
	Theme string `json:"theme,omitempty"`
	// Name of your company
	CompanyName string `json:"companyName,omitempty"`
	// File name of your company logo. Can be `null` if no logo has been added.
	Logo string `json:"logo,omitempty"`
	// Default email address to use for system notificiations.
	CustomEmail string `json:"customEmail,omitempty"`
	// Verfied custom domain on the account.
	VerifiedDomain string `json:"verifiedDomain,omitempty"`
	// ID of the verifed domain.
	VerifiedDomainId int32 `json:"verifiedDomainId,omitempty"`
	// `true` if the verified domain is valid.
	VerifiedDomainValid bool `json:"verifiedDomainValid,omitempty"`
	// Account creation datetime.
	Created string `json:"created,omitempty"`
	// Account modification datetime.
	Modified string `json:"modified,omitempty"`
}

type AccountRelationships ¶

type AccountRelationships struct {
	MasterUser *AccountRelationshipsMasterUser `json:"masterUser,omitempty"`
}

type AccountRelationshipsMasterUser ¶

type AccountRelationshipsMasterUser struct {
	Data *AccountRelationshipsMasterUserData `json:"data,omitempty"`
}

type AccountRelationshipsMasterUserData ¶

type AccountRelationshipsMasterUserData struct {
	Type_ string `json:"type,omitempty"`
	// ID of master user for account
	Id int32 `json:"id,omitempty"`
}

type AccountResponse ¶

type AccountResponse struct {
	// Http status code of the response.
	ResponseStatus int32     `json:"responseStatus,omitempty"`
	Data           *Account1 `json:"data,omitempty"`
}

PLACEHOLDER

type ActivityApiGetActivityLogsOpts ¶

type ActivityApiGetActivityLogsOpts struct {
	Offset    optional.Int32
	Limit     optional.Int32
	UserName  optional.String
	Path      optional.String
	IpAddress optional.String
	Type_     optional.String
	StartDate optional.String
	EndDate   optional.String
	Sort      optional.String
}

type ActivityApiGetWebhookLogsOpts ¶

type ActivityApiGetWebhookLogsOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	Path       optional.String
	StatusCode optional.Int32
	Event      optional.String
	Sort       optional.String
	Username   optional.String
}

type ActivityApiService ¶

type ActivityApiService service

func (*ActivityApiService) GetActivityLogs ¶

func (a *ActivityApiService) GetActivityLogs(ctx context.Context, evApiKey string, evAccessToken string, localVarOptionals *ActivityApiGetActivityLogsOpts) (SessionActivityResponse, *http.Response, error)

func (*ActivityApiService) GetWebhookLogs ¶

func (a *ActivityApiService) GetWebhookLogs(ctx context.Context, evApiKey string, evAccessToken string, localVarOptionals *ActivityApiGetWebhookLogsOpts) (WebhooksActivityResponse, *http.Response, error)

type AllOfResourceDeleteMultiResponseObjectResponsesItems ¶

type AllOfResourceDeleteMultiResponseObjectResponsesItems struct {
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Errors         []interface{} `json:"errors,omitempty"`
}

type AllOfResourceMultiResponseDeleteResponsesItems ¶

type AllOfResourceMultiResponseDeleteResponsesItems struct {
	// Http status code of the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Errors         []interface{} `json:"errors,omitempty"`
}

type AllOfResourceMultiResponseObjectResponsesItems ¶

type AllOfResourceMultiResponseObjectResponsesItems struct {
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Errors         []interface{} `json:"errors,omitempty"`
}

type AllOfResourceMultiResponseResponsesItems ¶

type AllOfResourceMultiResponseResponsesItems struct {
	// Http status code of the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Errors         []interface{} `json:"errors,omitempty"`
}

type AnyOfDirectFileExtendedResponseIncludedItems ¶

type AnyOfDirectFileExtendedResponseIncludedItems struct {
}

type AnyOfFormAttributesElementsItems ¶

type AnyOfFormAttributesElementsItems struct {
}

type AnyOfFormExtendedResponseAttributesElementsItems ¶

type AnyOfFormExtendedResponseAttributesElementsItems struct {
}

type AnyOfFormResponseAttributesElementsItems ¶

type AnyOfFormResponseAttributesElementsItems struct {
}

type AnyOfShareExtendedResponseIncludedItems ¶

type AnyOfShareExtendedResponseIncludedItems struct {
}

type AvailableUser ¶

type AvailableUser struct {
	// Flag indicates if username is available.
	Available bool `json:"available,omitempty"`
}

Object contains infromation about username availability.

type AvailableUser1 ¶

type AvailableUser1 struct {
	// `true` if username is available.
	Available bool `json:"available,omitempty"`
}

Object contains infromation about username availability.

type AvailableUserResponse ¶

type AvailableUserResponse struct {
	// Http status code of the response.
	ResponseStatus int32           `json:"responseStatus,omitempty"`
	Data           *AvailableUser1 `json:"data,omitempty"`
}

PLACEHOLDER

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Body ¶

type Body struct {
	// Name of the email list.
	Name string `json:"name"`
	// Array of email addresses to include in the email list.
	Emails []string `json:"emails"`
}

type Body1 ¶

type Body1 struct {
	// Name of the email list.
	Name string `json:"name,omitempty"`
	// Array of email addresses to add to the email list.
	Emails []string `json:"emails,omitempty"`
}

type Body10 ¶

type Body10 struct {
	// Name of the folder to create.
	FolderName string `json:"folderName"`
	// Where to create the folder. Use **_/_** to create a folder in the user's home directory.
	Path string `json:"path"`
}

type Body11 ¶

type Body11 struct {
	// Array containing file/folder paths to move.
	Resrouces []string `json:"resrouces"`
	// Remote destination path to move files/folders to.
	ParentResource string `json:"parentResource"`
}

type Body12 ¶

type Body12 struct {
	File **os.File `json:"file,omitempty"`
}

type Body13 ¶

type Body13 struct {
	// Whether the system should email the account owner when usage exceeds quotaNoticeThreshold value
	QuotaNoticeEnabled bool `json:"quotaNoticeEnabled,omitempty"`
	// Percent of account usage to trigger quota notices for.
	QuotaNoticeThreshold int32 `json:"quotaNoticeThreshold,omitempty"`
	// Whether unencrypted FTP connections should be denied for the account.
	SecureOnly bool `json:"secureOnly,omitempty"`
	// Whether to require complex passwords for all passwords.
	ComplexPasswords bool `json:"complexPasswords,omitempty"`
	// Whether to display links for others to sign up on share views and invitation emails
	ShowReferralLinks bool `json:"showReferralLinks,omitempty"`
	// Custom address used for web file manager. Not available for all account types.
	ExternalDomain []string `json:"externalDomain,omitempty"`
	// Content of welcome email template.
	EmailContent string `json:"emailContent,omitempty"`
	// Subject line for welcome emails
	EmailSubject string `json:"emailSubject,omitempty"`
	// IP Address Ranges for restricting account access
	AllowedIpRanges  []AccountAllowedIpRanges `json:"allowedIpRanges,omitempty"`
	CallbackSettings *CallbackSettings1       `json:"callbackSettings,omitempty"`
	BrandingSettings *BrandingSettings1       `json:"brandingSettings,omitempty"`
	// PLACEHOLDER
	AccountOnboarding bool `json:"accountOnboarding,omitempty"`
	// PLACEHOLDER
	CustomSignature string `json:"customSignature,omitempty"`
}

type Body14 ¶

type Body14 struct {
	Emails  []string `json:"emails"`
	Message string   `json:"message"`
}

type Body15 ¶

type Body15 struct {
	// The type of share to create. See above for a description of each.
	Type_ string `json:"type"`
	// Name of the share.
	Name string `json:"name"`
	// Array of strings containing the file paths to share.
	FilePaths []string `json:"filePaths"`
	// Type of permissions share recipients have.
	AccessMode []string `json:"accessMode"`
	// Array of strings for CC email recipients (for email invitations).
	CcEmail string `json:"ccEmail,omitempty"`
	// Allows user to embed a widget with the share.
	Embed bool `json:"embed,omitempty"`
	// Expiration date for the share
	Expiration string `json:"expiration,omitempty"`
	// True if notifications are set up for the share.
	HasNotification bool `json:"hasNotification,omitempty"`
	// True if a public link is available.
	IsPublic bool   `json:"isPublic,omitempty"`
	Message  string `json:"message,omitempty"`
	// Emails that will recevie notificiations.
	NotificationEmails []string `json:"notificationEmails,omitempty"`
	// Set a password for recipients to access the share.
	Password string `json:"password,omitempty"`
	// True if recipients must provide their email to access the share.
	RequireEmail bool   `json:"requireEmail,omitempty"`
	Subject      string `json:"subject,omitempty"`
	// True if files uploaded should create new folders.
	FileDropCreateFolders bool `json:"fileDropCreateFolders,omitempty"`
}

type Body16 ¶

type Body16 struct {
	// The type of share to create. See above for a description of each.
	Type_ string `json:"type,omitempty"`
	// Name of the share.
	Name string `json:"name,omitempty"`
	// Array of strings containing the file paths to share.
	FilePaths             []string `json:"filePaths,omitempty"`
	AccessMode            []string `json:"accessMode,omitempty"`
	CcEmail               string   `json:"ccEmail,omitempty"`
	Embed                 bool     `json:"embed,omitempty"`
	Expiration            string   `json:"expiration,omitempty"`
	HasNotification       bool     `json:"hasNotification,omitempty"`
	IsPublic              bool     `json:"isPublic,omitempty"`
	Message               string   `json:"message,omitempty"`
	NotificationEmails    []string `json:"notificationEmails,omitempty"`
	Password              string   `json:"password,omitempty"`
	RequireEmail          bool     `json:"requireEmail,omitempty"`
	Subject               string   `json:"subject,omitempty"`
	FileDropCreateFolders bool     `json:"fileDropCreateFolders,omitempty"`
}

type Body2 ¶

type Body2 struct {
	// Set a description for the form that will be visible to recipients.
	FormDescription string `json:"formDescription,omitempty"`
	// Text to be displayed on the submission button.
	SubmitButtonText string `json:"submitButtonText,omitempty"`
	// Text to be displayed when a recipient has submitted the form.
	SuccessMessage string            `json:"successMessage,omitempty"`
	Elements       []FormsidElements `json:"elements,omitempty"`
	// CSS Styles of the form.
	CssStyles string `json:"cssStyles,omitempty"`
}

type Body3 ¶

type Body3 struct {
	// JSON object containing field names and their values.
	Data *interface{} `json:"data"`
}

type Body4 ¶

type Body4 struct {
	// Full path of file/folder where the notification is set.
	Path string `json:"path,omitempty"`
	// Type of action to filter on. Notifications will only be fired for the given type of action.
	Action string `json:"action,omitempty"`
	// Array of usernames or with one flag to filter on. This options allows to filter what users will trigger the notification.
	Usernames []string `json:"usernames,omitempty"`
	// Set to true if the user should be notified by email when the notification is triggered.
	SendEmail bool `json:"sendEmail,omitempty"`
	// Email addresses to send notification to. If not specified, sends to the authenticated user.
	Emails []string `json:"emails,omitempty"`
}

type Body5 ¶

type Body5 struct {
	// Notification id to unsubscribe from.
	Id int32 `json:"id,omitempty"`
	// Email to remove from the notification recipients list.
	Email string `json:"email,omitempty"`
}

type Body6 ¶

type Body6 struct {
	// Type of resource you're setting the notification on.
	Type_ string `json:"type"`
	// Type of action to filter on. Notifications will only be fired for the given type of action.
	Action string `json:"action"`
	// Determines which users should trigger the notification. Either one of the values above, or an array of usernames.
	Usernames []string `json:"usernames"`
	// Set to true if the user should be notified by email when the notification is triggered.
	SendEmail bool `json:"sendEmail"`
	// Email addresses to send the notification to. If not specified, sends to the authenticated user.
	Emails []string `json:"emails,omitempty"`
}

type Body7 ¶

type Body7 struct {
	// Username of the user to create. This should follow standard username conventions; e.g. all lowercase, no spaces, etc. We do allow email addresses as usernames.
	Username string `json:"username"`
	// An optional nickname (e.g. 'David from Sales').
	Nickname string `json:"nickname,omitempty"`
	// The path to the user's home folder. For the account root, specify `/`. Otherwise, use standard Unix path format, e.g. `/path/to/some/dir`. The user will be locked to this directory and unable to move 'up' in the account. If the folder does not exist in the account, it will be created. Note that users with the role `admin` cannot have a folder other than `/`.
	HomeResource string `json:"homeResource"`
	// The user's email address.
	Email string `json:"email"`
	// The user's password.
	Password string `json:"password"`
	// The user's role. Note that admin users cannot have a `homeResource` other than `/`, and will be setup with full permissions regardless of what you specify in the `permissions` property.
	Role string `json:"role"`
	// A CSV string of user permissions. For example: `upload,download,list`. Note that users will be unable to see any files in the account unless you include `list` permission.
	Permissions string `json:"permissions"`
	// The user's timezone, used for accurate time display within the application. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone"`
	// Optional timestamp when the user should expire, formatted in ISO 8601.
	Expiration time.Time `json:"expiration,omitempty"`
	// If true, the user's account is locked by default. Locked users cannot log in.
	Locked bool `json:"locked,omitempty"`
	// If `true`, send a user email upon creation. The default welcome email can be configured from the settings page in your account.
	WelcomeEmail bool `json:"welcomeEmail,omitempty"`
	// If `true`, enable extra help popups in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
}

type Body8 ¶

type Body8 struct {
	// Username of the user to create. This should follow standard username conventions; e.g. all lowercase, no spaces, etc. We do allow email addresses as usernames.
	Username string `json:"username,omitempty"`
	// An optional nickname (e.g. 'David from Sales').
	Nickname string `json:"nickname,omitempty"`
	// The path to the user's home folder. For the account root, specify `/`. Otherwise, use standard Unix path format, e.g. `/path/to/some/dir`. The user will be locked to this directory and unable to move 'up' in the account. If the folder does not exist in the account, it will be created. Note that users with the role `admin` cannot have a folder other than `/`.
	DestinationFolder string `json:"destinationFolder,omitempty"`
	// The user's email address.
	Email string `json:"email,omitempty"`
	// The user's password.
	Password string `json:"password,omitempty"`
	// The user's role. Note that admin users cannot have a `destinationFolder` other than `/`, and will be setup with full permissions regardless of what you specify in the `permissions` property.
	Role string `json:"role,omitempty"`
	// A CSV string of user permissions. For example: `upload,download,list`. Note that users will be unable to see any files in the account unless you include `list` permission.
	Permissions string `json:"permissions,omitempty"`
	// The user's timezone, used for accurate time display within the application. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone,omitempty"`
	// Optional timestamp when the user should expire, formatted in ISO 8601.
	Expiration string `json:"expiration,omitempty"`
	// If true, the user's account is locked by default. Locked users cannot log in.
	Locked bool `json:"locked,omitempty"`
	// If `true`, enable extra help popups in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
}

type Body9 ¶

type Body9 struct {
	// The new name for the resource (file or folder).
	NewName string `json:"newName,omitempty"`
}

type BrandingSettings ¶

type BrandingSettings struct {
	// PLACEHOLDER
	CompanyName string `json:"companyName,omitempty"`
	// PLACEHOLDER
	CustomEmail string `json:"customEmail,omitempty"`
	// PLACEHOLDER
	Logo string `json:"logo,omitempty"`
	// PLACEHOLDER
	LogoExt string `json:"logoExt,omitempty"`
	// PLACEHOLDER
	Theme string `json:"theme,omitempty"`
}

type BrandingSettings1 ¶

type BrandingSettings1 struct {
	// PLACEHOLDER
	CompanyName string `json:"companyName,omitempty"`
	// PLACEHOLDER
	CustomEmail string `json:"customEmail,omitempty"`
	// PLACEHOLDER
	Theme string `json:"theme,omitempty"`
}

type BrandingSettings2 ¶

type BrandingSettings2 struct {
	// PLACEHOLDER
	CompanyName string `json:"companyName,omitempty"`
	// PLACEHOLDER
	CustomEmail string `json:"customEmail,omitempty"`
	// PLACEHOLDER
	Logo string `json:"logo,omitempty"`
	// PLACEHOLDER
	LogoExt string `json:"logoExt,omitempty"`
	// PLACEHOLDER
	Theme string `json:"theme,omitempty"`
}

type CallbackSettings ¶

type CallbackSettings struct {
	// ID of the account these settings belongs to.
	AccountId string `json:"accountId,omitempty"`
	// Where callback settings object sent to.
	EndpointUrl string `json:"endpointUrl,omitempty"`
	// Verification token for the request authentication.
	Token    string                    `json:"token,omitempty"`
	Triggers *CallbackSettingsTriggers `json:"triggers,omitempty"`
}

type CallbackSettings1 ¶

type CallbackSettings1 struct {
	EndpointUrl string `json:"endpointUrl,omitempty"`
}

type CallbackSettings2 ¶

type CallbackSettings2 struct {
	// ID of the account these settings belongs to.
	AccountId string `json:"accountId,omitempty"`
	// Where callback settings object sent to.
	EndpointUrl string `json:"endpointUrl,omitempty"`
	// Verification token for the request authentication.
	Token    string                    `json:"token,omitempty"`
	Triggers *CallbackSettingsTriggers `json:"triggers,omitempty"`
}

type CallbackSettingsTriggers ¶

type CallbackSettingsTriggers struct {
	// Trigger callback on upload.
	Upload string `json:"upload,omitempty"`
	// Trigger callback on download.
	Download string `json:"download,omitempty"`
	// Trigger callback on delete.
	Delete string `json:"delete,omitempty"`
	// Trigger callback on fodler create.
	CreateFolder string `json:"createFolder,omitempty"`
	// Trigger callback on rename.
	Rename string `json:"rename,omitempty"`
	// Trigger callback on move.
	Move string `json:"move,omitempty"`
	// Trigger callback on copy.
	Copy string `json:"copy,omitempty"`
	// Trigger callback on compress.
	Compress string `json:"compress,omitempty"`
	// Trigger callback on extract.
	Extract string `json:"extract,omitempty"`
	// Trigger callback on share folder create.
	ShareFolder string `json:"shareFolder,omitempty"`
	// Trigger callback on send files.
	SendFiles string `json:"sendFiles,omitempty"`
	// Trigger callback on receive folder create.
	ReceiveFiles string `json:"receiveFiles,omitempty"`
	// Trigger callback on share folder update.
	UpdateShare string `json:"updateShare,omitempty"`
	// Trigger callback on receive folder update.
	UpdateReceive string `json:"updateReceive,omitempty"`
	// Trigger callback on send files delete.
	DeleteSend string `json:"deleteSend,omitempty"`
	// Trigger callback on receive folder delete.
	DeleteReceive string `json:"deleteReceive,omitempty"`
	// Trigger callback on share folder delete.
	DeleteShare string `json:"deleteShare,omitempty"`
	// Trigger callback on notification create.
	CreateNotification string `json:"createNotification,omitempty"`
	// Trigger callback on notification update.
	UpdateNotification string `json:"updateNotification,omitempty"`
	// Trigger callback on notification delete.
	DeleteNotification string `json:"deleteNotification,omitempty"`
	// Trigger callback on user create.
	CreateUser string `json:"createUser,omitempty"`
	// Trigger callback on user update.
	UpdateUser string `json:"updateUser,omitempty"`
	// Trigger callback on user delete.
	DeleteUser string `json:"deleteUser,omitempty"`
	// Trigger callback on user connect.
	UserConnect string `json:"userConnect,omitempty"`
	// Trigger callback on user disconnect.
	UserDisconnect string `json:"userDisconnect,omitempty"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration(pathPrefix string) *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type DirectFile ¶

type DirectFile struct {
	// ID of the direct file.
	Id            int32                    `json:"id,omitempty"`
	Type_         string                   `json:"type,omitempty"`
	Attributes    *DirectFileAttributes    `json:"attributes,omitempty"`
	Relationships *DirectFileRelationships `json:"relationships,omitempty"`
}

type DirectFile1 ¶

type DirectFile1 struct {
	// ID of the direct file.
	Id            int32                    `json:"id,omitempty"`
	Type_         string                   `json:"type,omitempty"`
	Attributes    *DirectFileAttributes    `json:"attributes,omitempty"`
	Relationships *DirectFileRelationships `json:"relationships,omitempty"`
}

type DirectFile2 ¶

type DirectFile2 struct {
	// ID of the direct file.
	Id int32 `json:"id,omitempty"`
	// Type is directFile.
	Type_         string                    `json:"type,omitempty"`
	Attributes    *DirectFile2Attributes    `json:"attributes,omitempty"`
	Relationships *DirectFile2Relationships `json:"relationships,omitempty"`
}

type DirectFile2Attributes ¶

type DirectFile2Attributes struct {
	// Path to the folder direct file is set on.
	Path string `json:"path,omitempty"`
	// Flag indicates if direct file is turned `on` or `off`.
	IsEnabled bool `json:"isEnabled,omitempty"`
	// Flag indicates if folder listing is `on` or `off`. If it is enabled you can see folder content in the browser.
	IsIndexEnabled bool `json:"isIndexEnabled,omitempty"`
	// Timestamp of direct file block until date. Equals `0000-00-00 00:00:00` when no block date is setup. Used when direct file bandwidth quota limit crossed.
	BlockUntil string `json:"blockUntil,omitempty"`
	// Unix timestamp of direct file creation.
	Created string `json:"created,omitempty"`
	// Unix timestamp of direct file modification.
	Modified string `json:"modified,omitempty"`
	// ID of the account the direct file belongs to.
	AccountId int32 `json:"accountId,omitempty"`
}

type DirectFile2Relationships ¶

type DirectFile2Relationships struct {
	OwnerAccount *DirectFile2RelationshipsOwnerAccount `json:"ownerAccount,omitempty"`
	Resource     *DirectFile2RelationshipsResource     `json:"resource,omitempty"`
}

type DirectFile2RelationshipsOwnerAccount ¶

type DirectFile2RelationshipsOwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the account the direct file belongs to.
	Id int32 `json:"id,omitempty"`
}

type DirectFile2RelationshipsResource ¶

type DirectFile2RelationshipsResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

type DirectFile3 ¶

type DirectFile3 struct {
	// ID of the direct file.
	Id int32 `json:"id,omitempty"`
	// Type is directFile.
	Type_         string                    `json:"type,omitempty"`
	Attributes    *DirectFile2Attributes    `json:"attributes,omitempty"`
	Relationships *DirectFile3Relationships `json:"relationships,omitempty"`
}

type DirectFile3Relationships ¶

type DirectFile3Relationships struct {
	OwnerAccount *DirectFile3RelationshipsOwnerAccount `json:"ownerAccount,omitempty"`
	Resource     *DirectFile2RelationshipsResource     `json:"resource,omitempty"`
}

type DirectFile3RelationshipsOwnerAccount ¶

type DirectFile3RelationshipsOwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the account the direct file belongs to.
	Id int32 `json:"id,omitempty"`
}

ID of the account the direct file belongs to.

type DirectFileAttributes ¶

type DirectFileAttributes struct {
	// Path to the folder direct file is set on.
	Path string `json:"path,omitempty"`
	// Flag indicates if direct file is turned `on` or `off`.
	IsEnabled bool `json:"isEnabled,omitempty"`
	// Flag indicates if folder listing is `on` or `off`. If it is enabled you can see folder content in the browser.
	IsIndexEnabled bool `json:"isIndexEnabled,omitempty"`
	// Timestamp of direct file block until date. Equals `0000-00-00 00:00:00` when no block date is setup. Used when direct file bandwidth quota limit crossed.
	BlockUntil string `json:"blockUntil,omitempty"`
	// Unix timestamp of direct file creation.
	Created string `json:"created,omitempty"`
	// Unix timestamp of direct file modification.
	Modified string `json:"modified,omitempty"`
}

type DirectFileCollectionExtendedResponse ¶

type DirectFileCollectionExtendedResponse struct {
	Included []struct{} `json:"included,omitempty"`
}

type DirectFileCollectionResponse ¶

type DirectFileCollectionResponse struct {
	ResponseStatus  int32         `json:"responseStatus,omitempty"`
	TotalResults    int32         `json:"totalResults,omitempty"`
	ReturnedResults int32         `json:"returnedResults,omitempty"`
	Data            []DirectFile1 `json:"data,omitempty"`
}

type DirectFileExtendedResponse ¶

type DirectFileExtendedResponse struct {
	Data     *DirectFile3                                   `json:"data,omitempty"`
	Included []AnyOfDirectFileExtendedResponseIncludedItems `json:"included,omitempty"`
}

Response object for direct files with metadata for included relationships.

type DirectFileRelationships ¶

type DirectFileRelationships struct {
	Owner    *DirectFileRelationshipsOwner    `json:"owner,omitempty"`
	Resource *DirectFileRelationshipsResource `json:"resource,omitempty"`
}

type DirectFileRelationshipsOwner ¶

type DirectFileRelationshipsOwner struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type DirectFileRelationshipsResource ¶

type DirectFileRelationshipsResource struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type DirectFileResponse ¶

type DirectFileResponse struct {
	Data *DirectFile2 `json:"data,omitempty"`
}

Response object for direct files.

type DownloadPolling ¶

type DownloadPolling struct {
	// Name of the zip file.
	Zip string `json:"zip,omitempty"`
	// Indicates archiving process completeness.
	Percent int32 `json:"percent,omitempty"`
}

Object contains infromation about ongoing arhivation of files for download.

type DownloadPolling1 ¶

type DownloadPolling1 struct {
	// Name of the zip file.
	Zip string `json:"zip,omitempty"`
	// Indicates archiving process completeness.
	Percent int32 `json:"percent,omitempty"`
}

Object contains infromation about ongoing arhivation of files for download.

type DownloadPollingResponse ¶

type DownloadPollingResponse struct {
	// Http status code of the response.
	ResponseStatus int32             `json:"responseStatus,omitempty"`
	Data           *DownloadPolling1 `json:"data,omitempty"`
}

type DownloadWithPollingResponseObject ¶

type DownloadWithPollingResponseObject struct {
	ResponseStatus int32             `json:"responseStatus,omitempty"`
	Data           *DownloadPolling1 `json:"data,omitempty"`
}

PLACEHOLDER

type EmailApiPostEmailReferralOpts ¶

type EmailApiPostEmailReferralOpts struct {
	Body optional.Interface
}

type EmailApiService ¶

type EmailApiService service

func (*EmailApiService) PostEmailReferral ¶

func (a *EmailApiService) PostEmailReferral(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *EmailApiPostEmailReferralOpts) (InlineResponse2014, *http.Response, error)

func (*EmailApiService) PostEmailWelcomeUsername ¶

func (a *EmailApiService) PostEmailWelcomeUsername(ctx context.Context, evAccessToken string, username string, evApiKey string) (InlineResponse2014, *http.Response, error)

EmailApiService Resend welcome email to specific user Resend the initial welcome email to specific user.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param username A username to send welcome email to
@param evApiKey API Key required to make the API call.

@return InlineResponse2014

type EmailList ¶

type EmailList struct {
	Id            int32                   `json:"id,omitempty"`
	Type_         string                  `json:"type,omitempty"`
	Attributes    *EmailListAttributes    `json:"attributes,omitempty"`
	Relationships *EmailListRelationships `json:"relationships,omitempty"`
}

type EmailList1 ¶

type EmailList1 struct {
	// ID of the email list.
	Id int32 `json:"id,omitempty"`
	// Type is emailList.
	Type_         string                                   `json:"type,omitempty"`
	Attributes    *EmailListsIncludedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *EmailListsIncludedResponseRelationships `json:"relationships,omitempty"`
}

type EmailList2 ¶

type EmailList2 struct {
	// ID of the email list.
	Id int32 `json:"id,omitempty"`
	// Type is emailList.
	Type_         string                                   `json:"type,omitempty"`
	Attributes    *EmailList2Attributes                    `json:"attributes,omitempty"`
	Relationships *EmailListsIncludedResponseRelationships `json:"relationships,omitempty"`
}

type EmailList2Attributes ¶

type EmailList2Attributes struct {
	// ID of the email list.
	Name string `json:"name,omitempty"`
	// Receipient emails in the email list.
	Members []string `json:"members,omitempty"`
	// Created datetime.
	Created string `json:"created,omitempty"`
	// Modified datetime.
	Modified string `json:"modified,omitempty"`
}

type EmailListAttributes ¶

type EmailListAttributes struct {
	Name     string   `json:"name,omitempty"`
	Members  []string `json:"members,omitempty"`
	Created  string   `json:"created,omitempty"`
	Modified string   `json:"modified,omitempty"`
}

type EmailListRelationships ¶

type EmailListRelationships struct {
	Owner *EmailListRelationshipsOwner `json:"owner,omitempty"`
}

type EmailListRelationshipsOwner ¶

type EmailListRelationshipsOwner struct {
	Data *EmailListRelationshipsOwnerData `json:"data,omitempty"`
}

type EmailListRelationshipsOwnerData ¶

type EmailListRelationshipsOwnerData struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type EmailListResponse ¶

type EmailListResponse struct {
	Data *EmailList2 `json:"data,omitempty"`
}

Response object for a single email list.

type EmailListResponse1 ¶

type EmailListResponse1 struct {
	// Http status code of the response.
	ResponseStatus int32               `json:"responseStatus,omitempty"`
	Data           *EmailListsResponse `json:"data,omitempty"`
}

type EmailListsApiGetEmailListsOpts ¶

type EmailListsApiGetEmailListsOpts struct {
	Include optional.String
}

type EmailListsApiPatchEmailListOpts ¶

type EmailListsApiPatchEmailListOpts struct {
	Body optional.Interface
}

type EmailListsApiPostEmailListsOpts ¶

type EmailListsApiPostEmailListsOpts struct {
	Body optional.Interface
}

type EmailListsApiService ¶

type EmailListsApiService service

func (*EmailListsApiService) DeleteEmailList ¶

func (a *EmailListsApiService) DeleteEmailList(ctx context.Context, evAccessToken string, id string, evApiKey string) (InlineResponse2001, *http.Response, error)

EmailListsApiService Delete an email list with given id Permanently delete an email list. List action is not reversable. We recommend making a user confirm this action before sending the API call.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id Form id
@param evApiKey API Key required to make the API call.

@return InlineResponse2001

func (*EmailListsApiService) GetEmailLists ¶

func (a *EmailListsApiService) GetEmailLists(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *EmailListsApiGetEmailListsOpts) (InlineResponse200, *http.Response, error)

func (*EmailListsApiService) GetEmailListsId ¶

func (a *EmailListsApiService) GetEmailListsId(ctx context.Context, evAccessToken string, id string, evApiKey string) (EmailListResponse1, *http.Response, error)

EmailListsApiService Get individual email list Retrieve all the metadata tied to a specific email list.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id Form id
@param evApiKey API Key required to make the API call.

@return EmailListResponse1

func (*EmailListsApiService) PatchEmailList ¶

func (a *EmailListsApiService) PatchEmailList(ctx context.Context, evAccessToken string, evApiKey string, id string, localVarOptionals *EmailListsApiPatchEmailListOpts) (EmailListsResponse2, *http.Response, error)

func (*EmailListsApiService) PostEmailLists ¶

func (a *EmailListsApiService) PostEmailLists(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *EmailListsApiPostEmailListsOpts) (EmailListsResponse1, *http.Response, error)

type EmailListsIncludedResponse ¶

type EmailListsIncludedResponse struct {
	Included []User3 `json:"included,omitempty"`
}

Response object for email lists with metadata for included relationships.

type EmailListsIncludedResponseAttributes ¶

type EmailListsIncludedResponseAttributes struct {
	// Name of the email list.
	Name string `json:"name,omitempty"`
	// Receipient emails in the email list.
	Members []string `json:"members,omitempty"`
	// Created datetime.
	Created string `json:"created,omitempty"`
	// Modified datetime.
	Modified string `json:"modified,omitempty"`
}

type EmailListsIncludedResponseAttributes1 ¶

type EmailListsIncludedResponseAttributes1 struct {
	// Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
	Status int32 `json:"status,omitempty"`
	// Timestamp of user expiration.
	Expiration string `json:"expiration,omitempty"`
	// Timestamp of user creation.
	Created string `json:"created,omitempty"`
	// Timestamp of user modification.
	Modified string `json:"modified,omitempty"`
	// Timestamp of most recent successful user login.
	AccessTimestamp string `json:"accessTimestamp,omitempty"`
	// Name of the account this user belongs to.
	AccountName string `json:"accountName,omitempty"`
	// Username of the user.
	Username string `json:"username,omitempty"`
	// Nickname of the user.
	Nickname string `json:"nickname,omitempty"`
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// Path to the user's home folder.
	HomeDir     string                                               `json:"homeDir,omitempty"`
	Permissions *UserCollectionExtendedResponseAttributesPermissions `json:"permissions,omitempty"`
	// User's access level.
	Role string `json:"role,omitempty"`
	// User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone,omitempty"`
	// Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
	// `true` if the user has logged into the system.
	FirstLogin time.Time `json:"firstLogin,omitempty"`
}

type EmailListsIncludedResponseRelationships ¶

type EmailListsIncludedResponseRelationships struct {
	OwnerUser *EmailListsIncludedResponseRelationshipsOwnerUser `json:"ownerUser,omitempty"`
}

type EmailListsIncludedResponseRelationships1 ¶

type EmailListsIncludedResponseRelationships1 struct {
	HomeResource *EmailListsIncludedResponseRelationships1HomeResource `json:"homeResource,omitempty"`
	OwnerAccount *EmailListsIncludedResponseRelationships1OwnerAccount `json:"ownerAccount,omitempty"`
}

type EmailListsIncludedResponseRelationships1HomeResource ¶

type EmailListsIncludedResponseRelationships1HomeResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

type EmailListsIncludedResponseRelationships1OwnerAccount ¶

type EmailListsIncludedResponseRelationships1OwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the account.
	Id int32 `json:"id,omitempty"`
}

type EmailListsIncludedResponseRelationshipsOwnerUser ¶

type EmailListsIncludedResponseRelationshipsOwnerUser struct {
	Data *EmailListsIncludedResponseRelationshipsOwnerUserData `json:"data,omitempty"`
}

type EmailListsIncludedResponseRelationshipsOwnerUserData ¶

type EmailListsIncludedResponseRelationshipsOwnerUserData struct {
	// ID of the owner user.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_ string `json:"type,omitempty"`
}

type EmailListsResponse ¶

type EmailListsResponse struct {
	// ID of the email list.
	Id int32 `json:"id,omitempty"`
	// Type is emailList.
	Type_         string                           `json:"type,omitempty"`
	Attributes    *EmailListsResponseAttributes    `json:"attributes,omitempty"`
	Relationships *EmailListsResponseRelationships `json:"relationships,omitempty"`
}

Response object for email lists

type EmailListsResponse1 ¶

type EmailListsResponse1 struct {
	// Http status code of the response
	ResponseStatus int32               `json:"responseStatus,omitempty"`
	Data           *EmailListsResponse `json:"data,omitempty"`
}

type EmailListsResponse2 ¶

type EmailListsResponse2 struct {
	// Http status code of the response.
	ResponseStatus int32               `json:"responseStatus,omitempty"`
	Data           *EmailListsResponse `json:"data,omitempty"`
}

type EmailListsResponseAttributes ¶

type EmailListsResponseAttributes struct {
	// Name of the email list.
	Name string `json:"name,omitempty"`
	// Recipient emails in the email list.
	Members []string `json:"members,omitempty"`
	// Created datetime.
	Created string `json:"created,omitempty"`
	// Modified datetime.
	Modified string `json:"modified,omitempty"`
}

type EmailListsResponseRelationships ¶

type EmailListsResponseRelationships struct {
	OwnerUser *EmailListsResponseRelationshipsOwnerUser `json:"ownerUser,omitempty"`
}

type EmailListsResponseRelationshipsOwnerUser ¶

type EmailListsResponseRelationshipsOwnerUser struct {
	Data *EmailListsResponseRelationshipsOwnerUserData `json:"data,omitempty"`
}

type EmailListsResponseRelationshipsOwnerUserData ¶

type EmailListsResponseRelationshipsOwnerUserData struct {
	// ID of the owner user.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_ string `json:"type,omitempty"`
}

type Error401 ¶

type Error401 struct {
	// HTTP Status Code
	ResponseStatus int32            `json:"responseStatus"`
	Errors         []Error401Errors `json:"errors,omitempty"`
}

type Error401Errors ¶

type Error401Errors struct {
	// Error Code
	Code string `json:"code"`
	// Additional Details
	Detail string `json:"detail"`
}

type Error403 ¶

type Error403 struct {
	ResponseStatus int32            `json:"responseStatus"`
	Errors         []Error403Errors `json:"errors,omitempty"`
}

type Error403Errors ¶

type Error403Errors struct {
	// Error code
	Code string `json:"code"`
	// Additional Detail
	Detail string `json:"detail"`
}

type Form ¶

type Form struct {
	// Resource type
	Type_ string `json:"type,omitempty"`
	// ID of the form.
	Id            int32              `json:"id,omitempty"`
	Attributes    *FormAttributes    `json:"attributes,omitempty"`
	Relationships *FormRelationships `json:"relationships,omitempty"`
}

Object contains form properties.

type FormApiFormEntriesOpts ¶

type FormApiFormEntriesOpts struct {
	Body optional.Interface
}

type FormApiFormsEntriesIdGetOpts ¶

type FormApiFormsEntriesIdGetOpts struct {
	Limit  optional.Int32
	Offset optional.Int32
}

type FormApiGetFormsIdOpts ¶

type FormApiGetFormsIdOpts struct {
	Include optional.String
}

type FormApiGetFormsOpts ¶

type FormApiGetFormsOpts struct {
	Include optional.String
}

type FormApiService ¶

type FormApiService service

func (*FormApiService) AddFormMessage ¶

func (a *FormApiService) AddFormMessage(ctx context.Context, evApiKey string, evAccessToken string, entryId string, nodeId string, shareHash string) (InlineResponse2011, *http.Response, error)

FormApiService Add a form submission Adds a set of submission data to the form submission history

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evApiKey API Key
@param evAccessToken Access Token
@param entryId Id of the entry to associate a node with
@param nodeId Id of the node to be associated with an entry
@param shareHash Hash of a share that owns current form

@return InlineResponse2011

func (*FormApiService) FormEntries ¶

func (a *FormApiService) FormEntries(ctx context.Context, evApiKey string, shareHash string, localVarOptionals *FormApiFormEntriesOpts) (InlineResponse201, *http.Response, error)

func (*FormApiService) FormsEntriesCompleteEntryIdPost ¶

func (a *FormApiService) FormsEntriesCompleteEntryIdPost(ctx context.Context, evApiKey string, id string) (InlineResponse2004, *http.Response, error)

FormApiService Notifies about form entry completion

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evApiKey API key required to make the API call.
@param id Id of the entry to be completed

@return InlineResponse2004

func (*FormApiService) FormsEntriesIdDelete ¶

func (a *FormApiService) FormsEntriesIdDelete(ctx context.Context, evAccessToken string, id string, evApiKey string) (*http.Response, error)

FormApiService Deletes form data for a given entry id

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id Id of the entry to be deleted data for
@param evApiKey API Key required to make the API call.

func (*FormApiService) FormsEntriesIdGet ¶

func (a *FormApiService) FormsEntriesIdGet(ctx context.Context, evAccessToken string, formId string, evApiKey string, localVarOptionals *FormApiFormsEntriesIdGetOpts) (FormDataResponse, *http.Response, error)

func (*FormApiService) GetForms ¶

func (a *FormApiService) GetForms(ctx context.Context, evApiKey string, shareHash string, evAccessToken string, localVarOptionals *FormApiGetFormsOpts) (InlineResponse2002, *http.Response, error)

func (*FormApiService) GetFormsId ¶

func (a *FormApiService) GetFormsId(ctx context.Context, evApiKey string, id int32, evAccessToken string, localVarOptionals *FormApiGetFormsIdOpts) (InlineResponse2003, *http.Response, error)

func (*FormApiService) UpdateForm ¶

func (a *FormApiService) UpdateForm(ctx context.Context, evAccessToken string, evApiKey string, id string, localVarOptionals *FormApiUpdateFormOpts) (RegularFormResponse, *http.Response, error)

type FormApiUpdateFormOpts ¶

type FormApiUpdateFormOpts struct {
	Body optional.Interface
}

type FormAttributes ¶

type FormAttributes struct {
	// Text that appears at the top of a receive form
	FormDescription string `json:"formDescription,omitempty"`
	// Text that appears on the submit button for the form
	SubmitButtonText string `json:"submitButtonText,omitempty"`
	// Description of form that appears at top.
	Name string `json:"name,omitempty"`
	// Message displayed to submitter after files are uploaded
	SuccessMessage string `json:"successMessage,omitempty"`
	// CSS to format appearance of form elements.
	CssStyles string `json:"cssStyles,omitempty"`
	// Array of form fields defined for the form
	Elements []AnyOfFormAttributesElementsItems `json:"elements,omitempty"`
}

type FormDataResponse ¶

type FormDataResponse struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Total results found.
	TotalResults int32 `json:"totalResults,omitempty"`
	// Number of returned results.
	ReturnedResults int32 `json:"returnedResults,omitempty"`
	// Object submissions data for form.
	Data []FormFieldData1 `json:"data,omitempty"`
}

type FormExtendedResponse ¶

type FormExtendedResponse struct {
	Included []Share4 `json:"included,omitempty"`
}

Response object for forms with metadata for included relationships.

type FormExtendedResponseAttributes ¶

type FormExtendedResponseAttributes struct {
	// Text that appears at the top of a receive form
	FormDescription string `json:"formDescription,omitempty"`
	// Text that appears on the submit button for the form
	SubmitButtonText string `json:"submitButtonText,omitempty"`
	// Description of form that appears at top.
	Name string `json:"name,omitempty"`
	// Message displayed to submitter after files are uploaded
	SuccessMessage string `json:"successMessage,omitempty"`
	// CSS to format appearance of form elements.
	CssStyles string `json:"cssStyles,omitempty"`
	// Array of form fields defined for the form
	Elements []AnyOfFormExtendedResponseAttributesElementsItems `json:"elements,omitempty"`
}

type FormField ¶

type FormField struct {
	// Field id number
	Id int32 `json:"id,omitempty"`
	// Label of the field
	Name string `json:"name,omitempty"`
	// Order that field appears on the form, starting from 0
	Order int32 `json:"order,omitempty"`
	// Field type
	Type_    string             `json:"type,omitempty"`
	Settings *FormFieldSettings `json:"settings,omitempty"`
}

type FormFieldData ¶

type FormFieldData struct {
	// Timestamp of the submission
	Created string `json:"created,omitempty"`
	// Full paths to files associated with the form submission
	Paths []string `json:"paths,omitempty"`
	// All fields defined on the form will be included. Name will be the name of the field. Value is the value that was submitted in the form. Each will be its own attribute of the data object
	OtherFields struct{} `json:"other fields,omitempty"`
}

Contains the data submitted for a form.

type FormFieldData1 ¶

type FormFieldData1 struct {
	// Timestamp of the submission
	Created string `json:"created,omitempty"`
	// Full paths to files associated with the form submission
	Paths []string `json:"paths,omitempty"`
	// All fields defined on the form will be included. Name will be the name of the field. Value is the value that was submitted in the form. Each will be its own attribute of the data object
	OtherFields struct{} `json:"other fields,omitempty"`
}

Contains the data submitted for a form.

type FormFieldSettings ¶

type FormFieldSettings struct {
	// Secondary description of field
	Description string `json:"description,omitempty"`
	// How much of the available width the field should occupy
	Width float32 `json:"width,omitempty"`
	// Whether this field must be completed before form can be submitted
	IsRequired bool `json:"isRequired,omitempty"`
	// Whether to place submitted files into a subfolder named the contents of this field. Only takes effect when the `fileDropCreateFolders` parameter on the receive folder is `true`. `isRequired` must be set to `true` if this setting is `true`.
	UseAsFolderName bool `json:"useAsFolderName,omitempty"`
}

Advanced field settings

type FormRelationships ¶

type FormRelationships struct {
	Share *FormRelationshipsShare `json:"share,omitempty"`
}

type FormRelationshipsShare ¶

type FormRelationshipsShare struct {
	Data *FormRelationshipsShareData `json:"data,omitempty"`
}

type FormRelationshipsShareData ¶

type FormRelationshipsShareData struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type FormResponse ¶

type FormResponse struct {
	// Type is form.
	Type_ string `json:"type,omitempty"`
	// ID of the form.
	Id            int32                      `json:"id,omitempty"`
	Attributes    *FormResponseAttributes    `json:"attributes,omitempty"`
	Relationships *FormResponseRelationships `json:"relationships,omitempty"`
}

Response object for forms.

type FormResponseAttributes ¶

type FormResponseAttributes struct {
	// Text that appears at the top of a receive form
	FormDescription string `json:"formDescription,omitempty"`
	// Text that appears on the submit button for the form
	SubmitButtonText string `json:"submitButtonText,omitempty"`
	// Message displayed to submitter after files are uploaded
	SuccessMessage string `json:"successMessage,omitempty"`
	// CSS Styles of the form.
	CssStyles string `json:"cssStyles,omitempty"`
	// Array of form fields defined for the form
	Elements []AnyOfFormResponseAttributesElementsItems `json:"elements,omitempty"`
}

type FormResponseRelationships ¶

type FormResponseRelationships struct {
	Share *FormResponseRelationshipsShare `json:"share,omitempty"`
}

type FormResponseRelationshipsShare ¶

type FormResponseRelationshipsShare struct {
	Data *FormResponseRelationshipsShareData `json:"data,omitempty"`
}

type FormResponseRelationshipsShareData ¶

type FormResponseRelationshipsShareData struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type is share.
	Type_ string `json:"type,omitempty"`
}

type FormsidElements ¶

type FormsidElements struct {
	// ID of the form element. If you're adding a new element to the form, do not include this field.
	Id int32 `json:"id,omitempty"`
	// Name of the form element.
	Name string `json:"name,omitempty"`
	// The order the fields will be displayed to the receipient. Starts at 0.
	Order int32 `json:"order,omitempty"`
	// Type of form field to use.
	Type_    string           `json:"type,omitempty"`
	Settings *FormsidSettings `json:"settings,omitempty"`
}

type FormsidSettings ¶

type FormsidSettings struct {
	// True is the form element is required for submission.
	IsRequired  bool `json:"isRequired,omitempty"`
	SenderEmail bool `json:"senderEmail,omitempty"`
	// True if the submitted response should be used as the name for the new folder.
	UseAsFolderName bool `json:"useAsFolderName,omitempty"`
}

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InlineResponse200 ¶

type InlineResponse200 struct {
}

type InlineResponse2001 ¶

type InlineResponse2001 struct {
	// Http status code of the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Data           []interface{} `json:"data,omitempty"`
}

type InlineResponse20010 ¶

type InlineResponse20010 struct {
	// Http status code for the response.
	ResponseStatus int32        `json:"responseStatus,omitempty"`
	Data           *interface{} `json:"data,omitempty"`
}

type InlineResponse20011 ¶

type InlineResponse20011 struct {
}

type InlineResponse20012 ¶

type InlineResponse20012 struct {
	Included []interface{} `json:"included,omitempty"`
}

type InlineResponse20013 ¶

type InlineResponse20013 struct {
	Included []interface{} `json:"included,omitempty"`
}

type InlineResponse20014 ¶

type InlineResponse20014 struct {
	// Http status code of the response.
	ResponseStatus int32                    `json:"responseStatus,omitempty"`
	Data           *InlineResponse20014Data `json:"data,omitempty"`
}

type InlineResponse20014Data ¶

type InlineResponse20014Data struct {
	// ID of the deleted resource.
	Id string `json:"id,omitempty"`
	// Type is resource.
	Type_ string                       `json:"type,omitempty"`
	Meta  *InlineResponse20014DataMeta `json:"meta,omitempty"`
}

type InlineResponse20014DataMeta ¶

type InlineResponse20014DataMeta struct {
	// ID of the meta.
	Id string `json:"id,omitempty"`
}

type InlineResponse20015 ¶

type InlineResponse20015 struct {
	Included []interface{} `json:"included,omitempty"`
}

type InlineResponse20016 ¶

type InlineResponse20016 struct {
	Included []interface{} `json:"included,omitempty"`
}

type InlineResponse20017 ¶

type InlineResponse20017 struct {
	Meta *InlineResponse20017Meta `json:"meta,omitempty"`
}

type InlineResponse20017Meta ¶

type InlineResponse20017Meta struct {
	// Path to the original resource.
	Path []string `json:"path,omitempty"`
	// Path to the copied resource.
	DedestinationPath string `json:"dedestinationPath,omitempty"`
}

type InlineResponse20018 ¶

type InlineResponse20018 struct {
	Meta *InlineResponse20018Meta `json:"meta,omitempty"`
}

type InlineResponse20018Meta ¶

type InlineResponse20018Meta struct {
	// Path to the original resources.
	ResourcePath []string `json:"resourcePath,omitempty"`
	// Path to the moved resource.
	Destination string `json:"destination,omitempty"`
}

type InlineResponse20019 ¶

type InlineResponse20019 struct {
}

type InlineResponse2002 ¶

type InlineResponse2002 struct {
}

type InlineResponse20020 ¶

type InlineResponse20020 struct {
}

type InlineResponse20021 ¶

type InlineResponse20021 struct {
}

type InlineResponse20022 ¶

type InlineResponse20022 struct {
	// Http status code of the response
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// All email addresses that have recevied a share.
	Data []string `json:"data,omitempty"`
}

type InlineResponse20023 ¶

type InlineResponse20023 struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
}

type InlineResponse2003 ¶

type InlineResponse2003 struct {
}

type InlineResponse2004 ¶

type InlineResponse2004 struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
}

type InlineResponse2005 ¶

type InlineResponse2005 struct {
}

type InlineResponse2006 ¶

type InlineResponse2006 struct {
	// Http status code of the response.
	ResponseStatus int32        `json:"responseStatus,omitempty"`
	Data           *interface{} `json:"data,omitempty"`
}

type InlineResponse2007 ¶

type InlineResponse2007 struct {
}

type InlineResponse2008 ¶

type InlineResponse2008 struct {
}

type InlineResponse2009 ¶

type InlineResponse2009 struct {
}

type InlineResponse201 ¶

type InlineResponse201 struct {
	ResponseStatus int32                  `json:"responseStatus,omitempty"`
	Data           *InlineResponse201Data `json:"data,omitempty"`
}

type InlineResponse2011 ¶

type InlineResponse2011 struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
}

type InlineResponse2012 ¶

type InlineResponse2012 struct {
	Included []interface{} `json:"included,omitempty"`
}

type InlineResponse2013 ¶

type InlineResponse2013 struct {
	// Http status code for the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Count of results returned in the call.
	ReturnedResults int32             `json:"returnedResults,omitempty"`
	Data            *ResourceResponse `json:"data,omitempty"`
}

type InlineResponse2014 ¶

type InlineResponse2014 struct {
	// Http status code of the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Data           []interface{} `json:"data,omitempty"`
}

type InlineResponse2015 ¶

type InlineResponse2015 struct {
	// Http status code of the response.
	ResponseStatus int32                   `json:"responseStatus,omitempty"`
	Data           *InlineResponse2015Data `json:"data,omitempty"`
}

type InlineResponse2015Data ¶

type InlineResponse2015Data struct {
	// List of email addresses for the share's recipients.
	Recipients []string `json:"recipients,omitempty"`
}

type InlineResponse201Data ¶

type InlineResponse201Data struct {
	// PLACEHOLDER
	MessageId int32 `json:"messageId,omitempty"`
}

type Message ¶

type Message struct {
	// Message id.
	Id int32 `json:"id,omitempty"`
	// Resource type
	Type_      string             `json:"type,omitempty"`
	Attributes *MessageAttributes `json:"attributes,omitempty"`
}

type Message1 ¶

type Message1 struct {
	// Message id.
	Id int32 `json:"id,omitempty"`
	// Resource type
	Type_      string             `json:"type,omitempty"`
	Attributes *MessageAttributes `json:"attributes,omitempty"`
}

type MessageAttributes ¶

type MessageAttributes struct {
	// Message subject.
	Subject string `json:"subject,omitempty"`
	// Message text.
	Body string `json:"body,omitempty"`
	// Timestamp of message creation.
	Created string `json:"created,omitempty"`
	// Timestamp of message modification.
	Modified string `json:"modified,omitempty"`
}

type ModelError ¶

type ModelError struct {
	// Specific internal error string.
	Code string `json:"code,omitempty"`
	// Human readable summary of the problem.
	Title string `json:"title,omitempty"`
	// human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail,omitempty"`
	// Meta object containing non-standard meta-information about the error.
	Meta *interface{} `json:"meta,omitempty"`
}

type NotificartionRecipient ¶

type NotificartionRecipient struct {
	// ID of the recipient.
	Id int32 `json:"id,omitempty"`
	// ID of the notification that the recipient belongs to.
	NotificationId string `json:"notificationId,omitempty"`
	// Recipient email.
	Email string `json:"email,omitempty"`
	// Timestamp of adding notification recipient.
	Created string `json:"created,omitempty"`
	// Timestamp of notification recipient modification.
	Modified string `json:"modified,omitempty"`
}

type Notification ¶

type Notification struct {
	Id            int32                                                `json:"id,omitempty"`
	Type_         string                                               `json:"type,omitempty"`
	Attributes    *NotificationCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *NotificationCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

Object containing notification properties.

type Notification1 ¶

type Notification1 struct {
	Id            int32                                                `json:"id,omitempty"`
	Type_         string                                               `json:"type,omitempty"`
	Attributes    *NotificationCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *NotificationCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

Object containing notification properties.

type NotificationCollectionExtendedResponse ¶

type NotificationCollectionExtendedResponse struct {
	Included []struct{} `json:"included,omitempty"`
}

type NotificationCollectionExtendedResponseAttributes ¶

type NotificationCollectionExtendedResponseAttributes struct {
	// ID of the user that the notification belongs to.
	UserId string `json:"userId,omitempty"`
	// Notification type.
	Type_ string `json:"type,omitempty"`
	// Path to the item that the notification is set on.
	Path string `json:"path,omitempty"`
	// Name of the item that the notification is set on.
	Name string `json:"name,omitempty"`
	// Action that triggers notification.
	Action string `json:"action,omitempty"`
	// Detail on which users can trigger the notification.
	Usernames []string `json:"usernames,omitempty"`
	// Notification recipients.
	Recipients []NotificartionRecipient `json:"recipients,omitempty"`
	// Email addresses of all recipients.
	RecipientEmails []string `json:"recipientEmails,omitempty"`
	// Send email when the notification is triggered.
	SendEmail string `json:"sendEmail,omitempty"`
	// Human readable description of the notification.
	ReadableDescription string `json:"readableDescription,omitempty"`
	// Human readable description of the notification without item path.
	ReadableDescriptionWithoutPath string `json:"readableDescriptionWithoutPath,omitempty"`
	// ID of the share that the notification belogns to.
	ShareId string `json:"shareId,omitempty"`
	// Custom message that will be sent to the notification recipients.
	Message string `json:"message,omitempty"`
	// Timestamp of notifiction creation.
	Created string `json:"created,omitempty"`
	// Timestamp of notification modification.
	Modified string `json:"modified,omitempty"`
}

type NotificationCollectionExtendedResponseRelationships ¶

type NotificationCollectionExtendedResponseRelationships struct {
	Node  *NotificationCollectionExtendedResponseRelationshipsNode  `json:"node,omitempty"`
	Share *NotificationCollectionExtendedResponseRelationshipsShare `json:"share,omitempty"`
	Owner *NotificationCollectionExtendedResponseRelationshipsOwner `json:"owner,omitempty"`
}

type NotificationCollectionExtendedResponseRelationshipsNode ¶

type NotificationCollectionExtendedResponseRelationshipsNode struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type NotificationCollectionExtendedResponseRelationshipsOwner ¶

type NotificationCollectionExtendedResponseRelationshipsOwner struct {
	// PLACEHOLDER
	Type_ string `json:"type,omitempty"`
	// PLACEHOLDER
	Id int32 `json:"id,omitempty"`
}

type NotificationCollectionExtendedResponseRelationshipsShare ¶

type NotificationCollectionExtendedResponseRelationshipsShare struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type NotificationCollectionResponse ¶

type NotificationCollectionResponse struct {
	ResponseStatus  int32           `json:"responseStatus,omitempty"`
	TotalResults    int32           `json:"totalResults,omitempty"`
	ReturnedResults int32           `json:"returnedResults,omitempty"`
	Data            []Notification1 `json:"data,omitempty"`
}

type NotificationExtendedResponse ¶

type NotificationExtendedResponse struct {
	Included []interface{} `json:"included,omitempty"`
}

Response object for notifications with metadata for included relationships.

type NotificationRecipient ¶

type NotificationRecipient struct {
	// ID of the recipient.
	Id int32 `json:"id,omitempty"`
	// ID of the notification that the recipient belongs to.
	NotificationId string `json:"notificationId,omitempty"`
	// Recipient email.
	Email string `json:"email,omitempty"`
	// Timestamp of adding notification recipient.
	Created string `json:"created,omitempty"`
	// Timestamp of notification recipient modification.
	Modified string `json:"modified,omitempty"`
}

type NotificationResponse ¶

type NotificationResponse struct {
	// ID of the notification.
	Id int32 `json:"id,omitempty"`
	// Type is notification.
	Type_         string                             `json:"type,omitempty"`
	Attributes    *NotificationResponseAttributes    `json:"attributes,omitempty"`
	Relationships *NotificationResponseRelationships `json:"relationships,omitempty"`
}

Response object for notifications.

type NotificationResponseAttributes ¶

type NotificationResponseAttributes struct {
	// ID of the user that the notification belongs to.
	UserId string `json:"userId,omitempty"`
	// Type of the resoucre the notification is attached to.
	Type_ string `json:"type,omitempty"`
	// Path to the item that the notification is set on.
	Path string `json:"path,omitempty"`
	// Name of the item that the notification is set on.
	Name string `json:"name,omitempty"`
	// Action that triggers notification.
	Action string `json:"action,omitempty"`
	// Detail on which users can trigger the notification.
	Usernames []string `json:"usernames,omitempty"`
	// Notification recipients.
	Recipients []NotificartionRecipient `json:"recipients,omitempty"`
	// Email addresses of all recipients.
	RecipientEmails []string `json:"recipientEmails,omitempty"`
	// Whether or not an email will send when the notification is triggered.
	SendEmail string `json:"sendEmail,omitempty"`
	// Human readable description of the notification.
	ReadableDescription string `json:"readableDescription,omitempty"`
	// Human readable description of the notification without item path.
	ReadableDescriptionWithoutPath string `json:"readableDescriptionWithoutPath,omitempty"`
	// ID of the share that the notification belogns to.
	ShareId string `json:"shareId,omitempty"`
	// Custom message that will be sent to the notification recipients.
	Message string `json:"message,omitempty"`
	// Timestamp of notifiction creation.
	Created string `json:"created,omitempty"`
	// Timestamp of notification modification.
	Modified string `json:"modified,omitempty"`
}

type NotificationResponseObject ¶

type NotificationResponseObject struct {
	// Http status code of the response.
	ResponseStatus int32                 `json:"responseStatus,omitempty"`
	Data           *NotificationResponse `json:"data,omitempty"`
}

type NotificationResponseObject1 ¶

type NotificationResponseObject1 struct {
	// Http status code of the response.
	ResponseStatus int32                 `json:"responseStatus,omitempty"`
	Data           *NotificationResponse `json:"data,omitempty"`
}

type NotificationResponseRelationships ¶

type NotificationResponseRelationships struct {
	Resource  *NotificationResponseRelationshipsResource  `json:"resource,omitempty"`
	Share     *NotificationResponseRelationshipsShare     `json:"share,omitempty"`
	OwnerUser *NotificationResponseRelationshipsOwnerUser `json:"ownerUser,omitempty"`
}

type NotificationResponseRelationshipsOwnerUser ¶

type NotificationResponseRelationshipsOwnerUser struct {
	// Type is user.
	Type_ string `json:"type,omitempty"`
	// ID of the user that owns the notification.
	Id int32 `json:"id,omitempty"`
}

type NotificationResponseRelationshipsResource ¶

type NotificationResponseRelationshipsResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

type NotificationResponseRelationshipsShare ¶

type NotificationResponseRelationshipsShare struct {
	// Type is share.
	Type_ string `json:"type,omitempty"`
	// ID of the share.
	Id int32 `json:"id,omitempty"`
}

type NotificationsApiNotificationsGetOpts ¶

type NotificationsApiNotificationsGetOpts struct {
	Type_   optional.String
	Offset  optional.Int32
	Sort    optional.String
	Limit   optional.Int32
	Include optional.String
}

type NotificationsApiNotificationsIdGetOpts ¶

type NotificationsApiNotificationsIdGetOpts struct {
	Include optional.String
}

type NotificationsApiNotificationsIdPatchOpts ¶

type NotificationsApiNotificationsIdPatchOpts struct {
	Body optional.Interface
}

type NotificationsApiNotificationsPostOpts ¶

type NotificationsApiNotificationsPostOpts struct {
	Body optional.Interface
}

type NotificationsApiNotificationsUnsubscribePostOpts ¶

type NotificationsApiNotificationsUnsubscribePostOpts struct {
	Body optional.Interface
}

type NotificationsApiService ¶

type NotificationsApiService service

func (*NotificationsApiService) NotificationsGet ¶

func (a *NotificationsApiService) NotificationsGet(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *NotificationsApiNotificationsGetOpts) (InlineResponse2007, *http.Response, error)

func (*NotificationsApiService) NotificationsIdDelete ¶

func (a *NotificationsApiService) NotificationsIdDelete(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse2006, *http.Response, error)

NotificationsApiService Delete a notification Deletes the specified notification. Note that deleting a notification _only_ deletes the notification &ndash; it does not delete any underlying files or folders. > **Notes:** - Authenticated user requires notification permission. - Authenticated user should be the owner of the specified notification.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id ID of the notification. Use <a href=\"#operation/getNotifications\">getNotifications</a> if you need to lookup an ID.
@param evApiKey API Key required to make the API call.

@return InlineResponse2006

func (*NotificationsApiService) NotificationsIdGet ¶

func (a *NotificationsApiService) NotificationsIdGet(ctx context.Context, evAccessToken string, id int32, evApiKey string, localVarOptionals *NotificationsApiNotificationsIdGetOpts) (InlineResponse2005, *http.Response, error)

func (*NotificationsApiService) NotificationsIdPatch ¶

func (a *NotificationsApiService) NotificationsIdPatch(ctx context.Context, evAccessToken string, evApiKey string, id int32, localVarOptionals *NotificationsApiNotificationsIdPatchOpts) (NotificationResponseObject, *http.Response, error)

func (*NotificationsApiService) NotificationsPost ¶

func (a *NotificationsApiService) NotificationsPost(ctx context.Context, evAccessToken string, evApiKey string, resource string, localVarOptionals *NotificationsApiNotificationsPostOpts) (NotificationResponseObject1, *http.Response, error)

func (*NotificationsApiService) NotificationsUnsubscribePost ¶

func (a *NotificationsApiService) NotificationsUnsubscribePost(ctx context.Context, evApiKey string, evAccessToken string, localVarOptionals *NotificationsApiNotificationsUnsubscribePostOpts) (*http.Response, error)

type OneOfinlineResponse200 ¶

type OneOfinlineResponse200 struct {
}

type OneOfinlineResponse2002 ¶

type OneOfinlineResponse2002 struct {
}

type OneOfinlineResponse20020 ¶

type OneOfinlineResponse20020 struct {
}

type OneOfinlineResponse20021 ¶

type OneOfinlineResponse20021 struct {
}

type OneOfinlineResponse2003 ¶

type OneOfinlineResponse2003 struct {
}

type OneOfinlineResponse2005 ¶

type OneOfinlineResponse2005 struct {
}

type OneOfinlineResponse2007 ¶

type OneOfinlineResponse2007 struct {
}

type OneOfinlineResponse2008 ¶

type OneOfinlineResponse2008 struct {
}

type OneOfinlineResponse2009 ¶

type OneOfinlineResponse2009 struct {
}

type PreivewFileResponseObject ¶

type PreivewFileResponseObject struct {
	// HTTP Status Code
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Data           *PreviewFile2 `json:"data,omitempty"`
}

PLACEHOLDER

type PreviewFile ¶

type PreviewFile struct {
	Id         int32                   `json:"id,omitempty"`
	Type_      string                  `json:"type,omitempty"`
	Attributes *PreviewFile1Attributes `json:"attributes,omitempty"`
}

Object with preview image properties.

type PreviewFile1 ¶

type PreviewFile1 struct {
	Id         int32                   `json:"id,omitempty"`
	Type_      string                  `json:"type,omitempty"`
	Attributes *PreviewFile1Attributes `json:"attributes,omitempty"`
}

Object with preview image properties.

type PreviewFile1Attributes ¶

type PreviewFile1Attributes struct {
	// Binary image content, base64 encoded.
	Image string `json:"image,omitempty"`
	// Size of the image in bytes.
	Size int64 `json:"size,omitempty"`
	// ID of the image.
	ImageId string `json:"imageId,omitempty"`
	// Amount of pages available in the file. Used only for multipage documents.
	PageCount int32 `json:"pageCount,omitempty"`
}

type PreviewFile2 ¶

type PreviewFile2 struct {
	// Resource ID
	Id int32 `json:"id,omitempty"`
	// Type of resource
	Type_      string                  `json:"type,omitempty"`
	Attributes *PreviewFile1Attributes `json:"attributes,omitempty"`
}

Object with preview image properties.

type PreviewFileResponse ¶

type PreviewFileResponse struct {
	Data *PreviewFile1 `json:"data,omitempty"`
}

PLACEHOLDER

type RecipientsApiService ¶

type RecipientsApiService service

func (*RecipientsApiService) DeleteRecipientsSharesEmail ¶

func (a *RecipientsApiService) DeleteRecipientsSharesEmail(ctx context.Context, evAccessToken string, email string, evApiKey string) (InlineResponse20023, *http.Response, error)

RecipientsApiService Delete a share recipient from all shares Delete a share recipient from all shares they've been invited to. This will not delete any files or folders.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param email PLACEHOLDER
@param evApiKey API Key required to make the API call.

@return InlineResponse20023

func (*RecipientsApiService) DeleteRecipientsSharesShareIdEmail ¶

func (a *RecipientsApiService) DeleteRecipientsSharesShareIdEmail(ctx context.Context, evAccessToken string, shareId int32, email string, evApiKey string) (InlineResponse20023, *http.Response, error)

RecipientsApiService Delete a share recipient from a single share Delete a share recipient from a single share they've been invited to. This will not delete any files or folders.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param shareId PLACEHOLDER
@param email PLACEHOLDER
@param evApiKey API Key required to make the API call.

@return InlineResponse20023

func (*RecipientsApiService) GetRecipients ¶

func (a *RecipientsApiService) GetRecipients(ctx context.Context, evAccessToken string, evApiKey string) (InlineResponse20022, *http.Response, error)

RecipientsApiService Get share recipient emails Retrieve all email addresses that have been sent a share in the past.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param evApiKey API Key required to make the API call.

@return InlineResponse20022

func (*RecipientsApiService) PostRecipientsSharesInvitesShareId ¶

func (a *RecipientsApiService) PostRecipientsSharesInvitesShareId(ctx context.Context, evAccessToken string, shareId int32, evApiKey string) (InlineResponse2015, *http.Response, error)

RecipientsApiService Resend invitations to share recipients Resend invitations to all recipients on a defined share.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param shareId PLACEHOLDER
@param evApiKey API Key required to make the API call.

@return InlineResponse2015

type RegularFormResponse ¶

type RegularFormResponse struct {
	// Http status code of the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Data           *FormResponse `json:"data,omitempty"`
}

type RegularShareResponse ¶

type RegularShareResponse struct {
	// Http status code of the response.
	ResponseStatus int32           `json:"responseStatus,omitempty"`
	Data           []ShareResponse `json:"data,omitempty"`
}

type RegularShareResponse1 ¶

type RegularShareResponse1 struct {
	// Http status code of the response.
	ResponseStatus int32          `json:"responseStatus,omitempty"`
	Data           *ShareResponse `json:"data,omitempty"`
}

type RegularShareResponse2 ¶

type RegularShareResponse2 struct {
	ResponseStatus int32          `json:"responseStatus,omitempty"`
	Data           *ShareResponse `json:"data,omitempty"`
}

PLACEHOLDER

type ReportResponse ¶

type ReportResponse struct {
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Array contains report lines.
	Data []string `json:"data,omitempty"`
}

PLACEHOLDER

type Resource ¶

type Resource struct {
	Id            int32                                            `json:"id,omitempty"`
	Type_         string                                           `json:"type,omitempty"`
	Attributes    *ResourceCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *ResourceCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

All properties of the resource.

type Resource1 ¶

type Resource1 struct {
	Id            int32                                            `json:"id,omitempty"`
	Type_         string                                           `json:"type,omitempty"`
	Attributes    *ResourceCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *ResourceCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

All properties of the resource.

type Resource2 ¶

type Resource2 struct {
	Id            int32                                            `json:"id,omitempty"`
	Type_         string                                           `json:"type,omitempty"`
	Attributes    *Resource2Attributes                             `json:"attributes,omitempty"`
	Relationships *ResourceCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

All properties of the resource.

type Resource2Attributes ¶

type Resource2Attributes struct {
	// Unique hash of the resource.
	Hash string `json:"hash,omitempty"`
	// Resource name, e.g. the name of the file or folder.
	Name string `json:"name,omitempty"`
	// Resource extension. Property exists only if resource `type` is file.
	Extension string `json:"extension,omitempty"`
	// Type of the resource.
	Type_ string `json:"type,omitempty"`
	// Username of the creator.
	CreatedBy string `json:"createdBy,omitempty"`
	// Timestamp of resource upload.
	UploadDate string `json:"uploadDate,omitempty"`
	// Timestamp of resource creation.
	CreatedAt string `json:"createdAt,omitempty"`
	// Timestamp of resource modification.
	UpdatedAt string `json:"updatedAt,omitempty"`
	// Timestamp of the time when resource was accessed.
	AccessedAt string `json:"accessedAt,omitempty"`
	// Full path to the resource.
	Path string `json:"path,omitempty"`
	// Count of files in resource. Property exists only if resource `type` is folder.
	FileCount int32 `json:"fileCount,omitempty"`
	// Resource size in bytes.
	Size int64 `json:"size,omitempty"`
	// Can resource be previewed. Property equals `null` if resource `type` is folder.
	Previewable bool   `json:"previewable,omitempty"`
	CreatedTIme string `json:"createdTIme,omitempty"`
	UpdatedTIme string `json:"updatedTIme,omitempty"`
	AccessTime  string `json:"accessTime,omitempty"`
}

type ResourceAttributes ¶

type ResourceAttributes struct {
	// Unique hash of the resource.
	Hash string `json:"hash,omitempty"`
	// Resource name, e.g. the name of the file or folder.
	Name string `json:"name,omitempty"`
	// Resource extension. Property exists only if resource `type` is file.
	Extension string `json:"extension,omitempty"`
	// Type of the resource.
	Type_ string `json:"type,omitempty"`
	// Username of the creator.
	CreatedBy string `json:"createdBy,omitempty"`
	// Timestamp of resource upload.
	UploadDate string `json:"uploadDate,omitempty"`
	// Timestamp of resource creation.
	CreatedAt string `json:"createdAt,omitempty"`
	// Timestamp of resource modification.
	UpdatedAt string `json:"updatedAt,omitempty"`
	// Timestamp of the time when resource was accessed.
	AccessedAt string `json:"accessedAt,omitempty"`
	// Full path to the resource.
	Path string `json:"path,omitempty"`
	// Resource size in bytes
	Size int64 `json:"size,omitempty"`
	// Can resource be previewed. Property equals `null` if resource `type` is dir.
	Previewable bool `json:"previewable,omitempty"`
	// Number of files within folder. null if resource type is a file.
	FileCount int `json:"fileCount,omitempty"`
}

type ResourceCollectionExtendedResponse ¶

type ResourceCollectionExtendedResponse struct {
	Included []struct{} `json:"included,omitempty"`
}

type ResourceCollectionExtendedResponseAttributes ¶

type ResourceCollectionExtendedResponseAttributes struct {
	// Unique hash of the resource.
	Hash string `json:"hash,omitempty"`
	// Resource name, e.g. the name of the file or folder.
	Name string `json:"name,omitempty"`
	// Resource extension. Property exists only if resource `type` is file.
	Extension string `json:"extension,omitempty"`
	// Type of the resource.
	Type_ string `json:"type,omitempty"`
	// Username of the creator.
	CreatedBy string `json:"createdBy,omitempty"`
	// Timestamp of resource upload.
	UploadDate string `json:"uploadDate,omitempty"`
	// Timestamp of resource creation.
	CreatedAt string `json:"createdAt,omitempty"`
	// Timestamp of resource modification.
	UpdatedAt string `json:"updatedAt,omitempty"`
	// Timestamp of the time when resource was accessed.
	AccessedAt string `json:"accessedAt,omitempty"`
	// Parent path of the resource.
	Parent string `json:"parent,omitempty"`
	// Full path to the resource.
	Path string `json:"path,omitempty"`
	// Count of files in resource. Property exists only if resource `type` is folder.
	FileCount int32 `json:"fileCount,omitempty"`
	// Resource size.
	Size int64 `json:"size,omitempty"`
	// Can resource be previewed. Property equals `null` if resource `type` is folder.
	Previewable bool `json:"previewable,omitempty"`
}

type ResourceCollectionExtendedResponseRelationships ¶

type ResourceCollectionExtendedResponseRelationships struct {
	Share        *ResourceCollectionExtendedResponseRelationshipsShare        `json:"share,omitempty"`
	Notification *ResourceCollectionExtendedResponseRelationshipsNotification `json:"notification,omitempty"`
	DirectFile   *ResourceCollectionExtendedResponseRelationshipsDirectFile   `json:"directFile,omitempty"`
	ParentNode   *ResourceCollectionExtendedResponseRelationshipsParentNode   `json:"parentNode,omitempty"`
}

type ResourceCollectionExtendedResponseRelationshipsDirectFile ¶

type ResourceCollectionExtendedResponseRelationshipsDirectFile struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type ResourceCollectionExtendedResponseRelationshipsNotification ¶

type ResourceCollectionExtendedResponseRelationshipsNotification struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type ResourceCollectionExtendedResponseRelationshipsParentNode ¶

type ResourceCollectionExtendedResponseRelationshipsParentNode struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type ResourceCollectionExtendedResponseRelationshipsShare ¶

type ResourceCollectionExtendedResponseRelationshipsShare struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
}

type ResourceCollectionMetaResponse ¶

type ResourceCollectionMetaResponse struct {
	Meta *ResourceCollectionMetaResponseMeta `json:"meta,omitempty"`
}

type ResourceCollectionMetaResponseMeta ¶

type ResourceCollectionMetaResponseMeta struct {
	OriginalId   int32  `json:"originalId,omitempty"`
	ResourcePath string `json:"resourcePath,omitempty"`
	Destination  string `json:"destination,omitempty"`
}

type ResourceCollectionResponse ¶

type ResourceCollectionResponse struct {
	ResponseStatus  int32       `json:"responseStatus,omitempty"`
	TotalResults    int32       `json:"totalResults,omitempty"`
	ReturnedResults int32       `json:"returnedResults,omitempty"`
	Data            []Resource1 `json:"data,omitempty"`
}

type ResourceDeleteMultiResponseObject ¶

type ResourceDeleteMultiResponseObject struct {
	Responses []AllOfResourceDeleteMultiResponseObjectResponsesItems `json:"responses,omitempty"`
}

PLACEHOLDER

type ResourceDeleteResponse ¶

type ResourceDeleteResponse struct {
	ResponseStatus int32                       `json:"responseStatus,omitempty"`
	Data           *ResourceDeleteResponseData `json:"data,omitempty"`
}

PLACEHOLDER

type ResourceDeleteResponseData ¶

type ResourceDeleteResponseData struct {
	Id    int32  `json:"id,omitempty"`
	Type_ string `json:"type,omitempty"`
	// Meta object containing non-standard meta-information about the delete operation.
	Meta *interface{} `json:"meta,omitempty"`
}

type ResourceExtendedResponse ¶

type ResourceExtendedResponse struct {
	Included []interface{} `json:"included,omitempty"`
}

type ResourceMultiResponse ¶

type ResourceMultiResponse struct {
	Responses []AllOfResourceMultiResponseResponsesItems `json:"responses,omitempty"`
}

type ResourceMultiResponseDelete ¶

type ResourceMultiResponseDelete struct {
	Responses []AllOfResourceMultiResponseDeleteResponsesItems `json:"responses,omitempty"`
}

type ResourceMultiResponseObject ¶

type ResourceMultiResponseObject struct {
	Responses []AllOfResourceMultiResponseObjectResponsesItems `json:"responses,omitempty"`
}

PLACEHOLDER

type ResourceResponse ¶

type ResourceResponse struct {
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
	// Type is resource.
	Type_         string                         `json:"type,omitempty"`
	Attributes    *ResourceResponseAttributes    `json:"attributes,omitempty"`
	Relationships *ResourceResponseRelationships `json:"relationships,omitempty"`
}

Response object for resources.

type ResourceResponseAttributes ¶

type ResourceResponseAttributes struct {
	// Unique hash of the resource.
	Hash string `json:"hash,omitempty"`
	// Resource name, e.g. the name of the file or folder.
	Name string `json:"name,omitempty"`
	// Resource extension. Property exists only if resource `type` is file.
	Extension string `json:"extension,omitempty"`
	// Type of the resource.
	Type_ string `json:"type,omitempty"`
	// Username of the creator.
	CreatedBy string `json:"createdBy,omitempty"`
	// Timestamp of resource upload.
	UploadDate string `json:"uploadDate,omitempty"`
	// Timestamp of resource creation.
	CreatedAt string `json:"createdAt,omitempty"`
	// Timestamp of resource modification.
	UpdatedAt string `json:"updatedAt,omitempty"`
	// Timestamp of the time when resource was accessed.
	AccessedAt string `json:"accessedAt,omitempty"`
	// Full path to the resource.
	Path string `json:"path,omitempty"`
	// Count of files in resource. Property exists only if resource `type` is folder.
	FileCount int32 `json:"fileCount,omitempty"`
	// Resource size in bytes.
	Size int64 `json:"size,omitempty"`
	// Can resource be previewed. Property equals `null` if resource `type` is folder.
	Previewable  bool   `json:"previewable,omitempty"`
	CreatedTime  string `json:"createdTime,omitempty"`
	UpdatedTime  string `json:"updatedTime,omitempty"`
	AccessedTime string `json:"accessedTime,omitempty"`
}

type ResourceResponseObject ¶

type ResourceResponseObject struct {
	// Http status code of the response.
	ResponseStatus int32             `json:"responseStatus,omitempty"`
	Data           *ResourceResponse `json:"data,omitempty"`
}

type ResourceResponseObject1 ¶

type ResourceResponseObject1 struct {
	// status code of the response.
	ResponseStatus int32             `json:"responseStatus,omitempty"`
	Data           *ResourceResponse `json:"data,omitempty"`
}

type ResourceResponseRelationships ¶

type ResourceResponseRelationships struct {
	Share          *ResourceResponseRelationshipsShare          `json:"share,omitempty"`
	Notification   *ResourceResponseRelationshipsNotification   `json:"notification,omitempty"`
	DirectFile     *ResourceResponseRelationshipsDirectFile     `json:"directFile,omitempty"`
	ParentResource *ResourceResponseRelationshipsParentResource `json:"parentResource,omitempty"`
	OwnerUser      *ResourceResponseRelationshipsOwnerUser      `json:"ownerUser,omitempty"`
	OwnerAccount   *ResourceResponseRelationshipsOwnerAccount   `json:"ownerAccount,omitempty"`
}

type ResourceResponseRelationshipsDirectFile ¶

type ResourceResponseRelationshipsDirectFile struct {
	// ID of the direct file.
	Id int32 `json:"id,omitempty"`
	// Type is directFile.
	Type_ string `json:"type,omitempty"`
}

type ResourceResponseRelationshipsNotification ¶

type ResourceResponseRelationshipsNotification struct {
	// ID of the noritifcation.
	Id int32 `json:"id,omitempty"`
	// Type is notification.
	Type_ string `json:"type,omitempty"`
}

type ResourceResponseRelationshipsOwnerAccount ¶

type ResourceResponseRelationshipsOwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the owner account.
	Id int32 `json:"id,omitempty"`
}

type ResourceResponseRelationshipsOwnerUser ¶

type ResourceResponseRelationshipsOwnerUser struct {
	// Type is user.
	Type_ string `json:"type,omitempty"`
	// ID of the owner user.
	Id int32 `json:"id,omitempty"`
}

type ResourceResponseRelationshipsParentResource ¶

type ResourceResponseRelationshipsParentResource struct {
	// ID of the parent resource.
	Id int32 `json:"id,omitempty"`
	// Type is resource.
	Type_ string `json:"type,omitempty"`
}

type ResourceResponseRelationshipsShare ¶

type ResourceResponseRelationshipsShare struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type is share.
	Type_ string `json:"type,omitempty"`
}

type ResourcesApiCompressFilesOpts ¶

type ResourcesApiCompressFilesOpts struct {
	ArchiveName optional.String
}

type ResourcesApiCreateFolderOpts ¶

type ResourcesApiCreateFolderOpts struct {
	Body optional.Interface
}

type ResourcesApiDownloadOpts ¶

type ResourcesApiDownloadOpts struct {
	DownloadName   optional.String
	Polling        optional.Bool
	PollingZipName optional.String
}

type ResourcesApiGetResourceListOpts ¶

type ResourcesApiGetResourceListOpts struct {
	Hash    optional.String
	Path    optional.String
	Type_   optional.String
	SortBy  optional.String
	Offset  optional.Int32
	Limit   optional.Int32
	Include optional.String
}

type ResourcesApiGetResourcePropertiesOpts ¶

type ResourcesApiGetResourcePropertiesOpts struct {
	Include optional.String
}

type ResourcesApiGetResourceProperties_1Opts ¶

type ResourcesApiGetResourceProperties_1Opts struct {
	Include optional.String
}

type ResourcesApiMoveResourcesOpts ¶

type ResourcesApiMoveResourcesOpts struct {
	Body optional.Interface
}

type ResourcesApiPreviewOpts ¶

type ResourcesApiPreviewOpts struct {
	Width  optional.Int32
	Height optional.Int32
	Page   optional.Int32
}

type ResourcesApiResourcesIdPatchOpts ¶

type ResourcesApiResourcesIdPatchOpts struct {
	Body optional.Interface
}

type ResourcesApiResourcesListIdGetOpts ¶

type ResourcesApiResourcesListIdGetOpts struct {
	Sort    optional.String
	Offset  optional.Int32
	Limit   optional.Int32
	Include optional.String
}

type ResourcesApiService ¶

type ResourcesApiService service

func (*ResourcesApiService) CompressFiles ¶

func (a *ResourcesApiService) CompressFiles(ctx context.Context, evAccessToken string, evApiKey string, resources string, parentResource string, localVarOptionals *ResourcesApiCompressFilesOpts) (InlineResponse2012, *http.Response, error)

func (*ResourcesApiService) CopyResources ¶

func (a *ResourcesApiService) CopyResources(ctx context.Context, evAccessToken string, evApiKey string, resources string, parentResource string) (InlineResponse20017, *http.Response, error)

ResourcesApiService Copy resources Copies a set of exisiting files/folders (provided by an array **filePaths**) to the requested **destinationPath** in your account. In the **filePaths** array, you may specify paths pointing files/folders throughout the account, but everything will be copied to the root of the **destinationPath**. **Notes:** - Authenticated user should have modify permission.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param evApiKey API Key required to make the API call.
@param resources Array of resources to be copied. Can be path/id/hash
@param parentResource Destination of the copied files or folders. Can be path/id/hash

@return InlineResponse20017

func (*ResourcesApiService) CreateFolder ¶

func (a *ResourcesApiService) CreateFolder(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *ResourcesApiCreateFolderOpts) (ResourceResponseObject1, *http.Response, error)

func (*ResourcesApiService) DeleteResource ¶

func (a *ResourcesApiService) DeleteResource(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse20014, *http.Response, error)

ResourcesApiService Delete a Resource Delete the files/folders located at a given set of paths. Note that this call performs the delete **immediately**, and it is irreversible. We strongly recommend that you confirm your user's intention to delete file(s) before issuing this API call. **Notes:** - Authenticated user should have delete permission.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id ID of the file or folder to delete.
@param evApiKey API Key required to make the API call.

@return InlineResponse20014

func (*ResourcesApiService) DeleteResources ¶

func (a *ResourcesApiService) DeleteResources(ctx context.Context, evApiKey string, evAccessToken string, filePaths []string, id []string, hash []string) (InlineResponse20014, *http.Response, error)

ResourcesApiService Delete Resources Delete the files/folders located at a given set of paths. Note that this call performs the delete **immediately**, and it is irreversible. We strongly recommend that you confirm your user's intention to delete file(s) before issuing this API call. **Notes:** - Authenticated user should have delete permission.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evApiKey API Key
@param evAccessToken Access Token
@param filePaths Array containing paths of the files or folder to delete.
@param id Array containing ids of the files or folder to delete.
@param hash Array containing hashes of the files or folder to delete.

@return InlineResponse20014

func (*ResourcesApiService) Download ¶

func (a *ResourcesApiService) Download(ctx context.Context, evAccessToken string, resources string, evApiKey string, localVarOptionals *ResourcesApiDownloadOpts) (*http.Response, error)

func (*ResourcesApiService) ExtractFiles ¶

func (a *ResourcesApiService) ExtractFiles(ctx context.Context, evAccessToken string, evApiKey string, resource string, parentResource string) (InlineResponse2013, *http.Response, error)

ResourcesApiService Extract resources Extract the contents of a zip archive to a specified directory. Note that this can be a very slow operation. **Notes:** - Authenticated user should have modify permission.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param evApiKey API Key required to make the API call.
@param resource Path of the compressed resource, including the archive name.
@param parentResource Path for the extracted resoure(s) to be stored.

@return InlineResponse2013

func (*ResourcesApiService) GetResourceList ¶

func (a *ResourcesApiService) GetResourceList(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *ResourcesApiGetResourceListOpts) (InlineResponse20012, *http.Response, error)

func (*ResourcesApiService) GetResourceProperties ¶

func (a *ResourcesApiService) GetResourceProperties(ctx context.Context, evAccessToken string, id int32, evApiKey string, localVarOptionals *ResourcesApiGetResourcePropertiesOpts) (InlineResponse20013, *http.Response, error)

func (*ResourcesApiService) GetResourceProperties_1 ¶

func (a *ResourcesApiService) GetResourceProperties_1(ctx context.Context, evAccessToken string, path string, hash string, evApiKey string, localVarOptionals *ResourcesApiGetResourceProperties_1Opts) (InlineResponse20015, *http.Response, error)

func (*ResourcesApiService) MoveResources ¶

func (a *ResourcesApiService) MoveResources(ctx context.Context, evAccessToken string, evApiKey string, resources string, parentResource string, localVarOptionals *ResourcesApiMoveResourcesOpts) (InlineResponse20018, *http.Response, error)

func (*ResourcesApiService) Preview ¶

func (a *ResourcesApiService) Preview(ctx context.Context, evApiKey string, evAccessToken string, resource string, size string, localVarOptionals *ResourcesApiPreviewOpts) (PreivewFileResponseObject, *http.Response, error)

func (*ResourcesApiService) ResourcesIdPatch ¶

func (a *ResourcesApiService) ResourcesIdPatch(ctx context.Context, evAccessToken string, evApiKey string, id int32, localVarOptionals *ResourcesApiResourcesIdPatchOpts) (ResourceResponseObject, *http.Response, error)

func (*ResourcesApiService) ResourcesListIdGet ¶

func (a *ResourcesApiService) ResourcesListIdGet(ctx context.Context, evAccessToken string, id int32, evApiKey string, localVarOptionals *ResourcesApiResourcesListIdGetOpts) (InlineResponse20016, *http.Response, error)

func (*ResourcesApiService) Upload ¶

func (a *ResourcesApiService) Upload(ctx context.Context, evAccessToken string, evApiKey string, path string, fileSize int32, localVarOptionals *ResourcesApiUploadOpts) (ResourceResponseObject, *http.Response, error)

type ResourcesApiUploadOpts ¶

type ResourcesApiUploadOpts struct {
	File           optional.Interface
	OffsetBytes    optional.Int32
	Resume         optional.Bool
	AllowOverwrite optional.Bool
}

type SessionActivityEntry ¶

type SessionActivityEntry struct {
	Id         int32                              `json:"id,omitempty"`
	Type_      string                             `json:"type,omitempty"`
	Attributes *SessionActivityResponseAttributes `json:"attributes,omitempty"`
}

type SessionActivityResponse ¶

type SessionActivityResponse struct {
	ResponseStatus  int32                          `json:"responseStatus,omitempty"`
	TotalResults    int32                          `json:"totalResults,omitempty"`
	ReturnedResults int32                          `json:"returnedResults,omitempty"`
	Data            []SingleEntryOfSessionActivity `json:"data,omitempty"`
}

type SessionActivityResponseAttributes ¶

type SessionActivityResponseAttributes struct {
	BytesTransferred int32  `json:"bytesTransferred,omitempty"`
	Created          string `json:"created,omitempty"`
	Duration         int32  `json:"duration,omitempty"`
	FileName         string `json:"fileName,omitempty"`
	FileSource       string `json:"fileSource,omitempty"`
	IpAddress        string `json:"ipAddress,omitempty"`
	Operation        string `json:"operation,omitempty"`
	Protocol         string `json:"protocol,omitempty"`
	SessionId        string `json:"sessionId,omitempty"`
	Status           string `json:"status,omitempty"`
	Username         string `json:"username,omitempty"`
}

type Share struct {
	// ID of the share.
	Id            int32               `json:"id,omitempty"`
	Type_         string              `json:"type,omitempty"`
	Attributes    *ShareAttributes    `json:"attributes,omitempty"`
	Relationships *ShareRelationships `json:"relationships,omitempty"`
}

Object contains share properties.

type Share1 ¶

type Share1 struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type of the share.
	Type_         string               `json:"type,omitempty"`
	Attributes    *Share1Attributes    `json:"attributes,omitempty"`
	Relationships *Share1Relationships `json:"relationships,omitempty"`
}

Object contains share properties.

type Share1Attributes ¶

type Share1Attributes struct {
	// Share name.
	Name string `json:"name,omitempty"`
	// True if the share has password.
	HasPassword bool `json:"hasPassword,omitempty"`
	// True if the share has a public url.
	Public bool `json:"public,omitempty"`
	// Access rights for the share.
	AccessMode string `json:"accessMode,omitempty"`
	// Description of the share access rights.
	AccessDescription string `json:"accessDescription,omitempty"`
	// True if share can be embedded.
	Embed bool `json:"embed,omitempty"`
	// Share hash.
	Hash string `json:"hash,omitempty"`
	// Share owner's hash.
	OwnerHash string `json:"ownerHash,omitempty"`
	// Expiration date of the share.
	Expiration string `json:"expiration,omitempty"`
	// True if the share has expired.
	Expired bool `json:"expired,omitempty"`
	// Invitations resent date. Can be `null` if resent never happened.
	Resent string `json:"resent,omitempty"`
	// Type of share.
	Type_ string `json:"type,omitempty"`
	// True if share requires email to access.
	RequireEmail bool `json:"requireEmail,omitempty"`
	// Flag to show if separate folders should be created for each file upload to receive folder.
	FileDropCreateFolders bool `json:"fileDropCreateFolders,omitempty"`
	// Path to the shared resource in your account.
	Paths []string `json:"paths,omitempty"`
	// Array of recipients.
	Recipients []ShareRecipient1 `json:"recipients,omitempty"`
	// Array of invitation messages.
	Messages []Message1 `json:"messages,omitempty"`
	// True if share inherited from parent folder.
	Inherited bool `json:"inherited,omitempty"`
	// Share activity status. Can be active (1) or deactivated (0).
	Status int32 `json:"status,omitempty"`
	// True if share has notification.
	HasNotification bool `json:"hasNotification,omitempty"`
	// Timestamp of share creation.
	Created string `json:"created,omitempty"`
	// Timestamp of share modification. Can be `null` if it wasn't modified.
	Modified string `json:"modified,omitempty"`
	// Checks recipient received status and returns whether it's been recevied (`complete`,) partial recevied (`incomplete`,) or not recevied yet (`pending`.)
	TrackingStatus string `json:"trackingStatus,omitempty"`
	// ID of the form.
	FormId int32 `json:"formId,omitempty"`
}

type Share1Relationships ¶

type Share1Relationships struct {
	// PLACEHOLDER
	Messages []Share1RelationshipsMessages `json:"messages,omitempty"`
	Owner    *Share1RelationshipsOwner     `json:"owner,omitempty"`
	Resource *Share1RelationshipsResource  `json:"resource,omitempty"`
	// PLACEHOLDER
	Notifications []Share1RelationshipsNotifications `json:"notifications,omitempty"`
}

type Share1RelationshipsMessages ¶

type Share1RelationshipsMessages struct {
	// Type is message.
	Type_ string `json:"type,omitempty"`
	// ID of the message.
	Id int32 `json:"id,omitempty"`
}

type Share1RelationshipsNotifications ¶

type Share1RelationshipsNotifications struct {
	// Type is notification.
	Type_ string `json:"type,omitempty"`
	// ID of the notification.
	Id int32 `json:"id,omitempty"`
}

type Share1RelationshipsOwner ¶

type Share1RelationshipsOwner struct {
	// Type is user.
	Type_ string `json:"type,omitempty"`
	// ID of the owner.
	Id int32 `json:"id,omitempty"`
}

type Share1RelationshipsResource ¶

type Share1RelationshipsResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

PLACEHOLDER

type Share2 ¶

type Share2 struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type of the share.
	Type_         string                                `json:"type,omitempty"`
	Attributes    *Share1Attributes                     `json:"attributes,omitempty"`
	Relationships *ShareCollectionResponseRelationships `json:"relationships,omitempty"`
}

Object contains share properties.

type Share3 ¶

type Share3 struct {
	// ID of the share.
	Id            int32                                         `json:"id,omitempty"`
	Type_         string                                        `json:"type,omitempty"`
	Attributes    *ShareCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *ShareCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

Object contains share properties.

type Share4 ¶

type Share4 struct {
	// ID of the share.
	Id            int32               `json:"id,omitempty"`
	Type_         string              `json:"type,omitempty"`
	Attributes    *ShareAttributes    `json:"attributes,omitempty"`
	Relationships *ShareRelationships `json:"relationships,omitempty"`
}

Object contains share properties.

type ShareApiGetSharesOpts ¶

type ShareApiGetSharesOpts struct {
	Hash    optional.String
	Offset  optional.Int32
	Limit   optional.Int32
	Scope   optional.String
	Sort    optional.String
	Type_   optional.String
	Include optional.String
	Path    optional.String
}

type ShareApiService ¶

type ShareApiService service

func (*ShareApiService) GetShares ¶

func (a *ShareApiService) GetShares(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *ShareApiGetSharesOpts) (InlineResponse20020, *http.Response, error)

type ShareAttributes ¶

type ShareAttributes struct {
	// Share name.
	Name string `json:"name,omitempty"`
	// True if the share has password.
	HasPassword bool `json:"hasPassword,omitempty"`
	// True if the share has a public url.
	Public bool `json:"public,omitempty"`
	// Access rights for the share.
	AccessMode string `json:"accessMode,omitempty"`
	// Description of the share access rights.
	AccessDescription string `json:"accessDescription,omitempty"`
	// True if share can be embedded.
	Embed bool `json:"embed,omitempty"`
	// Share hash.
	Hash string `json:"hash,omitempty"`
	// Share owner's hash.
	OwnerHash string `json:"ownerHash,omitempty"`
	// Expiration date of the share.
	Expiration string `json:"expiration,omitempty"`
	// True if the share has expired.
	Expired bool `json:"expired,omitempty"`
	// Invitations resent date. Can be `null` if resent never happened.
	Resent string `json:"resent,omitempty"`
	// Type of share.
	Type_ string `json:"type,omitempty"`
	// True if share requires email to access.
	RequireEmail bool `json:"requireEmail,omitempty"`
	// Flag to show if separate folders should be created for each file upload to receive folder.
	FileDropCreateFolders bool `json:"fileDropCreateFolders,omitempty"`
	// Path to the shared resource in your account.
	Paths []string `json:"paths,omitempty"`
	// Array of recipients.
	Recipients []ShareRecipient1 `json:"recipients,omitempty"`
	// Array of invitation messages.
	Messages []Message1 `json:"messages,omitempty"`
	// True if share inherited from parent folder.
	Inherited bool `json:"inherited,omitempty"`
	// Share activity status. Can be active (1) or deactivated (0).
	Status int32 `json:"status,omitempty"`
	// True if share has notification.
	HasNotification bool `json:"hasNotification,omitempty"`
	// Notification object if share has one.
	Notification string `json:"notification,omitempty"`
	// Timestamp of share creation.
	Created string `json:"created,omitempty"`
	// Timestamp of share modification. Can be `null` if it wasn't modified.
	Modified string `json:"modified,omitempty"`
}

type ShareCollectionExtendedResponse ¶

type ShareCollectionExtendedResponse struct {
	Included []interface{} `json:"included,omitempty"`
}

type ShareCollectionExtendedResponseAttributes ¶

type ShareCollectionExtendedResponseAttributes struct {
	// Share name.
	Name string `json:"name,omitempty"`
	// True if the share has password.
	HasPassword bool `json:"hasPassword,omitempty"`
	// True if the share has a public url.
	Public bool `json:"public,omitempty"`
	// Access rights for the share.
	AccessMode string `json:"accessMode,omitempty"`
	// Description of the share access rights.
	AccessDescription string `json:"accessDescription,omitempty"`
	// True if share can be embedded.
	Embed bool `json:"embed,omitempty"`
	// Share hash.
	Hash string `json:"hash,omitempty"`
	// Share owner's hash.
	OwnerHash string `json:"ownerHash,omitempty"`
	// Expiration date of the share.
	Expiration string `json:"expiration,omitempty"`
	// True if the share has expired.
	Expired bool `json:"expired,omitempty"`
	// Invitations resent date. Can be `null` if resent never happened.
	Resent string `json:"resent,omitempty"`
	// Type of share.
	Type_ string `json:"type,omitempty"`
	// True if share requires email to access.
	RequireEmail bool `json:"requireEmail,omitempty"`
	// Flag to show if separate folders should be created for each file upload to receive folder.
	FileDropCreateFolders bool `json:"fileDropCreateFolders,omitempty"`
	// Path to the shared resource in your account.
	Paths []string `json:"paths,omitempty"`
	// Array of recipients.
	Recipients []ShareRecipient1 `json:"recipients,omitempty"`
	// Array of invitation messages.
	Messages []Message1 `json:"messages,omitempty"`
	// True if share inherited from parent folder.
	Inherited bool `json:"inherited,omitempty"`
	// Share activity status. Can be active (1) or deactivated (0).
	Status int32 `json:"status,omitempty"`
	// True if share has notification.
	HasNotification bool `json:"hasNotification,omitempty"`
	// Timestamp of share creation.
	Created string `json:"created,omitempty"`
	// Timestamp of share modification. Can be `null` if it wasn't modified.
	Modified string `json:"modified,omitempty"`
	// Checks recipient received status and returns whether it's been recevied (`complete`,) partial recevied (`incomplete`,) or not recevied yet (`pending`.)
	TrackingStatus string `json:"trackingStatus,omitempty"`
	// ID of the form.
	FormId int32 `json:"formId,omitempty"`
}

type ShareCollectionExtendedResponseRelationships ¶

type ShareCollectionExtendedResponseRelationships struct {
	// PLACEHOLDER
	Messages []Share1RelationshipsMessages                         `json:"messages,omitempty"`
	Owner    *Share1RelationshipsOwner                             `json:"owner,omitempty"`
	Resource *ShareCollectionExtendedResponseRelationshipsResource `json:"resource,omitempty"`
	// PLACEHOLDER
	Notifications []ShareResponseRelationshipsNotifications `json:"notifications,omitempty"`
}

type ShareCollectionExtendedResponseRelationshipsResource ¶

type ShareCollectionExtendedResponseRelationshipsResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

PLACEHOLDER

type ShareCollectionResponse ¶

type ShareCollectionResponse struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Total results found.
	TotalResults int32 `json:"totalResults,omitempty"`
	// Number of returned results.
	ReturnedResults int32    `json:"returnedResults,omitempty"`
	Data            []Share2 `json:"data,omitempty"`
}

type ShareCollectionResponseRelationships ¶

type ShareCollectionResponseRelationships struct {
	// PLACEHOLDER
	Messages []Share1RelationshipsMessages                 `json:"messages,omitempty"`
	Owner    *ShareCollectionResponseRelationshipsOwner    `json:"owner,omitempty"`
	Resource *ShareCollectionResponseRelationshipsResource `json:"resource,omitempty"`
	// PLACEHOLDER
	Notifications []ShareCollectionResponseRelationshipsNotifications `json:"notifications,omitempty"`
}

type ShareCollectionResponseRelationshipsNotifications ¶

type ShareCollectionResponseRelationshipsNotifications struct {
	// Type is notification.
	Type_ string `json:"type,omitempty"`
	// ID of the notification.
	Id int32 `json:"id,omitempty"`
}

type ShareCollectionResponseRelationshipsOwner ¶

type ShareCollectionResponseRelationshipsOwner struct {
	// Type is user.
	Type_ string `json:"type,omitempty"`
	// ID of the owner.
	Id int32 `json:"id,omitempty"`
}

type ShareCollectionResponseRelationshipsResource ¶

type ShareCollectionResponseRelationshipsResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

PLACEHOLDER

type ShareExtendedResponse ¶

type ShareExtendedResponse struct {
	Data     *Share1                                   `json:"data,omitempty"`
	Included []AnyOfShareExtendedResponseIncludedItems `json:"included,omitempty"`
}

Response object for shares with metadata for included relationships.

type ShareRecipient ¶

type ShareRecipient struct {
	// ID of the recipient.
	Id int32 `json:"id,omitempty"`
	// ID of the share that the recipoient belongs to.
	ShareId string `json:"shareId,omitempty"`
	// Type of the recipient.
	Type_ string `json:"type,omitempty"`
	// Share hash.
	Hash string `json:"hash,omitempty"`
	// Recipient email address.
	Email string `json:"email,omitempty"`
	// Set to true if invite email was sent; false otherwise.
	Sent bool `json:"sent,omitempty"`
	// Set to true if recipient has accessed the share. Note this is set to true when the recipient clicks the link to access the share; not when they download a file.
	Received bool `json:"received,omitempty"`
	// Timestamp of adding recipient to the share.
	Created string `json:"created,omitempty"`
}

type ShareRecipient1 ¶

type ShareRecipient1 struct {
	// ID of the recipient.
	Id int32 `json:"id,omitempty"`
	// ID of the share that the recipoient belongs to.
	ShareId string `json:"shareId,omitempty"`
	// Type of the recipient.
	Type_ string `json:"type,omitempty"`
	// Share hash.
	Hash string `json:"hash,omitempty"`
	// Recipient email address.
	Email string `json:"email,omitempty"`
	// Set to true if invite email was sent; false otherwise.
	Sent bool `json:"sent,omitempty"`
	// Set to true if recipient has accessed the share. Note this is set to true when the recipient clicks the link to access the share; not when they download a file.
	Received bool `json:"received,omitempty"`
	// Timestamp of adding recipient to the share.
	Created string `json:"created,omitempty"`
}

type ShareRelationship ¶

type ShareRelationship struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type of share.
	Type_ string `json:"type,omitempty"`
}

type ShareRelationships ¶

type ShareRelationships struct {
	// PLACEHOLDER
	Messages []ShareRelationshipsMessages                              `json:"messages,omitempty"`
	Owner    *NotificationCollectionExtendedResponseRelationshipsOwner `json:"owner,omitempty"`
	Resource *ShareRelationshipsResource                               `json:"resource,omitempty"`
	// PLACEHOLDER
	Notifications []ShareRelationshipsNotifications `json:"notifications,omitempty"`
}

type ShareRelationshipsMessages ¶

type ShareRelationshipsMessages struct {
	// PLACEHOLDER
	Type_ string `json:"type,omitempty"`
	// PLACEHOLDER
	Id int32 `json:"id,omitempty"`
}

type ShareRelationshipsNotifications ¶

type ShareRelationshipsNotifications struct {
	// PLACEHOLDER
	Type_ string `json:"type,omitempty"`
	// PLACEHOLDER
	Id int32 `json:"id,omitempty"`
}

type ShareRelationshipsResource ¶

type ShareRelationshipsResource struct {
	// PLACEHOLDER
	Type_ string `json:"type,omitempty"`
	// PLACEHOLDER
	Id int32 `json:"id,omitempty"`
}

PLACEHOLDER

type ShareResponse ¶

type ShareResponse struct {
	// ID of the share.
	Id int32 `json:"id,omitempty"`
	// Type of the share.
	Type_         string                      `json:"type,omitempty"`
	Attributes    *Share1Attributes           `json:"attributes,omitempty"`
	Relationships *ShareResponseRelationships `json:"relationships,omitempty"`
}

Response object for shares.

type ShareResponseRelationships ¶

type ShareResponseRelationships struct {
	// PLACEHOLDER
	Messages  []ShareResponseRelationshipsMessages `json:"messages,omitempty"`
	Owner     *ShareResponseRelationshipsOwner     `json:"owner,omitempty"`
	Resources *ShareResponseRelationshipsResources `json:"resources,omitempty"`
	// PLACEHOLDER
	Notifications []ShareResponseRelationshipsNotifications `json:"notifications,omitempty"`
}

type ShareResponseRelationshipsMessages ¶

type ShareResponseRelationshipsMessages struct {
	// Type is message.
	Type_ string `json:"type,omitempty"`
	// ID of the message.
	Id int32 `json:"id,omitempty"`
}

type ShareResponseRelationshipsNotifications ¶

type ShareResponseRelationshipsNotifications struct {
	// Type is notification.
	Type_ string `json:"type,omitempty"`
	// ID of the notification.
	Id int32 `json:"id,omitempty"`
}

type ShareResponseRelationshipsOwner ¶

type ShareResponseRelationshipsOwner struct {
	// ID of the owner.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_ string `json:"type,omitempty"`
}

type ShareResponseRelationshipsResources ¶

type ShareResponseRelationshipsResources struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of the shared resource.
	Id int32 `json:"id,omitempty"`
}

PLACEHOLDER

type SharesApiGetSharesIdOpts ¶

type SharesApiGetSharesIdOpts struct {
	Include optional.String
}

type SharesApiPostSharesOpts ¶

type SharesApiPostSharesOpts struct {
	Body optional.Interface
}

type SharesApiService ¶

type SharesApiService service

func (*SharesApiService) DeleteSharesId ¶

func (a *SharesApiService) DeleteSharesId(ctx context.Context, evAccessToken string, id int32, evApiKey string) (*http.Response, error)

SharesApiService Deactivate a share Delete a share. Deleting a share does not remove the underlying files for shared_folder and receive share types; it merely removes the access URL. Delating a send share type does remove the associated files, as files that have been sent are only associated with the share, and aren't stored anywhere else in the account. **Notes:** Authenticated user's role must be admin or master, or user must be the owner of the specified share.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id ID of the share
@param evApiKey API Key required to make the API call.

func (*SharesApiService) GetSharesId ¶

func (a *SharesApiService) GetSharesId(ctx context.Context, evApiKey string, evAccessToken string, id int32, localVarOptionals *SharesApiGetSharesIdOpts) (InlineResponse20021, *http.Response, error)

func (*SharesApiService) PatchSharesId ¶

func (a *SharesApiService) PatchSharesId(ctx context.Context, body Body16, evApiKey string, evAccessToken string, id int32) (RegularShareResponse1, *http.Response, error)

SharesApiService Update a share Change the settings on an active share.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body
@param evApiKey API Key
@param evAccessToken Access Token
@param id PLACEHOLDER

@return RegularShareResponse1

func (*SharesApiService) PostShares ¶

func (a *SharesApiService) PostShares(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *SharesApiPostSharesOpts) (RegularShareResponse, *http.Response, error)

func (*SharesApiService) PostSharesCompleteSendId ¶

func (a *SharesApiService) PostSharesCompleteSendId(ctx context.Context, evApiKey string, evAccessToken string, id int32) (RegularShareResponse2, *http.Response, error)

SharesApiService Complete send files After uploading the files to be sent, use this method to trigger invitation emails and finish the send files setup.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evApiKey API Key
@param evAccessToken Access Token
@param id PLACEHOLDER

@return RegularShareResponse2

type SingleEntryOfSessionActivity ¶

type SingleEntryOfSessionActivity struct {
	Id         int32                              `json:"id,omitempty"`
	Type_      string                             `json:"type,omitempty"`
	Attributes *SessionActivityResponseAttributes `json:"attributes,omitempty"`
}

type SingleEntryOfSessionActivity1 ¶

type SingleEntryOfSessionActivity1 struct {
	// ID of the webhook activity.
	Id int32 `json:"id,omitempty"`
	// Type is webhookActivity.
	Type_      string                              `json:"type,omitempty"`
	Attributes *WebhooksActivityResponseAttributes `json:"attributes,omitempty"`
}

type User ¶

type User struct {
	// ID of the user.
	Id int32 `json:"id"`
	// Type of object being returned. Always \"user\"
	Type_         string             `json:"type"`
	Attributes    *UserAttributes    `json:"attributes"`
	Relationships *UserRelationships `json:"relationships"`
}

Object contains user properties.

type User1 ¶

type User1 struct {
	// ID of the user.
	Id            int32                                        `json:"id,omitempty"`
	Type_         string                                       `json:"type,omitempty"`
	Attributes    *UserCollectionExtendedResponseAttributes    `json:"attributes,omitempty"`
	Relationships *UserCollectionExtendedResponseRelationships `json:"relationships,omitempty"`
}

Object contains user properties.

type User2 ¶

type User2 struct {
	// ID of the user.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_         string                               `json:"type,omitempty"`
	Attributes    *UserCollectionResponseAttributes    `json:"attributes,omitempty"`
	Relationships *UserCollectionResponseRelationships `json:"relationships,omitempty"`
}

Object contains user properties.

type User3 ¶

type User3 struct {
	// ID of the user.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_         string                                    `json:"type,omitempty"`
	Attributes    *EmailListsIncludedResponseAttributes1    `json:"attributes,omitempty"`
	Relationships *EmailListsIncludedResponseRelationships1 `json:"relationships,omitempty"`
}

Object contains user properties.

type UserAttributes ¶

type UserAttributes struct {
	// Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
	Status int32 `json:"status"`
	// Timestamp of user expiration.
	Expiration time.Time `json:"expiration,omitempty"`
	// Timestamp of user creation.
	Created time.Time `json:"created"`
	// Timestamp of user modification.
	Modified string `json:"modified"`
	// Timestamp of most recent successful user login.
	AccessTimestamp time.Time `json:"accessTimestamp,omitempty"`
	// Name of the account this user belongs to.
	AccountName string `json:"accountName"`
	// Username of the user.
	Username string `json:"username"`
	// Nickname of the user.
	Nickname string `json:"nickname"`
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// Path to the user's home folder.
	HomeDir     string                     `json:"homeDir"`
	Permissions *UserAttributesPermissions `json:"permissions"`
	// User's access level
	Role string `json:"role"`
	// User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone"`
	// Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
	Onboarding bool `json:"onboarding"`
	// `true` if the user has logged into the system.
	FirstLogin time.Time `json:"firstLogin,omitempty"`
}

User information

type UserAttributesPermissions ¶

type UserAttributesPermissions struct {
	// Download permission flag.
	Download bool `json:"download"`
	// Upload permission flag.
	Upload bool `json:"upload"`
	// Modify permission flag.
	Modify bool `json:"modify"`
	// Delete permission flag.
	Delete bool `json:"delete"`
	// View files permission flag.
	List bool `json:"list"`
	// Change permission flag.
	ChangePassword bool `json:"changePassword"`
	// Share folders permission flag.
	Share bool `json:"share"`
	// Create notifications permission flag.
	Notification bool `json:"notification"`
	// Access Form Data permission flag. If `true`, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form.
	ViewFormData bool `json:"viewFormData"`
	// Delete form data permission flag. If `true`, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded.
	DeleteFormData bool `json:"deleteFormData"`
}

type UserCollectionExtendedResponse ¶

type UserCollectionExtendedResponse struct {
	Included []struct{} `json:"included,omitempty"`
}

type UserCollectionExtendedResponseAttributes ¶

type UserCollectionExtendedResponseAttributes struct {
	// Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
	Status int32 `json:"status,omitempty"`
	// Timestamp of user expiration.
	Expiration string `json:"expiration,omitempty"`
	// Timestamp of user creation.
	Created string `json:"created,omitempty"`
	// Timestamp of user modification.
	Modified string `json:"modified,omitempty"`
	// Timestamp of most recent successful user login.
	AccessTimestamp string `json:"accessTimestamp,omitempty"`
	// Internal ID of the account this user belongs to.
	AccountId int32 `json:"accountId,omitempty"`
	// Name of the account this user belongs to.
	AccountName string `json:"accountName,omitempty"`
	// Username of the user.
	Username string `json:"username,omitempty"`
	// Nickname of the user.
	Nickname string `json:"nickname,omitempty"`
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// Path to the user's home folder.
	HomeDir     string                                               `json:"homeDir,omitempty"`
	Permissions *UserCollectionExtendedResponseAttributesPermissions `json:"permissions,omitempty"`
	// User's role.
	Role string `json:"role,omitempty"`
	// User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone,omitempty"`
	// Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
	// Whether this is the first time the user has logged into the system.
	FirstLogin bool `json:"firstLogin,omitempty"`
}

type UserCollectionExtendedResponseAttributesPermissions ¶

type UserCollectionExtendedResponseAttributesPermissions struct {
	// Download permission flag.
	Download bool `json:"download,omitempty"`
	// Upload permission flag.
	Upload bool `json:"upload,omitempty"`
	// Modify permission flag.
	Modify bool `json:"modify,omitempty"`
	// Delete permission flag.
	Delete bool `json:"delete,omitempty"`
	// View files permission flag.
	List bool `json:"list,omitempty"`
	// Change permission flag.
	ChangePassword bool `json:"changePassword,omitempty"`
	// Share folders permission flag.
	Share bool `json:"share,omitempty"`
	// Create notifications permission flag.
	Notification bool `json:"notification,omitempty"`
	// Access Form Data permission flag. If `true`, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form.
	ViewFormData bool `json:"viewFormData,omitempty"`
	// Delete form data permission flag. If `true`, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded.
	DeleteFormData bool `json:"deleteFormData,omitempty"`
}

type UserCollectionExtendedResponseRelationships ¶

type UserCollectionExtendedResponseRelationships struct {
	HomeDir *NotificationCollectionExtendedResponseRelationshipsNode `json:"homeDir,omitempty"`
	Account *UserCollectionExtendedResponseRelationshipsAccount      `json:"account,omitempty"`
}

type UserCollectionExtendedResponseRelationshipsAccount ¶

type UserCollectionExtendedResponseRelationshipsAccount struct {
	Type_ string `json:"type,omitempty"`
	Id    int32  `json:"id,omitempty"`
}

type UserCollectionResponse ¶

type UserCollectionResponse struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Total results found.
	TotalResults int32 `json:"totalResults,omitempty"`
	// Number of results returned.
	ReturnedResults int32   `json:"returnedResults,omitempty"`
	Data            []User2 `json:"data,omitempty"`
}

type UserCollectionResponseAttributes ¶

type UserCollectionResponseAttributes struct {
	// Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
	Status int32 `json:"status,omitempty"`
	// Timestamp of user expiration.
	Expiration string `json:"expiration,omitempty"`
	// Timestamp of user creation.
	Created string `json:"created,omitempty"`
	// Timestamp of user modification.
	Modified string `json:"modified,omitempty"`
	// Timestamp of most recent successful user login.
	AccessTimestamp string `json:"accessTimestamp,omitempty"`
	// Name of the account this user belongs to.
	AccountName string `json:"accountName,omitempty"`
	// Username of the user.
	Username string `json:"username,omitempty"`
	// Nickname of the user.
	Nickname string `json:"nickname,omitempty"`
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// Path to the user's home folder.
	HomeDir     string                                               `json:"homeDir,omitempty"`
	Permissions *UserCollectionExtendedResponseAttributesPermissions `json:"permissions,omitempty"`
	// User's role.
	Role string `json:"role,omitempty"`
	// User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone,omitempty"`
	// Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
	// `true` if the user has logged into the system.
	FirstLogin bool `json:"firstLogin,omitempty"`
}

type UserCollectionResponseRelationships ¶

type UserCollectionResponseRelationships struct {
	HomeResource *UserCollectionResponseRelationshipsHomeResource `json:"homeResource,omitempty"`
	OwnerAccount *UserCollectionResponseRelationshipsOwnerAccount `json:"ownerAccount,omitempty"`
}

type UserCollectionResponseRelationshipsHomeResource ¶

type UserCollectionResponseRelationshipsHomeResource struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of home directory resource.
	Id int32 `json:"id,omitempty"`
}

type UserCollectionResponseRelationshipsOwnerAccount ¶

type UserCollectionResponseRelationshipsOwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the account.
	Id int32 `json:"id,omitempty"`
}

type UserExtendedResponse ¶

type UserExtendedResponse struct {
}

Response object for users with metadata for included relationships.

type UserPermissions ¶

type UserPermissions struct {
	// Download permission flag
	Download bool `json:"download"`
	// Upload permission flag
	Upload bool `json:"upload"`
	// Modify permission flag
	Modify bool `json:"modify"`
	// Delete permission flag
	Delete bool `json:"delete"`
	// View folder contents permission flag
	List bool `json:"list"`
	// Change (own) password permission flag
	ChangePassword bool `json:"changePassword"`
	// Sharing permission flag
	Share bool `json:"share"`
	// Notifications permission flag
	Notification bool `json:"notification"`
	// Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form.
	ViewFormData bool `json:"viewFormData"`
	// Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded.
	DeleteFormData bool `json:"deleteFormData"`
}

type UserRelationships ¶

type UserRelationships struct {
	HomeResource *UserRelationshipsHomeResource `json:"homeResource,omitempty"`
	OwnerAccount *UserRelationshipsOwnerAccount `json:"ownerAccount"`
}

type UserRelationshipsHomeResource ¶

type UserRelationshipsHomeResource struct {
	Data *UserRelationshipsHomeResourceData `json:"data,omitempty"`
}

type UserRelationshipsHomeResourceData ¶

type UserRelationshipsHomeResourceData struct {
	// Type is resource.
	Type_ string `json:"type,omitempty"`
	// ID of home directory resource.
	Id int32 `json:"id,omitempty"`
}

type UserRelationshipsOwnerAccount ¶

type UserRelationshipsOwnerAccount struct {
	Data *UserRelationshipsOwnerAccountData `json:"data"`
}

type UserRelationshipsOwnerAccountData ¶

type UserRelationshipsOwnerAccountData struct {
	// Type is account.
	Type_ string `json:"type"`
	// ID of the account.
	Id int32 `json:"id"`
}

type UserResponse ¶

type UserResponse struct {
	// ID of the user.
	Id int32 `json:"id,omitempty"`
	// Type is user.
	Type_         string                     `json:"type,omitempty"`
	Attributes    *UserResponseAttributes    `json:"attributes,omitempty"`
	Relationships *UserResponseRelationships `json:"relationships,omitempty"`
}

Response object for users.

type UserResponseAttributes ¶

type UserResponseAttributes struct {
	// Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.
	Status int32 `json:"status,omitempty"`
	// Timestamp of user expiration.
	Expiration string `json:"expiration,omitempty"`
	// Timestamp of user creation.
	Created string `json:"created,omitempty"`
	// Timestamp of user modification.
	Modified string `json:"modified,omitempty"`
	// Timestamp of most recent successful user login.
	AccessTimestamp string `json:"accessTimestamp,omitempty"`
	// Name of the account this user belongs to.
	AccountName string `json:"accountName,omitempty"`
	// Username of the user.
	Username string `json:"username,omitempty"`
	// Nickname of the user.
	Nickname string `json:"nickname,omitempty"`
	// Email address of the user.
	Email string `json:"email,omitempty"`
	// Path to the user's home folder.
	HomeDir     string                                               `json:"homeDir,omitempty"`
	Permissions *UserCollectionExtendedResponseAttributesPermissions `json:"permissions,omitempty"`
	// User's access level.
	Role string `json:"role,omitempty"`
	// User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values.
	TimeZone string `json:"timeZone,omitempty"`
	// Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user.
	Onboarding bool `json:"onboarding,omitempty"`
	// `true` if the user has logged into the system.
	FirstLogin bool `json:"firstLogin,omitempty"`
}

type UserResponseObject ¶

type UserResponseObject struct {
	// Http code for the response.
	ResponseStatus int32         `json:"responseStatus,omitempty"`
	Data           *UserResponse `json:"data,omitempty"`
}

type UserResponseRelationships ¶

type UserResponseRelationships struct {
	HomeResource *UserResponseRelationshipsHomeResource `json:"homeResource,omitempty"`
	OwnerAccount *UserResponseRelationshipsOwnerAccount `json:"ownerAccount,omitempty"`
}

type UserResponseRelationshipsHomeResource ¶

type UserResponseRelationshipsHomeResource struct {
	// ID of home directory resource.
	Type_ string `json:"type,omitempty"`
	// ID of the resource.
	Id int32 `json:"id,omitempty"`
}

type UserResponseRelationshipsOwnerAccount ¶

type UserResponseRelationshipsOwnerAccount struct {
	// Type is account.
	Type_ string `json:"type,omitempty"`
	// ID of the account.
	Id int32 `json:"id,omitempty"`
}

type UsersApiCreateUserOpts ¶

type UsersApiCreateUserOpts struct {
	Body optional.Interface
}

type UsersApiGetUserOpts ¶

type UsersApiGetUserOpts struct {
	Include optional.String
}

type UsersApiGetUsersOpts ¶

type UsersApiGetUsersOpts struct {
	Username optional.String
	Offset   optional.Int32
	Sort     optional.String
	Limit    optional.Int32
	Include  optional.String
}

type UsersApiService ¶

type UsersApiService service

func (*UsersApiService) CreateUser ¶

func (a *UsersApiService) CreateUser(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *UsersApiCreateUserOpts) (UserResponseObject, *http.Response, error)

func (*UsersApiService) DeleteUser ¶

func (a *UsersApiService) DeleteUser(ctx context.Context, evAccessToken string, id int32, evApiKey string) (InlineResponse20010, *http.Response, error)

UsersApiService Delete a user Delete a user from the account. Deleting a user does **NOT** delete any files from the account; it merely removes a user's access. Only account administrators can delete a user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param evAccessToken Access token required to make the API call.
@param id The user's ID. Note that this is our internal ID, and _not the username_. You can obtain it by calling the <a href=\"#operation/getUser\">getUser</a> method.
@param evApiKey API key required to make the API call.

@return InlineResponse20010

func (*UsersApiService) GetUser ¶

func (a *UsersApiService) GetUser(ctx context.Context, evAccessToken string, id int32, evApiKey string, localVarOptionals *UsersApiGetUserOpts) (InlineResponse2009, *http.Response, error)

func (*UsersApiService) GetUsers ¶

func (a *UsersApiService) GetUsers(ctx context.Context, evAccessToken string, evApiKey string, localVarOptionals *UsersApiGetUsersOpts) (InlineResponse2008, *http.Response, error)

func (*UsersApiService) UpdateUser ¶

func (a *UsersApiService) UpdateUser(ctx context.Context, evAccessToken string, evApiKey string, id int32, localVarOptionals *UsersApiUpdateUserOpts) (InlineResponse20011, *http.Response, error)

type UsersApiUpdateUserOpts ¶

type UsersApiUpdateUserOpts struct {
	Body optional.Interface
}

type WebhooksActivityEntry ¶

type WebhooksActivityEntry struct {
	Id         int32                            `json:"id,omitempty"`
	Type_      string                           `json:"type,omitempty"`
	Attributes *WebhooksActivityEntryAttributes `json:"attributes,omitempty"`
}

type WebhooksActivityEntryAttributes ¶

type WebhooksActivityEntryAttributes struct {
	Attempt      int32  `json:"attempt,omitempty"`
	Created      string `json:"created,omitempty"`
	EndpointUrl  string `json:"endpointUrl,omitempty"`
	Event        string `json:"event,omitempty"`
	Response     string `json:"response,omitempty"`
	ResponseSize int32  `json:"responseSize,omitempty"`
	Status       int32  `json:"status,omitempty"`
}

type WebhooksActivityResponse ¶

type WebhooksActivityResponse struct {
	// Http status code of the response.
	ResponseStatus int32 `json:"responseStatus,omitempty"`
	// Total results found.
	TotalResults int32 `json:"totalResults,omitempty"`
	// Number of results returned.
	ReturnedResults int32                           `json:"returnedResults,omitempty"`
	Data            []SingleEntryOfSessionActivity1 `json:"data,omitempty"`
}

type WebhooksActivityResponseAttributes ¶

type WebhooksActivityResponseAttributes struct {
	// The number of attempts made to send the webhook.
	Attempt int32 `json:"attempt,omitempty"`
	// Datetime that the webhook was sent.
	Created string `json:"created,omitempty"`
	// The URL the webhook was sent to.
	EndpointUrl string `json:"endpointUrl,omitempty"`
	// Event the triggered the webhook
	Event        string `json:"event,omitempty"`
	Response     string `json:"response,omitempty"`
	ResponseSize int32  `json:"responseSize,omitempty"`
	Status       int32  `json:"status,omitempty"`
}

type WebhooksApiGetWebhookLogsOpts ¶

type WebhooksApiGetWebhookLogsOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	Path       optional.String
	StatusCode optional.Int32
	Event      optional.String
	Sort       optional.String
	Username   optional.String
}

type WebhooksApiService ¶

type WebhooksApiService service

func (*WebhooksApiService) GetWebhookLogs ¶

func (a *WebhooksApiService) GetWebhookLogs(ctx context.Context, evApiKey string, evAccessToken string, localVarOptionals *WebhooksApiGetWebhookLogsOpts) (WebhooksActivityResponse, *http.Response, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL