From b1701333817a51cad218682f42c231827c3d9232 Mon Sep 17 00:00:00 2001 From: jdawg093 <49189518+jdawg093@users.noreply.github.com> Date: Mon, 22 Jul 2024 09:54:51 +1000 Subject: [PATCH 1/6] ON-41972 # Added role permissions required to client docs --- CHANGELOG.md | 4 ++ docs/approvals-client.md | 12 ++++ docs/data-manager-client.md | 8 +++ docs/email-client.md | 4 ++ docs/email-template-client.md | 20 +++++++ docs/forms-app-environments.md | 20 +++++++ docs/forms-apps-client.md | 58 ++++++++++++++++++ docs/forms-client.md | 104 +++++++++++++++++++++++++++++++++ docs/jobs-client.md | 28 +++++++++ docs/keys-client.md | 4 ++ docs/lists-client.md | 16 +++++ docs/lookups-client.md | 20 +++++++ docs/organisations-client.md | 4 ++ docs/pdf-client.md | 12 ++++ docs/team-members-client.md | 4 ++ 15 files changed, 318 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e4e2f3..f9aaa81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Added + +- Role Permissions required to Client docs + ## [6.2.2] - 2024-07-10 ### Changed diff --git a/docs/approvals-client.md b/docs/approvals-client.md index 9e0b2f2..5e3b8ae 100644 --- a/docs/approvals-client.md +++ b/docs/approvals-client.md @@ -61,6 +61,10 @@ GetFormSubmissionAdministrationApprovalsResponse response = await approvalsClien A `GetFormSubmissionAdministrationApprovalsResponse` Object +### Role Permission Required + +FaaS: `Developer` + ## `GetFormSubmissionApproval()` ### Example @@ -85,6 +89,10 @@ GetFormSubmissionApprovalResponse response = await approvalsClient.GetFormSubmis A `GetFormSubmissionApprovalResponse` Object +### Role Permission Required + +FaaS: `Developer + ## `GetFormApprovalFlowInstance()` ### Example @@ -108,3 +116,7 @@ GetFormApprovalFlowInstanceResponse response = await approvalsClient.GetFormAppr ### Result A `GetFormApprovalFlowInstanceResponse` Object + +### Role Permission Required + +FaaS: `Developer` diff --git a/docs/data-manager-client.md b/docs/data-manager-client.md index dc79a4e..bb6ce71 100644 --- a/docs/data-manager-client.md +++ b/docs/data-manager-client.md @@ -46,6 +46,10 @@ FormStoreDefinition response = await approvalsClient.GetFormDefinition(formId); A `FormStoreDefinition` Object +### Role Permissions Required + +Form Submissions: `Manager` or `Read Only` + ## `Search()` ### Example @@ -84,3 +88,7 @@ FormStoreSearchResult response = await dataManagerClient.Searc ### Result A `FormStoreSearchResult` Object + +### Role Permissions Required + +Form Submissions: `Manager` or `Read Only` diff --git a/docs/email-client.md b/docs/email-client.md index e2e77d5..17e7759 100644 --- a/docs/email-client.md +++ b/docs/email-client.md @@ -37,3 +37,7 @@ string messageId = await EmailClient.SendEmail(body, attachments, from, toAddres ### Result A `Task` + +### Role Permissions Required + +No Permissions Required diff --git a/docs/email-template-client.md b/docs/email-template-client.md index df0c7ad..6462986 100644 --- a/docs/email-template-client.md +++ b/docs/email-template-client.md @@ -52,6 +52,10 @@ OneBlink.SDK.Model.EmailTemplatesSearchResult response = await emailTemplatesCli A `EmailTemplatesSearchResult` class +### Role Permissions Required + +Email Templates: `Manager` or `Read Only` + ## `Get()` Retrieve an email template by id @@ -79,6 +83,10 @@ OneBlink.SDK.Model.EmailTemplate emailTemplate = await emailTemplatesClient.Get( A `EmailTemplate` class +### Role Permissions Required + +Email Templates: `Manager` or `Read Only` + ## `Create()` Create a new email template @@ -106,6 +114,10 @@ OneBlink.SDK.Model.EmailTemplate savedEmailTemplate = await emailTemplatesClient A `EmailTemplate` class +### Role Permissions Required + +Email Templates: `Manager` + ## `Update()` Update a email template @@ -133,6 +145,10 @@ OneBlink.SDK.Model.EmailTemplate updatedEmailTemplate = await emailTemplatesClie A `EmailTemplate` class +### Role Permissions Required + +Email Templates: `Manager` + ## `Delete()` ### Example @@ -157,3 +173,7 @@ await emailTemplatesClient.Delete(emailTemplateId); ### Result No return value (`void`) + +### Role Permissions Required + +Email Templates: `Manager` diff --git a/docs/forms-app-environments.md b/docs/forms-app-environments.md index 313a08d..d08e453 100644 --- a/docs/forms-app-environments.md +++ b/docs/forms-app-environments.md @@ -53,6 +53,10 @@ OneBlink.SDK.Model.FormsAppEnvironmentsSearchResult response = await formsAppEnv A `FormsAppEnvironmentsSearchResult` class +### Role Permissions Required + +Forms App Environments: `Manager` or `Read Only` + ## `Get()` Retrieve a forms app environment by id @@ -80,6 +84,10 @@ OneBlink.SDK.Model.FormsAppEnvironment formsAppEnvironment = await formsAppEnvir A `FormsAppEnvironments` class +### Role Permissions Required + +Forms App Environments: `Manager` or `Read Only` + ## `Create()` Create a new forms app environment @@ -107,6 +115,10 @@ OneBlink.SDK.Model.FormsAppEnvironment savedFormsAppEnvironment = await formsApp A `FormsAppEnvironment` class +### Role Permissions Required + +Forms App Environments: `Manager` + ## `Update()` Update a forms app environment @@ -134,6 +146,10 @@ OneBlink.SDK.Model.FormsAppEnvironment updatedFormsAppEnvironment = await formsA A `FormsAppEnvironment` class +### Role Permissions Required + +Forms App Environments: `Manager` + ## `Delete()` ### Example @@ -158,3 +174,7 @@ await formsClient.Delete(formsAppEnvironmentId); ### Result No return value (`void`) + +### Role Permissions Required + +Forms App Environments: `Manager` diff --git a/docs/forms-apps-client.md b/docs/forms-apps-client.md index c3129e3..238a4a9 100644 --- a/docs/forms-apps-client.md +++ b/docs/forms-apps-client.md @@ -59,6 +59,10 @@ JWTPayload result = await formsAppsClient.VerifyJWT(token); A `OneBlink.SDK.Model.JWTPayload` class +### Role Permissions Required + +No Permissions Required + ## `Get()` Retrieve a forms app by id @@ -87,6 +91,12 @@ var formsApp = await formsAppsClient.Get(id); A `T` class +### Role Permissions Required + +For Apps: `Manager` or `Read Only` + +For Data Manager, Approvals, Volunteers: `Manager` or `Read Only` + ## `Create()` Create a new forms app @@ -115,6 +125,12 @@ var savedFormsApps = await formsAppsClient.Create(newFormsApp) A `T` class +### Role Permissions Required + +For Apps: `Manager` + +For Data Manager, Approvals, Volunteers: `Manager` + ## `Update()` Update a existing forms app @@ -143,6 +159,12 @@ FormsListFormApp updatedFormsApp = await formsAppsClient.Update` class or `null` +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `Search()` ### Example @@ -155,6 +167,10 @@ OneBlink.SDK.Model.FormsSearchResult response = await formsClient.Search(isAuthe A `FormsSearchResult` class +### Roles Permissions Required + +Form: `Manager` or `Read Only` + ## `SearchSubmissions(long formId)` Search for details on submissions that match the formId provided. @@ -186,6 +202,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `SearchSubmissions(long formId, DateTime submissionDateFrom, DateTime submissionDateTo, int limit, int offset, bool? isValid, string submissionTitle` Search for details on submissions for a particular formId with various criteria @@ -230,6 +250,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `SearchSubmissionsFromDate(long formId, DateTime submissionDateFrom)` Search for details on submissions for a particular formId that occurred **after** a given date. @@ -266,6 +290,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `SearchSubmissionsToDate(long formId, DateTime submissionDateTo)` Search for details on submissions for a particular formId that occurred **before** a given date. @@ -300,6 +328,10 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `Get()` Retrieve a form by id and optionally include the details of any child form elements @@ -328,6 +360,10 @@ OneBlink.SDK.Model.Form form = await formsClient.Get(id, false); A `Form` class +### Role Permissions Required + +Form: `Manager` or `Read Only` + ## `Create()` Create a new form @@ -355,6 +391,10 @@ OneBlink.SDK.Model.Form savedForm = await formsClient.Create(newForm); A `Form` class +### Role Permissions Required + +Form: `Manager` + ## `Update()` Update a form @@ -383,6 +423,10 @@ OneBlink.SDK.Model.Form updatedForm = await formsClient.Update(formToUpdate); A `Form` class +### Role Permissions Required + +Form: `Manager` + ## `Delete()` ### Example @@ -409,6 +453,10 @@ await formsClient.Delete(formId); No return value (`void`) +### Role Permissions Required + +Form: `Manager` + ## `GenerateFormUrl()` ### Example @@ -439,6 +487,22 @@ FormUrlResult result = await formsClient.GenerateFormUrl( A `OneBlink.SDK.Model.FormUrlResult` class +### Role Permissions Required + +#### For Private Forms + +Forms: `Manager` or `Read Only` + +Apps: `Manager` or `Read Only` + +#### For Public Forms + +Apps: `Manager` or `Read Only` + +#### For Form Submission and Pre-Fill Data + +FaaS: `Developer` + ## `GenerateSubmissionDataUrl()` ### Example @@ -465,6 +529,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionDataUr A `OneBlink.SDK.Model.SubmissionDataUrl` class +### Role Permissions Required + +Form Submissions: `Manager` or `Read Only` + ## `GetFormSubmissionAttachment()` ### Example @@ -489,6 +557,10 @@ Stream attachmentStream = await formsClient.GetFormSubmissionAttachment(formId, A `System.IO.Stream` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `GetFormSubmissionAttachmentMeta()` ### Example @@ -513,6 +585,10 @@ FormAttachmentMeta meta = await formsClient.GetFormSubmissionAttachmentMeta(form A `FormAttachmentMeta` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `CreateSubmissionAttachment()` ### Example @@ -541,6 +617,10 @@ AttachmentData attachmentData = await formsClient.CreateSubmissionAttachment(for A `OneBlink.SDK.Model.AttachmentData` class +### Role Permissions Required + +FaaS: `Developer` + ## `GenerateSubmissionAttachmentUrl()` ### Example @@ -567,6 +647,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionAttach A `OneBlink.SDK.Model.SubmissionDataUrl` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `GenerateWorkflowAttachmentLink()` ### Example @@ -593,6 +677,10 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateWorkflowAttachme A `OneBlink.SDK.Model.SubmissionDataUrl` class +### Role Permissions Required + +Form Submission: `Manager` or `Read Only` + ## `Migrate()` ### Example @@ -620,6 +708,10 @@ await formsClient.Migrate(formMigrationOptions); No return value (`void`) +### Role Permissions Required + +Form: `Manager` + ## `GetFormSubmissionMeta()` Retrieve the Form Submission metadata for by submission id. This will include the approval associated with the submission if the form had an approval flow setup. @@ -646,6 +738,10 @@ OneBlink.SDK.Model.FormSubmissionMetadataResponse formSubmissionMetadataResponse A `FormSubmissionMetadataResponse` class +### Role Permissions Required + +Form Submissions: `Manager` or `Read Only` + ## `UploadEmailAttachment()` ### Example @@ -671,6 +767,10 @@ EmailAttachmentData emailAttachmentData = await formsClient.UploadEmailAttachmen A `OneBlink.SDK.Model.EmailAttachmentData` class +### Role Permissions Required + +FaaS: `Developer` + ## `ExecuteWorkflowEvent()` ### Example @@ -698,3 +798,7 @@ FormSubmissionWorkflowEvent formSubmissionWorkflowEvent = await formsClient.Exec ### Result A `OneBlink.SDK.Model.FormSubmissionWorkflowEvent` class + +### Role Permissions Required + +Form Submission: `Manager` diff --git a/docs/jobs-client.md b/docs/jobs-client.md index 30b8f3d..5921364 100644 --- a/docs/jobs-client.md +++ b/docs/jobs-client.md @@ -73,6 +73,10 @@ OneBlink.SDK.Model.Job job = await jobsClient.CreateJob(job); A `OneBlink.SDK.Model.Job` Object +### Role Permissions Required + +Jobs: `Manager` + ## `CreateJob(job, T)` ### Example @@ -127,6 +131,10 @@ OneBlink.SDK.Model.Job job = await jobsClient.CreateJob(job, A `OneBlink.SDK.Model.Job` Object +### Role Permissions Required + +Jobs: `Manager` + ## `DeleteJob(jobId)` ### Example @@ -153,6 +161,10 @@ await jobsClient.DeleteJob(jobId); No return value (`void`) +### Role Permissions Required + +Jobs: `Manager` + ## `Search(searchParams)` ### Example @@ -188,6 +200,10 @@ JobsSearchResult results = await jobsClient.Search(searchParams); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. +### Role Permissions Required + +Jobs: `Manager` or `Read Only` + ## `SearchByExternalId(externalId)` ### Example @@ -213,6 +229,10 @@ JobsSearchResult results = await jobsClient.SearchByExternalId(externalId); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. +### Role Permissions Required + +Jobs: `Manager` or `Read Only` + ## `SearchByFormId(formId)` ### Example @@ -238,6 +258,10 @@ JobsSearchResult results = await jobsClient.SearchByFormId(formId); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. +### Role Permissions Required + +Jobs: `Manager` or `Read Only` + ## `SearchByUsername(username)` ### Example @@ -262,3 +286,7 @@ JobsSearchResult results = await jobsClient.SearchByUsername(username); ### Result Returns a `OneBlink.SDK.Model.JobsSearchResult` object. + +### Role Permissions Required + +Jobs: `Manager` or `Read Only` diff --git a/docs/keys-client.md b/docs/keys-client.md index be3a922..a5d9e97 100644 --- a/docs/keys-client.md +++ b/docs/keys-client.md @@ -44,3 +44,7 @@ OneBlink.SDK.Model.DeveloperKey developerKey = await keysClient.GetDeveloperKey( ### Result A `OneBlink.SDK.Model.DeveloperKey` class + +### Role Permissions Required + +Calendar Bookings, Integrations & Developer Keys: `Manager` or `Read Only` diff --git a/docs/lists-client.md b/docs/lists-client.md index 45b0fd3..88b1ff1 100644 --- a/docs/lists-client.md +++ b/docs/lists-client.md @@ -53,6 +53,10 @@ OneBlink.SDK.Model.FormElementListsSearchResult response = await formElementList A `FormElementListSearchResult` class +### Role Permissions Required + +No Permissions Required + ## `Create()` Create a new form element list @@ -80,6 +84,10 @@ OneBlink.SDK.Model.FormElementList savedFormElementList = await formElementLists A `FormElementList` class +### Role Permissions Required + +Form Element Lists: `Manager` + ## `Update()` Update a form element list @@ -107,6 +115,10 @@ OneBlink.SDK.Model.FormElementList updatedFormElementList = await formElementLis A `FormElementList` class +### Role Permissions Required + +Form Element Lists: `Manager` + ## `Delete()` ### Example @@ -131,3 +143,7 @@ await formElementListsClient.Delete(formElementListId); ### Result No return value (`void`) + +### Role Permissions Required + +Form Element Lists: `Manager` diff --git a/docs/lookups-client.md b/docs/lookups-client.md index 027be93..60aeb86 100644 --- a/docs/lookups-client.md +++ b/docs/lookups-client.md @@ -54,6 +54,10 @@ OneBlink.SDK.Model.FormElementLookupSearchResult response = await formElementLoo A `FormElementLookupSearchResult` class +### Role Permissions Required + +No Permissions Required + ## `Get()` Retrieve a form element lookup by id @@ -81,6 +85,10 @@ OneBlink.SDK.Model.FormElementLookup formElementLookup = await formElementLookup A `FormElementLookup` class +### Role Permissions Required + +Form Element Lookups: `Manager` or `Read Only` + ## `Create()` Create a new form element lookup @@ -108,6 +116,10 @@ OneBlink.SDK.Model.FormElementLookup savedFormElementLookup = await formElementL A `FormElementLookup` class +### Role Permissions Required + +Form Element Lookups: `Manager` + ## `Update()` Update a form element lookup @@ -135,6 +147,10 @@ OneBlink.SDK.Model.FormElementLookup updatedFormElementLookup = await formElemen A `FormElementLookup` class +### Role Permissions Required + +Form Element Lookups: `Manager` + ## `Delete()` ### Example @@ -159,3 +175,7 @@ await formElementLookupsClient.Delete(formElementLookupId); ### Result No return value (`void`) + +### Role Permissions Required + +Form Element Lookups: `Manager` diff --git a/docs/organisations-client.md b/docs/organisations-client.md index 08d1475..5fd5c3e 100644 --- a/docs/organisations-client.md +++ b/docs/organisations-client.md @@ -50,3 +50,7 @@ using (FileStream stream = new FileStream("contents.txt", FileMode.Open)) ### Result A `string` with the public url to the asset + +### Role Permissions Required + +No Permissions Required diff --git a/docs/pdf-client.md b/docs/pdf-client.md index 96b0f11..5a0a68f 100644 --- a/docs/pdf-client.md +++ b/docs/pdf-client.md @@ -59,6 +59,10 @@ Stream response = await pdfClient.GetSubmissionPdf(formId, submissionId); A `Stream` object +### Role Permissions Required + +PDF: `Developer` + ## `GeneratePdf()` ### Example @@ -87,6 +91,10 @@ Stream response = await pdfClient.GeneratePdf(pdfOptionsRequest); A `Stream` object +### Role Permissions Required + +PDF: `Developer` + ## `GeneratePdfFromSubmissionData()` ### Example @@ -117,3 +125,7 @@ Stream response = await pdfClient.GeneratePdfFromSubmissionData Date: Tue, 23 Jul 2024 08:46:02 +1000 Subject: [PATCH 2/6] ON-41972 # Updated permissions to reflect new permissions --- docs/forms-client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/forms-client.md b/docs/forms-client.md index 4b52899..6d220ea 100644 --- a/docs/forms-client.md +++ b/docs/forms-client.md @@ -769,7 +769,7 @@ A `OneBlink.SDK.Model.EmailAttachmentData` class ### Role Permissions Required -FaaS: `Developer` +Email Attachment: `Developer` ## `ExecuteWorkflowEvent()` From 95aba1eb59f266d6862b6ff704cea7a03e8e71ae Mon Sep 17 00:00:00 2001 From: jdawg093 <49189518+jdawg093@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:58:21 +1000 Subject: [PATCH 3/6] ON-41972 # Updated docs to reflect new perm changes --- docs/approvals-client.md | 12 +++++----- docs/data-manager-client.md | 4 ++-- docs/email-client.md | 6 ++++- docs/forms-app-environments.md | 10 ++++---- docs/forms-apps-client.md | 28 ++++++---------------- docs/forms-client.md | 44 ++++++++++++++-------------------- docs/lists-client.md | 6 ++--- docs/lookups-client.md | 8 +++---- docs/pdf-client.md | 6 ++--- 9 files changed, 53 insertions(+), 71 deletions(-) diff --git a/docs/approvals-client.md b/docs/approvals-client.md index 5e3b8ae..4f7228a 100644 --- a/docs/approvals-client.md +++ b/docs/approvals-client.md @@ -61,9 +61,9 @@ GetFormSubmissionAdministrationApprovalsResponse response = await approvalsClien A `GetFormSubmissionAdministrationApprovalsResponse` Object -### Role Permission Required +### Role Permissions Required -FaaS: `Developer` +Submission Data: `Manager` or `Read Only` ## `GetFormSubmissionApproval()` @@ -89,9 +89,9 @@ GetFormSubmissionApprovalResponse response = await approvalsClient.GetFormSubmis A `GetFormSubmissionApprovalResponse` Object -### Role Permission Required +### Role Permissions Required -FaaS: `Developer +Submission Data: `Manager` or `Read Only` ## `GetFormApprovalFlowInstance()` @@ -117,6 +117,6 @@ GetFormApprovalFlowInstanceResponse response = await approvalsClient.GetFormAppr A `GetFormApprovalFlowInstanceResponse` Object -### Role Permission Required +### Role Permissions Required -FaaS: `Developer` +Submission Data: `Manager` or `Read Only` diff --git a/docs/data-manager-client.md b/docs/data-manager-client.md index bb6ce71..5cc6373 100644 --- a/docs/data-manager-client.md +++ b/docs/data-manager-client.md @@ -48,7 +48,7 @@ A `FormStoreDefinition` Object ### Role Permissions Required -Form Submissions: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `Search()` @@ -91,4 +91,4 @@ A `FormStoreSearchResult` Object ### Role Permissions Required -Form Submissions: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` diff --git a/docs/email-client.md b/docs/email-client.md index 17e7759..03dcaa2 100644 --- a/docs/email-client.md +++ b/docs/email-client.md @@ -40,4 +40,8 @@ A `Task` ### Role Permissions Required -No Permissions Required +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 diff --git a/docs/forms-app-environments.md b/docs/forms-app-environments.md index d08e453..000557f 100644 --- a/docs/forms-app-environments.md +++ b/docs/forms-app-environments.md @@ -55,7 +55,7 @@ A `FormsAppEnvironmentsSearchResult` class ### Role Permissions Required -Forms App Environments: `Manager` or `Read Only` +Environments: `Manager` or `Read Only` ## `Get()` @@ -86,7 +86,7 @@ A `FormsAppEnvironments` class ### Role Permissions Required -Forms App Environments: `Manager` or `Read Only` +Environments: `Manager` or `Read Only` ## `Create()` @@ -117,7 +117,7 @@ A `FormsAppEnvironment` class ### Role Permissions Required -Forms App Environments: `Manager` +Environments: `Manager` ## `Update()` @@ -148,7 +148,7 @@ A `FormsAppEnvironment` class ### Role Permissions Required -Forms App Environments: `Manager` +Environments: `Manager` ## `Delete()` @@ -177,4 +177,4 @@ No return value (`void`) ### Role Permissions Required -Forms App Environments: `Manager` +Environments: `Manager` diff --git a/docs/forms-apps-client.md b/docs/forms-apps-client.md index 238a4a9..12defbd 100644 --- a/docs/forms-apps-client.md +++ b/docs/forms-apps-client.md @@ -93,9 +93,7 @@ A `T` class ### Role Permissions Required -For Apps: `Manager` or `Read Only` - -For Data Manager, Approvals, Volunteers: `Manager` or `Read Only` +Apps: `Manager` or `Read Only` ## `Create()` @@ -127,9 +125,7 @@ A `T` class ### Role Permissions Required -For Apps: `Manager` - -For Data Manager, Approvals, Volunteers: `Manager` +Apps: `Manager` ## `Update()` @@ -161,9 +157,7 @@ A `FormsApp` class ### Role Permissions Required -For Apps: `Manager` or `Read Only` - -For Data Manager, Approvals, Volunteers: `Manager` or `Read Only` +Apps: `Manager` or `Read Only` ## `Delete()` @@ -192,9 +186,7 @@ No return value (`void`) ### Role Permissions Required -For Apps: `Manager` - -For Data Manager, Approvals, Volunteers: `Manager` +Apps: `Manager` ## `SetSendingAddress()` @@ -228,9 +220,7 @@ A `OneBlink.SDK.Model.FormsAppSendingAddressResponse` class ### Role Permissions Required -For Apps: `Manager` - -For Data Manager, Approvals, Volunteers: `Manager` +Apps: `Manager` ## `DeleteSendingAddress()` @@ -259,9 +249,7 @@ No return value (`void`) ### Role Permissions Required -For Apps: `Manager` - -For Data Manager, Approvals, Volunteers: `Manager` +Apps: `Manager` ## `GetSendingAddress()` @@ -290,9 +278,7 @@ A `OneBlink.SDK.Model.FormsAppSendingAddressResponse` class ### Role Permissions Required -For Apps: `Manager` or `Read Only` - -For Data Manager, Approvals, Volunteers: `Manager` or `Read Only` +Apps: `Manager` or `Read Only` ## `GetMyFormsApp()` diff --git a/docs/forms-client.md b/docs/forms-client.md index 6d220ea..9ab1ba4 100644 --- a/docs/forms-client.md +++ b/docs/forms-client.md @@ -31,10 +31,6 @@ string username = FormsClient.DecryptUserToken( A `string` -### Role Permissions Required - -No Permissions Required - ## `EncryptUserToken()` ### Example @@ -61,10 +57,6 @@ string userToken = FormsClient.EncryptUserToken( A `string` -### Role Permissions Required - -No Permissions Required - ## Instance Functions - [`GetFormSubmission()`](#getformsubmission) @@ -131,7 +123,7 @@ A `FormSubmission` class or `null` ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `Search()` @@ -204,7 +196,7 @@ A `FormSubmissionSearchResult` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `SearchSubmissions(long formId, DateTime submissionDateFrom, DateTime submissionDateTo, int limit, int offset, bool? isValid, string submissionTitle` @@ -252,7 +244,7 @@ A `FormSubmissionSearchResult` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `SearchSubmissionsFromDate(long formId, DateTime submissionDateFrom)` @@ -292,7 +284,7 @@ A `FormSubmissionSearchResult` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `SearchSubmissionsToDate(long formId, DateTime submissionDateTo)` @@ -330,7 +322,7 @@ A `FormSubmissionSearchResult` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `Get()` @@ -362,7 +354,7 @@ A `Form` class ### Role Permissions Required -Form: `Manager` or `Read Only` +Forms: `Manager` or `Read Only` ## `Create()` @@ -393,7 +385,7 @@ A `Form` class ### Role Permissions Required -Form: `Manager` +Forms: `Manager` ## `Update()` @@ -425,7 +417,7 @@ A `Form` class ### Role Permissions Required -Form: `Manager` +Forms: `Manager` ## `Delete()` @@ -455,7 +447,7 @@ No return value (`void`) ### Role Permissions Required -Form: `Manager` +Forms: `Manager` ## `GenerateFormUrl()` @@ -531,7 +523,7 @@ A `OneBlink.SDK.Model.SubmissionDataUrl` class ### Role Permissions Required -Form Submissions: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `GetFormSubmissionAttachment()` @@ -559,7 +551,7 @@ A `System.IO.Stream` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `GetFormSubmissionAttachmentMeta()` @@ -587,7 +579,7 @@ A `FormAttachmentMeta` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `CreateSubmissionAttachment()` @@ -649,7 +641,7 @@ A `OneBlink.SDK.Model.SubmissionDataUrl` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `GenerateWorkflowAttachmentLink()` @@ -679,7 +671,7 @@ A `OneBlink.SDK.Model.SubmissionDataUrl` class ### Role Permissions Required -Form Submission: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `Migrate()` @@ -710,7 +702,7 @@ No return value (`void`) ### Role Permissions Required -Form: `Manager` +Forms: `Manager` ## `GetFormSubmissionMeta()` @@ -740,7 +732,7 @@ A `FormSubmissionMetadataResponse` class ### Role Permissions Required -Form Submissions: `Manager` or `Read Only` +Submission Data: `Manager` or `Read Only` ## `UploadEmailAttachment()` @@ -769,7 +761,7 @@ A `OneBlink.SDK.Model.EmailAttachmentData` class ### Role Permissions Required -Email Attachment: `Developer` +Email Attachments: `On` ## `ExecuteWorkflowEvent()` @@ -801,4 +793,4 @@ A `OneBlink.SDK.Model.FormSubmissionWorkflowEvent` class ### Role Permissions Required -Form Submission: `Manager` +Submission Data: `Manager` diff --git a/docs/lists-client.md b/docs/lists-client.md index 88b1ff1..759a9bb 100644 --- a/docs/lists-client.md +++ b/docs/lists-client.md @@ -86,7 +86,7 @@ A `FormElementList` class ### Role Permissions Required -Form Element Lists: `Manager` +Lists: `Manager` ## `Update()` @@ -117,7 +117,7 @@ A `FormElementList` class ### Role Permissions Required -Form Element Lists: `Manager` +Lists: `Manager` ## `Delete()` @@ -146,4 +146,4 @@ No return value (`void`) ### Role Permissions Required -Form Element Lists: `Manager` +Lists: `Manager` diff --git a/docs/lookups-client.md b/docs/lookups-client.md index 60aeb86..2241252 100644 --- a/docs/lookups-client.md +++ b/docs/lookups-client.md @@ -87,7 +87,7 @@ A `FormElementLookup` class ### Role Permissions Required -Form Element Lookups: `Manager` or `Read Only` +Lookups: `Manager` or `Read Only` ## `Create()` @@ -118,7 +118,7 @@ A `FormElementLookup` class ### Role Permissions Required -Form Element Lookups: `Manager` +Lookups: `Manager` ## `Update()` @@ -149,7 +149,7 @@ A `FormElementLookup` class ### Role Permissions Required -Form Element Lookups: `Manager` +Lookups: `Manager` ## `Delete()` @@ -178,4 +178,4 @@ No return value (`void`) ### Role Permissions Required -Form Element Lookups: `Manager` +Lookups: `Manager` diff --git a/docs/pdf-client.md b/docs/pdf-client.md index 5a0a68f..01c35d8 100644 --- a/docs/pdf-client.md +++ b/docs/pdf-client.md @@ -61,7 +61,7 @@ A `Stream` object ### Role Permissions Required -PDF: `Developer` +PDF Generation: `On` ## `GeneratePdf()` @@ -93,7 +93,7 @@ A `Stream` object ### Role Permissions Required -PDF: `Developer` +PDF Generation: `On` ## `GeneratePdfFromSubmissionData()` @@ -128,4 +128,4 @@ A `Stream` object ### Role Permissions Required -PDF: `Developer` +PDF Generation: `On` From de287bda1cb78ae27ac096093576c0a67ced4dbb Mon Sep 17 00:00:00 2001 From: jdawg093 <49189518+jdawg093@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:00:05 +1000 Subject: [PATCH 4/6] ON-41972 # Fixed heading and missing plural --- docs/forms-client.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/forms-client.md b/docs/forms-client.md index 9ab1ba4..467aabb 100644 --- a/docs/forms-client.md +++ b/docs/forms-client.md @@ -159,9 +159,9 @@ OneBlink.SDK.Model.FormsSearchResult response = await formsClient.Search(isAuthe A `FormsSearchResult` class -### Roles Permissions Required +### Role Permissions Required -Form: `Manager` or `Read Only` +Forms: `Manager` or `Read Only` ## `SearchSubmissions(long formId)` From 3952a425239ff669817f7b25580679be6dadee49 Mon Sep 17 00:00:00 2001 From: jdawg093 <49189518+jdawg093@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:41:03 +1000 Subject: [PATCH 5/6] ON-41972 # Update documentation --- CHANGELOG.md | 2 +- docs/README.md | 25 +++++++++ docs/approvals-client.md | 12 ++--- docs/data-manager-client.md | 8 +-- docs/email-client.md | 2 +- docs/email-template-client.md | 20 +++---- docs/forms-app-environments.md | 20 +++---- docs/forms-apps-client.md | 44 +++++++--------- docs/forms-client.md | 96 +++++++++++++++------------------- docs/jobs-client.md | 32 +++++++----- docs/keys-client.md | 4 +- docs/lists-client.md | 16 +++--- docs/lookups-client.md | 20 +++---- docs/models/Form.md | 2 +- docs/organisations-client.md | 27 ++++++++-- docs/pdf-client.md | 12 ++--- docs/team-members-client.md | 4 -- 17 files changed, 187 insertions(+), 159 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f9aaa81..4962881 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ### Added -- Role Permissions required to Client docs +- Minimum Role Permission to Client docs ## [6.2.2] - 2024-07-10 diff --git a/docs/README.md b/docs/README.md index 5ff7633..81d03f1 100644 --- a/docs/README.md +++ b/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) diff --git a/docs/approvals-client.md b/docs/approvals-client.md index 4f7228a..199c9d3 100644 --- a/docs/approvals-client.md +++ b/docs/approvals-client.md @@ -61,9 +61,9 @@ GetFormSubmissionAdministrationApprovalsResponse response = await approvalsClien A `GetFormSubmissionAdministrationApprovalsResponse` Object -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `GetFormSubmissionApproval()` @@ -89,9 +89,9 @@ GetFormSubmissionApprovalResponse response = await approvalsClient.GetFormSubmis A `GetFormSubmissionApprovalResponse` Object -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `GetFormApprovalFlowInstance()` @@ -117,6 +117,6 @@ GetFormApprovalFlowInstanceResponse response = await approvalsClient.GetFormAppr A `GetFormApprovalFlowInstanceResponse` Object -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ diff --git a/docs/data-manager-client.md b/docs/data-manager-client.md index 5cc6373..59417fb 100644 --- a/docs/data-manager-client.md +++ b/docs/data-manager-client.md @@ -46,9 +46,9 @@ FormStoreDefinition response = await approvalsClient.GetFormDefinition(formId); A `FormStoreDefinition` Object -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `Search()` @@ -89,6 +89,6 @@ FormStoreSearchResult response = await dataManagerClient.Searc A `FormStoreSearchResult` Object -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ diff --git a/docs/email-client.md b/docs/email-client.md index 03dcaa2..f9b76cc 100644 --- a/docs/email-client.md +++ b/docs/email-client.md @@ -38,7 +38,7 @@ string messageId = await EmailClient.SendEmail(body, attachments, from, toAddres A `Task` -### Role Permissions Required +### Permissions In AWS, you will require an IAM Role associated with the email used that has the permissions in order to use this function: diff --git a/docs/email-template-client.md b/docs/email-template-client.md index 6462986..e358b39 100644 --- a/docs/email-template-client.md +++ b/docs/email-template-client.md @@ -52,9 +52,9 @@ OneBlink.SDK.Model.EmailTemplatesSearchResult response = await emailTemplatesCli A `EmailTemplatesSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Email Templates: `Manager` or `Read Only` +Email Templates: _Read Only_ ## `Get()` @@ -83,9 +83,9 @@ OneBlink.SDK.Model.EmailTemplate emailTemplate = await emailTemplatesClient.Get( A `EmailTemplate` class -### Role Permissions Required +**Minimum Role Permission** -Email Templates: `Manager` or `Read Only` +Email Templates: _Read Only_ ## `Create()` @@ -114,9 +114,9 @@ OneBlink.SDK.Model.EmailTemplate savedEmailTemplate = await emailTemplatesClient A `EmailTemplate` class -### Role Permissions Required +**Minimum Role Permission** -Email Templates: `Manager` +Email Templates: _Manager_ ## `Update()` @@ -145,9 +145,9 @@ OneBlink.SDK.Model.EmailTemplate updatedEmailTemplate = await emailTemplatesClie A `EmailTemplate` class -### Role Permissions Required +**Minimum Role Permission** -Email Templates: `Manager` +Email Templates: _Manager_ ## `Delete()` @@ -174,6 +174,6 @@ await emailTemplatesClient.Delete(emailTemplateId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Email Templates: `Manager` +Email Templates: _Manager_ diff --git a/docs/forms-app-environments.md b/docs/forms-app-environments.md index 000557f..b5ec9a5 100644 --- a/docs/forms-app-environments.md +++ b/docs/forms-app-environments.md @@ -53,9 +53,9 @@ OneBlink.SDK.Model.FormsAppEnvironmentsSearchResult response = await formsAppEnv A `FormsAppEnvironmentsSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Environments: `Manager` or `Read Only` +Environments: _Read Only_ ## `Get()` @@ -84,9 +84,9 @@ OneBlink.SDK.Model.FormsAppEnvironment formsAppEnvironment = await formsAppEnvir A `FormsAppEnvironments` class -### Role Permissions Required +**Minimum Role Permission** -Environments: `Manager` or `Read Only` +Environments: _Read Only_ ## `Create()` @@ -115,9 +115,9 @@ OneBlink.SDK.Model.FormsAppEnvironment savedFormsAppEnvironment = await formsApp A `FormsAppEnvironment` class -### Role Permissions Required +**Minimum Role Permission** -Environments: `Manager` +Environments: _Manager_ ## `Update()` @@ -146,9 +146,9 @@ OneBlink.SDK.Model.FormsAppEnvironment updatedFormsAppEnvironment = await formsA A `FormsAppEnvironment` class -### Role Permissions Required +**Minimum Role Permission** -Environments: `Manager` +Environments: _Manager_ ## `Delete()` @@ -175,6 +175,6 @@ await formsClient.Delete(formsAppEnvironmentId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Environments: `Manager` +Environments: _Manager_ diff --git a/docs/forms-apps-client.md b/docs/forms-apps-client.md index 12defbd..162bda9 100644 --- a/docs/forms-apps-client.md +++ b/docs/forms-apps-client.md @@ -59,10 +59,6 @@ JWTPayload result = await formsAppsClient.VerifyJWT(token); A `OneBlink.SDK.Model.JWTPayload` class -### Role Permissions Required - -No Permissions Required - ## `Get()` Retrieve a forms app by id @@ -91,9 +87,9 @@ var formsApp = await formsAppsClient.Get(id); A `T` class -### Role Permissions Required +**Minimum Role Permission** -Apps: `Manager` or `Read Only` +Apps: _Read Only_ ## `Create()` @@ -123,9 +119,9 @@ var savedFormsApps = await formsAppsClient.Create(newFormsApp) A `T` class -### Role Permissions Required +**Minimum Role Permission** -Apps: `Manager` +Apps: _Manager_ ## `Update()` @@ -155,9 +151,9 @@ FormsListFormApp updatedFormsApp = await formsAppsClient.Update` class or `null` -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `Search()` @@ -159,9 +159,9 @@ OneBlink.SDK.Model.FormsSearchResult response = await formsClient.Search(isAuthe A `FormsSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` or `Read Only` +Forms: _Read Only_ ## `SearchSubmissions(long formId)` @@ -194,9 +194,9 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `SearchSubmissions(long formId, DateTime submissionDateFrom, DateTime submissionDateTo, int limit, int offset, bool? isValid, string submissionTitle` @@ -242,9 +242,9 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `SearchSubmissionsFromDate(long formId, DateTime submissionDateFrom)` @@ -282,9 +282,9 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `SearchSubmissionsToDate(long formId, DateTime submissionDateTo)` @@ -320,9 +320,9 @@ OneBlink.SDK.Model.FormSubmissionSearchResult response = await formsClient.Searc A `FormSubmissionSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `Get()` @@ -352,9 +352,9 @@ OneBlink.SDK.Model.Form form = await formsClient.Get(id, false); A `Form` class -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` or `Read Only` +Forms: _Read Only_ ## `Create()` @@ -383,9 +383,9 @@ OneBlink.SDK.Model.Form savedForm = await formsClient.Create(newForm); A `Form` class -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` +Forms: _Manager_ ## `Update()` @@ -415,9 +415,9 @@ OneBlink.SDK.Model.Form updatedForm = await formsClient.Update(formToUpdate); A `Form` class -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` +Forms: _Manager_ ## `Delete()` @@ -445,9 +445,9 @@ await formsClient.Delete(formId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` +Forms: _Manager_ ## `GenerateFormUrl()` @@ -479,21 +479,11 @@ FormUrlResult result = await formsClient.GenerateFormUrl( A `OneBlink.SDK.Model.FormUrlResult` class -### Role Permissions Required +**Minimum Role Permission** (only if using `preFillData`) -#### For Private Forms +Forms: _Manager_ -Forms: `Manager` or `Read Only` - -Apps: `Manager` or `Read Only` - -#### For Public Forms - -Apps: `Manager` or `Read Only` - -#### For Form Submission and Pre-Fill Data - -FaaS: `Developer` +**App Association Required** ## `GenerateSubmissionDataUrl()` @@ -521,9 +511,9 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionDataUr A `OneBlink.SDK.Model.SubmissionDataUrl` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `GetFormSubmissionAttachment()` @@ -549,9 +539,9 @@ Stream attachmentStream = await formsClient.GetFormSubmissionAttachment(formId, A `System.IO.Stream` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `GetFormSubmissionAttachmentMeta()` @@ -577,9 +567,9 @@ FormAttachmentMeta meta = await formsClient.GetFormSubmissionAttachmentMeta(form A `FormAttachmentMeta` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `CreateSubmissionAttachment()` @@ -609,9 +599,9 @@ AttachmentData attachmentData = await formsClient.CreateSubmissionAttachment(for A `OneBlink.SDK.Model.AttachmentData` class -### Role Permissions Required +**Minimum Role Permission** -FaaS: `Developer` +Upload Attachments: _On_ ## `GenerateSubmissionAttachmentUrl()` @@ -639,9 +629,9 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateSubmissionAttach A `OneBlink.SDK.Model.SubmissionDataUrl` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `GenerateWorkflowAttachmentLink()` @@ -669,9 +659,9 @@ SubmissionDataUrl submissionDataUrl = await formsClient.GenerateWorkflowAttachme A `OneBlink.SDK.Model.SubmissionDataUrl` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `Migrate()` @@ -700,9 +690,9 @@ await formsClient.Migrate(formMigrationOptions); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Forms: `Manager` +Forms: _Manager_ ## `GetFormSubmissionMeta()` @@ -730,9 +720,9 @@ OneBlink.SDK.Model.FormSubmissionMetadataResponse formSubmissionMetadataResponse A `FormSubmissionMetadataResponse` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` or `Read Only` +Submission Data: _Read Only_ ## `UploadEmailAttachment()` @@ -759,9 +749,9 @@ EmailAttachmentData emailAttachmentData = await formsClient.UploadEmailAttachmen A `OneBlink.SDK.Model.EmailAttachmentData` class -### Role Permissions Required +**Minimum Role Permission** -Email Attachments: `On` +Upload Attachments: _On_ ## `ExecuteWorkflowEvent()` @@ -791,6 +781,6 @@ FormSubmissionWorkflowEvent formSubmissionWorkflowEvent = await formsClient.Exec A `OneBlink.SDK.Model.FormSubmissionWorkflowEvent` class -### Role Permissions Required +**Minimum Role Permission** -Submission Data: `Manager` +Submission Data: _Manager_ diff --git a/docs/jobs-client.md b/docs/jobs-client.md index 5921364..98c40a4 100644 --- a/docs/jobs-client.md +++ b/docs/jobs-client.md @@ -73,9 +73,11 @@ OneBlink.SDK.Model.Job job = await jobsClient.CreateJob(job); A `OneBlink.SDK.Model.Job` Object -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` +Jobs: _Manager_ + +Upload Form Prefill Data: _On_ (only if using `preFillData`) ## `CreateJob(job, T)` @@ -131,9 +133,11 @@ OneBlink.SDK.Model.Job job = await jobsClient.CreateJob(job, A `OneBlink.SDK.Model.Job` Object -### Role Permissions Required +**Minimum Role Permission** + +Jobs: _Manager_ -Jobs: `Manager` +Upload Form Prefill Data: _On_ (only if using `preFillData`) ## `DeleteJob(jobId)` @@ -161,9 +165,9 @@ await jobsClient.DeleteJob(jobId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` +Jobs: _Manager_ ## `Search(searchParams)` @@ -200,9 +204,9 @@ JobsSearchResult results = await jobsClient.Search(searchParams); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` or `Read Only` +Jobs: _Read Only_ ## `SearchByExternalId(externalId)` @@ -229,9 +233,9 @@ JobsSearchResult results = await jobsClient.SearchByExternalId(externalId); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` or `Read Only` +Jobs: _Read Only_ ## `SearchByFormId(formId)` @@ -258,9 +262,9 @@ JobsSearchResult results = await jobsClient.SearchByFormId(formId); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` or `Read Only` +Jobs: _Read Only_ ## `SearchByUsername(username)` @@ -287,6 +291,6 @@ JobsSearchResult results = await jobsClient.SearchByUsername(username); Returns a `OneBlink.SDK.Model.JobsSearchResult` object. -### Role Permissions Required +**Minimum Role Permission** -Jobs: `Manager` or `Read Only` +Jobs: _Read Only_ diff --git a/docs/keys-client.md b/docs/keys-client.md index a5d9e97..df18b57 100644 --- a/docs/keys-client.md +++ b/docs/keys-client.md @@ -45,6 +45,6 @@ OneBlink.SDK.Model.DeveloperKey developerKey = await keysClient.GetDeveloperKey( A `OneBlink.SDK.Model.DeveloperKey` class -### Role Permissions Required +**Minimum Role Permission** -Calendar Bookings, Integrations & Developer Keys: `Manager` or `Read Only` +Calendar Bookings, Integrations & Developer Keys: _Read Only_ diff --git a/docs/lists-client.md b/docs/lists-client.md index 759a9bb..81b2729 100644 --- a/docs/lists-client.md +++ b/docs/lists-client.md @@ -53,9 +53,9 @@ OneBlink.SDK.Model.FormElementListsSearchResult response = await formElementList A `FormElementListSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -No Permissions Required +Lists: _Read Only_ ## `Create()` @@ -84,9 +84,9 @@ OneBlink.SDK.Model.FormElementList savedFormElementList = await formElementLists A `FormElementList` class -### Role Permissions Required +**Minimum Role Permission** -Lists: `Manager` +Lists: _Manager_ ## `Update()` @@ -115,9 +115,9 @@ OneBlink.SDK.Model.FormElementList updatedFormElementList = await formElementLis A `FormElementList` class -### Role Permissions Required +**Minimum Role Permission** -Lists: `Manager` +Lists: _Manager_ ## `Delete()` @@ -144,6 +144,6 @@ await formElementListsClient.Delete(formElementListId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Lists: `Manager` +Lists: _Manager_ diff --git a/docs/lookups-client.md b/docs/lookups-client.md index 2241252..37ec646 100644 --- a/docs/lookups-client.md +++ b/docs/lookups-client.md @@ -54,9 +54,9 @@ OneBlink.SDK.Model.FormElementLookupSearchResult response = await formElementLoo A `FormElementLookupSearchResult` class -### Role Permissions Required +**Minimum Role Permission** -No Permissions Required +Lookups: _Read Only_ ## `Get()` @@ -85,9 +85,9 @@ OneBlink.SDK.Model.FormElementLookup formElementLookup = await formElementLookup A `FormElementLookup` class -### Role Permissions Required +**Minimum Role Permission** -Lookups: `Manager` or `Read Only` +Lookups: _Read Only_ ## `Create()` @@ -116,9 +116,9 @@ OneBlink.SDK.Model.FormElementLookup savedFormElementLookup = await formElementL A `FormElementLookup` class -### Role Permissions Required +**Minimum Role Permission** -Lookups: `Manager` +Lookups: _Manager_ ## `Update()` @@ -147,9 +147,9 @@ OneBlink.SDK.Model.FormElementLookup updatedFormElementLookup = await formElemen A `FormElementLookup` class -### Role Permissions Required +**Minimum Role Permission** -Lookups: `Manager` +Lookups: _Manager_ ## `Delete()` @@ -176,6 +176,6 @@ await formElementLookupsClient.Delete(formElementLookupId); No return value (`void`) -### Role Permissions Required +**Minimum Role Permission** -Lookups: `Manager` +Lookups: _Manager_ diff --git a/docs/models/Form.md b/docs/models/Form.md index ea51968..2bba9d2 100644 --- a/docs/models/Form.md +++ b/docs/models/Form.md @@ -36,7 +36,7 @@ | `continueWithAutosave` | No | `boolean` | Whether or not viewing the form should auto-continue with autosave data when available rather than prompting the user title | `false` | | `customCssClasses` | No | `List` | Custom CSS classes that will be added to the form during rendering | `new List()` | | `pointAddressEnvironmentId` | No | `Guid?` | Optional except when `elements` contains a Point Address element | `null` | -| `allowGeoscapeAddresses` | No | `bool?` | Optional configiration to allow use of Geoscape elements on the form | `null` | +| `allowGeoscapeAddresses` | No | `bool?` | Optional configuration to allow use of Geoscape elements on the form | `null` | ### Other properties diff --git a/docs/organisations-client.md b/docs/organisations-client.md index 5fd5c3e..e909523 100644 --- a/docs/organisations-client.md +++ b/docs/organisations-client.md @@ -2,7 +2,8 @@ ## Instance Functions -- [`UploadAsset()`](#getformsubmission) +- [`UploadAsset()`](#uploadasset) +- [`GetOrganisation()`](#getorganisation) ## Constructor @@ -51,6 +52,26 @@ using (FileStream stream = new FileStream("contents.txt", FileMode.Open)) A `string` with the public url to the asset -### Role Permissions Required +## `GetOrganisation()` -No Permissions Required +### Example + +```c# +string organisationId = "abcdefghijklmn1234567890"; +Organisation organisation = organisationsClient.GetOrganisation(organisationId) +``` + +### Parameters + +| Parameter | Required | Type | Description | +| ---------------- | -------- | -------- | -------------------------- | +| `organisationId` | Yes | `string` | The id of the Organisation | + +### Throws + +- `OneBlinkAPIException` +- `Exception` + +### Result + +An `Organisation` class diff --git a/docs/pdf-client.md b/docs/pdf-client.md index 01c35d8..b21554a 100644 --- a/docs/pdf-client.md +++ b/docs/pdf-client.md @@ -59,9 +59,9 @@ Stream response = await pdfClient.GetSubmissionPdf(formId, submissionId); A `Stream` object -### Role Permissions Required +**Minimum Role Permission** -PDF Generation: `On` +PDF Generation: _On_ ## `GeneratePdf()` @@ -91,9 +91,9 @@ Stream response = await pdfClient.GeneratePdf(pdfOptionsRequest); A `Stream` object -### Role Permissions Required +**Minimum Role Permission** -PDF Generation: `On` +PDF Generation: _On_ ## `GeneratePdfFromSubmissionData()` @@ -126,6 +126,6 @@ Stream response = await pdfClient.GeneratePdfFromSubmissionData Date: Thu, 25 Jul 2024 15:46:19 +1000 Subject: [PATCH 6/6] ON-41972 # Forgot to update certain permissions --- docs/forms-client.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/forms-client.md b/docs/forms-client.md index 910dd8c..d89d90b 100644 --- a/docs/forms-client.md +++ b/docs/forms-client.md @@ -479,9 +479,9 @@ FormUrlResult result = await formsClient.GenerateFormUrl( A `OneBlink.SDK.Model.FormUrlResult` class -**Minimum Role Permission** (only if using `preFillData`) +**Minimum Role Permission** -Forms: _Manager_ +Upload Form Prefill Data: _Manager_ (only if using `preFillData`) **App Association Required**