diff --git a/api/openapi.yaml b/api/openapi.yaml index 4e150bf1..5a90fb23 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -780,6 +780,7 @@ paths: - description: "Not intended for explicit use. To use pagination, follow the\ \ links in the `Link` header of the response, as indicated in the endpoint\ \ description." + example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9 explode: true in: query name: pageToken @@ -1434,6 +1435,7 @@ paths: - description: "Not intended for explicit use. To use pagination, follow the\ \ links in the `Link` header of the response, as indicated in the endpoint\ \ description." + example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9 explode: true in: query name: pageToken @@ -6309,6 +6311,7 @@ components: pageToken1: description: "Not intended for explicit use. To use pagination, follow the links\ \ in the `Link` header of the response, as indicated in the endpoint description." + example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9 explode: true in: query name: pageToken @@ -7296,12 +7299,14 @@ components: enum: - INBOUND - OUTBOUND + example: INBOUND type: string messageDirectionEnum: description: The direction of the message. One of in out. enum: - in - out + example: in type: string messageTypeEnum: description: The type of message. Either SMS or MMS. @@ -11546,20 +11551,23 @@ components: type: string useCaseSummary: description: A general idea of the use case and customer. + example: Text summarizing the use case for the toll-free number maxLength: 500 - minLength: 1 + minLength: 0 nullable: false type: string productionMessageContent: description: Example of message content. + example: Production message content maxLength: 500 - minLength: 1 + minLength: 0 nullable: false type: string optInWorkflow: $ref: '#/components/schemas/optInWorkflow' additionalInformation: description: Any additional information. + example: Any additional information maxLength: 500 minLength: 0 nullable: true @@ -11601,12 +11609,14 @@ components: type: string useCaseSummary: description: A general idea of the use case and customer. + example: Text summarizing the use case for the toll-free number maxLength: 500 minLength: 0 nullable: false type: string productionMessageContent: description: Example of message content. + example: Production message content maxLength: 500 minLength: 0 nullable: false @@ -11638,9 +11648,11 @@ components: tfvBasicAuthentication: properties: username: + example: username maxLength: 100 type: string password: + example: password maxLength: 200 type: string required: @@ -11798,7 +11810,7 @@ components: address: example: zip: "27606" - addr2: addr2 + addr2: 2230 Bandmate Way addr1: 2230 Bandmate Way city: Raleigh name: Bandwidth Inc. @@ -11822,6 +11834,7 @@ components: type: string addr2: description: The address of the business using the toll-free number. + example: 2230 Bandmate Way maxLength: 500 minLength: 0 nullable: true @@ -11862,6 +11875,12 @@ components: - url - zip type: object + additionalInformation: + description: Any additional information. + maxLength: 500 + minLength: 0 + nullable: true + type: string optInWorkflow: example: imageUrls: @@ -11981,6 +12000,20 @@ components: maxLength: 500 minLength: 0 type: string + useCaseSummary: + description: A general idea of the use case and customer. + example: Text summarizing the use case for the toll-free number + maxLength: 500 + minLength: 0 + nullable: false + type: string + productionMessageContent: + description: Example of message content. + example: Production message content + maxLength: 500 + minLength: 0 + nullable: false + type: string webhookSubscriptionsListBody: description: A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated). @@ -12179,7 +12212,7 @@ components: createdDateTime: 2021-06-08T06:45:13Z modifiedDateTime: 2021-06-08T06:45:13Z submission: - additionalInformation: Any additional information + additionalInformation: additionalInformation useCase: 2FA isvReseller: Test ISV businessContact: @@ -12191,7 +12224,7 @@ components: productionMessageContent: Production message content businessAddress: zip: "27606" - addr2: addr2 + addr2: 2230 Bandmate Way addr1: 2230 Bandmate Way city: Raleigh name: Bandwidth Inc. @@ -12250,7 +12283,7 @@ components: type: object tfvSubmissionInfo: example: - additionalInformation: Any additional information + additionalInformation: additionalInformation useCase: 2FA isvReseller: Test ISV businessContact: @@ -12262,7 +12295,7 @@ components: productionMessageContent: Production message content businessAddress: zip: "27606" - addr2: addr2 + addr2: 2230 Bandmate Way addr1: 2230 Bandmate Way city: Raleigh name: Bandwidth Inc. @@ -12309,7 +12342,6 @@ components: $ref: '#/components/schemas/optInWorkflow' additionalInformation: description: Any additional information. - example: Any additional information maxLength: 500 minLength: 0 nullable: true diff --git a/bandwidth.yml b/bandwidth.yml index 801e18f9..8f3d160b 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -1641,12 +1641,14 @@ components: enum: - INBOUND - OUTBOUND + example: INBOUND messageDirectionEnum: type: string description: The direction of the message. One of in out. enum: - in - out + example: in messageTypeEnum: type: string description: The type of message. Either SMS or MMS. @@ -4797,17 +4799,9 @@ components: useCase: $ref: '#/components/schemas/useCase' useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 1 - maxLength: 500 - nullable: false + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - type: string - description: Example of message content. - minLength: 1 - maxLength: 500 - nullable: false + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: $ref: '#/components/schemas/optInWorkflow' additionalInformation: @@ -4816,6 +4810,7 @@ components: minLength: 0 maxLength: 500 nullable: true + example: Any additional information isvReseller: $ref: '#/components/schemas/isvReseller' verificationUpdateRequest: @@ -4842,25 +4837,13 @@ components: useCase: $ref: '#/components/schemas/useCase' useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 0 - maxLength: 500 - nullable: false + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - type: string - description: Example of message content. - minLength: 0 - maxLength: 500 - nullable: false + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: $ref: '#/components/schemas/optInWorkflow' additionalInformation: - type: string - description: Any additional information. - minLength: 0 - maxLength: 500 - nullable: true + $ref: '#/components/schemas/additionalInformation' isvReseller: $ref: '#/components/schemas/isvReseller' tfvBasicAuthentication: @@ -4869,9 +4852,11 @@ components: username: type: string maxLength: 100 + example: username password: type: string maxLength: 200 + example: password required: - username - password @@ -4986,6 +4971,7 @@ components: minLength: 0 maxLength: 500 nullable: true + example: 2230 Bandmate Way city: type: string description: The city of the business using the toll-free number. @@ -5014,6 +5000,12 @@ components: maxLength: 500 nullable: false example: https://www.example.com/path/to/resource + additionalInformation: + type: string + description: Any additional information. + minLength: 0 + maxLength: 500 + nullable: true optInWorkflow: type: object nullable: false @@ -5101,6 +5093,20 @@ components: minLength: 0 maxLength: 500 example: 2FA + useCaseSummary: + type: string + description: A general idea of the use case and customer. + minLength: 0 + maxLength: 500 + nullable: false + example: Text summarizing the use case for the toll-free number + productionMessageContent: + type: string + description: Example of message content. + minLength: 0 + maxLength: 500 + nullable: false + example: Production message content webhookSubscriptionsListBody: description: >- A list of all webhook subscriptions registered for this account ID for @@ -5277,28 +5283,13 @@ components: useCase: $ref: '#/components/schemas/useCase' useCaseSummary: - type: string - description: A general idea of the use case and customer. - minLength: 0 - maxLength: 500 - nullable: false - example: Text summarizing the use case for the toll-free number + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - type: string - description: Example of message content. - minLength: 0 - maxLength: 500 - nullable: false - example: Production message content + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: $ref: '#/components/schemas/optInWorkflow' additionalInformation: - type: string - description: Any additional information. - minLength: 0 - maxLength: 500 - nullable: true - example: Any additional information + $ref: '#/components/schemas/additionalInformation' isvReseller: $ref: '#/components/schemas/isvReseller' tfvStatusEnum: @@ -6235,6 +6226,7 @@ components: Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. + example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9 disconnectCause: name: disconnectCause in: query diff --git a/docs/CallsApi.md b/docs/CallsApi.md index f02b185c..19512af8 100644 --- a/docs/CallsApi.md +++ b/docs/CallsApi.md @@ -203,7 +203,7 @@ public class Example { String maxStartTime = "2022-06-21T19:13:21Z"; // String | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). String disconnectCause = "hangup"; // String | Filter results to calls with specified call Disconnect Cause. Integer pageSize = 1000; // Integer | Specifies the max number of calls that will be returned. - String pageToken = "pageToken_example"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. + String pageToken = "eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. try { List result = apiInstance.listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken); System.out.println(result); diff --git a/docs/ConferencesApi.md b/docs/ConferencesApi.md index 6a51cbea..74750e16 100644 --- a/docs/ConferencesApi.md +++ b/docs/ConferencesApi.md @@ -445,7 +445,7 @@ public class Example { String minCreatedTime = "2022-06-21T19:13:21Z"; // String | Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). String maxCreatedTime = "2022-06-21T19:13:21Z"; // String | Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). Integer pageSize = 1000; // Integer | Specifies the max number of conferences that will be returned. - String pageToken = "pageToken_example"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. + String pageToken = "eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9"; // String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. try { List result = apiInstance.listConferences(accountId, name, minCreatedTime, maxCreatedTime, pageSize, pageToken); System.out.println(result);