freeclimb 4.6.1 → 4.7.0

data/openapi.json

@@ -480,8 +480,19 @@
         }
       },
       "AddToConference": {
-        "description": "The `AddToConference` command adds a Participant to a Conference. If this Participant currently is in another Conference, the Participant is first removed from that Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.",
+        "description": "The `AddToConference` command adds a Participant to a Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "false",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "false",
+          "\"TEST_STRING\"",
+          "false",
+          "false"
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -533,6 +544,15 @@
       "CreateConference": {
         "description": "The `CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants). Once created, a Conference remains in FreeClimb until explicitly terminated by a customer. Once a Conference has been terminated, it can no longer be used.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "false",
+          "PlayBeep.ALWAYS",
+          "false",
+          "\"https://a.com\"",
+          "\"https://a.com\"",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -585,6 +605,13 @@
       "Enqueue": {
         "description": "The `Enqueue` command adds the current Call to a call Queue. If the specified Queue does not exist, it is created and then the Call is added to it. The default maximum length of the queue is 100. This can be modified using the REST API.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -619,6 +646,18 @@
       "GetDigits": {
         "description": "The `GetDigits` command collects DTMF inputs from the caller. It is only supported only when there is a single party on the Call. `GetDigits` is a Terminal Command — any actions following it are never executed. When the Caller is done entering the digits, FreeClimb submits that data to the provided `actionUrl` using an HTTP POST request. Your server will be required to respond to the FreeClimb Webhook with PerCL to continue handling the call.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"https://a.com\"",
+          "1",
+          "\"TEST_STRING\"",
+          "false",
+          "300",
+          "1",
+          "1",
+          "new List<PerclCommand>()",
+          "false",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -676,6 +715,22 @@
       "GetSpeech": {
         "description": "The `GetSpeech` command enables the Caller to respond to the application using a supported language. Unlike DTMF entry, which implicitly restricts the user to using the available buttons on the phone key pad, speech input allows for flexible audio inputs based on grammar. FreeClimb supports grammars written using GRXML compatible with the Microsoft Speech Platform. `GetSpeech` is only supported on a single call leg. It is not supported when there are two or more call legs connected (as in within a Conference).",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"https://a.com\"",
+          "GrammarType.URL",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "false",
+          "new List<PerclCommand>()",
+          "1",
+          "1",
+          "1",
+          "1",
+          "1",
+          "1",
+          "false",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -767,6 +822,19 @@
       "OutDial": {
         "description": "The OutDial command is used to call a phone number",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"https://a.com\"",
+          "\"https://a.com\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "IfMachine.REDIRECT",
+          "\"https://a.com\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "1",
+          "false",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -829,6 +897,12 @@
       "Park": {
         "description": "The `Park` command allows a caller to be put on hold.  You can provide hold music,messages,etc until ready to resume the call. Park is a terminal command.  Actions performed on the Call while on hold are provided in a PerCL script in response to the waitUrl property. Actions performed on the Call after it has been unparked (resumed) will be provided in a PerCL script in response to the actionUrl provided. A Call can be resumed in two ways -- REST API invocation or the Unpark percl command. No actions can be nested within Park and Park cannot be nested in any other actions. ",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"https://a.com\"",
+          "\"https://a.com\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -859,6 +933,7 @@
       "Pause": {
         "description": "The `Pause` command halts execution of the current PerCL script for a specified number of milliseconds. If `Pause` is the first command in a PerCL document, FreeClimb will wait for the specified time to elapse before picking up the call.",
         "x-percl-command": true,
+        "x-ref-properties": ["1"],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -878,6 +953,7 @@
       "Play": {
         "description": "The `Play` command plays an audio file back to the caller. The audio file may be located at any location accessible via a URL. `Play` can exist as a stand-alone command or as a nested command. It does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
         "x-percl-command": true,
+        "x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -905,6 +981,7 @@
       "PlayEarlyMedia": {
         "description": "`PlayEarlyMedia` is relevant only when present as the very first command in the PerCL script returned for an incoming Call. In such cases, the command is executed before FreeClimb attempts to connect the call. The audio file it uses can be stored in any location that is accessible via URL.",
         "x-percl-command": true,
+        "x-ref-properties": ["\"TEST_STRING\""],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -924,6 +1001,15 @@
       "RecordUtterance": {
         "description": "The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording. `RecordUtterance` is blocking and is a terminal command. As such, the `actionUrl` property is required, and control of the Call picks up using the PerCL returned in response to the `actionUrl`. Recording information is returned in the `actionUrl` request.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"https://a.com\"",
+          "1",
+          "\"TEST_STRING\"",
+          "1",
+          "false",
+          "false",
+          "false"
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -969,6 +1055,7 @@
       "Redirect": {
         "description": "The `Redirect` command transfers control of a Call to the PerCL at a different URL. `Redirect` is a terminal command, so any actions following it are never executed. The maximum number of redirections allowed during the life time of a Call is 256. This is intended to prevent a Call from possibly looping infinitely due to errors in PerCL being generated.",
         "x-percl-command": true,
+        "x-ref-properties": ["\"https://a.com\""],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand",
@@ -990,6 +1077,7 @@
       "Reject": {
         "description": "The `Reject` command blocks an incoming Call. Using `Reject` is the only way to prevent FreeClimb from answering a Call. Any other response will result in an answered Call and your account will be billed.",
         "x-percl-command": true,
+        "x-ref-properties": ["\"TEST_STRING\""],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1023,6 +1111,12 @@
       "Say": {
         "description": "The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller. `Say` is useful in cases where it's difficult to pre-record a prompt for any reason. `Say` does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "1",
+          "false"
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1055,6 +1149,7 @@
       "SendDigits": {
         "description": "The `SendDigits` command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions.",
         "x-percl-command": true,
+        "x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1082,6 +1177,7 @@
       "SetListen": {
         "description": "The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference. The Participant can hear what the other participants are saying only if this privilege is enabled.",
         "x-percl-command": true,
+        "x-ref-properties": ["false"],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1101,6 +1197,7 @@
       "SetTalk": {
         "description": "The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference. If 'true', no audio from that Participant is shared with the other Participants of the Conference.",
         "x-percl-command": true,
+        "x-ref-properties": ["false"],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1120,6 +1217,11 @@
       "Sms": {
         "description": "The `Sms` command can be used to send an SMS message to a phone number during a phone call. International SMS is disabled by default.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1256,6 +1358,7 @@
         "type": "object",
         "required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
         "x-is-object": true,
+        "x-ref-properties": [false, false, false, false, false],
         "properties": {
           "voice": {
             "description": "Indicates whether a number can be used for voice calls. Replaces voiceEnabled.",
@@ -1289,6 +1392,7 @@
         "type": "object",
         "required": ["campaignId"],
         "x-is-object": true,
+        "x-ref-properties": ["\"TEST_STRING\""],
         "properties": {
           "campaignId": {
             "description": "alphanumeric identifier for the TollFree campaign associated with this number",
@@ -1449,6 +1553,7 @@
         }
       },
       "ApplicationList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1509,6 +1614,7 @@
         }
       },
       "AvailableNumberList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1623,6 +1729,7 @@
         }
       },
       "IncomingNumberList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1801,6 +1908,7 @@
         }
       },
       "CallList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1858,6 +1966,7 @@
         ]
       },
       "RecordingList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1916,6 +2025,7 @@
         }
       },
       "LogList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -1995,6 +2105,7 @@
         ]
       },
       "MessagesList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2055,6 +2166,7 @@
         ]
       },
       "ConferenceList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2244,6 +2356,7 @@
         }
       },
       "ConferenceParticipantList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2326,6 +2439,7 @@
         }
       },
       "QueueList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2376,6 +2490,7 @@
         }
       },
       "QueueMemberList": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2406,6 +2521,7 @@
         }
       },
       "SMSTenDLCCampaignsListResult": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2461,6 +2577,7 @@
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
             "x-enum-type": "SMSTenDLCCampaignStatusEnum",
+            "x-enum-type-c-sharp": "StatusEnum",
             "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
@@ -2667,6 +2784,7 @@
         }
       },
       "SMSTenDLCPartnerCampaignsListResult": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -2704,6 +2822,7 @@
             "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
             "x-enum-type": "SMSTenDLCPartnerCampaignStatusEnum",
+            "x-enum-type-c-sharp": "StatusEnum",
             "enum": ["ACTIVE", "EXPIRED"],
             "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
@@ -2887,6 +3006,19 @@
         "required": ["email", "phone"],
         "type": "object",
         "x-is-object": true,
+        "x-sms-ten-dlc-partner-campaign-brand": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "\"TEST_STRING\"",
+          "new Dictionary<string, object>()",
+          "1"
+        ],
         "properties": {
           "accountId": {
             "type": "string",
@@ -2956,6 +3088,7 @@
         }
       },
       "SMSTenDLCBrandsListResult": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -3001,6 +3134,7 @@
             "x-has-writer": true,
             "description": "Entity type behind the brand. This is the form of business establishment.",
             "x-enum-type": "SMSTenDLCBrandEntityTypeEnum",
+            "x-enum-type-c-sharp": "EntityTypeEnum",
             "enum": [
               "PRIVATE_PROFIT",
               "PUBLIC_PROFIT",
@@ -3115,6 +3249,7 @@
             "description": "(Required for public company) stock exchange.",
             "example": "NASDAQ",
             "x-enum-type": "SMSTenDLCBrandStockExchangeEnum",
+            "x-enum-type-c-sharp": "StockExchangeEnum",
             "enum": [
               "NONE",
               "NASDAQ",
@@ -3190,6 +3325,7 @@
             "x-has-writer": true,
             "description": "Brand relationship to the CSP",
             "x-enum-type": "SMSTenDLCBrandBrandRelationshipEnum",
+            "x-enum-type-c-sharp": "BrandRelationshipEnum",
             "enum": [
               "BASIC_ACCOUNT",
               "SMALL_ACCOUNT",
@@ -3219,6 +3355,7 @@
             "type": "string",
             "x-has-writer": true,
             "x-enum-type": "SMSTenDLCBrandAltBusinessIdTypeEnum",
+            "x-enum-type-c-sharp": "AltBusinessIdTypeEnum",
             "enum": ["NONE", "DUNS", "GIIN", "LEI"],
             "x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
             "description": "The type of the Alternative business identifier"
@@ -3252,6 +3389,7 @@
             "x-has-writer": true,
             "description": "TCR assessment of the brand identification status.",
             "x-enum-type": "SMSTenDLCBrandIdentityStatusEnum",
+            "x-enum-type-c-sharp": "IdentityStatusEnum",
             "enum": [
               "SELF_DECLARED",
               "UNVERIFIED",
@@ -3306,6 +3444,7 @@
         }
       },
       "SMSTollFreeCampaignsListResult": {
+        "x-implements": "Pagination",
         "allOf": [
           {
             "$ref": "#/components/schemas/PaginationModel"
@@ -3355,6 +3494,7 @@
             "x-has-writer": true,
             "description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
             "x-enum-type": "SMSTollFreeCampaignRegistrationStatusEnum",
+            "x-enum-type-c-sharp": "RegistrationStatusEnum",
             "enum": [
               "UNREGISTERED",
               "INITIATED",
@@ -3388,6 +3528,15 @@
         },
         "description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
         "x-percl-command": true,
+        "x-ref-properties": [
+          "\"TEST_STRING\"",
+          "false",
+          "new TranscribeUtteranceAllOfRecord()",
+          "false",
+          "false",
+          "new List<Object>()",
+          "\"TEST_STRING\""
+        ],
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -3649,6 +3798,7 @@
         "tags": [],
         "summary": "List applications",
         "operationId": "list-applications",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "alias",
@@ -3716,6 +3866,7 @@
         "tags": [],
         "summary": "List available numbers",
         "operationId": "list-available-numbers",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "phoneNumber",
@@ -3901,6 +4052,7 @@
         "tags": [],
         "summary": "List Incoming Numbers",
         "operationId": "list-incoming-numbers",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -4182,6 +4334,7 @@
         "tags": [],
         "summary": "List Calls",
         "operationId": "list-calls",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "active",
@@ -4286,6 +4439,7 @@
         "tags": [],
         "summary": "List Call Recordings",
         "operationId": "list-call-recordings",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "dateCreated",
@@ -4329,6 +4483,7 @@
         "tags": [],
         "summary": "List Call Logs",
         "operationId": "list-call-logs",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -4361,7 +4516,6 @@
     "/Accounts/{accountId}/Calls/WebRTC/Token": {
       "post": {
         "summary": "Make a JWT for WebRTC calling",
-        "description": "Make a JWT for WebRTC calling",
         "operationId": "make-a-webrtc-jwt",
         "x-web-rtc": true,
         "parameters": [
@@ -4433,6 +4587,7 @@
         "tags": [],
         "summary": "List Conferences",
         "operationId": "list-conferences",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "status",
@@ -4691,6 +4846,7 @@
         "tags": [],
         "summary": "List Participants",
         "operationId": "list-participants",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "talk",
@@ -4743,6 +4899,7 @@
         "tags": [],
         "summary": "List Conference Recordings",
         "operationId": "list-conference-recordings",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "callId",
@@ -4871,6 +5028,7 @@
         "tags": [],
         "summary": "List Active Queues",
         "operationId": "list-active-queues",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "alias",
@@ -5004,6 +5162,7 @@
         "tags": [],
         "summary": "List Members",
         "operationId": "list-members",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5122,6 +5281,7 @@
         "tags": [],
         "summary": "List All Account Logs",
         "operationId": "list-all-account-logs",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5181,6 +5341,7 @@
         "tags": [],
         "summary": "List Recordings",
         "operationId": "list-recordings",
+        "x-is-paginated": true,
         "parameters": [
           {
             "name": "callId",
@@ -5362,6 +5523,7 @@
         "tags": [],
         "summary": "List SMS Messages",
         "operationId": "list-sms-messages",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5527,6 +5689,7 @@
         "tags": [],
         "summary": "Get list of SMS 10DLC Campaigns",
         "operationId": "get-tenDLC-sms-Campaigns",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5639,6 +5802,7 @@
         "tags": [],
         "summary": "Get list of SMS 10DLC Partner Campaigns",
         "operationId": "get-tenDLC-sms-partnerCampaigns",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5760,6 +5924,7 @@
         "tags": [],
         "summary": "Get list of SMS 10DLC Brands",
         "operationId": "get-tenDLC-sms-brands",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"
@@ -5861,6 +6026,7 @@
         "tags": [],
         "summary": "Get list of TollFree Campaigns",
         "operationId": "get-tollFree-sms-campaigns",
+        "x-is-paginated": true,
         "parameters": [
           {
             "$ref": "#/components/parameters/AccountId"