added HidePositionInLine attribute to the waiting room API (#584)

* added HidePositionInLine attribute to the waiting room API

* #WR-866 - updated the hide position in line description

* #WR-866 - updated the hide position in line description in documentation.

Author: AvishPel

incapsula/client_waiting_room.go

@@ -32,6 +32,7 @@ type WaitingRoomDTO struct {
 	Mode                    string            `json:"mode,omitempty"`
 	BotsActionInQueuingMode string            `json:"botsActionInQueuingMode,omitempty"`
 	QueueInactivityTimeout  int               `json:"queueInactivityTimeout,omitempty"`
+	HidePositionInLine      bool              `json:"hidePositionInLine"`
 	ThresholdSettings       ThresholdSettings `json:"thresholdSettings"`
 }
 

incapsula/resource_waiting_room.go

@@ -129,6 +129,12 @@ func resourceWaitingRoom() *schema.Resource {
 				Type:        schema.TypeString,
 				Computed:    true,
 			},
+			"hide_position_in_line": {
+				Description: "Enable to hide the user's position in waiting room queue.",
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+			},
 		},
 	}
 }
@@ -153,6 +159,7 @@ func resourceWaitingRoomCreate(ctx context.Context, data *schema.ResourceData, m
 		Enabled:                 data.Get("enabled").(bool),
 		BotsActionInQueuingMode: data.Get("bots_action_in_queuing_mode").(string),
 		QueueInactivityTimeout:  data.Get("queue_inactivity_timeout").(int),
+		HidePositionInLine:      data.Get("hide_position_in_line").(bool),
 		ThresholdSettings:       thresholdSettings,
 	}
 
@@ -251,6 +258,7 @@ func resourceWaitingRoomRead(ctx context.Context, data *schema.ResourceData, m i
 	data.Set("last_modified_at", strconv.FormatInt(waitingRoom.LastModifiedAt, 10))
 	data.Set("last_modified_by", waitingRoom.LastModifiedBy)
 	data.Set("mode", waitingRoom.Mode)
+	data.Set("hide_position_in_line", waitingRoom.HidePositionInLine)
 
 	return diags
 }
@@ -286,6 +294,7 @@ func resourceWaitingRoomUpdate(ctx context.Context, data *schema.ResourceData, m
 		Enabled:                 data.Get("enabled").(bool),
 		BotsActionInQueuingMode: data.Get("bots_action_in_queuing_mode").(string),
 		QueueInactivityTimeout:  data.Get("queue_inactivity_timeout").(int),
+		HidePositionInLine:      data.Get("hide_position_in_line").(bool),
 		ThresholdSettings:       thresholdSettings,
 	}
 

incapsula/resource_waiting_room_test.go

@@ -48,6 +48,7 @@ func TestAccWaitingRoom_Basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet(waitingRoomResource, "last_modified_at"),
 					resource.TestCheckResourceAttrSet(waitingRoomResource, "last_modified_by"),
 					resource.TestCheckResourceAttr(waitingRoomResource, "mode", "NOT_QUEUING"),
+					resource.TestCheckResourceAttr(waitingRoomResource, "hide_position_in_line", "false"),
 				),
 			},
 			{
@@ -75,6 +76,13 @@ func TestAccWaitingRoom_Basic(t *testing.T) {
 					resource.TestCheckResourceAttr(waitingRoomResource, "concurrent_sessions_threshold", "50"),
 				),
 			},
+			{
+				Config: testAccWaitingRoomHidePositionInLine(t),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckWaitingRoomExists(&waitingRoomDTOResponse),
+					resource.TestCheckResourceAttr(waitingRoomResource, "hide_position_in_line", "true"),
+				),
+			},
 			{
 				ResourceName:      waitingRoomResource,
 				ImportState:       true,
@@ -157,6 +165,15 @@ func testAccWaitingRoomConcurrentSessionsOnly(t *testing.T, concurrentSessions i
 	}`, waitingRoomResourceName, waitingRoomConfigName, rand.New(rand.NewSource(time.Now().UnixNano())).Intn(1000), concurrentSessions)
 }
 
+func testAccWaitingRoomHidePositionInLine(t *testing.T) string {
+	return testAccCheckIncapsulaSiteConfigBasic(GenerateTestDomain(t)) + fmt.Sprintf(`
+	resource "%s" "%s" {
+		site_id = incapsula_site.testacc-terraform-site.id
+		name = "testWaitingRoom%d"
+		hide_position_in_line = "true"
+	}`, waitingRoomResourceName, waitingRoomConfigName, rand.New(rand.NewSource(time.Now().UnixNano())).Intn(1000))
+}
+
 func testAccCheckWaitingRoomThresholds(waitingRoomDTOresponse *WaitingRoomDTO, entranceRate int, concurrentSessions int, inactivityTimeout int, queueInactivityTimeout int) resource.TestCheckFunc {
 	return func(state *terraform.State) error {
 		if entranceRate == 0 {

website/docs/r/waiting_room.html.markdown

@@ -31,6 +31,7 @@ resource "incapsula_waiting_room" "example-waiting-room" {
     concurrent_sessions_threshold = 600
     inactivity_timeout = 30
     queue_inactivity_timeout = 1
+    hide_position_in_line = true
 }
 ```
 
@@ -72,6 +73,8 @@ Possible values:
 
 * `queue_inactivity_timeout` - (Optional) Queue inactivity timeout, from 1 to 10 minutes. A user in the waiting room who is inactive for a longer period of time is considered as having left the queue. On returning to the site, the user moves to the end of the queue and needs to wait in line again if the waiting room is active. **Default:** 1 minute.
 
+* `hide_position_in_line` - (Optional) Enable to hide the user's position in waiting room queue. **Default:** false.
+
 ## Attributes Reference
 
 The following attributes are exported:
@@ -88,4 +91,4 @@ Waiting rooms can be imported using the waiting room account_id, site_id and wai
 
 ```
 $ terraform import incapsula_waiting_room.example-waiting-room account_id/site_id/waiting_room_id
-```
+```