Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ON-39507 # Added includeCalendarBookingInPdf to FormSubmissionEventConfiguration #308

Merged
merged 2 commits into from
May 2, 2024
Merged

ON-39507 # Added includeCalendarBookingInPdf to FormSubmissionEventConfiguration #308

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68cae4b
ON-39507 # Added `includeCalendarBookingInPdf` to `FormSubmissionEven…
jdawg093 May 2, 2024
b5127d2
ON-39507 # Added to end of function params
jdawg093 May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Added

- `includeCalendarBookingInPdf` to `FormSubmissionEventConfiguration`

## [5.6.2] - 2024-04-30

### Changed
Expand Down
2 changes: 2 additions & 0 deletions OneBlink.SDK/PdfClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public async Task<Stream> GetSubmissionPdf(long formId,
List<Guid> excludedElementIds = null,
bool? usePagesAsBreaks = null,
bool? includePaymentInPdf = null,
bool? includeCalendarBookingInPdf = null,
List<string> excludedCSSClasses = null,
bool? includeExternalIdInPdf = null,
string pdfSize = "A4")
Expand All @@ -36,6 +37,7 @@ public async Task<Stream> GetSubmissionPdf(long formId,
isDraft = isDraft,
includeSubmissionIdInPdf = includeSubmissionIdInPdf,
includePaymentInPdf = includePaymentInPdf,
includeCalendarBookingInPdf = includeCalendarBookingInPdf,
excludedCSSClasses = excludedCSSClasses,
includeExternalIdInPdf = includeExternalIdInPdf,
pdfSize = pdfSize
Expand Down
8 changes: 8 additions & 0 deletions OneBlink.SDK/models/FormSubmissionEvent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public static FormSubmissionEvent CreateTrimSubmissionEvent(Guid environmentId,
string pdfFileName = null,
bool? includeSubmissionIdInPdf = null,
bool? includePaymentInPdf = null,
bool? includeCalendarBookingInPdf = null,
mymattcarroll marked this conversation as resolved.
Show resolved Hide resolved
string label = null,
List<string> excludedCSSClasses = default(List<string>),
bool? includeExternalIdInPdf = null,
Expand All @@ -114,6 +115,7 @@ public static FormSubmissionEvent CreateTrimSubmissionEvent(Guid environmentId,
fseconfig.pdfFileName = pdfFileName;
fseconfig.includeSubmissionIdInPdf = includeSubmissionIdInPdf;
fseconfig.includePaymentInPdf = includePaymentInPdf;
fseconfig.includeCalendarBookingInPdf = includeCalendarBookingInPdf;
if (excludedCSSClasses != default(List<string>))
{
fseconfig.excludedCSSClasses = excludedCSSClasses;
Expand Down Expand Up @@ -158,6 +160,7 @@ public static FormSubmissionEvent CreateCivicaCrmSubmissionEvent(
bool conditionallyExecute = false,
bool requiresAllConditionallyExecutePredicates = false,
Boolean? includePaymentInPdf = null,
bool? includeCalendarBookingInPdf = null,
string label = null,
List<string> excludedCSSClasses = default(List<string>),
Boolean? includeExternalIdInPdf = null,
Expand All @@ -171,6 +174,7 @@ public static FormSubmissionEvent CreateCivicaCrmSubmissionEvent(
fseconfig.pdfFileName = pdfFileName;
fseconfig.includeSubmissionIdInPdf = includeSubmissionIdInPdf;
fseconfig.includePaymentInPdf = includePaymentInPdf;
fseconfig.includeCalendarBookingInPdf = includeCalendarBookingInPdf;
if (excludedElementIds != default(List<string>))
{
fseconfig.excludedElementIds = excludedElementIds;
Expand Down Expand Up @@ -230,6 +234,7 @@ public static FormSubmissionEvent CreatePDFSubmissionEvent(
bool conditionallyExecute = false,
bool requiresAllConditionallyExecutePredicates = false,
bool? includePaymentInPdf = null,
bool? includeCalendarBookingInPdf = null,
string label = null,
List<string> toEmail = default(List<string>),
List<string> ccEmail = default(List<string>),
Expand All @@ -245,6 +250,7 @@ public static FormSubmissionEvent CreatePDFSubmissionEvent(
fseconfig.pdfFileName = pdfFileName;
fseconfig.includeSubmissionIdInPdf = includeSubmissionIdInPdf;
fseconfig.includePaymentInPdf = includePaymentInPdf;
fseconfig.includeCalendarBookingInPdf = includeCalendarBookingInPdf;
fseconfig.excludedElementIds = excludedElementIds;
fseconfig.usePagesAsBreaks = usePagesAsBreaks;
fseconfig.emailTemplate = emailTemplate;
Expand Down Expand Up @@ -288,6 +294,7 @@ public static FormSubmissionEvent CreatePDFSubmissionEvent(
bool conditionallyExecute = false,
bool requiresAllConditionallyExecutePredicates = false,
bool? includePaymentInPdf = null,
bool? includeCalendarBookingInPdf = null,
string label = null,
List<string> toEmail = default(List<string>),
List<string> ccEmail = default(List<string>),
Expand All @@ -303,6 +310,7 @@ public static FormSubmissionEvent CreatePDFSubmissionEvent(
fseconfig.pdfFileName = pdfFileName;
fseconfig.includeSubmissionIdInPdf = includeSubmissionIdInPdf;
fseconfig.includePaymentInPdf = includePaymentInPdf;
fseconfig.includeCalendarBookingInPdf = includeCalendarBookingInPdf;
if (excludedElementIds != default(List<string>))
{
fseconfig.excludedElementIds = excludedElementIds;
Expand Down
4 changes: 4 additions & 0 deletions OneBlink.SDK/models/GetSubmissionPdfRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ public bool? includePaymentInPdf
{
get; set;
}
public bool? includeCalendarBookingInPdf
{
get; set;
}
public List<string> excludedCSSClasses
{
get; set;
Expand Down
4 changes: 4 additions & 0 deletions OneBlink.SDK/models/PDFConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ public Boolean? includePaymentInPdf
{
get; set;
}
public bool? includeCalendarBookingInPdf
{
get; set;
}
public List<string> excludedElementIds
{
get; set;
Expand Down
24 changes: 13 additions & 11 deletions docs/pdf-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,19 @@ Stream response = await pdfClient.GetSubmissionPdf(formId, submissionId);

### Parameters

| Parameter | Required | Type | Description |
| -------------------------- | -------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `formId` | Yes | `long` | The exact id of the form you wish to get submission PDF for |
| `submissionId` | Yes | `string` | The submission identifier generated after a successful form submission, this will be return to you after a successful forms submission via a callback URL |
| `isDraft` | No | `bool?` | `true` if the submission is a draft submission, otherwise `false` |
| `includeSubmissionIdInPdf` | No | `bool?` | `true` to include the submission identifier in the PDF, otherwise `false` |
| `excludedElementIds` | No | `List<string>` | Optional list of element id's to be excluded from the pdf document |
| `usePagesAsBreaks` | No | `bool?` | `true` to use Pages as page breaks in the PDF, otherwise `false` |
| `excludedCSSClasses` | No | `List<string>` | Optional list of CSS Classes to be excluded from the pdf document |
| `includeExternalIdInPdf` | No | `bool?` | `true` to include the external submission identifier in the PDF, otherwise `false` |
| `pdfSize` | No | `string` | Sets the size of the PDF. Options are `Letter` and `A4`. |
| Parameter | Required | Type | Description |
| ----------------------------- | -------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `formId` | Yes | `long` | The exact id of the form you wish to get submission PDF for |
| `submissionId` | Yes | `string` | The submission identifier generated after a successful form submission, this will be return to you after a successful forms submission via a callback URL |
| `isDraft` | No | `bool?` | `true` if the submission is a draft submission, otherwise `false` |
| `includeSubmissionIdInPdf` | No | `bool?` | `true` to include the submission identifier in the PDF, otherwise `false` |
| `includePaymentInPdf` | No | `bool?` | `true` to include the payment details in the PDF, otherwise `false` |
| `includeCalendarBookingInPdf` | No | `bool?` | `true` to include the calendar booking details in the PDF, otherwise `false` |
| `excludedElementIds` | No | `List<string>` | Optional list of element id's to be excluded from the pdf document |
| `usePagesAsBreaks` | No | `bool?` | `true` to use Pages as page breaks in the PDF, otherwise `false` |
| `excludedCSSClasses` | No | `List<string>` | Optional list of CSS Classes to be excluded from the pdf document |
| `includeExternalIdInPdf` | No | `bool?` | `true` to include the external submission identifier in the PDF, otherwise `false` |
| `pdfSize` | No | `string` | Sets the size of the PDF. Options are `Letter` and `A4`. |

### Throws

Expand Down
Loading