freeclimb 4.4.1 → 4.4.3

data/openapi.json

@@ -166,7 +166,6 @@
           "RECOGNITION"
         ],
         "x-enum": true
-
       },
       "GrammarFileBuiltIn": {
         "type": "string",
@@ -431,6 +430,7 @@
           "commands": {
             "type": "array",
             "description": "A JSON array of PerCL commands",
+            "x-is-list": true,
             "items": {
               "$ref": "#/components/schemas/PerclCommand"
             }
@@ -506,7 +506,7 @@
               },
               "callId": {
                 "description": "ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one.",
-                "type": "boolean"
+                "type": "string"
               },
               "leaveConferenceUrl": {
                 "description": "URL to be invoked when the Participant leaves the Conference. ",
@@ -537,7 +537,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "type": "object",
@@ -545,7 +546,8 @@
             "properties": {
               "actionUrl": {
                 "description": " This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. ",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "alias": {
                 "description": "Descriptive name for the Conference. ",
@@ -588,7 +590,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "type": "object",
@@ -596,11 +599,13 @@
             "properties": {
               "actionUrl": {
                 "description": "A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "notificationUrl": {
                 "description": "URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "queueId": {
                 "description": "ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters.",
@@ -619,7 +624,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "type": "object",
@@ -627,7 +633,8 @@
             "properties": {
               "actionUrl": {
                 "description": "When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "digitTimeoutMs": {
                 "description": " Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered.",
@@ -656,6 +663,7 @@
               "prompts": {
                 "description": "JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller.",
                 "type": "array",
+                "x-is-list": true,
                 "items": {
                   "$ref": "#/components/schemas/PerclCommand"
                 }
@@ -682,7 +690,8 @@
               "actionUrl": {
                 "description": "When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.",
                 "type": "string",
-                "format": "uri"
+                "format": "uri",
+                "x-is-uri": true
               },
               "grammarType": {
                 "$ref": "#/components/schemas/GrammarType"
@@ -704,7 +713,8 @@
                 "type": "array",
                 "items": {
                   "$ref": "#/components/schemas/PerclCommand"
-                }
+                },
+                "x-is-list": true
               },
               "noInputTimeoutMs": {
                 "description": "When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation.",
@@ -761,7 +771,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "required": [
@@ -774,11 +785,13 @@
             "properties": {
               "actionUrl": {
                 "description": "URL to which FreeClimb sends an HTTP POST request. ",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "callConnectUrl": {
                 "description": "URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "callingNumber": {
                 "description": "he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb.",
@@ -820,7 +833,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "type": "object",
@@ -828,11 +842,13 @@
             "properties": {
               "waitUrl": {
                 "description": "Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "actionUrl": {
                 "description": "A request is made to this URL when the Call is resumed, which can occur if the Call is resumed via the Unpark command, the REST API (POST to Call resource), or the caller hangs up. The PerCL script returned in response to the actionUrl will be executed on the resumed call.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "notificationUrl": {
                 "description": "URL to be invoked when the Call is parked. The request to the URL contains the standard request parameters.",
@@ -916,7 +932,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "required": ["actionUrl"],
@@ -924,7 +941,8 @@
             "properties": {
               "actionUrl": {
                 "description": "URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               },
               "silenceTimeoutMs": {
                 "description": "Interval of silence that should elapse before ending the recording.",
@@ -959,7 +977,8 @@
         "x-percl-command": true,
         "allOf": [
           {
-            "$ref": "#/components/schemas/PerclCommand"
+            "$ref": "#/components/schemas/PerclCommand",
+            "x-is-uri": true
           },
           {
             "required": ["actionUrl"],
@@ -967,7 +986,8 @@
             "properties": {
               "actionUrl": {
                 "description": "URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call.",
-                "type": "string"
+                "type": "string",
+                "x-is-uri": true
               }
             }
           }
@@ -1454,7 +1474,8 @@
                 "items": {
                   "$ref": "#/components/schemas/ApplicationResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1513,7 +1534,8 @@
                 "items": {
                   "$ref": "#/components/schemas/AvailableNumber"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1528,7 +1550,7 @@
             "type": "object",
             "properties": {
               "capabilities": {
-                "$ref": "#/components/schemas/Capabilities"              
+                "$ref": "#/components/schemas/Capabilities"
               },
               "campaignId": {
                 "type": "string",
@@ -1622,7 +1644,8 @@
                 "items": {
                   "$ref": "#/components/schemas/IncomingNumberResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1797,7 +1820,8 @@
                 "items": {
                   "$ref": "#/components/schemas/CallResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1853,7 +1877,8 @@
                 "items": {
                   "$ref": "#/components/schemas/RecordingResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1910,7 +1935,8 @@
                 "items": {
                   "$ref": "#/components/schemas/LogResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -1989,7 +2015,8 @@
                 "items": {
                   "$ref": "#/components/schemas/MessageResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2041,7 +2068,8 @@
                 "items": {
                   "$ref": "#/components/schemas/ConferenceResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2092,6 +2120,21 @@
                 "type": "string",
                 "description": "URL invoked when message sent",
                 "nullable": true
+              },
+              "brandId": {
+                "type": "string",
+                "description": "The unique identifier for the brand associated with the message",
+                "nullable": true
+              },
+              "campaignId": {
+                "type": "string",
+                "description": "The unique identifier for the campaign associated with the message",
+                "nullable": true
+              },
+              "segmentCount": {
+                "type": "number",
+                "description": "The number of segments into which the message was split",
+                "nullable": true
               }
             }
           }
@@ -2204,7 +2247,8 @@
                 "items": {
                   "$ref": "#/components/schemas/ConferenceParticipantResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2285,7 +2329,8 @@
                 "items": {
                   "$ref": "#/components/schemas/QueueResult"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2334,7 +2379,8 @@
                 "items": {
                   "$ref": "#/components/schemas/QueueMember"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2363,7 +2409,8 @@
                 "items": {
                   "$ref": "#/components/schemas/SMSTenDLCCampaign"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
@@ -2405,10 +2452,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
-            "enum": [
-              "ACTIVE",
-              "EXPIRED"
-            ],
+            "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
           "createDate": {
@@ -2441,6 +2485,7 @@
           },
           "subUsecases": {
             "uniqueItems": true,
+            "x-is-set": true,
             "type": "array",
             "description": "Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases",
             "items": {
@@ -2448,7 +2493,7 @@
               "description": "Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases"
             }
           },
-            "description": {
+          "description": {
             "maxLength": 4096,
             "type": "string",
             "description": "Summary description of this campaign."
@@ -2553,8 +2598,7 @@
             "x-is-date": true,
             "example": "2000-01-01"
           }
-        }
-        ,
+        },
         "example": {
           "campaignId": "CX56XX4",
           "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
@@ -2602,19 +2646,15 @@
                 "items": {
                   "$ref": "#/components/schemas/SMSTenDLCPartnerCampaign"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
         ]
       },
       "SMSTenDLCPartnerCampaign": {
-        "required": [
-          "brandId",
-          "campaignId",
-          "description",
-          "usecase"
-        ],
+        "required": ["brandId", "campaignId", "description", "usecase"],
         "type": "object",
         "properties": {
           "accountId": {
@@ -2630,10 +2670,7 @@
             "type": "string",
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
-            "enum": [
-              "ACTIVE",
-              "EXPIRED"
-            ],
+            "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
           "createDate": {
@@ -2813,11 +2850,8 @@
           }
         }
       },
-      "SMSTenDLCPartnerCampaignBrand":{
-        "required": [
-          "email",
-          "phone"
-        ],
+      "SMSTenDLCPartnerCampaignBrand": {
+        "required": ["email", "phone"],
         "type": "object",
         "x-is-object": true,
         "properties": {
@@ -2873,6 +2907,7 @@
             "example": "http://www.abcmobile.com"
           },
           "optionalAttributes": {
+            "x-is-map": true,
             "type": "object",
             "x-is-hash": true,
             "additionalProperties": {
@@ -2900,13 +2935,14 @@
                 "items": {
                   "$ref": "#/components/schemas/SMSTenDLCBrand"
                 },
-                "nullable": true
+                "nullable": true,
+                "x-is-list": true
               }
             }
           }
         ]
       },
-      "SMSTenDLCBrand":{
+      "SMSTenDLCBrand": {
         "required": [
           "brandRelationship",
           "country",
@@ -2937,12 +2973,13 @@
               "GOVERNMENT",
               "SOLE_PROPRIETOR"
             ],
-            "x-enum-varnames": ["PRIVATE_PROFIT",
+            "x-enum-varnames": [
+              "PRIVATE_PROFIT",
               "PUBLIC_PROFIT",
               "NON_PROFIT",
               "GOVERNMENT",
               "SOLE_PROPRIETOR"
-          ]
+            ]
           },
           "cspId": {
             "type": "string",
@@ -3148,18 +3185,8 @@
           "altBusinessIdType": {
             "type": "string",
             "x-has-writer": true,
-            "enum": [
-              "NONE",
-              "DUNS",
-              "GIIN",
-              "LEI"
-            ],
-            "x-enum-varnames": [
-              "NONE",
-              "DUNS",
-              "GIIN",
-              "LEI"
-            ],
+            "enum": ["NONE", "DUNS", "GIIN", "LEI"],
+            "x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
             "description": "The type of the Alternative business identifier"
           },
           "universalEin": {
@@ -3173,6 +3200,7 @@
             "description": "Caller supplied brand reference ID. If supplied, the value must be unique across all submitted brands. Can be used to prevent duplicate brand registrations."
           },
           "optionalAttributes": {
+            "x-is-map": true,
             "type": "object",
             "x-is-hash": true,
             "additionalProperties": {
@@ -5076,6 +5104,33 @@
             "schema": {
               "$ref": "#/components/schemas/MessageDirection"
             }
+          },
+          {
+            "name": "campaignId",
+            "in": "query",
+            "description": "Only show messages associated with this campaign ID.",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "brandId",
+            "in": "query",
+            "description": "Only show messages associated with this brand ID",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "is10DLC",
+            "in": "query",
+            "description": "Only show messages that were sent as part of a 10DLC campaign.",
+            "required": false,
+            "schema": {
+              "type": "boolean"
+            }
           }
         ],
         "responses": {

data/spec/models/account_request_spec.rb

@@ -70,6 +70,15 @@ describe Freeclimb::AccountRequest do
       )
       expect(instance.valid?).to eq(true)
     end
+    it 'checks if properties are invalid' do
+      instance = Freeclimb::AccountRequest.new(
+      )
+      expect(instance.valid?).to eq(false)
+    end
+    it 'checks if model is empty' do
+      instance = Freeclimb::AccountRequest.new()
+      expect(instance.valid?).to eq(false)
+    end
   end
 
   describe 'test method "eql?"' do

data/spec/models/account_result_spec.rb

@@ -182,6 +182,15 @@ describe Freeclimb::AccountResult do
       )
       expect(instance.valid?).to eq(true)
     end
+    it 'checks if properties are invalid' do
+      instance = Freeclimb::AccountResult.new(
+      )
+      expect(instance.valid?).to eq(false)
+    end
+    it 'checks if model is empty' do
+      instance = Freeclimb::AccountResult.new()
+      expect(instance.valid?).to eq(false)
+    end
   end
 
   describe 'test method "eql?"' do