Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 629a581

Browse files
DX-BandwidthDX-Bandwidth
authored
bwdb-14275-10dlc (#807)
* Add Code Snippets to Spec Files * Add Code Snippets to Spec Files
1 parent 973cb71 commit 629a581

File tree

1 file changed

+305
-8
lines changed

1 file changed

+305
-8
lines changed

‎site/specs/numbers.yml

Lines changed: 305 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1286,6 +1286,116 @@ components:
12861286
$ref: '#/components/schemas/Brand'
12871287
type: object
12881288
type: object
1289+
BrandVetting:
1290+
properties:
1291+
VettingClass:
1292+
description: Identifies the vetting classification.
1293+
enum:
1294+
- STANDARD
1295+
- ENHANCED
1296+
- POLITICAL
1297+
type: string
1298+
VettingId:
1299+
description: >-
1300+
Unique ID that identifies a vetting transaction performed by a
1301+
vetting provider. This ID is provided by the vetting provider at
1302+
time of vetting.
1303+
type: string
1304+
type: object
1305+
BrandVettingImportRequest:
1306+
properties:
1307+
BrandVetting:
1308+
properties:
1309+
EvpId:
1310+
description: >-
1311+
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
1312+
CV(Campaign Verify), WMC(WMC Global)
1313+
enum:
1314+
- AEGIS
1315+
- CV
1316+
- WMC
1317+
type: string
1318+
VettingId:
1319+
description: >-
1320+
Unique ID that identifies a vetting transaction performed by a
1321+
vetting provider. This ID is provided by the vetting provider at
1322+
time of vetting.
1323+
type: string
1324+
type: object
1325+
type: object
1326+
BrandVettingImportResponse:
1327+
properties:
1328+
BrandVetting:
1329+
properties:
1330+
BrandId:
1331+
description: Unique ID that identifies a brand.
1332+
type: string
1333+
EvpId:
1334+
description: >-
1335+
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
1336+
CV(Campaign Verify), WMC(WMC Global)
1337+
enum:
1338+
- AEGIS
1339+
- CV
1340+
- WMC
1341+
type: string
1342+
VettingId:
1343+
description: >-
1344+
Unique ID that identifies a vetting transaction performed by a
1345+
vetting provider. This ID is provided by the vetting provider at
1346+
time of vetting.
1347+
type: string
1348+
VettingStatus:
1349+
description: >-
1350+
Identifies the vetting request status. PENDING, UNSCORE,
1351+
ACTIVE, FAILED, EXPIRED ]
1352+
enum:
1353+
- PENDING
1354+
- UNSCORE
1355+
- ACTIVE
1356+
- FAILED
1357+
- EXPIRED
1358+
type: string
1359+
type: object
1360+
type: object
1361+
BrandVettingRequest:
1362+
properties:
1363+
BrandVetting:
1364+
properties:
1365+
EvpId:
1366+
description: >-
1367+
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
1368+
CV(Campaign Verify), WMC(WMC Global)
1369+
enum:
1370+
- AEGIS
1371+
- CV
1372+
- WMC
1373+
type: string
1374+
VettingClass:
1375+
description: Identifies the vetting classification.
1376+
enum:
1377+
- STANDARD
1378+
- ENHANCED
1379+
- POLITICAL
1380+
type: string
1381+
type: object
1382+
type: object
1383+
BrandVettingsErrorResponse:
1384+
properties:
1385+
BrandVettingsResponse:
1386+
properties:
1387+
BrandVetting:
1388+
$ref: '#/components/schemas/ResponseStatus'
1389+
type: object
1390+
type: object
1391+
BrandVettingsResponse:
1392+
properties:
1393+
BrandVettingsResponse:
1394+
properties:
1395+
BrandVetting:
1396+
$ref: '#/components/schemas/BrandVetting'
1397+
type: object
1398+
type: object
12891399
BrandsErrorResponse:
12901400
properties:
12911401
BrandsResponse:
@@ -13855,14 +13965,17 @@ paths:
1385513965
tags:
1385613966
- 10DLC
1385713967
post:
13858-
description: >-
13859-
<p>Create campaign registry brand on the Account</p><p>My Brand Note:
13860-
Regardless of if you are a DirectCustomer or Reseller, you will need to
13861-
create a 'My Brand'. You can only create one of these. On the Request
13862-
Body you can indicate a 'My Brand' by setting the IsMain flag to
13863-
true.</p><p>Please visit <a
13864-
href='/docs/messaging/campaign-management/csp/reseller-brand-api/'>Brand
13865-
and Reseller Management.</a></p>
13968+
description: >
13969+
Create campaign registry brand on the Account.
13970+
13971+
My Brand Note Regardless of if you are a DirectCustomer or Reseller, you
13972+
will need to create a My Brand.
13973+
13974+
You can only create one of these. On the Request Body you can indicate a
13975+
My Brand by setting the IsMain flag to true.
13976+
13977+
Please visit [Brand and Reseller
13978+
Management](/docs/messaging/campaign-management/csp/reseller-brand-api)
1386613979
operationId: Create brand
1386713980
parameters:
1386813981
- $ref: '#/components/parameters/AccountIdPathParam'
@@ -13976,6 +14089,190 @@ paths:
1397614089
description: Error Response
1397714090
tags:
1397814091
- 10DLC
14092+
/accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}/vetting:
14093+
get:
14094+
description: Retrieve brand external vetting records
14095+
operationId: Retrieve brand vettings
14096+
parameters:
14097+
- $ref: '#/components/parameters/AccountIdPathParam'
14098+
- description: Brand id.
14099+
example: B5DG4HH
14100+
in: path
14101+
name: brandId
14102+
required: true
14103+
schema:
14104+
type: string
14105+
- description: Vetting provider ID.
14106+
example: AEGIS
14107+
in: query
14108+
name: evpId
14109+
schema:
14110+
type: string
14111+
- description: Vetting class.
14112+
example: STANDARD
14113+
in: query
14114+
name: vettingClass
14115+
schema:
14116+
type: string
14117+
responses:
14118+
'200':
14119+
content:
14120+
application/xml:
14121+
examples:
14122+
example:
14123+
value: |-
14124+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14125+
<BrandVettingResponse>
14126+
<BrandVetting>
14127+
<VettingId>69823255-96b3-412f-9120-3e77f94c6be5</VettingId>
14128+
<VettingStatus>PENDING</VettingStatus>
14129+
</BrandVetting>
14130+
</BrandVettingResponse>
14131+
schema:
14132+
$ref: '#/components/schemas/BrandVettingsResponse'
14133+
description: OK
14134+
'400':
14135+
content:
14136+
application/xml:
14137+
examples:
14138+
example:
14139+
value: |-
14140+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14141+
<BrandVettingResponse>
14142+
<ResponseStatus>
14143+
<ErrorCode>12055</ErrorCode>
14144+
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
14145+
</ResponseStatus>
14146+
</BrandVettingResponse>
14147+
schema:
14148+
$ref: '#/components/schemas/BrandVettingsErrorResponse'
14149+
description: Error Response
14150+
tags:
14151+
- 10DLC
14152+
post:
14153+
description: Create brand an external vetting
14154+
operationId: Create brand vetting
14155+
parameters:
14156+
- $ref: '#/components/parameters/AccountIdPathParam'
14157+
- description: Brand id.
14158+
example: B5DG4HH
14159+
in: path
14160+
name: brandId
14161+
required: true
14162+
schema:
14163+
type: string
14164+
requestBody:
14165+
content:
14166+
application/xml:
14167+
examples:
14168+
example:
14169+
value: |-
14170+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14171+
<Brand>
14172+
<EvpId>AEGIS</EvpId>
14173+
<VettingClass>STANDARD</VettingClass>
14174+
</Brand>
14175+
schema:
14176+
$ref: '#/components/schemas/BrandVettingRequest'
14177+
responses:
14178+
'200':
14179+
content:
14180+
application/xml:
14181+
examples:
14182+
example:
14183+
value: |-
14184+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14185+
<BrandVettingResponse>
14186+
<BrandVetting>
14187+
<EvpId>BJDHM3</EvpId>
14188+
<VettingId>CMHSJ9</VettingId>
14189+
<VettingStatus>ACTIVE</VettingStatus>
14190+
<BrandId>111111111</BrandId>
14191+
</BrandVetting>
14192+
</BrandVettingResponse>
14193+
schema:
14194+
$ref: '#/components/schemas/BrandVettingsResponse'
14195+
description: OK
14196+
'400':
14197+
content:
14198+
application/xml:
14199+
examples:
14200+
example:
14201+
value: |-
14202+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14203+
<BrandVettingResponse>
14204+
<ResponseStatus>
14205+
<ErrorCode>12055</ErrorCode>
14206+
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
14207+
</ResponseStatus>
14208+
</BrandVettingResponse>
14209+
schema:
14210+
$ref: '#/components/schemas/BrandVettingsErrorResponse'
14211+
description: Error Response
14212+
tags:
14213+
- 10DLC
14214+
put:
14215+
description: Import brand external vetting records
14216+
operationId: Import brand vetting
14217+
parameters:
14218+
- $ref: '#/components/parameters/AccountIdPathParam'
14219+
- description: Brand id.
14220+
example: B5DG4HH
14221+
in: path
14222+
name: brandId
14223+
required: true
14224+
schema:
14225+
type: string
14226+
requestBody:
14227+
content:
14228+
application/xml:
14229+
examples:
14230+
example:
14231+
value: |-
14232+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14233+
<Brand>
14234+
<EvpId>AEGIS</EvpId>
14235+
<VettingId>b62ed6ba-20f7-4031-a5fa-68e96cd6c036</VettingId>
14236+
</Brand>
14237+
schema:
14238+
$ref: '#/components/schemas/BrandVettingImportRequest'
14239+
responses:
14240+
'200':
14241+
content:
14242+
application/xml:
14243+
examples:
14244+
example:
14245+
value: |-
14246+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14247+
<BrandVettingResponse>
14248+
<BrandVetting>
14249+
<EvpId>BJDHM3</EvpId>
14250+
<VettingId>CMHSJ9</VettingId>
14251+
<VettingStatus>PUBLIC_PROFIT</VettingStatus>
14252+
<BrandId>111111111</BrandId>
14253+
</BrandVetting>
14254+
</BrandVettingResponse>
14255+
schema:
14256+
$ref: '#/components/schemas/BrandVettingImportResponse'
14257+
description: OK
14258+
'400':
14259+
content:
14260+
application/xml:
14261+
examples:
14262+
example:
14263+
value: |-
14264+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
14265+
<BrandVettingResponse>
14266+
<ResponseStatus>
14267+
<ErrorCode>12055</ErrorCode>
14268+
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
14269+
</ResponseStatus>
14270+
</BrandVettingResponse>
14271+
schema:
14272+
$ref: '#/components/schemas/BrandVettingsErrorResponse'
14273+
description: Error Response
14274+
tags:
14275+
- 10DLC
1397914276
/accounts/{accountId}/campaignManagement/10dlc/campaigns/imports:
1398014277
get:
1398114278
description: >-

0 commit comments

Comments
 (0)