bandwidth-sdk 3.2.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/.github/workflows/deploy.yml +1 -0
  2. package/.openapi-generator/FILES +3 -8
  3. package/bandwidth.yml +422 -475
  4. package/configuration.ts +1 -1
  5. package/coverage/clover.xml +9 -10
  6. package/coverage/coverage-final.json +2 -1
  7. package/coverage/lcov-report/index.html +7 -7
  8. package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
  9. package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
  10. package/coverage/lcov-report/node-sdk/api/index.html +1 -1
  11. package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
  12. package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
  13. package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
  14. package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
  15. package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
  16. package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
  17. package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
  18. package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
  19. package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
  20. package/coverage/lcov-report/node-sdk/common.ts.html +1 -1
  21. package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
  22. package/coverage/lcov-report/node-sdk/index.html +1 -1
  23. package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
  24. package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
  25. package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
  26. package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
  27. package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
  28. package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
  29. package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
  30. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
  31. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
  32. package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
  33. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
  34. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
  35. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
  36. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
  37. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
  38. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
  39. package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
  40. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
  41. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
  42. package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
  43. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
  44. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
  45. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
  46. package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
  47. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
  48. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
  49. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
  50. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
  51. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
  52. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
  53. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
  54. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
  55. package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
  56. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
  57. package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
  58. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
  59. package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
  60. package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
  61. package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
  62. package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
  63. package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
  64. package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
  65. package/coverage/lcov-report/node-sdk/models/callback-type-enum.ts.html +184 -0
  66. package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
  67. package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
  68. package/coverage/lcov-report/node-sdk/models/index.html +20 -5
  69. package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -22
  70. package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
  71. package/coverage/lcov-report/node-sdk/models/lookup-status-enum.ts.html +1 -1
  72. package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
  73. package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
  74. package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
  75. package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
  76. package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
  77. package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
  78. package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
  79. package/coverage/lcov.info +12 -7
  80. package/dist/configuration.js +1 -1
  81. package/dist/models/callback-type-enum.d.ts +23 -0
  82. package/dist/models/{message-delivered-callback-message.js → callback-type-enum.js} +12 -0
  83. package/dist/models/create-call.d.ts +1 -1
  84. package/dist/models/index.d.ts +3 -8
  85. package/dist/models/index.js +3 -8
  86. package/dist/models/{message-sending-callback-message.d.ts → message-callback-message.d.ts} +17 -17
  87. package/dist/models/message-callback.d.ts +56 -0
  88. package/models/callback-type-enum.ts +33 -0
  89. package/models/create-call.ts +1 -1
  90. package/models/index.ts +3 -8
  91. package/models/{message-sending-callback-message.ts → message-callback-message.ts} +17 -17
  92. package/models/message-callback.ts +68 -0
  93. package/package.json +1 -1
  94. package/tests/unit/models/callback-type-enum.test.ts +10 -0
  95. package/dist/models/inbound-message-callback-message.d.ts +0 -92
  96. package/dist/models/inbound-message-callback.d.ts +0 -49
  97. package/dist/models/message-delivered-callback-message.d.ts +0 -92
  98. package/dist/models/message-delivered-callback.d.ts +0 -49
  99. package/dist/models/message-delivered-callback.js +0 -15
  100. package/dist/models/message-failed-callback-message.d.ts +0 -92
  101. package/dist/models/message-failed-callback-message.js +0 -15
  102. package/dist/models/message-failed-callback.d.ts +0 -55
  103. package/dist/models/message-failed-callback.js +0 -15
  104. package/dist/models/message-sending-callback-message.js +0 -15
  105. package/dist/models/message-sending-callback.d.ts +0 -49
  106. package/dist/models/message-sending-callback.js +0 -15
  107. package/dist/models/transcription-list.d.ts +0 -25
  108. package/dist/models/transcription-list.js +0 -15
  109. package/dist/models/transcription-metadata.d.ts +0 -42
  110. package/dist/models/transcription-metadata.js +0 -15
  111. package/models/inbound-message-callback-message.ts +0 -104
  112. package/models/inbound-message-callback.ts +0 -57
  113. package/models/message-delivered-callback-message.ts +0 -104
  114. package/models/message-delivered-callback.ts +0 -57
  115. package/models/message-failed-callback-message.ts +0 -104
  116. package/models/message-failed-callback.ts +0 -63
  117. package/models/message-sending-callback.ts +0 -57
  118. package/models/transcription-list.ts +0 -33
  119. package/models/transcription-metadata.ts +0 -48
  120. /package/dist/models/{inbound-message-callback-message.js → message-callback-message.js} +0 -0
  121. /package/dist/models/{inbound-message-callback.js → message-callback.js} +0 -0
@@ -163,7 +163,7 @@ export type MessageTypeEnum = typeof MessageTypeEnum[keyof typeof MessageTypeEnu
163
163
  <div class='footer quiet pad2 space-top1 center small'>
164
164
  Code coverage generated by
165
165
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
166
- at 2024-12-10T18:39:11.715Z
166
+ at 2025-01-21T18:00:10.051Z
167
167
  </div>
168
168
  <script src="../../prettify.js"></script>
169
169
  <script>
@@ -163,7 +163,7 @@ export type PriorityEnum = typeof PriorityEnum[keyof typeof PriorityEnum];
163
163
  <div class='footer quiet pad2 space-top1 center small'>
164
164
  Code coverage generated by
165
165
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
166
- at 2024-12-10T18:39:11.715Z
166
+ at 2025-01-21T18:00:10.051Z
167
167
  </div>
168
168
  <script src="../../prettify.js"></script>
169
169
  <script>
@@ -163,7 +163,7 @@ export type RecordingStateEnum = typeof RecordingStateEnum[keyof typeof Recordin
163
163
  <div class='footer quiet pad2 space-top1 center small'>
164
164
  Code coverage generated by
165
165
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
166
- at 2024-12-10T18:39:11.715Z
166
+ at 2025-01-21T18:00:10.051Z
167
167
  </div>
168
168
  <script src="../../prettify.js"></script>
169
169
  <script>
@@ -163,7 +163,7 @@ export type RedirectMethodEnum = typeof RedirectMethodEnum[keyof typeof Redirect
163
163
  <div class='footer quiet pad2 space-top1 center small'>
164
164
  Code coverage generated by
165
165
  <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
166
- at 2024-12-10T18:39:11.715Z
166
+ at 2025-01-21T18:00:10.051Z
167
167
  </div>
168
168
  <script src="../../prettify.js"></script>
169
169
  <script>
@@ -3084,6 +3084,16 @@ BRF:0
3084
3084
  BRH:0
3085
3085
  end_of_record
3086
3086
  TN:
3087
+ SF:models/callback-type-enum.ts
3088
+ FNF:0
3089
+ FNH:0
3090
+ DA:23,7
3091
+ LF:1
3092
+ LH:1
3093
+ BRF:0
3094
+ BRH:0
3095
+ end_of_record
3096
+ TN:
3087
3097
  SF:models/conference-state-enum.ts
3088
3098
  FNF:0
3089
3099
  FNH:0
@@ -3196,13 +3206,8 @@ DA:86,6
3196
3206
  DA:87,6
3197
3207
  DA:88,6
3198
3208
  DA:89,6
3199
- DA:90,6
3200
- DA:91,6
3201
- DA:92,6
3202
- DA:93,6
3203
- DA:94,6
3204
- LF:94
3205
- LH:94
3209
+ LF:89
3210
+ LH:89
3206
3211
  BRF:0
3207
3212
  BRH:0
3208
3213
  end_of_record
@@ -35,7 +35,7 @@ var Configuration = /** @class */ (function () {
35
35
  this.accessToken = param.accessToken;
36
36
  this.basePath = param.basePath;
37
37
  this.serverIndex = param.serverIndex;
38
- this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/3.2.0/typescript-axios" }) });
38
+ this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign(__assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/4.0.0/typescript-axios" }) });
39
39
  this.formDataCtor = param.formDataCtor;
40
40
  }
41
41
  /**
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const CallbackTypeEnum: {
18
+ readonly Received: "message-received";
19
+ readonly Sending: "message-sending";
20
+ readonly Delivered: "message-delivered";
21
+ readonly Failed: "message-failed";
22
+ };
23
+ export type CallbackTypeEnum = typeof CallbackTypeEnum[keyof typeof CallbackTypeEnum];
@@ -13,3 +13,15 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CallbackTypeEnum = void 0;
17
+ /**
18
+ * Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.CallbackTypeEnum = {
23
+ Received: 'message-received',
24
+ Sending: 'message-sending',
25
+ Delivered: 'message-delivered',
26
+ Failed: 'message-failed'
27
+ };
@@ -42,7 +42,7 @@ export interface CreateCall {
42
42
  */
43
43
  'displayName'?: string | null;
44
44
  /**
45
- * A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\' and \'base64\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators.
45
+ * A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators.
46
46
  * @type {string}
47
47
  * @memberof CreateCall
48
48
  */
@@ -12,6 +12,7 @@ export * from './call-transcription-metadata';
12
12
  export * from './call-transcription-response';
13
13
  export * from './call-transcription-track-enum';
14
14
  export * from './callback-method-enum';
15
+ export * from './callback-type-enum';
15
16
  export * from './code-request';
16
17
  export * from './conference';
17
18
  export * from './conference-completed-callback';
@@ -34,8 +35,6 @@ export * from './dtmf-callback';
34
35
  export * from './field-error';
35
36
  export * from './file-format-enum';
36
37
  export * from './gather-callback';
37
- export * from './inbound-message-callback';
38
- export * from './inbound-message-callback-message';
39
38
  export * from './initiate-callback';
40
39
  export * from './list-message-direction-enum';
41
40
  export * from './list-message-item';
@@ -49,14 +48,10 @@ export * from './machine-detection-mode-enum';
49
48
  export * from './machine-detection-result';
50
49
  export * from './media';
51
50
  export * from './message';
52
- export * from './message-delivered-callback';
53
- export * from './message-delivered-callback-message';
51
+ export * from './message-callback';
52
+ export * from './message-callback-message';
54
53
  export * from './message-direction-enum';
55
- export * from './message-failed-callback';
56
- export * from './message-failed-callback-message';
57
54
  export * from './message-request';
58
- export * from './message-sending-callback';
59
- export * from './message-sending-callback-message';
60
55
  export * from './message-status-enum';
61
56
  export * from './message-type-enum';
62
57
  export * from './messages-list';
@@ -28,6 +28,7 @@ __exportStar(require("./call-transcription-metadata"), exports);
28
28
  __exportStar(require("./call-transcription-response"), exports);
29
29
  __exportStar(require("./call-transcription-track-enum"), exports);
30
30
  __exportStar(require("./callback-method-enum"), exports);
31
+ __exportStar(require("./callback-type-enum"), exports);
31
32
  __exportStar(require("./code-request"), exports);
32
33
  __exportStar(require("./conference"), exports);
33
34
  __exportStar(require("./conference-completed-callback"), exports);
@@ -50,8 +51,6 @@ __exportStar(require("./dtmf-callback"), exports);
50
51
  __exportStar(require("./field-error"), exports);
51
52
  __exportStar(require("./file-format-enum"), exports);
52
53
  __exportStar(require("./gather-callback"), exports);
53
- __exportStar(require("./inbound-message-callback"), exports);
54
- __exportStar(require("./inbound-message-callback-message"), exports);
55
54
  __exportStar(require("./initiate-callback"), exports);
56
55
  __exportStar(require("./list-message-direction-enum"), exports);
57
56
  __exportStar(require("./list-message-item"), exports);
@@ -65,14 +64,10 @@ __exportStar(require("./machine-detection-mode-enum"), exports);
65
64
  __exportStar(require("./machine-detection-result"), exports);
66
65
  __exportStar(require("./media"), exports);
67
66
  __exportStar(require("./message"), exports);
68
- __exportStar(require("./message-delivered-callback"), exports);
69
- __exportStar(require("./message-delivered-callback-message"), exports);
67
+ __exportStar(require("./message-callback"), exports);
68
+ __exportStar(require("./message-callback-message"), exports);
70
69
  __exportStar(require("./message-direction-enum"), exports);
71
- __exportStar(require("./message-failed-callback"), exports);
72
- __exportStar(require("./message-failed-callback-message"), exports);
73
70
  __exportStar(require("./message-request"), exports);
74
- __exportStar(require("./message-sending-callback"), exports);
75
- __exportStar(require("./message-sending-callback-message"), exports);
76
71
  __exportStar(require("./message-status-enum"), exports);
77
72
  __exportStar(require("./message-type-enum"), exports);
78
73
  __exportStar(require("./messages-list"), exports);
@@ -12,81 +12,81 @@
12
12
  import type { MessageDirectionEnum } from './message-direction-enum';
13
13
  import type { PriorityEnum } from './priority-enum';
14
14
  /**
15
- * Message Sending Callback Message Schema
15
+ * Message payload schema within a MessageCallback
16
16
  * @export
17
- * @interface MessageSendingCallbackMessage
17
+ * @interface MessageCallbackMessage
18
18
  */
19
- export interface MessageSendingCallbackMessage {
19
+ export interface MessageCallbackMessage {
20
20
  /**
21
21
  *
22
22
  * @type {string}
23
- * @memberof MessageSendingCallbackMessage
23
+ * @memberof MessageCallbackMessage
24
24
  */
25
25
  'id': string;
26
26
  /**
27
27
  *
28
28
  * @type {string}
29
- * @memberof MessageSendingCallbackMessage
29
+ * @memberof MessageCallbackMessage
30
30
  */
31
31
  'owner': string;
32
32
  /**
33
33
  *
34
34
  * @type {string}
35
- * @memberof MessageSendingCallbackMessage
35
+ * @memberof MessageCallbackMessage
36
36
  */
37
37
  'applicationId': string;
38
38
  /**
39
39
  *
40
40
  * @type {string}
41
- * @memberof MessageSendingCallbackMessage
41
+ * @memberof MessageCallbackMessage
42
42
  */
43
43
  'time': string;
44
44
  /**
45
45
  *
46
46
  * @type {number}
47
- * @memberof MessageSendingCallbackMessage
47
+ * @memberof MessageCallbackMessage
48
48
  */
49
49
  'segmentCount': number;
50
50
  /**
51
51
  *
52
52
  * @type {MessageDirectionEnum}
53
- * @memberof MessageSendingCallbackMessage
53
+ * @memberof MessageCallbackMessage
54
54
  */
55
55
  'direction': MessageDirectionEnum;
56
56
  /**
57
57
  *
58
58
  * @type {Set<string>}
59
- * @memberof MessageSendingCallbackMessage
59
+ * @memberof MessageCallbackMessage
60
60
  */
61
61
  'to': Set<string>;
62
62
  /**
63
63
  *
64
64
  * @type {string}
65
- * @memberof MessageSendingCallbackMessage
65
+ * @memberof MessageCallbackMessage
66
66
  */
67
67
  'from': string;
68
68
  /**
69
69
  *
70
70
  * @type {string}
71
- * @memberof MessageSendingCallbackMessage
71
+ * @memberof MessageCallbackMessage
72
72
  */
73
73
  'text': string;
74
74
  /**
75
75
  *
76
76
  * @type {string}
77
- * @memberof MessageSendingCallbackMessage
77
+ * @memberof MessageCallbackMessage
78
78
  */
79
79
  'tag'?: string;
80
80
  /**
81
- *
81
+ * Optional media, applicable only for mms
82
82
  * @type {Array<string>}
83
- * @memberof MessageSendingCallbackMessage
83
+ * @memberof MessageCallbackMessage
84
84
  */
85
- 'media': Array<string>;
85
+ 'media'?: Array<string> | null;
86
86
  /**
87
87
  *
88
88
  * @type {PriorityEnum}
89
- * @memberof MessageSendingCallbackMessage
89
+ * @memberof MessageCallbackMessage
90
90
  */
91
91
  'priority'?: PriorityEnum;
92
92
  }
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Bandwidth
3
+ * Bandwidth\'s Communication APIs
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: letstalk@bandwidth.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { CallbackTypeEnum } from './callback-type-enum';
13
+ import type { MessageCallbackMessage } from './message-callback-message';
14
+ /**
15
+ * Message Callback Schema
16
+ * @export
17
+ * @interface MessageCallback
18
+ */
19
+ export interface MessageCallback {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof MessageCallback
24
+ */
25
+ 'time': string;
26
+ /**
27
+ *
28
+ * @type {CallbackTypeEnum}
29
+ * @memberof MessageCallback
30
+ */
31
+ 'type': CallbackTypeEnum;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof MessageCallback
36
+ */
37
+ 'to': string;
38
+ /**
39
+ * A detailed description of the event described by the callback.
40
+ * @type {string}
41
+ * @memberof MessageCallback
42
+ */
43
+ 'description': string;
44
+ /**
45
+ *
46
+ * @type {MessageCallbackMessage}
47
+ * @memberof MessageCallback
48
+ */
49
+ 'message': MessageCallbackMessage;
50
+ /**
51
+ * Optional error code, applicable only when type is `message-failed`.
52
+ * @type {number}
53
+ * @memberof MessageCallback
54
+ */
55
+ 'errorCode'?: number | null;
56
+ }
@@ -0,0 +1,33 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Indicates the type of the callback: - `message-received` for inbound callbacks. - One of `message-sending`, `message-delivered`, `message-failed` for status callbacks.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const CallbackTypeEnum = {
24
+ Received: 'message-received',
25
+ Sending: 'message-sending',
26
+ Delivered: 'message-delivered',
27
+ Failed: 'message-failed'
28
+ } as const;
29
+
30
+ export type CallbackTypeEnum = typeof CallbackTypeEnum[keyof typeof CallbackTypeEnum];
31
+
32
+
33
+
@@ -51,7 +51,7 @@ export interface CreateCall {
51
51
  */
52
52
  'displayName'?: string | null;
53
53
  /**
54
- * A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\' and \'base64\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators.
54
+ * A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators.
55
55
  * @type {string}
56
56
  * @memberof CreateCall
57
57
  */
package/models/index.ts CHANGED
@@ -12,6 +12,7 @@ export * from './call-transcription-metadata';
12
12
  export * from './call-transcription-response';
13
13
  export * from './call-transcription-track-enum';
14
14
  export * from './callback-method-enum';
15
+ export * from './callback-type-enum';
15
16
  export * from './code-request';
16
17
  export * from './conference';
17
18
  export * from './conference-completed-callback';
@@ -34,8 +35,6 @@ export * from './dtmf-callback';
34
35
  export * from './field-error';
35
36
  export * from './file-format-enum';
36
37
  export * from './gather-callback';
37
- export * from './inbound-message-callback';
38
- export * from './inbound-message-callback-message';
39
38
  export * from './initiate-callback';
40
39
  export * from './list-message-direction-enum';
41
40
  export * from './list-message-item';
@@ -49,14 +48,10 @@ export * from './machine-detection-mode-enum';
49
48
  export * from './machine-detection-result';
50
49
  export * from './media';
51
50
  export * from './message';
52
- export * from './message-delivered-callback';
53
- export * from './message-delivered-callback-message';
51
+ export * from './message-callback';
52
+ export * from './message-callback-message';
54
53
  export * from './message-direction-enum';
55
- export * from './message-failed-callback';
56
- export * from './message-failed-callback-message';
57
54
  export * from './message-request';
58
- export * from './message-sending-callback';
59
- export * from './message-sending-callback-message';
60
55
  export * from './message-status-enum';
61
56
  export * from './message-type-enum';
62
57
  export * from './messages-list';
@@ -21,81 +21,81 @@ import type { MessageDirectionEnum } from './message-direction-enum';
21
21
  import type { PriorityEnum } from './priority-enum';
22
22
 
23
23
  /**
24
- * Message Sending Callback Message Schema
24
+ * Message payload schema within a MessageCallback
25
25
  * @export
26
- * @interface MessageSendingCallbackMessage
26
+ * @interface MessageCallbackMessage
27
27
  */
28
- export interface MessageSendingCallbackMessage {
28
+ export interface MessageCallbackMessage {
29
29
  /**
30
30
  *
31
31
  * @type {string}
32
- * @memberof MessageSendingCallbackMessage
32
+ * @memberof MessageCallbackMessage
33
33
  */
34
34
  'id': string;
35
35
  /**
36
36
  *
37
37
  * @type {string}
38
- * @memberof MessageSendingCallbackMessage
38
+ * @memberof MessageCallbackMessage
39
39
  */
40
40
  'owner': string;
41
41
  /**
42
42
  *
43
43
  * @type {string}
44
- * @memberof MessageSendingCallbackMessage
44
+ * @memberof MessageCallbackMessage
45
45
  */
46
46
  'applicationId': string;
47
47
  /**
48
48
  *
49
49
  * @type {string}
50
- * @memberof MessageSendingCallbackMessage
50
+ * @memberof MessageCallbackMessage
51
51
  */
52
52
  'time': string;
53
53
  /**
54
54
  *
55
55
  * @type {number}
56
- * @memberof MessageSendingCallbackMessage
56
+ * @memberof MessageCallbackMessage
57
57
  */
58
58
  'segmentCount': number;
59
59
  /**
60
60
  *
61
61
  * @type {MessageDirectionEnum}
62
- * @memberof MessageSendingCallbackMessage
62
+ * @memberof MessageCallbackMessage
63
63
  */
64
64
  'direction': MessageDirectionEnum;
65
65
  /**
66
66
  *
67
67
  * @type {Set<string>}
68
- * @memberof MessageSendingCallbackMessage
68
+ * @memberof MessageCallbackMessage
69
69
  */
70
70
  'to': Set<string>;
71
71
  /**
72
72
  *
73
73
  * @type {string}
74
- * @memberof MessageSendingCallbackMessage
74
+ * @memberof MessageCallbackMessage
75
75
  */
76
76
  'from': string;
77
77
  /**
78
78
  *
79
79
  * @type {string}
80
- * @memberof MessageSendingCallbackMessage
80
+ * @memberof MessageCallbackMessage
81
81
  */
82
82
  'text': string;
83
83
  /**
84
84
  *
85
85
  * @type {string}
86
- * @memberof MessageSendingCallbackMessage
86
+ * @memberof MessageCallbackMessage
87
87
  */
88
88
  'tag'?: string;
89
89
  /**
90
- *
90
+ * Optional media, applicable only for mms
91
91
  * @type {Array<string>}
92
- * @memberof MessageSendingCallbackMessage
92
+ * @memberof MessageCallbackMessage
93
93
  */
94
- 'media': Array<string>;
94
+ 'media'?: Array<string> | null;
95
95
  /**
96
96
  *
97
97
  * @type {PriorityEnum}
98
- * @memberof MessageSendingCallbackMessage
98
+ * @memberof MessageCallbackMessage
99
99
  */
100
100
  'priority'?: PriorityEnum;
101
101
  }
@@ -0,0 +1,68 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Bandwidth
5
+ * Bandwidth\'s Communication APIs
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: letstalk@bandwidth.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { CallbackTypeEnum } from './callback-type-enum';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { MessageCallbackMessage } from './message-callback-message';
22
+
23
+ /**
24
+ * Message Callback Schema
25
+ * @export
26
+ * @interface MessageCallback
27
+ */
28
+ export interface MessageCallback {
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof MessageCallback
33
+ */
34
+ 'time': string;
35
+ /**
36
+ *
37
+ * @type {CallbackTypeEnum}
38
+ * @memberof MessageCallback
39
+ */
40
+ 'type': CallbackTypeEnum;
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof MessageCallback
45
+ */
46
+ 'to': string;
47
+ /**
48
+ * A detailed description of the event described by the callback.
49
+ * @type {string}
50
+ * @memberof MessageCallback
51
+ */
52
+ 'description': string;
53
+ /**
54
+ *
55
+ * @type {MessageCallbackMessage}
56
+ * @memberof MessageCallback
57
+ */
58
+ 'message': MessageCallbackMessage;
59
+ /**
60
+ * Optional error code, applicable only when type is `message-failed`.
61
+ * @type {number}
62
+ * @memberof MessageCallback
63
+ */
64
+ 'errorCode'?: number | null;
65
+ }
66
+
67
+
68
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bandwidth-sdk",
3
- "version": "3.2.0",
3
+ "version": "4.0.0",
4
4
  "description": "OpenAPI client for bandwidth-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -0,0 +1,10 @@
1
+ import { CallbackTypeEnum } from '../../../models/callback-type-enum';
2
+
3
+ describe('CallbackTypeEnum', () => {
4
+ test('should define the expected values', () => {
5
+ expect(CallbackTypeEnum.Received).toBe('message-received');
6
+ expect(CallbackTypeEnum.Delivered).toBe('message-delivered');
7
+ expect(CallbackTypeEnum.Failed).toBe('message-failed');
8
+ expect(CallbackTypeEnum.Sending).toBe('message-sending');
9
+ });
10
+ });