freeclimb 4.2.0 → 4.4.0

data/openapi.json

@@ -85,28 +85,33 @@
         "type": "string",
         "enum": ["closed", "suspended", "active"],
         "x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
-        "description": "The status of this account. It is one of: active, suspended, or closed."
+        "description": "The status of this account. It is one of: active, suspended, or closed.",
+        "nullable": true
       },
       "AccountType": {
         "type": "string",
         "description": "The type of this account. It is one of: trial or full.",
         "enum": ["trial", "full"],
-        "x-enum-varnames": ["TRIAL", "FULL"]
+        "x-enum-varnames": ["TRIAL", "FULL"],
+        "nullable": true
       },
       "AnsweredBy": {
         "type": "string",
+        "nullable": true,
         "enum": ["human", "machine"],
         "x-enum-varnames": ["HUMAN", "MACHINE"],
         "description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
       },
       "CallDirection": {
         "type": "string",
+        "nullable": true,
         "enum": ["inbound", "outboundAPI", "outboundDial"],
         "x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
         "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": {
         "type": "string",
+        "nullable": true,
         "enum": [
           "queued",
           "ringing",
@@ -131,6 +136,7 @@
       },
       "ConferenceStatus": {
         "type": "string",
+        "nullable": true,
         "enum": ["empty", "populated", "inProgress", "terminated"],
         "x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
         "description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
@@ -194,6 +200,7 @@
       "GrammarType": {
         "type": "string",
         "enum": ["URL", "BUILTIN"],
+        "nullable": true,
         "x-enum-varnames": ["URL", "BUILT_IN"],
         "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."
       },
@@ -265,6 +272,7 @@
       "LogLevel": {
         "type": "string",
         "enum": ["info", "warning", "error"],
+        "nullable": true,
         "x-enum-varnames": ["INFO", "WARNING", "ERROR"],
         "description": "Level of the log. Possible values are info, warning, and error."
       },
@@ -280,6 +288,7 @@
       },
       "MessageStatus": {
         "type": "string",
+        "nullable": true,
         "description": "Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown",
         "enum": [
           "new",
@@ -310,9 +319,10 @@
       },
       "PlayBeep": {
         "type": "string",
+        "nullable": true,
         "enum": ["always", "never", "entryOnly", "exitOnly"],
         "x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
-        "description": "Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`.",
+        "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"
       },
@@ -520,7 +530,6 @@
                 "type": "boolean"
               },
               "playBeep": {
-                "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` ",
                 "$ref": "#/components/schemas/PlayBeep"
               },
               "record": {
@@ -653,8 +662,7 @@
                 "format": "uri"
               },
               "grammarType": {
-                "$ref": "#/components/schemas/GrammarType",
-                "nullable": true
+                "$ref": "#/components/schemas/GrammarType"
               },
               "grammarFile": {
                 "description": "The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL.",
@@ -1297,12 +1305,10 @@
                 "nullable": true
               },
               "type": {
-                "$ref": "#/components/schemas/AccountType",
-                "nullable": true
+                "$ref": "#/components/schemas/AccountType"
               },
               "status": {
-                "$ref": "#/components/schemas/AccountStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/AccountStatus"
               },
               "subresourceUris": {
                 "type": "object",
@@ -1569,6 +1575,11 @@
           "alias": {
             "type": "string",
             "description": "Description for this phone number."
+          },
+          "campaignId": {
+            "type": "string",
+            "description": "The campaign ID generated by the campaign registry",
+            "nullable": true
           }
         }
       },
@@ -1648,8 +1659,7 @@
                 "nullable": true
               },
               "callStatus": {
-                "$ref": "#/components/schemas/CallStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/CallStatus"
               },
               "startTime": {
                 "type": "string",
@@ -1677,12 +1687,10 @@
                 "nullable": true
               },
               "direction": {
-                "$ref": "#/components/schemas/CallDirection",
-                "nullable": true
+                "$ref": "#/components/schemas/CallDirection"
               },
               "answeredBy": {
-                "$ref": "#/components/schemas/AnsweredBy",
-                "nullable": true
+                "$ref": "#/components/schemas/AnsweredBy"
               },
               "subresourceUris": {
                 "type": "object",
@@ -1834,9 +1842,7 @@
             "nullable": true
           },
           "level": {
-            "$ref": "#/components/schemas/LogLevel",
-
-            "nullable": true
+            "$ref": "#/components/schemas/LogLevel"
           },
           "requestId": {
             "type": "string",
@@ -1909,8 +1915,7 @@
               },
               "playBeep": {
                 "$ref": "#/components/schemas/PlayBeep",
-                "description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always.",
-                "nullable": true
+                "description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always."
               },
               "record": {
                 "type": "boolean",
@@ -1918,8 +1923,7 @@
                 "nullable": true
               },
               "status": {
-                "$ref": "#/components/schemas/ConferenceStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/ConferenceStatus"
               },
               "waitUrl": {
                 "type": "string",
@@ -2036,8 +2040,7 @@
                 "nullable": true
               },
               "status": {
-                "$ref": "#/components/schemas/MessageStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/MessageStatus"
               },
               "from": {
                 "type": "string",
@@ -2320,6 +2323,819 @@
             "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,
+            "type": "string",
+            "nullable": true,
+            "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign."
+          },
+          "status": {
+            "type": "string",
+            "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
+            "enum": [
+              "ACTIVE",
+              "EXPIRED"
+            ]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when campaign was created.",
+            "format": "date-time"
+          },
+          "autoRenewal": {
+            "type": "boolean",
+            "description": "Campaign subscription auto-renewal status."
+          },
+          "billedDate": {
+            "type": "string",
+            "description": "Campaign recent billed date.",
+            "format": "date-time",
+            "nullable": true
+          },
+          "brandId": {
+            "maxLength": 8,
+            "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",
+            "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",
+            "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
+            "enum": [
+              "ACTIVE",
+              "EXPIRED"
+            ]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when campaign was created.",
+            "format": "date-time"
+          },
+          "brandId": {
+            "maxLength": 8,
+            "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"
+          }
+        },
+        "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",
+        "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",
+            "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",
+            "description": "Entity type behind the brand. This is the form of business establishment.",
+            "enum": [
+              "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"
+          },
+          "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,
+            "type": "string",
+            "description": "Postal codes. Use 5 digit zipcode for United States",
+            "example": "10001"
+          },
+          "country": {
+            "maxLength": 2,
+            "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,
+            "type": "string",
+            "description": "(Required for public company) stock symbol.",
+            "example": "ABC"
+          },
+          "stockExchange": {
+            "type": "string",
+            "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"
+            ]
+          },
+          "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",
+            "description": "Brand relationship to the CSP",
+            "enum": [
+              "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",
+            "enum": [
+              "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",
+            "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",
+            "description": "TCR assessment of the brand identification status.",
+            "enum": [
+              "SELF_DECLARED",
+              "UNVERIFIED",
+              "VERIFIED",
+              "VETTED_VERIFIED"
+            ]
+          },
+          "createDate": {
+            "type": "string",
+            "description": "Unix timestamp when brand was created.",
+            "format": "date-time"
+          }
+        },
+        "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"
+        }
       }
     }
   },
@@ -2818,6 +3634,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"
           },
@@ -2839,8 +3664,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"
             }
           }
         ],
@@ -3066,6 +3890,21 @@
               "type": "string"
             }
           },
+          {
+            "name": "applicationId",
+            "in": "query",
+            "description": "Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.",
+            "explode": true,
+            "required": false,
+            "schema": {
+              "type": "array",
+              "maxItems": 16,
+              "items": {
+                "type": "string",
+                "pattern": "^AP[0-9a-fA-F]{40}$"
+              }
+            }
+          },
           {
             "$ref": "#/components/parameters/AccountId"
           }
@@ -4216,6 +5055,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": [],