Skip to content

Commit 3f2d138

Browse files
Merge pull request #102 from Bandwidth/SWI-3665
SWI-3665 Update SDK Based on Recent Spec Changes
2 parents 123f100 + e50253e commit 3f2d138

File tree

90 files changed

+750
-100
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+750
-100
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.github/workflows/maven.yml
2-
.gitignore
31
.travis.yml
42
README.md
53
api/openapi.yaml

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Bandwidth
44
- API version: 1.0.0
5-
- Build date: 2023-08-29T14:24:34.966664-04:00[America/New_York]
5+
- Build date: 2023-10-03T14:41:14.487203Z[Etc/UTC]
66

77
Bandwidth's Communication APIs
88

@@ -124,6 +124,7 @@ Class | Method | HTTP request | Description
124124
------------ | ------------- | ------------- | -------------
125125
*CallsApi* | [**createCall**](docs/CallsApi.md#createCall) | **POST** /accounts/{accountId}/calls | Create Call
126126
*CallsApi* | [**getCallState**](docs/CallsApi.md#getCallState) | **GET** /accounts/{accountId}/calls/{callId} | Get Call State Information
127+
*CallsApi* | [**listCalls**](docs/CallsApi.md#listCalls) | **GET** /accounts/{accountId}/calls | Get Calls
127128
*CallsApi* | [**updateCall**](docs/CallsApi.md#updateCall) | **POST** /accounts/{accountId}/calls/{callId} | Update Call
128129
*CallsApi* | [**updateCallBxml**](docs/CallsApi.md#updateCallBxml) | **PUT** /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML
129130
*ConferencesApi* | [**downloadConferenceRecording**](docs/ConferencesApi.md#downloadConferenceRecording) | **GET** /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media | Download Conference Recording

api/openapi.yaml

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,185 @@ paths:
693693
- description: Production
694694
url: https://messaging.bandwidth.com/api/v2
695695
/accounts/{accountId}/calls:
696+
get:
697+
description: |-
698+
Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest.
699+
700+
**NOTE:** If the number of calls in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel="next"`) will be returned in the response. The url can be used to retrieve the next page of call records.
701+
Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
702+
operationId: listCalls
703+
parameters:
704+
- description: Your Bandwidth Account ID.
705+
example: "9900000"
706+
explode: false
707+
in: path
708+
name: accountId
709+
required: true
710+
schema:
711+
type: string
712+
style: simple
713+
- description: Filter results by the `to` field.
714+
example: '%2b19195551234'
715+
explode: true
716+
in: query
717+
name: to
718+
required: false
719+
schema:
720+
type: string
721+
style: form
722+
- description: Filter results by the `from` field.
723+
example: '%2b19195554321'
724+
explode: true
725+
in: query
726+
name: from
727+
required: false
728+
schema:
729+
type: string
730+
style: form
731+
- description: Filter results to calls which have a `startTime` after or including
732+
`minStartTime` (in ISO8601 format).
733+
example: 2022-06-21T19:13:21Z
734+
explode: true
735+
in: query
736+
name: minStartTime
737+
required: false
738+
schema:
739+
type: string
740+
style: form
741+
- description: Filter results to calls which have a `startTime` before or including
742+
`maxStartTime` (in ISO8601 format).
743+
example: 2022-06-21T19:13:21Z
744+
explode: true
745+
in: query
746+
name: maxStartTime
747+
required: false
748+
schema:
749+
type: string
750+
style: form
751+
- description: Filter results to calls with specified call Disconnect Cause.
752+
example: hangup
753+
explode: true
754+
in: query
755+
name: disconnectCause
756+
required: false
757+
schema:
758+
type: string
759+
style: form
760+
- description: Specifies the max number of calls that will be returned.
761+
example: 500
762+
explode: true
763+
in: query
764+
name: pageSize
765+
required: false
766+
schema:
767+
default: 1000
768+
format: int32
769+
maximum: 10000
770+
minimum: 1
771+
type: integer
772+
style: form
773+
- description: "Not intended for explicit use. To use pagination, follow the\
774+
\ links in the `Link` header of the response, as indicated in the endpoint\
775+
\ description."
776+
explode: true
777+
in: query
778+
name: pageToken
779+
required: false
780+
schema:
781+
type: string
782+
style: form
783+
responses:
784+
"200":
785+
content:
786+
application/json:
787+
schema:
788+
items:
789+
$ref: '#/components/schemas/callState'
790+
type: array
791+
description: Calls retrieved successfully
792+
"400":
793+
content:
794+
application/json:
795+
examples:
796+
badRequestErrorExample:
797+
$ref: '#/components/examples/voiceBadRequestErrorExample'
798+
schema:
799+
$ref: '#/components/schemas/voiceApiError'
800+
description: Bad Request
801+
"401":
802+
content:
803+
application/json:
804+
examples:
805+
unauthorizedErrorExample:
806+
$ref: '#/components/examples/voiceUnauthorizedErrorExample'
807+
schema:
808+
$ref: '#/components/schemas/voiceApiError'
809+
description: Unauthorized
810+
"403":
811+
content:
812+
application/json:
813+
examples:
814+
forbiddenErrorExample:
815+
$ref: '#/components/examples/voiceForbiddenErrorExample'
816+
schema:
817+
$ref: '#/components/schemas/voiceApiError'
818+
description: Forbidden
819+
"404":
820+
content:
821+
application/json:
822+
examples:
823+
notFoundErrorExample:
824+
$ref: '#/components/examples/voiceNotFoundErrorExample'
825+
schema:
826+
$ref: '#/components/schemas/voiceApiError'
827+
description: Not Found
828+
"405":
829+
content:
830+
application/json:
831+
examples:
832+
notAllowedErrorExample:
833+
$ref: '#/components/examples/voiceNotAllowedErrorExample'
834+
schema:
835+
$ref: '#/components/schemas/voiceApiError'
836+
description: Method Not Allowed
837+
"415":
838+
content:
839+
application/json:
840+
examples:
841+
tooManyRequestsErrorExample:
842+
$ref: '#/components/examples/voiceUnsupportedMediaTypeErrorExample'
843+
schema:
844+
$ref: '#/components/schemas/voiceApiError'
845+
description: Unsupported Media Type
846+
"429":
847+
content:
848+
application/json:
849+
examples:
850+
tooManyRequestsErrorExample:
851+
$ref: '#/components/examples/voiceTooManyRequestsErrorExample'
852+
schema:
853+
$ref: '#/components/schemas/voiceApiError'
854+
description: Too Many Requests
855+
headers:
856+
Retry-After:
857+
description: When you should try your request again.
858+
explode: false
859+
schema:
860+
type: string
861+
style: simple
862+
"500":
863+
content:
864+
application/json:
865+
examples:
866+
internalServerErrorExample:
867+
$ref: '#/components/examples/voiceInternalServerErrorExample'
868+
schema:
869+
$ref: '#/components/schemas/voiceApiError'
870+
description: Internal Server Error
871+
summary: Get Calls
872+
tags:
873+
- Calls
874+
x-accepts: application/json
696875
post:
697876
description: |-
698877
Creates an outbound phone call.
@@ -4601,6 +4780,42 @@ components:
46014780
minimum: 1
46024781
type: integer
46034782
style: form
4783+
minStartTimeCalls:
4784+
description: Filter results to calls which have a `startTime` after or including
4785+
`minStartTime` (in ISO8601 format).
4786+
example: 2022-06-21T19:13:21Z
4787+
explode: true
4788+
in: query
4789+
name: minStartTime
4790+
required: false
4791+
schema:
4792+
type: string
4793+
style: form
4794+
maxStartTimeCalls:
4795+
description: Filter results to calls which have a `startTime` before or including
4796+
`maxStartTime` (in ISO8601 format).
4797+
example: 2022-06-21T19:13:21Z
4798+
explode: true
4799+
in: query
4800+
name: maxStartTime
4801+
required: false
4802+
schema:
4803+
type: string
4804+
style: form
4805+
pageSizeCalls:
4806+
description: Specifies the max number of calls that will be returned.
4807+
example: 500
4808+
explode: true
4809+
in: query
4810+
name: pageSize
4811+
required: false
4812+
schema:
4813+
default: 1000
4814+
format: int32
4815+
maximum: 10000
4816+
minimum: 1
4817+
type: integer
4818+
style: form
46044819
pageToken1:
46054820
description: "Not intended for explicit use. To use pagination, follow the links\
46064821
\ in the `Link` header of the response, as indicated in the endpoint description."
@@ -4611,6 +4826,16 @@ components:
46114826
schema:
46124827
type: string
46134828
style: form
4829+
disconnectCause:
4830+
description: Filter results to calls with specified call Disconnect Cause.
4831+
example: hangup
4832+
explode: true
4833+
in: query
4834+
name: disconnectCause
4835+
required: false
4836+
schema:
4837+
type: string
4838+
style: form
46144839
requestId:
46154840
description: The phone number lookup request ID from Bandwidth.
46164841
example: 004223a0-8b17-41b1-bf81-20732adf5590
@@ -5021,6 +5246,14 @@ components:
50215246
schema:
50225247
$ref: '#/components/schemas/callState'
50235248
description: Call found
5249+
listCallsResponse:
5250+
content:
5251+
application/json:
5252+
schema:
5253+
items:
5254+
$ref: '#/components/schemas/callState'
5255+
type: array
5256+
description: Calls retrieved successfully
50245257
getStatisticsResponse:
50255258
content:
50265259
application/json:

0 commit comments

Comments
 (0)