twilio 5.5.0 → 5.5.2

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 (183) hide show
  1. package/lib/rest/Knowledge.d.ts +4 -0
  2. package/lib/rest/Knowledge.js +8 -0
  3. package/lib/rest/KnowledgeBase.d.ts +13 -0
  4. package/lib/rest/KnowledgeBase.js +31 -0
  5. package/lib/rest/PreviewBase.d.ts +0 -3
  6. package/lib/rest/PreviewBase.js +0 -5
  7. package/lib/rest/Twilio.d.ts +5 -0
  8. package/lib/rest/Twilio.js +5 -0
  9. package/lib/rest/accounts/v1/safelist.d.ts +4 -4
  10. package/lib/rest/api/v2010/account/address/dependentPhoneNumber.d.ts +3 -0
  11. package/lib/rest/api/v2010/account/call/recording.d.ts +6 -0
  12. package/lib/rest/api/v2010/account/call/siprec.d.ts +3 -0
  13. package/lib/rest/api/v2010/account/call/stream.d.ts +3 -0
  14. package/lib/rest/api/v2010/account/call/transcription.d.ts +3 -0
  15. package/lib/rest/api/v2010/account/call.d.ts +3 -0
  16. package/lib/rest/api/v2010/account/conference/participant.d.ts +4 -1
  17. package/lib/rest/api/v2010/account/conference/recording.d.ts +6 -0
  18. package/lib/rest/api/v2010/account/conference.d.ts +7 -1
  19. package/lib/rest/api/v2010/account/incomingPhoneNumber/local.d.ts +6 -0
  20. package/lib/rest/api/v2010/account/incomingPhoneNumber/mobile.d.ts +6 -0
  21. package/lib/rest/api/v2010/account/incomingPhoneNumber/tollFree.d.ts +6 -0
  22. package/lib/rest/api/v2010/account/incomingPhoneNumber.d.ts +6 -0
  23. package/lib/rest/api/v2010/account/message/feedback.d.ts +3 -0
  24. package/lib/rest/api/v2010/account/message.d.ts +9 -0
  25. package/lib/rest/api/v2010/account/message.js +2 -0
  26. package/lib/rest/api/v2010/account/recording/addOnResult.d.ts +3 -0
  27. package/lib/rest/api/v2010/account/recording/transcription.d.ts +3 -0
  28. package/lib/rest/api/v2010/account/recording.d.ts +6 -0
  29. package/lib/rest/api/v2010/account/transcription.d.ts +3 -0
  30. package/lib/rest/api/v2010/account/usage/record/allTime.d.ts +3 -0
  31. package/lib/rest/api/v2010/account/usage/record/daily.d.ts +3 -0
  32. package/lib/rest/api/v2010/account/usage/record/lastMonth.d.ts +3 -0
  33. package/lib/rest/api/v2010/account/usage/record/monthly.d.ts +3 -0
  34. package/lib/rest/api/v2010/account/usage/record/thisMonth.d.ts +3 -0
  35. package/lib/rest/api/v2010/account/usage/record/today.d.ts +3 -0
  36. package/lib/rest/api/v2010/account/usage/record/yearly.d.ts +3 -0
  37. package/lib/rest/api/v2010/account/usage/record/yesterday.d.ts +3 -0
  38. package/lib/rest/api/v2010/account/usage/record.d.ts +3 -0
  39. package/lib/rest/api/v2010/account/usage/trigger.d.ts +6 -0
  40. package/lib/rest/api/v2010/account/usage.d.ts +3 -0
  41. package/lib/rest/api/v2010/account.d.ts +6 -0
  42. package/lib/rest/chat/v2/service/binding.d.ts +3 -0
  43. package/lib/rest/chat/v2/service/channel/webhook.d.ts +3 -0
  44. package/lib/rest/chat/v2/service/user/userBinding.d.ts +3 -0
  45. package/lib/rest/chat/v2/service/user/userChannel.d.ts +3 -0
  46. package/lib/rest/conversations/v1/addressConfiguration.d.ts +3 -0
  47. package/lib/rest/conversations/v1/configuration/webhook.d.ts +6 -0
  48. package/lib/rest/conversations/v1/conversation/webhook.d.ts +3 -0
  49. package/lib/rest/conversations/v1/conversation.d.ts +3 -0
  50. package/lib/rest/conversations/v1/conversationWithParticipants.d.ts +3 -0
  51. package/lib/rest/conversations/v1/service/binding.d.ts +3 -0
  52. package/lib/rest/conversations/v1/service/configuration/webhook.d.ts +3 -0
  53. package/lib/rest/conversations/v1/service/conversation/webhook.d.ts +3 -0
  54. package/lib/rest/conversations/v1/service/conversation.d.ts +3 -0
  55. package/lib/rest/conversations/v1/service/conversationWithParticipants.d.ts +3 -0
  56. package/lib/rest/conversations/v1/service/user/userConversation.d.ts +3 -0
  57. package/lib/rest/conversations/v1/user/userConversation.d.ts +3 -0
  58. package/lib/rest/events/v1/sink.d.ts +6 -0
  59. package/lib/rest/flexApi/v1/configuration.d.ts +3 -0
  60. package/lib/rest/flexApi/v1/flexFlow.d.ts +6 -0
  61. package/lib/rest/flexApi/v1/interaction/interactionChannel/interactionChannelParticipant.d.ts +3 -0
  62. package/lib/rest/flexApi/v1/interaction/interactionChannel.d.ts +3 -0
  63. package/lib/rest/flexApi/v1/provisioningStatus.d.ts +3 -0
  64. package/lib/rest/flexApi/v2/flexUser.d.ts +0 -24
  65. package/lib/rest/flexApi/v2/flexUser.js +0 -12
  66. package/lib/rest/iam/V1.d.ts +5 -0
  67. package/lib/rest/iam/V1.js +6 -0
  68. package/lib/rest/iam/v1/token.d.ts +88 -0
  69. package/lib/rest/iam/v1/token.js +99 -0
  70. package/lib/rest/insights/v1/room/participant.d.ts +2 -2
  71. package/lib/rest/insights/v1/room.d.ts +2 -2
  72. package/lib/rest/intelligence/v2/customOperator.d.ts +3 -0
  73. package/lib/rest/intelligence/v2/operator.d.ts +3 -0
  74. package/lib/rest/intelligence/v2/operatorType.d.ts +9 -0
  75. package/lib/rest/intelligence/v2/prebuiltOperator.d.ts +3 -0
  76. package/lib/rest/intelligence/v2/transcript/operatorResult.d.ts +3 -0
  77. package/lib/rest/intelligence/v2/transcript.d.ts +3 -0
  78. package/lib/rest/knowledge/V1.d.ts +15 -0
  79. package/lib/rest/{preview/Sync.js → knowledge/V1.js} +11 -11
  80. package/lib/rest/knowledge/v1/knowledge/chunk.d.ts +167 -0
  81. package/lib/rest/knowledge/v1/knowledge/chunk.js +131 -0
  82. package/lib/rest/knowledge/v1/knowledge/knowledgeStatus.d.ts +101 -0
  83. package/lib/rest/knowledge/v1/knowledge/knowledgeStatus.js +118 -0
  84. package/lib/rest/knowledge/v1/knowledge.d.ts +406 -0
  85. package/lib/rest/{preview/sync/service/document.js → knowledge/v1/knowledge.js} +102 -91
  86. package/lib/rest/lookups/v1/phoneNumber.d.ts +1 -1
  87. package/lib/rest/messaging/v1/brandRegistration/brandVetting.d.ts +3 -0
  88. package/lib/rest/messaging/v1/brandRegistration.d.ts +9 -0
  89. package/lib/rest/messaging/v1/service.d.ts +3 -0
  90. package/lib/rest/messaging/v1/tollfreeVerification.d.ts +6 -0
  91. package/lib/rest/monitor/v1/event.d.ts +1 -1
  92. package/lib/rest/notify/v1/service/binding.d.ts +3 -0
  93. package/lib/rest/notify/v1/service/notification.d.ts +3 -0
  94. package/lib/rest/numbers/v1/portingPortability.d.ts +3 -0
  95. package/lib/rest/numbers/v1/portingWebhookConfigurationDelete.d.ts +3 -0
  96. package/lib/rest/numbers/v2/authorizationDocument/dependentHostedNumberOrder.d.ts +3 -0
  97. package/lib/rest/numbers/v2/authorizationDocument.d.ts +3 -0
  98. package/lib/rest/numbers/v2/bulkHostedNumberOrder.d.ts +3 -0
  99. package/lib/rest/numbers/v2/bundleClone.d.ts +3 -0
  100. package/lib/rest/numbers/v2/hostedNumberOrder.d.ts +6 -0
  101. package/lib/rest/numbers/v2/regulatoryCompliance/bundle/bundleCopy.d.ts +3 -0
  102. package/lib/rest/numbers/v2/regulatoryCompliance/bundle/evaluation.d.ts +3 -0
  103. package/lib/rest/numbers/v2/regulatoryCompliance/bundle/replaceItems.d.ts +3 -0
  104. package/lib/rest/numbers/v2/regulatoryCompliance/bundle.d.ts +3 -0
  105. package/lib/rest/numbers/v2/regulatoryCompliance/endUser.d.ts +3 -0
  106. package/lib/rest/numbers/v2/regulatoryCompliance/regulation.d.ts +3 -0
  107. package/lib/rest/numbers/v2/regulatoryCompliance/supportingDocument.d.ts +3 -0
  108. package/lib/rest/numbers/v2/regulatoryCompliance.d.ts +3 -0
  109. package/lib/rest/preview/hosted_numbers/authorizationDocument/dependentHostedNumberOrder.d.ts +6 -0
  110. package/lib/rest/preview/hosted_numbers/authorizationDocument.d.ts +3 -0
  111. package/lib/rest/preview/hosted_numbers/hostedNumberOrder.d.ts +6 -0
  112. package/lib/rest/proxy/v1/service/session/interaction.d.ts +3 -0
  113. package/lib/rest/proxy/v1/service/session/participant/messageInteraction.d.ts +3 -0
  114. package/lib/rest/proxy/v1/service/session.d.ts +6 -0
  115. package/lib/rest/proxy/v1/service.d.ts +6 -0
  116. package/lib/rest/serverless/v1/service/asset/assetVersion.d.ts +3 -0
  117. package/lib/rest/serverless/v1/service/build/buildStatus.d.ts +3 -0
  118. package/lib/rest/serverless/v1/service/build.d.ts +6 -0
  119. package/lib/rest/serverless/v1/service/environment/log.d.ts +3 -0
  120. package/lib/rest/serverless/v1/service/function/functionVersion.d.ts +3 -0
  121. package/lib/rest/studio/v1/flow/engagement/step.d.ts +6 -0
  122. package/lib/rest/studio/v1/flow/engagement/step.js +2 -0
  123. package/lib/rest/studio/v1/flow/engagement.d.ts +3 -0
  124. package/lib/rest/studio/v1/flow/execution/executionStep.d.ts +6 -0
  125. package/lib/rest/studio/v1/flow/execution/executionStep.js +2 -0
  126. package/lib/rest/studio/v1/flow/execution.d.ts +3 -0
  127. package/lib/rest/studio/v1/flow.d.ts +3 -0
  128. package/lib/rest/studio/v2/flow/execution/executionStep.d.ts +6 -0
  129. package/lib/rest/studio/v2/flow/execution/executionStep.js +2 -0
  130. package/lib/rest/studio/v2/flow/execution.d.ts +3 -0
  131. package/lib/rest/studio/v2/flow/flowRevision.d.ts +3 -0
  132. package/lib/rest/studio/v2/flow.d.ts +3 -0
  133. package/lib/rest/supersim/v1/esimProfile.d.ts +3 -0
  134. package/lib/rest/supersim/v1/fleet.d.ts +3 -0
  135. package/lib/rest/supersim/v1/ipCommand.d.ts +9 -0
  136. package/lib/rest/supersim/v1/settingsUpdate.d.ts +3 -0
  137. package/lib/rest/supersim/v1/sim/simIpAddress.d.ts +3 -0
  138. package/lib/rest/supersim/v1/sim.d.ts +3 -0
  139. package/lib/rest/supersim/v1/smsCommand.d.ts +6 -0
  140. package/lib/rest/taskrouter/v1/workspace/task/reservation.d.ts +1 -1
  141. package/lib/rest/taskrouter/v1/workspace/taskQueue.d.ts +3 -0
  142. package/lib/rest/taskrouter/v1/workspace/worker/reservation.d.ts +1 -1
  143. package/lib/rest/trunking/v1/trunk.d.ts +3 -0
  144. package/lib/rest/trusthub/v1/customerProfiles/customerProfilesEvaluations.d.ts +3 -0
  145. package/lib/rest/trusthub/v1/customerProfiles.d.ts +3 -0
  146. package/lib/rest/trusthub/v1/supportingDocument.d.ts +3 -0
  147. package/lib/rest/trusthub/v1/trustProducts/trustProductsEvaluations.d.ts +3 -0
  148. package/lib/rest/trusthub/v1/trustProducts.d.ts +3 -0
  149. package/lib/rest/verify/v2/service/verification.d.ts +6 -0
  150. package/lib/rest/verify/v2/service/verificationCheck.d.ts +3 -0
  151. package/lib/rest/verify/v2/service/webhook.d.ts +6 -0
  152. package/lib/rest/verify/v2/verificationAttempt.d.ts +3 -0
  153. package/lib/rest/video/v1/composition.d.ts +6 -0
  154. package/lib/rest/video/v1/compositionHook.d.ts +3 -0
  155. package/lib/rest/video/v1/recording.d.ts +9 -0
  156. package/lib/rest/video/v1/room/participant/anonymize.d.ts +3 -0
  157. package/lib/rest/video/v1/room/participant/publishedTrack.d.ts +3 -0
  158. package/lib/rest/video/v1/room/participant/subscribedTrack.d.ts +3 -0
  159. package/lib/rest/video/v1/room/participant.d.ts +4 -1
  160. package/lib/rest/video/v1/room/roomRecording.d.ts +9 -0
  161. package/lib/rest/wireless/v1/command.d.ts +12 -0
  162. package/lib/rest/wireless/v1/ratePlan.d.ts +6 -0
  163. package/lib/rest/wireless/v1/ratePlan.js +2 -0
  164. package/lib/rest/wireless/v1/sim.d.ts +6 -0
  165. package/package.json +1 -1
  166. package/lib/rest/preview/Sync.d.ts +0 -15
  167. package/lib/rest/preview/sync/service/document/documentPermission.d.ts +0 -280
  168. package/lib/rest/preview/sync/service/document/documentPermission.js +0 -260
  169. package/lib/rest/preview/sync/service/document.d.ts +0 -295
  170. package/lib/rest/preview/sync/service/syncList/syncListItem.d.ts +0 -321
  171. package/lib/rest/preview/sync/service/syncList/syncListItem.js +0 -286
  172. package/lib/rest/preview/sync/service/syncList/syncListPermission.d.ts +0 -280
  173. package/lib/rest/preview/sync/service/syncList/syncListPermission.js +0 -260
  174. package/lib/rest/preview/sync/service/syncList.d.ts +0 -270
  175. package/lib/rest/preview/sync/service/syncList.js +0 -270
  176. package/lib/rest/preview/sync/service/syncMap/syncMapItem.d.ts +0 -323
  177. package/lib/rest/preview/sync/service/syncMap/syncMapItem.js +0 -290
  178. package/lib/rest/preview/sync/service/syncMap/syncMapPermission.d.ts +0 -280
  179. package/lib/rest/preview/sync/service/syncMap/syncMapPermission.js +0 -260
  180. package/lib/rest/preview/sync/service/syncMap.d.ts +0 -270
  181. package/lib/rest/preview/sync/service/syncMap.js +0 -270
  182. package/lib/rest/preview/sync/service.d.ts +0 -330
  183. package/lib/rest/preview/sync/service.js +0 -316
@@ -4,7 +4,13 @@ import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import HostedNumbers from "../HostedNumbers";
6
6
  import { PhoneNumberCapabilities } from "../../../interfaces";
7
+ /**
8
+ * Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values) section for more information on each of these statuses.
9
+ */
7
10
  export type HostedNumberOrderStatus = "received" | "pending-verification" | "verified" | "pending-loa" | "carrier-processing" | "testing" | "completed" | "failed" | "action-required";
11
+ /**
12
+ * The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`.
13
+ */
8
14
  export type HostedNumberOrderVerificationType = "phone-call" | "phone-bill";
9
15
  /**
10
16
  * Options to pass to update a HostedNumberOrderInstance
@@ -4,6 +4,9 @@ import Page, { TwilioResponsePayload } from "../../../../../base/Page";
4
4
  import Response from "../../../../../http/response";
5
5
  import V1 from "../../../V1";
6
6
  export type InteractionResourceStatus = "accepted" | "answered" | "busy" | "canceled" | "completed" | "deleted" | "delivered" | "delivery-unknown" | "failed" | "in-progress" | "initiated" | "no-answer" | "queued" | "received" | "receiving" | "ringing" | "scheduled" | "sending" | "sent" | "undelivered" | "unknown";
7
+ /**
8
+ * The Type of the Interaction. Can be: `message`, `voice` or `unknown`.
9
+ */
7
10
  export type InteractionType = "message" | "voice" | "unknown";
8
11
  /**
9
12
  * Options to pass to each
@@ -4,6 +4,9 @@ import Page, { TwilioResponsePayload } from "../../../../../../base/Page";
4
4
  import Response from "../../../../../../http/response";
5
5
  import V1 from "../../../../V1";
6
6
  export type MessageInteractionResourceStatus = "accepted" | "answered" | "busy" | "canceled" | "completed" | "deleted" | "delivered" | "delivery-unknown" | "failed" | "in-progress" | "initiated" | "no-answer" | "queued" | "received" | "receiving" | "ringing" | "scheduled" | "sending" | "sent" | "undelivered" | "unknown";
7
+ /**
8
+ * The Type of Message Interaction. This value is always `message`.
9
+ */
7
10
  export type MessageInteractionType = "message" | "voice" | "unknown";
8
11
  /**
9
12
  * Options to pass to create a MessageInteractionInstance
@@ -5,7 +5,13 @@ import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
6
  import { InteractionListInstance } from "./session/interaction";
7
7
  import { ParticipantListInstance } from "./session/participant";
8
+ /**
9
+ * The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message`.
10
+ */
8
11
  export type SessionMode = "message-only" | "voice-only" | "voice-and-message";
12
+ /**
13
+ * The status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`.
14
+ */
9
15
  export type SessionStatus = "open" | "in-progress" | "closed" | "failed" | "unknown";
10
16
  /**
11
17
  * Options to pass to update a SessionInstance
@@ -6,7 +6,13 @@ import V1 from "../V1";
6
6
  import { PhoneNumberListInstance } from "./service/phoneNumber";
7
7
  import { SessionListInstance } from "./service/session";
8
8
  import { ShortCodeListInstance } from "./service/shortCode";
9
+ /**
10
+ * Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.
11
+ */
9
12
  export type ServiceGeoMatchLevel = "area-code" | "overlay" | "radius" | "country";
13
+ /**
14
+ * The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.
15
+ */
10
16
  export type ServiceNumberSelectionBehavior = "avoid-sticky" | "prefer-sticky";
11
17
  /**
12
18
  * Options to pass to update a ServiceInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../../base/Page";
4
4
  import Response from "../../../../../http/response";
5
5
  import V1 from "../../../V1";
6
+ /**
7
+ * The access control that determines how the Asset Version resource can be accessed. Can be: `public`, `protected`, or `private`.
8
+ */
6
9
  export type AssetVersionVisibility = "public" | "private" | "protected";
7
10
  /**
8
11
  * Options to pass to each
@@ -1,6 +1,9 @@
1
1
  /// <reference types="node" />
2
2
  import { inspect, InspectOptions } from "util";
3
3
  import V1 from "../../../V1";
4
+ /**
5
+ * The status of the Build. Can be: `building`, `completed`, or `failed`.
6
+ */
4
7
  export type BuildStatusStatus = "building" | "completed" | "failed";
5
8
  export interface BuildStatusContext {
6
9
  /**
@@ -4,7 +4,13 @@ import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
6
  import { BuildStatusListInstance } from "./build/buildStatus";
7
+ /**
8
+ * The Runtime version that will be used to run the Build resource when it is deployed.
9
+ */
7
10
  export type BuildRuntime = "node8" | "node10" | "node12" | "node14" | "node16" | "node18";
11
+ /**
12
+ * The status of the Build. Can be: `building`, `completed`, or `failed`.
13
+ */
8
14
  export type BuildStatus = "building" | "completed" | "failed";
9
15
  /**
10
16
  * Options to pass to create a BuildInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../../base/Page";
4
4
  import Response from "../../../../../http/response";
5
5
  import V1 from "../../../V1";
6
+ /**
7
+ * The log level. Can be: `info`, `warn`, or `error`.
8
+ */
6
9
  export type LogLevel = "info" | "warn" | "error";
7
10
  /**
8
11
  * Options to pass to each
@@ -4,6 +4,9 @@ import Page, { TwilioResponsePayload } from "../../../../../base/Page";
4
4
  import Response from "../../../../../http/response";
5
5
  import V1 from "../../../V1";
6
6
  import { FunctionVersionContentListInstance } from "./functionVersion/functionVersionContent";
7
+ /**
8
+ * The access control that determines how the Function Version resource can be accessed. Can be: `public`, `protected`, or `private`.
9
+ */
7
10
  export type FunctionVersionVisibility = "public" | "private" | "protected";
8
11
  /**
9
12
  * Options to pass to each
@@ -84,6 +84,7 @@ interface StepResource {
84
84
  engagement_sid: string;
85
85
  name: string;
86
86
  context: Record<string, object>;
87
+ parent_step_sid: string;
87
88
  transitioned_from: string;
88
89
  transitioned_to: string;
89
90
  date_created: Date;
@@ -120,6 +121,10 @@ export declare class StepInstance {
120
121
  * The current state of the Flow\'s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.
121
122
  */
122
123
  context: Record<string, object>;
124
+ /**
125
+ * The SID of the parent Step.
126
+ */
127
+ parentStepSid: string;
123
128
  /**
124
129
  * The Widget that preceded the Widget for the Step.
125
130
  */
@@ -169,6 +174,7 @@ export declare class StepInstance {
169
174
  engagementSid: string;
170
175
  name: string;
171
176
  context: Record<string, object>;
177
+ parentStepSid: string;
172
178
  transitionedFrom: string;
173
179
  transitionedTo: string;
174
180
  dateCreated: Date;
@@ -79,6 +79,7 @@ class StepInstance {
79
79
  this.engagementSid = payload.engagement_sid;
80
80
  this.name = payload.name;
81
81
  this.context = payload.context;
82
+ this.parentStepSid = payload.parent_step_sid;
82
83
  this.transitionedFrom = payload.transitioned_from;
83
84
  this.transitionedTo = payload.transitioned_to;
84
85
  this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
@@ -122,6 +123,7 @@ class StepInstance {
122
123
  engagementSid: this.engagementSid,
123
124
  name: this.name,
124
125
  context: this.context,
126
+ parentStepSid: this.parentStepSid,
125
127
  transitionedFrom: this.transitionedFrom,
126
128
  transitionedTo: this.transitionedTo,
127
129
  dateCreated: this.dateCreated,
@@ -5,6 +5,9 @@ import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
6
  import { EngagementContextListInstance } from "./engagement/engagementContext";
7
7
  import { StepListInstance } from "./engagement/step";
8
+ /**
9
+ * The status of the Engagement. Can be: `active` or `ended`.
10
+ */
8
11
  export type EngagementStatus = "active" | "ended";
9
12
  /**
10
13
  * Options to pass to create a EngagementInstance
@@ -82,6 +82,7 @@ interface ExecutionStepResource {
82
82
  account_sid: string;
83
83
  flow_sid: string;
84
84
  execution_sid: string;
85
+ parent_step_sid: string;
85
86
  name: string;
86
87
  context: Record<string, object>;
87
88
  transitioned_from: string;
@@ -112,6 +113,10 @@ export declare class ExecutionStepInstance {
112
113
  * The SID of the Step\'s Execution resource.
113
114
  */
114
115
  executionSid: string;
116
+ /**
117
+ * This field shows the Step SID of the Widget in the parent Flow that started the Subflow. If this Step is not part of a Subflow execution, the value is null.
118
+ */
119
+ parentStepSid: string;
115
120
  /**
116
121
  * The event that caused the Flow to transition to the Step.
117
122
  */
@@ -167,6 +172,7 @@ export declare class ExecutionStepInstance {
167
172
  accountSid: string;
168
173
  flowSid: string;
169
174
  executionSid: string;
175
+ parentStepSid: string;
170
176
  name: string;
171
177
  context: Record<string, object>;
172
178
  transitionedFrom: string;
@@ -77,6 +77,7 @@ class ExecutionStepInstance {
77
77
  this.accountSid = payload.account_sid;
78
78
  this.flowSid = payload.flow_sid;
79
79
  this.executionSid = payload.execution_sid;
80
+ this.parentStepSid = payload.parent_step_sid;
80
81
  this.name = payload.name;
81
82
  this.context = payload.context;
82
83
  this.transitionedFrom = payload.transitioned_from;
@@ -120,6 +121,7 @@ class ExecutionStepInstance {
120
121
  accountSid: this.accountSid,
121
122
  flowSid: this.flowSid,
122
123
  executionSid: this.executionSid,
124
+ parentStepSid: this.parentStepSid,
123
125
  name: this.name,
124
126
  context: this.context,
125
127
  transitionedFrom: this.transitionedFrom,
@@ -5,6 +5,9 @@ import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
6
  import { ExecutionContextListInstance } from "./execution/executionContext";
7
7
  import { ExecutionStepListInstance } from "./execution/executionStep";
8
+ /**
9
+ * The status of the Execution. Can be: `active` or `ended`.
10
+ */
8
11
  export type ExecutionStatus = "active" | "ended";
9
12
  /**
10
13
  * Options to pass to update a ExecutionInstance
@@ -5,6 +5,9 @@ import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
6
  import { EngagementListInstance } from "./flow/engagement";
7
7
  import { ExecutionListInstance } from "./flow/execution";
8
+ /**
9
+ * The status of the Flow. Can be: `draft` or `published`.
10
+ */
8
11
  export type FlowStatus = "draft" | "published";
9
12
  /**
10
13
  * Options to pass to each
@@ -82,6 +82,7 @@ interface ExecutionStepResource {
82
82
  account_sid: string;
83
83
  flow_sid: string;
84
84
  execution_sid: string;
85
+ parent_step_sid: string;
85
86
  name: string;
86
87
  context: Record<string, object>;
87
88
  transitioned_from: string;
@@ -112,6 +113,10 @@ export declare class ExecutionStepInstance {
112
113
  * The SID of the Step\'s Execution resource.
113
114
  */
114
115
  executionSid: string;
116
+ /**
117
+ * The SID of the parent Step.
118
+ */
119
+ parentStepSid: string;
115
120
  /**
116
121
  * The event that caused the Flow to transition to the Step.
117
122
  */
@@ -167,6 +172,7 @@ export declare class ExecutionStepInstance {
167
172
  accountSid: string;
168
173
  flowSid: string;
169
174
  executionSid: string;
175
+ parentStepSid: string;
170
176
  name: string;
171
177
  context: Record<string, object>;
172
178
  transitionedFrom: string;
@@ -77,6 +77,7 @@ class ExecutionStepInstance {
77
77
  this.accountSid = payload.account_sid;
78
78
  this.flowSid = payload.flow_sid;
79
79
  this.executionSid = payload.execution_sid;
80
+ this.parentStepSid = payload.parent_step_sid;
80
81
  this.name = payload.name;
81
82
  this.context = payload.context;
82
83
  this.transitionedFrom = payload.transitioned_from;
@@ -120,6 +121,7 @@ class ExecutionStepInstance {
120
121
  accountSid: this.accountSid,
121
122
  flowSid: this.flowSid,
122
123
  executionSid: this.executionSid,
124
+ parentStepSid: this.parentStepSid,
123
125
  name: this.name,
124
126
  context: this.context,
125
127
  transitionedFrom: this.transitionedFrom,
@@ -5,6 +5,9 @@ import Response from "../../../../http/response";
5
5
  import V2 from "../../V2";
6
6
  import { ExecutionContextListInstance } from "./execution/executionContext";
7
7
  import { ExecutionStepListInstance } from "./execution/executionStep";
8
+ /**
9
+ * The status of the Execution. Can be: `active` or `ended`.
10
+ */
8
11
  export type ExecutionStatus = "active" | "ended";
9
12
  /**
10
13
  * Options to pass to update a ExecutionInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V2 from "../../V2";
6
+ /**
7
+ * The status of the Flow. Can be: `draft` or `published`.
8
+ */
6
9
  export type FlowRevisionStatus = "draft" | "published";
7
10
  /**
8
11
  * Options to pass to each
@@ -6,6 +6,9 @@ import V2 from "../V2";
6
6
  import { ExecutionListInstance } from "./flow/execution";
7
7
  import { FlowRevisionListInstance } from "./flow/flowRevision";
8
8
  import { FlowTestUserListInstance } from "./flow/flowTestUser";
9
+ /**
10
+ * The status of the Flow. Can be: `draft` or `published`.
11
+ */
9
12
  export type FlowStatus = "draft" | "published";
10
13
  /**
11
14
  * Options to pass to update a FlowInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The status of the eSIM Profile. Can be: `new`, `reserving`, `available`, `downloaded`, `installed` or `failed`. See the [eSIM Profile Status Values](https://www.twilio.com/docs/iot/supersim/api/esimprofile-resource#status-values) for a description of each.
8
+ */
6
9
  export type EsimProfileStatus = "new" | "reserving" | "available" | "downloaded" | "installed" | "failed";
7
10
  /**
8
11
  * Options to pass to create a EsimProfileInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The model by which a SIMs usage is metered and billed. Defaults to `payg`.
8
+ */
6
9
  export type FleetDataMetering = "payg";
7
10
  /**
8
11
  * Options to pass to update a FleetInstance
@@ -3,8 +3,17 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * Either `to_sim` or `from_sim`. Indicates whether the IP Command resource was sent from or to the Super SIM.
8
+ */
6
9
  export type IpCommandDirection = "to_sim" | "from_sim";
10
+ /**
11
+ * Either “text” or “binary”. For an IP Command sent to a Super SIM, `payload_type` is configurable. For an IP Command sent from a Super SIM, `payload_type` is always “binary”.
12
+ */
7
13
  export type IpCommandPayloadType = "text" | "binary";
14
+ /**
15
+ * The delivery status of the IP Command. This is one of the following: “queued”, “sent”, “failed” or “received”.
16
+ */
8
17
  export type IpCommandStatus = "queued" | "sent" | "received" | "failed";
9
18
  /**
10
19
  * Options to pass to create a IpCommandInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The Status of this Settings Update. One of `scheduled`, `in-progress`, `successful` or `failed`.
8
+ */
6
9
  export type SettingsUpdateStatus = "scheduled" | "in-progress" | "successful" | "failed";
7
10
  /**
8
11
  * Options to pass to each
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
+ /**
7
+ * IP address version of the corresponding IP address
8
+ */
6
9
  export type SimIpAddressIpAddressVersion = "IPv4" | "IPv6";
7
10
  /**
8
11
  * Options to pass to each
@@ -5,6 +5,9 @@ import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
6
  import { BillingPeriodListInstance } from "./sim/billingPeriod";
7
7
  import { SimIpAddressListInstance } from "./sim/simIpAddress";
8
+ /**
9
+ * The status of the Super SIM. Can be `new`, `ready`, `active`, `inactive`, or `scheduled`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for a description of each.
10
+ */
8
11
  export type SimStatus = "new" | "ready" | "active" | "inactive" | "scheduled";
9
12
  export type SimStatusUpdate = "ready" | "active" | "inactive";
10
13
  /**
@@ -3,7 +3,13 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The direction of the SMS Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
8
+ */
6
9
  export type SmsCommandDirection = "to_sim" | "from_sim";
10
+ /**
11
+ * The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/iot/supersim/api/smscommand-resource#status-values) for a description of each.
12
+ */
7
13
  export type SmsCommandStatus = "queued" | "sent" | "delivered" | "received" | "failed";
8
14
  /**
9
15
  * Options to pass to create a SmsCommandInstance
@@ -101,7 +101,7 @@ export interface ReservationContextUpdateOptions {
101
101
  conferenceRecordingStatusCallback?: string;
102
102
  /** The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. */
103
103
  conferenceRecordingStatusCallbackMethod?: string;
104
- /** The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. */
104
+ /** The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. */
105
105
  region?: string;
106
106
  /** The SIP username used for authentication. */
107
107
  sipAuthUsername?: string;
@@ -8,6 +8,9 @@ import { TaskQueueCumulativeStatisticsListInstance } from "./taskQueue/taskQueue
8
8
  import { TaskQueueRealTimeStatisticsListInstance } from "./taskQueue/taskQueueRealTimeStatistics";
9
9
  import { TaskQueueStatisticsListInstance } from "./taskQueue/taskQueueStatistics";
10
10
  import { TaskQueuesStatisticsListInstance } from "./taskQueue/taskQueuesStatistics";
11
+ /**
12
+ * How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or `FIFO` to assign the oldest Task. Default is FIFO. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.
13
+ */
11
14
  export type TaskQueueTaskOrder = "FIFO" | "LIFO";
12
15
  /**
13
16
  * Options to pass to update a TaskQueueInstance
@@ -100,7 +100,7 @@ export interface ReservationContextUpdateOptions {
100
100
  conferenceRecordingStatusCallback?: string;
101
101
  /** The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. */
102
102
  conferenceRecordingStatusCallbackMethod?: string;
103
- /** The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. */
103
+ /** The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. */
104
104
  region?: string;
105
105
  /** The SIP username used for authentication. */
106
106
  sipAuthUsername?: string;
@@ -8,6 +8,9 @@ import { IpAccessControlListListInstance } from "./trunk/ipAccessControlList";
8
8
  import { OriginationUrlListInstance } from "./trunk/originationUrl";
9
9
  import { PhoneNumberListInstance } from "./trunk/phoneNumber";
10
10
  import { RecordingListInstance } from "./trunk/recording";
11
+ /**
12
+ * Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.
13
+ */
11
14
  export type TrunkTransferCallerId = "from-transferee" | "from-transferor";
12
15
  export type TrunkTransferSetting = "disable-all" | "enable-all" | "sip-only";
13
16
  /**
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
+ /**
7
+ * The compliance status of the Evaluation resource.
8
+ */
6
9
  export type CustomerProfilesEvaluationsStatus = "compliant" | "noncompliant";
7
10
  /**
8
11
  * Options to pass to create a CustomerProfilesEvaluationsInstance
@@ -6,6 +6,9 @@ import V1 from "../V1";
6
6
  import { CustomerProfilesChannelEndpointAssignmentListInstance } from "./customerProfiles/customerProfilesChannelEndpointAssignment";
7
7
  import { CustomerProfilesEntityAssignmentsListInstance } from "./customerProfiles/customerProfilesEntityAssignments";
8
8
  import { CustomerProfilesEvaluationsListInstance } from "./customerProfiles/customerProfilesEvaluations";
9
+ /**
10
+ * The verification status of the Customer-Profile resource.
11
+ */
9
12
  export type CustomerProfilesStatus = "draft" | "pending-review" | "in-review" | "twilio-rejected" | "twilio-approved";
10
13
  /**
11
14
  * Options to pass to update a CustomerProfilesInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The verification status of the Supporting Document resource.
8
+ */
6
9
  export type SupportingDocumentStatus = "DRAFT" | "PENDING_REVIEW" | "REJECTED" | "APPROVED" | "EXPIRED" | "PROVISIONALLY_APPROVED";
7
10
  /**
8
11
  * Options to pass to update a SupportingDocumentInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V1 from "../../V1";
6
+ /**
7
+ * The compliance status of the Evaluation resource.
8
+ */
6
9
  export type TrustProductsEvaluationsStatus = "compliant" | "noncompliant";
7
10
  /**
8
11
  * Options to pass to create a TrustProductsEvaluationsInstance
@@ -6,6 +6,9 @@ import V1 from "../V1";
6
6
  import { TrustProductsChannelEndpointAssignmentListInstance } from "./trustProducts/trustProductsChannelEndpointAssignment";
7
7
  import { TrustProductsEntityAssignmentsListInstance } from "./trustProducts/trustProductsEntityAssignments";
8
8
  import { TrustProductsEvaluationsListInstance } from "./trustProducts/trustProductsEvaluations";
9
+ /**
10
+ * The verification status of the Trust Product resource.
11
+ */
9
12
  export type TrustProductsStatus = "draft" | "pending-review" | "in-review" | "twilio-rejected" | "twilio-approved";
10
13
  /**
11
14
  * Options to pass to update a TrustProductsInstance
@@ -1,8 +1,14 @@
1
1
  /// <reference types="node" />
2
2
  import { inspect, InspectOptions } from "util";
3
3
  import V2 from "../../V2";
4
+ /**
5
+ * The verification method used. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna`, or `rcs`.
6
+ */
4
7
  export type VerificationChannel = "sms" | "call" | "email" | "whatsapp" | "sna";
5
8
  export type VerificationRiskCheck = "enable" | "disable";
9
+ /**
10
+ * The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.
11
+ */
6
12
  export type VerificationStatus = "canceled" | "approved";
7
13
  /**
8
14
  * Options to pass to update a VerificationInstance
@@ -1,6 +1,9 @@
1
1
  /// <reference types="node" />
2
2
  import { inspect, InspectOptions } from "util";
3
3
  import V2 from "../../V2";
4
+ /**
5
+ * The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, or `sna`.
6
+ */
4
7
  export type VerificationCheckChannel = "sms" | "call" | "email" | "whatsapp" | "sna";
5
8
  /**
6
9
  * Options to pass to create a VerificationCheckInstance
@@ -4,7 +4,13 @@ import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
4
  import Response from "../../../../http/response";
5
5
  import V2 from "../../V2";
6
6
  export type WebhookMethods = "GET" | "POST";
7
+ /**
8
+ * The webhook status. Default value is `enabled`. One of: `enabled` or `disabled`
9
+ */
7
10
  export type WebhookStatus = "enabled" | "disabled";
11
+ /**
12
+ * The webhook version. Default value is `v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future.
13
+ */
8
14
  export type WebhookVersion = "v1" | "v2";
9
15
  /**
10
16
  * Options to pass to update a WebhookInstance
@@ -4,6 +4,9 @@ import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V2 from "../V2";
6
6
  export type VerificationAttemptChannels = "sms" | "call" | "email" | "whatsapp";
7
+ /**
8
+ * A string specifying the conversion status of the verification. A conversion happens when the user is able to provide the correct code. Possible values are `CONVERTED` and `UNCONVERTED`.
9
+ */
7
10
  export type VerificationAttemptConversionStatus = "converted" | "unconverted";
8
11
  /**
9
12
  * Options to pass to each
@@ -3,7 +3,13 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The container format of the composition\'s media files as specified in the POST request that created the Composition resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information.
8
+ */
6
9
  export type CompositionFormat = "mp4" | "webm";
10
+ /**
11
+ * The status of the composition. Can be: `enqueued`, `processing`, `completed`, `deleted` or `failed`. `enqueued` is the initial state and indicates that the composition request has been received and is scheduled for processing; `processing` indicates the composition is being processed; `completed` indicates the composition has been completed and is available for download; `deleted` means the composition media has been deleted from the system, but its metadata is still available for 30 days; `failed` indicates the composition failed to execute the media processing task.
12
+ */
7
13
  export type CompositionStatus = "enqueued" | "processing" | "completed" | "deleted" | "failed";
8
14
  /**
9
15
  * Options to pass to create a CompositionInstance
@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The container format of the media files used by the compositions created by the composition hook. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.
8
+ */
6
9
  export type CompositionHookFormat = "mp4" | "webm";
7
10
  /**
8
11
  * Options to pass to update a CompositionHookInstance
@@ -3,9 +3,18 @@ import { inspect, InspectOptions } from "util";
3
3
  import Page, { TwilioResponsePayload } from "../../../base/Page";
4
4
  import Response from "../../../http/response";
5
5
  import V1 from "../V1";
6
+ /**
7
+ * The codec used to encode the track. Can be: `VP8`, `H264`, `OPUS`, and `PCMU`.
8
+ */
6
9
  export type RecordingCodec = "VP8" | "H264" | "OPUS" | "PCMU";
7
10
  export type RecordingFormat = "mka" | "mkv";
11
+ /**
12
+ * The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the recording is still being captured; `completed` indicates the recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available.
13
+ */
8
14
  export type RecordingStatus = "processing" | "completed" | "deleted" | "failed";
15
+ /**
16
+ * The recording\'s media type. Can be: `audio` or `video`.
17
+ */
9
18
  export type RecordingType = "audio" | "video" | "data";
10
19
  /**
11
20
  * Options to pass to each