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

Commit

Permalink
bwdb-14275-10dlc (#807)
Browse files Browse the repository at this point in the history 
* Add Code Snippets to Spec Files

* Add Code Snippets to Spec Files
  • Loading branch information
@DX-Bandwidth
DX-Bandwidth authored Nov 8, 2022
1 parent 973cb71 commit 629a581
Showing 1 changed file with 305 additions and 8 deletions.
313 changes: 305 additions & 8 deletions site/specs/numbers.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1286,6 +1286,116 @@ components:
$ref: '#/components/schemas/Brand'
type: object
type: object
BrandVetting:
properties:
VettingClass:
description: Identifies the vetting classification.
enum:
- STANDARD
- ENHANCED
- POLITICAL
type: string
VettingId:
description: >-
Unique ID that identifies a vetting transaction performed by a
vetting provider. This ID is provided by the vetting provider at
time of vetting.
type: string
type: object
BrandVettingImportRequest:
properties:
BrandVetting:
properties:
EvpId:
description: >-
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
CV(Campaign Verify), WMC(WMC Global)
enum:
- AEGIS
- CV
- WMC
type: string
VettingId:
description: >-
Unique ID that identifies a vetting transaction performed by a
vetting provider. This ID is provided by the vetting provider at
time of vetting.
type: string
type: object
type: object
BrandVettingImportResponse:
properties:
BrandVetting:
properties:
BrandId:
description: Unique ID that identifies a brand.
type: string
EvpId:
description: >-
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
CV(Campaign Verify), WMC(WMC Global)
enum:
- AEGIS
- CV
- WMC
type: string
VettingId:
description: >-
Unique ID that identifies a vetting transaction performed by a
vetting provider. This ID is provided by the vetting provider at
time of vetting.
type: string
VettingStatus:
description: >-
Identifies the vetting request status. PENDING, UNSCORE,
ACTIVE, FAILED, EXPIRED ]
enum:
- PENDING
- UNSCORE
- ACTIVE
- FAILED
- EXPIRED
type: string
type: object
type: object
BrandVettingRequest:
properties:
BrandVetting:
properties:
EvpId:
description: >-
External vetting provider ID for the brand. AEGIS(Aegis Mobile),
CV(Campaign Verify), WMC(WMC Global)
enum:
- AEGIS
- CV
- WMC
type: string
VettingClass:
description: Identifies the vetting classification.
enum:
- STANDARD
- ENHANCED
- POLITICAL
type: string
type: object
type: object
BrandVettingsErrorResponse:
properties:
BrandVettingsResponse:
properties:
BrandVetting:
$ref: '#/components/schemas/ResponseStatus'
type: object
type: object
BrandVettingsResponse:
properties:
BrandVettingsResponse:
properties:
BrandVetting:
$ref: '#/components/schemas/BrandVetting'
type: object
type: object
BrandsErrorResponse:
properties:
BrandsResponse:
Expand Down Expand Up @@ -13855,14 +13965,17 @@ paths:
tags:
- 10DLC
post:
description: >-
<p>Create campaign registry brand on the Account</p><p>My Brand Note:
Regardless of if you are a DirectCustomer or Reseller, you will need to
create a 'My Brand'. You can only create one of these. On the Request
Body you can indicate a 'My Brand' by setting the IsMain flag to
true.</p><p>Please visit <a
href='/docs/messaging/campaign-management/csp/reseller-brand-api/'>Brand
and Reseller Management.</a></p>
description: >
Create campaign registry brand on the Account.

My Brand Note Regardless of if you are a DirectCustomer or Reseller, you
will need to create a My Brand.

You can only create one of these. On the Request Body you can indicate a
My Brand by setting the IsMain flag to true.

Please visit [Brand and Reseller
Management](/docs/messaging/campaign-management/csp/reseller-brand-api)
operationId: Create brand
parameters:
- $ref: '#/components/parameters/AccountIdPathParam'
Expand Down Expand Up @@ -13976,6 +14089,190 @@ paths:
description: Error Response
tags:
- 10DLC
/accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}/vetting:
get:
description: Retrieve brand external vetting records
operationId: Retrieve brand vettings
parameters:
- $ref: '#/components/parameters/AccountIdPathParam'
- description: Brand id.
example: B5DG4HH
in: path
name: brandId
required: true
schema:
type: string
- description: Vetting provider ID.
example: AEGIS
in: query
name: evpId
schema:
type: string
- description: Vetting class.
example: STANDARD
in: query
name: vettingClass
schema:
type: string
responses:
'200':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<BrandVetting>
<VettingId>69823255-96b3-412f-9120-3e77f94c6be5</VettingId>
<VettingStatus>PENDING</VettingStatus>
</BrandVetting>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingsResponse'
description: OK
'400':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<ResponseStatus>
<ErrorCode>12055</ErrorCode>
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
</ResponseStatus>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingsErrorResponse'
description: Error Response
tags:
- 10DLC
post:
description: Create brand an external vetting
operationId: Create brand vetting
parameters:
- $ref: '#/components/parameters/AccountIdPathParam'
- description: Brand id.
example: B5DG4HH
in: path
name: brandId
required: true
schema:
type: string
requestBody:
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Brand>
<EvpId>AEGIS</EvpId>
<VettingClass>STANDARD</VettingClass>
</Brand>
schema:
$ref: '#/components/schemas/BrandVettingRequest'
responses:
'200':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<BrandVetting>
<EvpId>BJDHM3</EvpId>
<VettingId>CMHSJ9</VettingId>
<VettingStatus>ACTIVE</VettingStatus>
<BrandId>111111111</BrandId>
</BrandVetting>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingsResponse'
description: OK
'400':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<ResponseStatus>
<ErrorCode>12055</ErrorCode>
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
</ResponseStatus>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingsErrorResponse'
description: Error Response
tags:
- 10DLC
put:
description: Import brand external vetting records
operationId: Import brand vetting
parameters:
- $ref: '#/components/parameters/AccountIdPathParam'
- description: Brand id.
example: B5DG4HH
in: path
name: brandId
required: true
schema:
type: string
requestBody:
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Brand>
<EvpId>AEGIS</EvpId>
<VettingId>b62ed6ba-20f7-4031-a5fa-68e96cd6c036</VettingId>
</Brand>
schema:
$ref: '#/components/schemas/BrandVettingImportRequest'
responses:
'200':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<BrandVetting>
<EvpId>BJDHM3</EvpId>
<VettingId>CMHSJ9</VettingId>
<VettingStatus>PUBLIC_PROFIT</VettingStatus>
<BrandId>111111111</BrandId>
</BrandVetting>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingImportResponse'
description: OK
'400':
content:
application/xml:
examples:
example:
value: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BrandVettingResponse>
<ResponseStatus>
<ErrorCode>12055</ErrorCode>
<Description>'LONG_CODE' feature is not enabled on account 900000</Description>
</ResponseStatus>
</BrandVettingResponse>
schema:
$ref: '#/components/schemas/BrandVettingsErrorResponse'
description: Error Response
tags:
- 10DLC
/accounts/{accountId}/campaignManagement/10dlc/campaigns/imports:
get:
description: >-
Expand Down

0 comments on commit 629a581

Please sign in to comment.