From 629a5815957049f75a07e5f82b244e14a40373f3 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth <42817071+DX-Bandwidth@users.noreply.github.com> Date: Tue, 8 Nov 2022 16:34:45 -0500 Subject: [PATCH] bwdb-14275-10dlc (#807) * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files --- site/specs/numbers.yml | 313 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 305 insertions(+), 8 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index ad3b8622d..daf28521b 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -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: @@ -13855,14 +13965,17 @@ paths: tags: - 10DLC post: - 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.

+ 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' @@ -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: |- + + + + 69823255-96b3-412f-9120-3e77f94c6be5 + PENDING + + + schema: + $ref: '#/components/schemas/BrandVettingsResponse' + description: OK + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 12055 + 'LONG_CODE' feature is not enabled on account 900000 + + + 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: |- + + + AEGIS + STANDARD + + schema: + $ref: '#/components/schemas/BrandVettingRequest' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + BJDHM3 + CMHSJ9 + ACTIVE + 111111111 + + + schema: + $ref: '#/components/schemas/BrandVettingsResponse' + description: OK + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 12055 + 'LONG_CODE' feature is not enabled on account 900000 + + + 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: |- + + + AEGIS + b62ed6ba-20f7-4031-a5fa-68e96cd6c036 + + schema: + $ref: '#/components/schemas/BrandVettingImportRequest' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + BJDHM3 + CMHSJ9 + PUBLIC_PROFIT + 111111111 + + + schema: + $ref: '#/components/schemas/BrandVettingImportResponse' + description: OK + '400': + content: + application/xml: + examples: + example: + value: |- + + + + 12055 + 'LONG_CODE' feature is not enabled on account 900000 + + + schema: + $ref: '#/components/schemas/BrandVettingsErrorResponse' + description: Error Response + tags: + - 10DLC /accounts/{accountId}/campaignManagement/10dlc/campaigns/imports: get: description: >-