freeclimb 4.3.0 → 4.4.1

data/openapi.json

@@ -85,6 +85,7 @@
         "type": "string",
         "enum": ["closed", "suspended", "active"],
         "x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
+        "x-enum": true,
         "description": "The status of this account. It is one of: active, suspended, or closed.",
         "nullable": true
       },
@@ -92,6 +93,7 @@
         "type": "string",
         "description": "The type of this account. It is one of: trial or full.",
         "enum": ["trial", "full"],
+        "x-enum": true,
         "x-enum-varnames": ["TRIAL", "FULL"],
         "nullable": true
       },
@@ -100,6 +102,7 @@
         "nullable": true,
         "enum": ["human", "machine"],
         "x-enum-varnames": ["HUMAN", "MACHINE"],
+        "x-enum": true,
         "description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
       },
       "CallDirection": {
@@ -107,6 +110,7 @@
         "nullable": true,
         "enum": ["inbound", "outboundAPI", "outboundDial"],
         "x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
+        "x-enum": true,
         "description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API,  `outboundDial` for Calls initiated by the `OutDial` PerCL command."
       },
       "CallStatus": {
@@ -132,6 +136,7 @@
           "BUSY",
           "NO_ANSWER"
         ],
+        "x-enum": true,
         "description": "* `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered."
       },
       "ConferenceStatus": {
@@ -139,6 +144,7 @@
         "nullable": true,
         "enum": ["empty", "populated", "inProgress", "terminated"],
         "x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
+        "x-enum": true,
         "description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
       },
       "GetSpeechReason": {
@@ -158,7 +164,9 @@
           "NO_INPUT",
           "NO_MATCH",
           "RECOGNITION"
-        ]
+        ],
+        "x-enum": true
+
       },
       "GrammarFileBuiltIn": {
         "type": "string",
@@ -195,19 +203,22 @@
           "DIG11",
           "UP_TO_20_DIGIT_SEQUENCE",
           "VERSAY_YESNO"
-        ]
+        ],
+        "x-enum": true
       },
       "GrammarType": {
         "type": "string",
         "enum": ["URL", "BUILTIN"],
         "nullable": true,
         "x-enum-varnames": ["URL", "BUILT_IN"],
+        "x-enum": true,
         "description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
       },
       "IfMachine": {
         "type": "string",
         "enum": ["redirect", "hangup"],
         "x-enum-varnames": ["REDIRECT", "HANGUP"],
+        "x-enum": true,
         "description": "Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked."
       },
       "Language": {
@@ -267,24 +278,28 @@
           "CHINESE_CN",
           "CHINESE_HK",
           "CHINESE_TW"
-        ]
+        ],
+        "x-enum": true
       },
       "LogLevel": {
         "type": "string",
         "enum": ["info", "warning", "error"],
         "nullable": true,
         "x-enum-varnames": ["INFO", "WARNING", "ERROR"],
+        "x-enum": true,
         "description": "Level of the log. Possible values are info, warning, and error."
       },
       "MachineType": {
         "type": "string",
         "enum": ["answeringMachine", "faxMachine"],
-        "x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"]
+        "x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"],
+        "x-enum": true
       },
       "MessageDirection": {
         "type": "string",
         "enum": ["inbound", "outbound"],
-        "x-enum-varnames": ["INBOUND", "OUTBOUND"]
+        "x-enum-varnames": ["INBOUND", "OUTBOUND"],
+        "x-enum": true
       },
       "MessageStatus": {
         "type": "string",
@@ -315,13 +330,15 @@
           "EXPIRED",
           "DELETED",
           "UNKNOWN"
-        ]
+        ],
+        "x-enum": true
       },
       "PlayBeep": {
         "type": "string",
         "nullable": true,
         "enum": ["always", "never", "entryOnly", "exitOnly"],
         "x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
+        "x-enum": true,
         "description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
         "default": "always",
         "x-enum-default-attr": "ALWAYS"
@@ -329,12 +346,14 @@
       "QueueResultStatus": {
         "type": "string",
         "enum": ["queueFull", "dequeued", "hangup", "systemError"],
-        "x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"]
+        "x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"],
+        "x-enum": true
       },
       "RecordUtteranceTermReason": {
         "type": "string",
         "enum": ["finishKey", "timeout", "hangup", "maxLength"],
-        "x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"]
+        "x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"],
+        "x-enum": true
       },
       "RequestType": {
         "type": "string",
@@ -387,18 +406,21 @@
           "CONFERENCE_CALL_CONTROL",
           "MESSAGE_DELIVERY",
           "MESSAGE_STATUS"
-        ]
+        ],
+        "x-enum": true
       },
       "UpdateCallRequestStatus": {
         "type": "string",
         "enum": ["canceled", "completed"],
         "x-enum-varnames": ["CANCELED", "COMPLETED"],
+        "x-enum": true,
         "description": "Either `canceled` or `completed`.  Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress."
       },
       "UpdateConferenceRequestStatus": {
         "type": "string",
         "enum": ["empty", "terminated"],
         "x-enum-varnames": ["EMPTY", "TERMINATED"],
+        "x-enum": true,
         "description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
       },
       "PerclScript": {
@@ -551,6 +573,7 @@
       "Dequeue": {
         "description": "The `Dequeue` command transfers control of a Call that is in a Queue so that the waiting caller exits the Queue. Execution continues with the first command in the PerCL script returned by the `actionUrl` specified in the `Enqueue` command.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1130,6 +1153,7 @@
       "StartRecordCall": {
         "description": "The `StartRecordCall` command records the current call and returns the URL of a file containing the audio recording when recording completes. `StartRecordCall` is non-blocking. After recording of the current call begins, control of the call moves to the PerCL command that follows `StartRecordCall` in the current PerCL script.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1161,6 +1185,7 @@
       "Unpark": {
         "description": "The `Unpark` command resumes a parked call.  Execution continues with the first command in the PerCL scripted returned by the actionUrl specified in the Park command as long as the call is still in progress.  If the call is no longer in progress, any returned PerCL will not be executed. Unpark is a terminal command -- any commands following it in the same script are not executed.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1235,6 +1260,7 @@
         "description": "Details for which features this number may be used.",
         "type": "object",
         "required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
+        "x-is-object": true,
         "properties": {
           "voice": {
             "description": "Indicates whether a number can be used for voice calls. Replaces voiceEnabled.",
@@ -1502,7 +1528,7 @@
             "type": "object",
             "properties": {
               "capabilities": {
-                "$ref": "#/components/schemas/Capabilities"
+                "$ref": "#/components/schemas/Capabilities"              
               },
               "campaignId": {
                 "type": "string",
@@ -1575,6 +1601,11 @@
           "alias": {
             "type": "string",
             "description": "Description for this phone number."
+          },
+          "campaignId": {
+            "type": "string",
+            "description": "The campaign ID generated by the campaign registry",
+            "nullable": true
           }
         }
       },
@@ -2318,6 +2349,898 @@
             "description": "The filter query for retrieving logs. See **Performance Query Language** below."
           }
         }
+      },
+      "SMSTenDLCCampaignsListResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationModel"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "campaigns": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/SMSTenDLCCampaign"
+                },
+                "nullable": true
+              }
+            }
+          }
+        ]
+      },
+      "SMSTenDLCCampaign": {
+        "required": [
+          "brandId",
+          "campaignId",
+          "cspId",
+          "description",
+          "mock",
+          "subUsecases",
+          "usecase"
+        ],
+        "type": "object",
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this Queue.",
+            "nullable": true
+          },
+          "campaignId": {
+            "type": "string",
+            "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC."
+          },
+          "cspId": {
+            "type": "string",
+            "description": "Alphanumeric identifier of the CSP associated with this campaign."
+          },
+          "resellerId": {
+            "maxLength": 8,
+            "x-max-length-8": true,
+            "type": "string",
+            "nullable": true,
+            "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign."
+          },
+          "status": {
+            "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"
+            ],
+            "x-enum-varnames": ["ACTIVE", "EXPIRED"]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when campaign was created.",
+            "format": "date-time",
+            "x-is-date-time": true
+          },
+          "autoRenewal": {
+            "type": "boolean",
+            "description": "Campaign subscription auto-renewal status."
+          },
+          "billedDate": {
+            "type": "string",
+            "description": "Campaign recent billed date.",
+            "format": "date-time",
+            "x-is-date-time": true,
+            "nullable": true
+          },
+          "brandId": {
+            "maxLength": 8,
+            "x-max-length-8": true,
+            "type": "string",
+            "description": "Alphanumeric identifier of the brand associated with this campaign."
+          },
+          "usecase": {
+            "maxLength": 20,
+            "type": "string",
+            "description": "Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand."
+          },
+          "subUsecases": {
+            "uniqueItems": 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": {
+              "type": "string",
+              "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": {
+            "maxLength": 4096,
+            "type": "string",
+            "description": "Summary description of this campaign."
+          },
+          "embeddedLink": {
+            "type": "boolean",
+            "description": "Does message generated by the campaign include URL link in SMS?",
+            "default": false
+          },
+          "embeddedPhone": {
+            "type": "boolean",
+            "description": "Does message generated by the campaign include phone number in SMS?",
+            "default": false
+          },
+          "affiliateMarketing": {
+            "type": "boolean",
+            "description": "Does message content controlled by affiliate marketing other than the brand?"
+          },
+          "numberPool": {
+            "type": "boolean",
+            "description": "Does campaign utilize pool of phone nubers?",
+            "default": false
+          },
+          "ageGated": {
+            "type": "boolean",
+            "description": "Age gated content in campaign."
+          },
+          "directLending": {
+            "type": "boolean"
+          },
+          "subscriberOptin": {
+            "type": "boolean",
+            "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?",
+            "default": false
+          },
+          "subscriberOptout": {
+            "type": "boolean",
+            "description": "Does campaign support subscriber opt-out keyword(s)?",
+            "default": false
+          },
+          "subscriberHelp": {
+            "type": "boolean",
+            "description": "Does campaign responds to help keyword(s)?",
+            "default": false
+          },
+          "sample1": {
+            "maxLength": 1024,
+            "type": "string",
+            "description": "Message sample. Some campaign tiers require 1 or more message samples."
+          },
+          "sample2": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 2 or more message samples."
+          },
+          "sample3": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 3 or more message samples."
+          },
+          "sample4": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 4 or more message samples."
+          },
+          "sample5": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 5 or more message samples."
+          },
+          "messageFlow": {
+            "maxLength": 2048,
+            "type": "string",
+            "nullable": true,
+            "description": "Message flow description."
+          },
+          "helpMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "nullable": true,
+            "description": "Help message of the campaign."
+          },
+          "referenceId": {
+            "maxLength": 50,
+            "type": "string",
+            "nullable": true,
+            "description": "Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations."
+          },
+          "mock": {
+            "type": "boolean",
+            "description": "Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP."
+          },
+          "nextRenewalOrExpirationDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "When the campaign would be due for its next renew/bill date.",
+            "format": "date",
+            "x-is-date": true,
+            "example": "2000-01-01"
+          }
+        }
+        ,
+        "example": {
+          "campaignId": "CX56XX4",
+          "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
+          "cspId": "SX56XX4",
+          "brandId": "BX56XX4",
+          "usecase": "2FA",
+          "description": "mock campaign.",
+          "subUsecases": [],
+          "resellerId": null,
+          "sample1": "Your verification code from FreeClimb is 000000. It expires in 10 minutes.",
+          "sample2": null,
+          "sample3": null,
+          "sample4": null,
+          "sample5": null,
+          "messageFlow": null,
+          "helpMessage": null,
+          "referenceId": null,
+          "status": "EXPIRED",
+          "mock": true,
+          "autoRenewal": false,
+          "embeddedLink": false,
+          "embeddedPhone": false,
+          "affiliateMarketing": false,
+          "numberPool": false,
+          "ageGated": false,
+          "directLending": false,
+          "subscriberOptin": true,
+          "subscriberOptout": false,
+          "subscriberHelp": true,
+          "createDate": "2022-07-05T15:17:05Z",
+          "billedDate": "2022-07-05T00:00:00Z",
+          "nextRenewalOrExpirationDate": null
+        }
+      },
+      "SMSTenDLCPartnerCampaignsListResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationModel"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "partnerCampaigns": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/SMSTenDLCPartnerCampaign"
+                },
+                "nullable": true
+              }
+            }
+          }
+        ]
+      },
+      "SMSTenDLCPartnerCampaign": {
+        "required": [
+          "brandId",
+          "campaignId",
+          "description",
+          "usecase"
+        ],
+        "type": "object",
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this Queue.",
+            "nullable": true
+          },
+          "campaignId": {
+            "type": "string",
+            "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC."
+          },
+          "status": {
+            "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"
+            ],
+            "x-enum-varnames": ["ACTIVE", "EXPIRED"]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when campaign was created.",
+            "format": "date-time",
+            "x-is-date-time": true
+          },
+          "brandId": {
+            "maxLength": 8,
+            "x-max-length-8": true,
+            "type": "string",
+            "description": "Alphanumeric identifier of the brand associated with this campaign."
+          },
+          "usecase": {
+            "maxLength": 20,
+            "type": "string",
+            "description": "Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand."
+          },
+          "description": {
+            "maxLength": 4096,
+            "type": "string",
+            "description": "Summary description of this campaign."
+          },
+          "embeddedLink": {
+            "type": "boolean",
+            "description": "Does message generated by the campaign include URL link in SMS?",
+            "default": false
+          },
+          "embeddedPhone": {
+            "type": "boolean",
+            "description": "Does message generated by the campaign include phone number in SMS?",
+            "default": false
+          },
+          "affiliateMarketing": {
+            "type": "boolean",
+            "description": "Does message content controlled by affiliate marketing other than the brand?"
+          },
+          "numberPool": {
+            "type": "boolean",
+            "description": "Does campaign utilize pool of phone nubers?",
+            "default": false
+          },
+          "ageGated": {
+            "type": "boolean",
+            "description": "Age gated content in campaign."
+          },
+          "directLending": {
+            "type": "boolean"
+          },
+          "subscriberOptin": {
+            "type": "boolean",
+            "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?",
+            "default": false
+          },
+          "subscriberOptout": {
+            "type": "boolean",
+            "description": "Does campaign support subscriber opt-out keyword(s)?",
+            "default": false
+          },
+          "subscriberHelp": {
+            "type": "boolean",
+            "description": "Does campaign responds to help keyword(s)?",
+            "default": false
+          },
+          "sample1": {
+            "maxLength": 1024,
+            "type": "string",
+            "description": "Message sample. Some campaign tiers require 1 or more message samples."
+          },
+          "sample2": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 2 or more message samples."
+          },
+          "sample3": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 3 or more message samples."
+          },
+          "sample4": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 4 or more message samples."
+          },
+          "sample5": {
+            "maxLength": 1024,
+            "type": "string",
+            "nullable": true,
+            "description": "Message sample. Some campaign tiers require 5 or more message samples."
+          },
+          "messageFlow": {
+            "maxLength": 2048,
+            "type": "string",
+            "nullable": true,
+            "description": "Message flow description."
+          },
+          "helpMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "nullable": true,
+            "description": "Help message of the campaign."
+          },
+          "optinKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-in keywords. Multiple keywords are comma separated without space."
+          },
+          "optoutKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-out keywords. Multiple keywords are comma separated without space."
+          },
+          "helpKeywords": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber help keywords. Multiple keywords are comma separated without space."
+          },
+          "optinMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-in message."
+          },
+          "optoutMessage": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Subscriber opt-out message."
+          },
+          "brand": {
+            "$ref": "#/components/schemas/SMSTenDLCPartnerCampaignBrand",
+            "x-partner-campaign-brand": true
+          }
+        },
+        "example": {
+          "campaignId": "CX56XX4",
+          "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
+          "brandId": "BX56XX4",
+          "usecase": "2FA",
+          "description": "mock campaign.",
+          "sample1": "Your verification code from FreeClimb is 000000. It expires in 10 minutes.",
+          "sample2": null,
+          "sample3": null,
+          "sample4": null,
+          "sample5": null,
+          "messageFlow": null,
+          "helpMessage": null,
+          "status": "EXPIRED",
+          "embeddedLink": false,
+          "embeddedPhone": false,
+          "affiliateMarketing": false,
+          "numberPool": false,
+          "ageGated": false,
+          "directLending": false,
+          "subscriberOptin": true,
+          "subscriberOptout": false,
+          "subscriberHelp": true,
+          "createDate": "2022-07-05T15:17:05Z",
+          "optinKeywords": "START",
+          "optoutKeywords": "STOP",
+          "helpKeywords": "HELP",
+          "optinMessage": "",
+          "optoutMessage": "",
+          "brand": {
+            "optionalAttributes": {},
+            "brandId": "BVCEBIJ",
+            "firstName": "",
+            "lastName": "",
+            "displayName": "FreeClimb LLC(mock)",
+            "companyName": "FreeClimb LLC",
+            "phone": "+18475722071",
+            "email": "bmabry@vailsys.com",
+            "website": "https://www.freeclimb.com/",
+            "evpVettingScore": 22
+          }
+        }
+      },
+      "SMSTenDLCPartnerCampaignBrand":{
+        "required": [
+          "email",
+          "phone"
+        ],
+        "type": "object",
+        "x-is-object": true,
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this Queue.",
+            "nullable": true
+          },
+          "brandId": {
+            "type": "string",
+            "description": "Unique identifier assigned to the brand by the registry.",
+            "readOnly": true
+          },
+          "firstName": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "First or given name. ",
+            "example": "John"
+          },
+          "lastName": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Last or Surname.",
+            "example": "Doe"
+          },
+          "displayName": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Display or marketing name of the brand.",
+            "example": "ABC Mobile"
+          },
+          "companyName": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "(Required for Non-profit/private/public) Legal company name.",
+            "example": "ABC Inc."
+          },
+          "phone": {
+            "maxLength": 20,
+            "type": "string",
+            "description": "Valid phone number in e.164 international format.",
+            "example": "+12024567890"
+          },
+          "email": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Valid email address of brand support contact."
+          },
+          "website": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Brand website URL.",
+            "example": "http://www.abcmobile.com"
+          },
+          "optionalAttributes": {
+            "type": "object",
+            "x-is-hash": true,
+            "additionalProperties": {
+              "type": "object",
+              "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
+            },
+            "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
+          },
+          "evpVettingScore": {
+            "type": "integer",
+            "description": "External vetting score."
+          }
+        }
+      },
+      "SMSTenDLCBrandsListResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginationModel"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "brands": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/SMSTenDLCBrand"
+                },
+                "nullable": true
+              }
+            }
+          }
+        ]
+      },
+      "SMSTenDLCBrand":{
+        "required": [
+          "brandRelationship",
+          "country",
+          "displayName",
+          "email",
+          "entityType",
+          "identityStatus",
+          "mock",
+          "phone",
+          "vertical"
+        ],
+        "type": "object",
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this Queue.",
+            "nullable": true
+          },
+          "entityType": {
+            "maxLength": 20,
+            "type": "string",
+            "x-has-writer": true,
+            "description": "Entity type behind the brand. This is the form of business establishment.",
+            "enum": [
+              "PRIVATE_PROFIT",
+              "PUBLIC_PROFIT",
+              "NON_PROFIT",
+              "GOVERNMENT",
+              "SOLE_PROPRIETOR"
+            ],
+            "x-enum-varnames": ["PRIVATE_PROFIT",
+              "PUBLIC_PROFIT",
+              "NON_PROFIT",
+              "GOVERNMENT",
+              "SOLE_PROPRIETOR"
+          ]
+          },
+          "cspId": {
+            "type": "string",
+            "description": "Unique identifier assigned to the csp by the registry.",
+            "readOnly": true
+          },
+          "brandId": {
+            "type": "string",
+            "description": "Unique identifier assigned to the brand by the registry.",
+            "readOnly": true
+          },
+          "firstName": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "First or given name. ",
+            "example": "John"
+          },
+          "lastName": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Last or Surname.",
+            "example": "Doe"
+          },
+          "displayName": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "Display or marketing name of the brand.",
+            "example": "ABC Mobile"
+          },
+          "companyName": {
+            "maxLength": 255,
+            "type": "string",
+            "description": "(Required for Non-profit/private/public) Legal company name.",
+            "example": "ABC Inc."
+          },
+          "ein": {
+            "maxLength": 21,
+            "type": "string",
+            "description": "(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.",
+            "example": "111111111"
+          },
+          "einIssuingCountry": {
+            "maxLength": 2,
+            "type": "string",
+            "description": "ISO2 2 characters country code. Example: US - United States",
+            "example": "US",
+            "x-max-length-2": true
+          },
+          "phone": {
+            "maxLength": 20,
+            "type": "string",
+            "description": "Valid phone number in e.164 international format.",
+            "example": "+12024567890"
+          },
+          "street": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Street number and name.",
+            "example": "123 6th Ave"
+          },
+          "city": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "City name",
+            "example": "New York"
+          },
+          "state": {
+            "maxLength": 20,
+            "type": "string",
+            "description": "State. Must be 2 letters code for United States.",
+            "example": "NY"
+          },
+          "postalCode": {
+            "maxLength": 10,
+            "x-max-length-10": true,
+            "type": "string",
+            "description": "Postal codes. Use 5 digit zipcode for United States",
+            "example": "10001"
+          },
+          "country": {
+            "maxLength": 2,
+            "x-max-length-2": true,
+            "type": "string",
+            "description": "ISO2 2 characters country code. Example: US - United States",
+            "example": "US"
+          },
+          "email": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Valid email address of brand support contact."
+          },
+          "stockSymbol": {
+            "maxLength": 10,
+            "x-max-length-10": true,
+            "type": "string",
+            "description": "(Required for public company) stock symbol.",
+            "example": "ABC"
+          },
+          "stockExchange": {
+            "type": "string",
+            "x-has-writer": true,
+            "description": "(Required for public company) stock exchange.",
+            "example": "NASDAQ",
+            "enum": [
+              "NONE",
+              "NASDAQ",
+              "NYSE",
+              "AMEX",
+              "AMX",
+              "ASX",
+              "B3",
+              "BME",
+              "BSE",
+              "FRA",
+              "ICEX",
+              "JPX",
+              "JSE",
+              "KRX",
+              "LON",
+              "NSE",
+              "OMX",
+              "SEHK",
+              "SGX",
+              "SSE",
+              "STO",
+              "SWX",
+              "SZSE",
+              "TSX",
+              "TWSE",
+              "VSE",
+              "OTHER"
+            ],
+            "x-enum-varnames": [
+              "NONE",
+              "NASDAQ",
+              "NYSE",
+              "AMEX",
+              "AMX",
+              "ASX",
+              "B3",
+              "BME",
+              "BSE",
+              "FRA",
+              "ICEX",
+              "JPX",
+              "JSE",
+              "KRX",
+              "LON",
+              "NSE",
+              "OMX",
+              "SEHK",
+              "SGX",
+              "SSE",
+              "STO",
+              "SWX",
+              "SZSE",
+              "TSX",
+              "TWSE",
+              "VSE",
+              "OTHER"
+            ]
+          },
+          "ipAddress": {
+            "maxLength": 50,
+            "type": "string",
+            "description": "IP address of the browser requesting to create brand identity."
+          },
+          "website": {
+            "maxLength": 100,
+            "type": "string",
+            "description": "Brand website URL.",
+            "example": "http://www.abcmobile.com"
+          },
+          "brandRelationship": {
+            "type": "string",
+            "x-has-writer": true,
+            "description": "Brand relationship to the CSP",
+            "enum": [
+              "BASIC_ACCOUNT",
+              "SMALL_ACCOUNT",
+              "MEDIUM_ACCOUNT",
+              "LARGE_ACCOUNT",
+              "KEY_ACCOUNT"
+            ],
+            "x-enum-varnames": [
+              "BASIC_ACCOUNT",
+              "SMALL_ACCOUNT",
+              "MEDIUM_ACCOUNT",
+              "LARGE_ACCOUNT",
+              "KEY_ACCOUNT"
+            ]
+          },
+          "vertical": {
+            "maxLength": 50,
+            "type": "string",
+            "description": "Vertical or industry segment of the brand."
+          },
+          "altBusinessId": {
+            "maxLength": 50,
+            "type": "string",
+            "description": "Alternate business identifier such as DUNS, LEI, or GIIN"
+          },
+          "altBusinessIdType": {
+            "type": "string",
+            "x-has-writer": true,
+            "enum": [
+              "NONE",
+              "DUNS",
+              "GIIN",
+              "LEI"
+            ],
+            "x-enum-varnames": [
+              "NONE",
+              "DUNS",
+              "GIIN",
+              "LEI"
+            ],
+            "description": "The type of the Alternative business identifier"
+          },
+          "universalEin": {
+            "type": "string",
+            "description": "Universal EIN of Brand, Read Only.",
+            "readOnly": true
+          },
+          "referenceId": {
+            "maxLength": 50,
+            "type": "string",
+            "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": {
+            "type": "object",
+            "x-is-hash": true,
+            "additionalProperties": {
+              "type": "object",
+              "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
+            },
+            "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
+          },
+          "mock": {
+            "type": "boolean",
+            "description": "Test brand."
+          },
+          "identityStatus": {
+            "type": "string",
+            "x-has-writer": true,
+            "description": "TCR assessment of the brand identification status.",
+            "enum": [
+              "SELF_DECLARED",
+              "UNVERIFIED",
+              "VERIFIED",
+              "VETTED_VERIFIED"
+            ],
+            "x-enum-varnames": [
+              "SELF_DECLARED",
+              "UNVERIFIED",
+              "VERIFIED",
+              "VETTED_VERIFIED"
+            ]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when brand was created.",
+            "format": "date-time",
+            "x-is-date-time": true
+          }
+        },
+        "description": "A brand is a business identity behind the campaign.",
+        "example": {
+          "mock": true,
+          "optionalAttributes": {},
+          "accountId": "AC1234512345123451234512345123451234512345",
+          "brandId": "BVCEBIJ",
+          "cspId": "SKGC6G0",
+          "firstName": "",
+          "lastName": "",
+          "displayName": "FreeClimb LLC(mock)",
+          "companyName": "FreeClimb LLC",
+          "ein": "843793747",
+          "einIssuingCountry": "US",
+          "phone": "+18475722071",
+          "street": "570 Lake Cook Rd Ste 400",
+          "city": "Deerfield",
+          "state": "IL",
+          "postalCode": "60015",
+          "country": "US",
+          "email": "bmabry@vailsys.com",
+          "stockSymbol": "",
+          "stockExchange": "NASDAQ",
+          "ipAddress": "127.0.0.1",
+          "website": "https://www.freeclimb.com/",
+          "vertical": "TECHNOLOGY",
+          "universalEin": "US_843793747",
+          "referenceId": "ACdeadbeef",
+          "entityType": "PRIVATE_PROFIT",
+          "brandRelationship": "SMALL_ACCOUNT",
+          "identityStatus": "VERIFIED",
+          "createDate": "2022-07-01T20:29:23Z"
+        }
       }
     }
   },
@@ -2816,6 +3739,15 @@
             },
             "deprecated": true
           },
+          {
+            "name": "hasCampaign",
+            "in": "query",
+            "description": "Indication of whether the phone number has a campaign associated with it",
+            "required": false,
+            "schema": {
+              "type": "boolean"
+            }
+          },
           {
             "$ref": "#/components/parameters/Capabilities.Voice"
           },
@@ -2837,8 +3769,7 @@
             "required": false,
             "description": "Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource.",
             "schema": {
-              "type": "boolean",
-              "nullable": true
+              "type": "boolean"
             }
           }
         ],
@@ -4229,6 +5160,340 @@
         },
         "deprecated": false
       }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/Campaigns": {
+      "get": {
+        "tags": [],
+        "summary": "Get list of SMS 10DLC Campaigns",
+        "operationId": "get-tenDLC-sms-Campaigns",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "brandId",
+            "in": "query",
+            "description": "The unique identifier for a brand",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list SMS 10DLC campaigns",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCCampaignsListResult"
+                },
+                "example": {
+                  "total": 1,
+                  "start": 0,
+                  "end": 0,
+                  "page": 0,
+                  "numPages": 1,
+                  "pageSize": 100,
+                  "nextPageUri": null,
+                  "campaigns": [
+                    {
+                      "campaignId": "C3TMRFL",
+                      "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
+                      "cspId": "SKGC6G0",
+                      "brandId": "BVCEBIJ",
+                      "usecase": "2FA",
+                      "description": "bmabry mock campaign.",
+                      "subUsecases": [],
+                      "resellerId": null,
+                      "sample1": "Your verification code from FreeClimb is 000000. It expires in 10 minutes.",
+                      "sample2": null,
+                      "sample3": null,
+                      "sample4": null,
+                      "sample5": null,
+                      "messageFlow": null,
+                      "helpMessage": null,
+                      "referenceId": null,
+                      "status": "EXPIRED",
+                      "mock": true,
+                      "autoRenewal": false,
+                      "embeddedLink": false,
+                      "embeddedPhone": false,
+                      "affiliateMarketing": false,
+                      "numberPool": false,
+                      "ageGated": false,
+                      "directLending": false,
+                      "subscriberOptin": true,
+                      "subscriberOptout": false,
+                      "subscriberHelp": true,
+                      "createDate": "2022-07-05T15:17:05Z",
+                      "billedDate": "2022-07-05T00:00:00Z",
+                      "nextRenewalOrExpirationDate": null
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}": {
+      "get": {
+        "tags": [],
+        "summary": "Get a 10DLC SMS Campaign",
+        "operationId": "get-tenDLC-sms-campaign",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "campaignId",
+            "in": "path",
+            "description": "String that uniquely identifies this campaign resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The specific SMS 10DLC Campaign that’s been processed by FreeClimb",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCCampaign"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns": {
+      "get": {
+        "tags": [],
+        "summary": "Get list of SMS 10DLC Partner Campaigns",
+        "operationId": "get-tenDLC-sms-partnerCampaigns",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "brandId",
+            "in": "query",
+            "description": "The unique identifier for a brand",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list SMS 10DLC partner campaigns",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCPartnerCampaignsListResult"
+                },
+                "example": {
+                  "total": 1,
+                  "start": 0,
+                  "end": 0,
+                  "page": 0,
+                  "numPages": 1,
+                  "pageSize": 100,
+                  "nextPageUri": null,
+                  "sharedCampaigns": [
+                    {
+                      "campaignId": "CX56XX4",
+                      "accountId": "ACe39970fb7c31c747c67148900b4d9da60a41e532",
+                      "brandId": "BX56XX4",
+                      "usecase": "2FA",
+                      "description": "mock campaign.",
+                      "sample1": "Your verification code from FreeClimb is 000000. It expires in 10 minutes.",
+                      "sample2": null,
+                      "sample3": null,
+                      "sample4": null,
+                      "sample5": null,
+                      "messageFlow": null,
+                      "helpMessage": null,
+                      "status": "EXPIRED",
+                      "embeddedLink": false,
+                      "embeddedPhone": false,
+                      "affiliateMarketing": false,
+                      "numberPool": false,
+                      "ageGated": false,
+                      "directLending": false,
+                      "subscriberOptin": true,
+                      "subscriberOptout": false,
+                      "subscriberHelp": true,
+                      "createDate": "2022-07-05T15:17:05Z",
+                      "optinKeywords": "START",
+                      "optoutKeywords": "STOP",
+                      "helpKeywords": "HELP",
+                      "optinMessage": "",
+                      "optoutMessage": "",
+                      "brand": {
+                        "optionalAttributes": {},
+                        "brandId": "BVCEBIJ",
+                        "firstName": "",
+                        "lastName": "",
+                        "displayName": "FreeClimb LLC(mock)",
+                        "companyName": "FreeClimb LLC",
+                        "phone": "+18475722071",
+                        "email": "bmabry@vailsys.com",
+                        "website": "https://www.freeclimb.com/",
+                        "evpVettingScore": 22
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}": {
+      "get": {
+        "tags": [],
+        "summary": "Get a 10DLC SMS Partner Campaign",
+        "operationId": "get-tenDLC-sms-partnerCampaign",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "campaignId",
+            "in": "path",
+            "description": "String that uniquely identifies this campaign resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The specific SMS 10DLC Partner Campaign that’s been processed by FreeClimb",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCPartnerCampaign"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/Brands": {
+      "get": {
+        "tags": [],
+        "summary": "Get list of SMS 10DLC Brands",
+        "operationId": "get-tenDLC-sms-brands",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list SMS 10DLC brands",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCBrandsListResult"
+                },
+                "example": {
+                  "total": 1,
+                  "start": 0,
+                  "end": 0,
+                  "page": 0,
+                  "numPages": 1,
+                  "pageSize": 100,
+                  "nextPageUri": null,
+                  "brands": [
+                    {
+                      "mock": true,
+                      "optionalAttributes": {},
+                      "accountId": "AC1234512345123451234512345123451234512345",
+                      "brandId": "BVCEBIJ",
+                      "cspId": "SKGC6G0",
+                      "firstName": "",
+                      "lastName": "",
+                      "displayName": "FreeClimb LLC(mock)",
+                      "companyName": "FreeClimb LLC",
+                      "ein": "843793747",
+                      "einIssuingCountry": "US",
+                      "phone": "+18475722071",
+                      "street": "570 Lake Cook Rd Ste 400",
+                      "city": "Deerfield",
+                      "state": "IL",
+                      "postalCode": "60015",
+                      "country": "US",
+                      "email": "bmabry@vailsys.com",
+                      "stockSymbol": "",
+                      "stockExchange": "ASX",
+                      "ipAddress": "127.0.0.1",
+                      "website": "https://www.freeclimb.com/",
+                      "vertical": "TECHNOLOGY",
+                      "universalEin": "US_843793747",
+                      "referenceId": "ACdeadbeef",
+                      "entityType": "PRIVATE_PROFIT",
+                      "brandRelationship": "SMALL_ACCOUNT",
+                      "identityStatus": "VERIFIED",
+                      "createDate": "2022-07-01T20:29:23Z"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/Accounts/{accountId}/Messages/10DLC/Brands/{brandId}": {
+      "get": {
+        "tags": [],
+        "summary": "Get a 10DLC SMS Brand",
+        "operationId": "get-tenDLC-sms-brand",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountId"
+          },
+          {
+            "name": "brandId",
+            "in": "path",
+            "description": "String that uniquely identifies this brand resource.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The specific SMS 10DLC Brand that’s been processed by FreeClimb",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SMSTenDLCBrand"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
     }
   },
   "x-headers": [],