Merge pull request #330 from oneblink/ON-41972

ON-41972 # Added role permissions required to client docs

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+
+- Minimum Role Permission to Client docs
+
 ## [6.2.2] - 2024-07-10
 
 ### Changed

docs/README.md

@@ -31,6 +31,31 @@ while (nextOffset != null) {
 
 Alternately, you could integrate pagination directly into your application.
 
+## Permissions
+
+The majority of actions in this SDK require that your developer key has particular permissions. These permissions can be set in your tenant's console. If you do not have access to your tenant's console, you will need to work with your Administrator to associate the permissions that you require with your key. The associated permissions for each function are detailed on the function definitions.
+
+### Developer Key & Role
+
+Actions that require a developer key with a minimum role permission will have the following in the function definition:
+
+**Minimum Role Permission**
+
+The developer key used must be assigned a role with at least the permission documented for each action. E.g. If the action's minimum role permission is _Forms: Read Only_, the role assigned to the developer key could have _Forms: Read Only_ or _Forms: Manager_.
+
+### Developer Key & App Association
+
+Actions that require a developer key to be assigned to an app will have the following in the function definition:
+
+**App Association Required**
+
+In the case of any actions relating to forms, the assigned app must be associated with the form that is being actioned. A form can be associated with an app in the following ways:
+
+- For _Forms List_ type apps, the form can be in the _Forms List_ menu item.
+- For _Tiles_ type apps, the form can be in a _Container_ menu item or added directly to the menu via a _Form_ menu item.
+- For _Tiles_ or _Forms List_ type apps, the form can be assigned to an action in a _Scheduled task_.
+- For _Approvals_ type apps, the form can be an _Approval form_.
+
 ## Clients
 
 - [FormsClient](./forms-client.md)

docs/approvals-client.md

@@ -61,6 +61,10 @@ GetFormSubmissionAdministrationApprovalsResponse response = await approvalsClien
 
 A `GetFormSubmissionAdministrationApprovalsResponse` Object
 
+**Minimum Role Permission**
+
+Submission Data: _Read Only_
+
 ## `GetFormSubmissionApproval()`
 
 ### Example
@@ -85,6 +89,10 @@ GetFormSubmissionApprovalResponse response = await approvalsClient.GetFormSubmis
 
 A `GetFormSubmissionApprovalResponse` Object
 
+**Minimum Role Permission**
+
+Submission Data: _Read Only_
+
 ## `GetFormApprovalFlowInstance()`
 
 ### Example
@@ -108,3 +116,7 @@ GetFormApprovalFlowInstanceResponse response = await approvalsClient.GetFormAppr
 ### Result
 
 A `GetFormApprovalFlowInstanceResponse` Object
+
+**Minimum Role Permission**
+
+Submission Data: _Read Only_

docs/data-manager-client.md

@@ -46,6 +46,10 @@ FormStoreDefinition response = await approvalsClient.GetFormDefinition(formId);
 
 A `FormStoreDefinition` Object
 
+**Minimum Role Permission**
+
+Submission Data: _Read Only_
+
 ## `Search()`
 
 ### Example
@@ -84,3 +88,7 @@ FormStoreSearchResult<SubmissionResult> response = await dataManagerClient.Searc
 ### Result
 
 A `FormStoreSearchResult<T>` Object
+
+**Minimum Role Permission**
+
+Submission Data: _Read Only_

docs/email-client.md

@@ -37,3 +37,11 @@ string messageId = await EmailClient.SendEmail(body, attachments, from, toAddres
 ### Result
 
 A `Task<string>`
+
+### Permissions
+
+In AWS, you will require an IAM Role associated with the email used that has
+the permissions in order to use this function:
+
+- SendEmail
+- SendRawEmail

docs/email-template-client.md

@@ -52,6 +52,10 @@ OneBlink.SDK.Model.EmailTemplatesSearchResult response = await emailTemplatesCli
 
 A `EmailTemplatesSearchResult` class
 
+**Minimum Role Permission**
+
+Email Templates: _Read Only_
+
 ## `Get()`
 
 Retrieve an email template by id
@@ -79,6 +83,10 @@ OneBlink.SDK.Model.EmailTemplate emailTemplate = await emailTemplatesClient.Get(
 
 A `EmailTemplate` class
 
+**Minimum Role Permission**
+
+Email Templates: _Read Only_
+
 ## `Create()`
 
 Create a new email template
@@ -106,6 +114,10 @@ OneBlink.SDK.Model.EmailTemplate savedEmailTemplate = await emailTemplatesClient
 
 A `EmailTemplate` class
 
+**Minimum Role Permission**
+
+Email Templates: _Manager_
+
 ## `Update()`
 
 Update a email template
@@ -133,6 +145,10 @@ OneBlink.SDK.Model.EmailTemplate updatedEmailTemplate = await emailTemplatesClie
 
 A `EmailTemplate` class
 
+**Minimum Role Permission**
+
+Email Templates: _Manager_
+
 ## `Delete()`
 
 ### Example
@@ -157,3 +173,7 @@ await emailTemplatesClient.Delete(emailTemplateId);
 ### Result
 
 No return value (`void`)
+
+**Minimum Role Permission**
+
+Email Templates: _Manager_

docs/forms-app-environments.md

@@ -53,6 +53,10 @@ OneBlink.SDK.Model.FormsAppEnvironmentsSearchResult response = await formsAppEnv
 
 A `FormsAppEnvironmentsSearchResult` class
 
+**Minimum Role Permission**
+
+Environments: _Read Only_
+
 ## `Get()`
 
 Retrieve a forms app environment by id
@@ -80,6 +84,10 @@ OneBlink.SDK.Model.FormsAppEnvironment formsAppEnvironment = await formsAppEnvir
 
 A `FormsAppEnvironments` class
 
+**Minimum Role Permission**
+
+Environments: _Read Only_
+
 ## `Create()`
 
 Create a new forms app environment
@@ -107,6 +115,10 @@ OneBlink.SDK.Model.FormsAppEnvironment savedFormsAppEnvironment = await formsApp
 
 A `FormsAppEnvironment` class
 
+**Minimum Role Permission**
+
+Environments: _Manager_
+
 ## `Update()`
 
 Update a forms app environment
@@ -134,6 +146,10 @@ OneBlink.SDK.Model.FormsAppEnvironment updatedFormsAppEnvironment = await formsA
 
 A `FormsAppEnvironment` class
 
+**Minimum Role Permission**
+
+Environments: _Manager_
+
 ## `Delete()`
 
 ### Example
@@ -158,3 +174,7 @@ await formsClient.Delete(formsAppEnvironmentId);
 ### Result
 
 No return value (`void`)
+
+**Minimum Role Permission**
+
+Environments: _Manager_

docs/forms-apps-client.md

@@ -87,6 +87,10 @@ var formsApp = await formsAppsClient.Get<FormsListFormApp>(id);
 
 A `T` class
 
+**Minimum Role Permission**
+
+Apps: _Read Only_
+
 ## `Create()`
 
 Create a new forms app
@@ -115,6 +119,10 @@ var savedFormsApps = await formsAppsClient.Create<FormsListFormApp>(newFormsApp)
 
 A `T` class
 
+**Minimum Role Permission**
+
+Apps: _Manager_
+
 ## `Update()`
 
 Update a existing forms app
@@ -143,6 +151,10 @@ FormsListFormApp updatedFormsApp = await formsAppsClient.Update<FormsListFormApp
 
 A `FormsApp` class
 
+**Minimum Role Permission**
+
+Apps: _Manager_
+
 ## `Delete()`
 
 ### Example
@@ -168,6 +180,10 @@ await formsAppsClient.Delete(formsAppId);
 
 No return value (`void`)
 
+**Minimum Role Permission**
+
+Apps: _Manager_
+
 ## `SetSendingAddress()`
 
 ### Example
@@ -198,6 +214,10 @@ OneBlink.SDK.Model.FormsAppSendingAddressResponse sendingAddress = await formsAp
 
 A `OneBlink.SDK.Model.FormsAppSendingAddressResponse` class
 
+**Minimum Role Permission**
+
+App Users: _Manager_
+
 ## `DeleteSendingAddress()`
 
 ### Example
@@ -223,6 +243,10 @@ await formsAppsClient.DeleteSendingAddress(formsAppId);
 
 No return value (`void`)
 
+**Minimum Role Permission**
+
+App Users: _Manager_
+
 ## `GetSendingAddress()`
 
 ### Example
@@ -248,6 +272,10 @@ OneBlink.SDK.Model.FormsAppSendingAddressResponse sendingAddress = await formsAp
 
 A `OneBlink.SDK.Model.FormsAppSendingAddressResponse` class
 
+**Minimum Role Permission**
+
+App Users: _Read Only_
+
 ## `GetMyFormsApp()`
 
 Retrieve a forms app associated to a user token
@@ -302,6 +330,10 @@ OneBlink.SDK.Model.FormsAppUser savedUser = await formsAppsClient.CreateUser(new
 
 A `FormsAppUser` class
 
+**Minimum Role Permission**
+
+App Users: _Manager_
+
 ## `DeleteUser()`
 
 ### Example
@@ -326,3 +358,7 @@ await formsAppsClient.DeleteUser(formsAppUserId);
 ### Result
 
 No return value (`void`)
+
+**Minimum Role Permission**
+
+App Users: _Manager_