From f963b81f694575b0e8ac08b9e2c728a648285f1a Mon Sep 17 00:00:00 2001 From: Kyle Seifert Date: Wed, 27 Jul 2022 17:12:22 -0600 Subject: [PATCH 1/2] change IVR to ivr when used as a key, for snake_case consistency We feel that it's important to keep our casing very consistent. Having IVR as `ivr` when referenced in a block config for channel-specific config is more consistent with our preference for `snake_case`. --- layers/2-mobile-primitives.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/layers/2-mobile-primitives.md b/layers/2-mobile-primitives.md index ff78707..792728f 100644 --- a/layers/2-mobile-primitives.md +++ b/layers/2-mobile-primitives.md @@ -544,7 +544,7 @@ This block writes the numeric value received to the output variable correspondin "prompt": "986a0f39-bfdf-4aa0-9fe2-28c90f422e1f", "validation_minimum": 0, "validation_maximum": 120, - "IVR": { + "ivr": { "max_digits": 3 } } @@ -598,7 +598,7 @@ For `TEXT`, `OFFLINE`, and `RICH_MESSAGING` modes that capture a text response, "exits": [...], "config": { "prompt": "b969cd54-c894-4f5a-891e-f1b24e32982b", - "IVR": { + "ivr": { "max_duration_seconds": 120, "end_recording_digits": "1234567890#*" } From b1ecf44865b1e1e25c545e9733deaf0d36fa6872 Mon Sep 17 00:00:00 2001 From: Kyle Seifert Date: Wed, 27 Jul 2022 17:18:14 -0600 Subject: [PATCH 2/2] switch IVR to ivr in block config descriptions --- layers/2-mobile-primitives.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/layers/2-mobile-primitives.md b/layers/2-mobile-primitives.md index 792728f..16f47ba 100644 --- a/layers/2-mobile-primitives.md +++ b/layers/2-mobile-primitives.md @@ -96,8 +96,8 @@ These tests apply to non-IVR flows. There may be multiple tests per choice: any | Key | Description | | :--- | :--- | -| `IVR`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. | -| `IVR`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. | +| `ivr`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. | +| `ivr`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. | ### Detailed behaviour by mode @@ -374,8 +374,8 @@ These tests apply to non-IVR flows. There may be multiple tests per choice: any | Key | Description | | :--- | :--- | -| `IVR`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. | -| `IVR`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. | +| `ivr`: `digit_prompts` \(array of resources\) | An ordered set of audio prompts, with the same length as `choices`, with content such as "Press 1", "Press 2", "Press 3". This is required when using `question_prompt` to present choices individually. | +| `ivr`: `randomize_choice_order` \(boolean, optional\) | Indicates that the choices should be presented in a random order to each Contact. (Used to minimize response order bias in surveying). Default false. Requires the use of `question_prompt`, `choices_prompt`, and `IVR.digit_prompts` to present choices individually. | ### Detailed behaviour by mode @@ -515,7 +515,7 @@ This block obtains a numeric response from the contact. | Key | Description | | :--- | :--- | -| `IVR`: `max_digits` \(number\) | After receiving this many digits, do not wait for any more; accept the digits entered so far as the complete response. | +| `ivr`: `max_digits` \(number\) | After receiving this many digits, do not wait for any more; accept the digits entered so far as the complete response. | This block can be configured to have a single exit, or a number of exits with possibilities based on the range of the numeric response given. The exit specification is as described in [Block `exits`](../flows.md#blocks). @@ -571,8 +571,8 @@ This block can be configured to have a single exit, or a number of exits with po | Key | Description | | :--- | :--- | -| `IVR`: `max_duration_seconds` \(number\) | The maximum duration to record for, before proceeding to the next block. | -| `IVR`: `end_recording_digits` \(string, optional\) | A set of key-press digits that terminate an open-ended recording, e.g.: "1789#" | +| `ivr`: `max_duration_seconds` \(number\) | The maximum duration to record for, before proceeding to the next block. | +| `ivr`: `end_recording_digits` \(string, optional\) | A set of key-press digits that terminate an open-ended recording, e.g.: "1789#" | ### Detailed behaviour by mode