@segment/public-api-sdk-typescript 1.0.1 → 1.0.2-b1

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 (509) hide show
  1. package/README.md +1 -1
  2. package/api/aPICallsApi.ts +1176 -0
  3. package/api/apis.ts +178 -0
  4. package/api/auditTrailApi.ts +714 -0
  5. package/api/catalogApi.ts +2916 -0
  6. package/api/deletionAndSuppressionApi.ts +4298 -0
  7. package/api/destinationFiltersApi.ts +3262 -0
  8. package/api/destinationsApi.ts +3494 -0
  9. package/api/edgeFunctionsApi.ts +593 -0
  10. package/api/eventsApi.ts +922 -0
  11. package/api/functionsApi.ts +3036 -0
  12. package/api/iAMGroupsApi.ts +6204 -0
  13. package/api/iAMRolesApi.ts +566 -0
  14. package/api/iAMUsersApi.ts +4486 -0
  15. package/api/labelsApi.ts +1488 -0
  16. package/api/monthlyTrackedUsersApi.ts +1178 -0
  17. package/api/selectiveSyncApi.ts +3321 -0
  18. package/api/sourcesApi.ts +5602 -0
  19. package/api/spacesApi.ts +489 -0
  20. package/api/testingApi.ts +568 -0
  21. package/api/trackingPlansApi.ts +6238 -0
  22. package/api/transformationsApi.ts +1316 -0
  23. package/api/warehousesApi.ts +5004 -0
  24. package/api/workspacesApi.ts +513 -0
  25. package/api.ts +3 -0
  26. package/dist/model/contact.d.ts +17 -0
  27. package/dist/model/contact.js +36 -0
  28. package/dist/model/contact.js.map +1 -0
  29. package/dist/model/destinationMetadata.d.ts +3 -0
  30. package/dist/model/destinationMetadata.js +10 -0
  31. package/dist/model/destinationMetadata.js.map +1 -1
  32. package/dist/model/destinationMetadataV1.d.ts +3 -0
  33. package/dist/model/destinationMetadataV1.js +10 -0
  34. package/dist/model/destinationMetadataV1.js.map +1 -1
  35. package/dist/model/metadata.d.ts +3 -0
  36. package/dist/model/metadata.js +10 -0
  37. package/dist/model/metadata.js.map +1 -1
  38. package/dist/model/models.d.ts +1 -0
  39. package/dist/model/models.js +3 -0
  40. package/dist/model/models.js.map +1 -1
  41. package/jest.config.js +10 -0
  42. package/model/aPICallSnapshotV1.ts +50 -0
  43. package/model/accessPermissionV1.ts +60 -0
  44. package/model/addConnectionFromSourceToWarehouse200Response.ts +36 -0
  45. package/model/addConnectionFromSourceToWarehouseV1Output.ts +48 -0
  46. package/model/addLabelsToSource200Response.ts +36 -0
  47. package/model/addLabelsToSource200Response1.ts +36 -0
  48. package/model/addLabelsToSourceAlphaInput.ts +42 -0
  49. package/model/addLabelsToSourceAlphaOutput.ts +42 -0
  50. package/model/addLabelsToSourceV1Input.ts +42 -0
  51. package/model/addLabelsToSourceV1Output.ts +42 -0
  52. package/model/addPermissionsToUser200Response.ts +36 -0
  53. package/model/addPermissionsToUserGroup200Response.ts +36 -0
  54. package/model/addPermissionsToUserGroupV1Input.ts +42 -0
  55. package/model/addPermissionsToUserGroupV1Output.ts +42 -0
  56. package/model/addPermissionsToUserV1Input.ts +42 -0
  57. package/model/addPermissionsToUserV1Output.ts +42 -0
  58. package/model/addSourceToTrackingPlan200Response.ts +36 -0
  59. package/model/addSourceToTrackingPlanV1Input.ts +41 -0
  60. package/model/addSourceToTrackingPlanV1Output.ts +47 -0
  61. package/model/addUsersToUserGroup200Response.ts +36 -0
  62. package/model/addUsersToUserGroupV1Input.ts +41 -0
  63. package/model/addUsersToUserGroupV1Output.ts +39 -0
  64. package/model/advancedWarehouseSyncScheduleV1Input.ts +51 -0
  65. package/model/advancedWarehouseSyncScheduleV1Output.ts +51 -0
  66. package/model/allowedLabelBeta.ts +59 -0
  67. package/model/auditEventV1.ts +95 -0
  68. package/model/batchQueryMessagingSubscriptionsForSpace200Response.ts +36 -0
  69. package/model/batchQueryMessagingSubscriptionsForSpaceAlphaInput.ts +42 -0
  70. package/model/batchQueryMessagingSubscriptionsForSpaceAlphaOutput.ts +69 -0
  71. package/model/breakdownBeta.ts +50 -0
  72. package/model/commonSourceSettingsV1.ts +68 -0
  73. package/model/contact.ts +68 -0
  74. package/model/createCloudSourceRegulation200Response.ts +36 -0
  75. package/model/createCloudSourceRegulationV1Input.ts +82 -0
  76. package/model/createCloudSourceRegulationV1Output.ts +41 -0
  77. package/model/createDestination200Response.ts +36 -0
  78. package/model/createDestinationSubscription200Response.ts +36 -0
  79. package/model/createDestinationSubscriptionAlphaInput.ts +77 -0
  80. package/model/createDestinationSubscriptionAlphaOutput.ts +39 -0
  81. package/model/createDestinationV1Input.ts +77 -0
  82. package/model/createDestinationV1Output.ts +39 -0
  83. package/model/createEdgeFunctions200Response.ts +36 -0
  84. package/model/createEdgeFunctionsAlphaInput.ts +41 -0
  85. package/model/createEdgeFunctionsAlphaOutput.ts +39 -0
  86. package/model/createFilterForDestination200Response.ts +36 -0
  87. package/model/createFilterForDestinationV1Input.ts +87 -0
  88. package/model/createFilterForDestinationV1Output.ts +39 -0
  89. package/model/createFunction200Response.ts +36 -0
  90. package/model/createFunctionDeployment200Response.ts +36 -0
  91. package/model/createFunctionDeploymentV1Output.ts +39 -0
  92. package/model/createFunctionV1Input.ts +94 -0
  93. package/model/createFunctionV1Output.ts +39 -0
  94. package/model/createInvites200Response.ts +36 -0
  95. package/model/createInvitesV1Input.ts +42 -0
  96. package/model/createInvitesV1Output.ts +41 -0
  97. package/model/createLabel200Response.ts +36 -0
  98. package/model/createLabel200Response1.ts +36 -0
  99. package/model/createLabelAlphaInput.ts +39 -0
  100. package/model/createLabelAlphaOutput.ts +42 -0
  101. package/model/createLabelV1Input.ts +39 -0
  102. package/model/createLabelV1Output.ts +39 -0
  103. package/model/createSource200Response.ts +36 -0
  104. package/model/createSource200Response1.ts +36 -0
  105. package/model/createSourceAlphaInput.ts +77 -0
  106. package/model/createSourceAlphaOutput.ts +39 -0
  107. package/model/createSourceRegulation200Response.ts +36 -0
  108. package/model/createSourceRegulationV1Input.ts +73 -0
  109. package/model/createSourceRegulationV1Output.ts +41 -0
  110. package/model/createSourceV1Input.ts +68 -0
  111. package/model/createSourceV1Output.ts +39 -0
  112. package/model/createTrackingPlan200Response.ts +36 -0
  113. package/model/createTrackingPlanV1Input.ts +68 -0
  114. package/model/createTrackingPlanV1Output.ts +39 -0
  115. package/model/createTransformation200Response.ts +36 -0
  116. package/model/createTransformationBetaInput.ts +96 -0
  117. package/model/createTransformationBetaOutput.ts +39 -0
  118. package/model/createUserGroup200Response.ts +36 -0
  119. package/model/createUserGroupV1Input.ts +41 -0
  120. package/model/createUserGroupV1Output.ts +39 -0
  121. package/model/createValidationInWarehouse200Response.ts +36 -0
  122. package/model/createValidationInWarehouseV1Input.ts +50 -0
  123. package/model/createValidationInWarehouseV1Output.ts +48 -0
  124. package/model/createWarehouse200Response.ts +36 -0
  125. package/model/createWarehouseV1Input.ts +68 -0
  126. package/model/createWarehouseV1Output.ts +39 -0
  127. package/model/createWorkspaceRegulation200Response.ts +36 -0
  128. package/model/createWorkspaceRegulationV1Input.ts +74 -0
  129. package/model/createWorkspaceRegulationV1Output.ts +41 -0
  130. package/model/deleteDestination200Response.ts +36 -0
  131. package/model/deleteDestinationV1Output.ts +47 -0
  132. package/model/deleteFunction200Response.ts +36 -0
  133. package/model/deleteFunctionV1Output.ts +47 -0
  134. package/model/deleteInvites200Response.ts +36 -0
  135. package/model/deleteInvitesV1Output.ts +47 -0
  136. package/model/deleteLabel200Response.ts +36 -0
  137. package/model/deleteLabel200Response1.ts +36 -0
  138. package/model/deleteLabelAlphaOutput.ts +47 -0
  139. package/model/deleteLabelV1Output.ts +47 -0
  140. package/model/deleteRegulation200Response.ts +36 -0
  141. package/model/deleteRegulationV1Output.ts +47 -0
  142. package/model/deleteSource200Response.ts +36 -0
  143. package/model/deleteSource200Response1.ts +36 -0
  144. package/model/deleteSourceAlphaOutput.ts +47 -0
  145. package/model/deleteSourceV1Output.ts +47 -0
  146. package/model/deleteTrackingPlan200Response.ts +36 -0
  147. package/model/deleteTrackingPlanV1Output.ts +47 -0
  148. package/model/deleteTransformation200Response.ts +36 -0
  149. package/model/deleteTransformationBetaOutput.ts +47 -0
  150. package/model/deleteUserGroup200Response.ts +36 -0
  151. package/model/deleteUserGroupV1Output.ts +47 -0
  152. package/model/deleteUsers200Response.ts +36 -0
  153. package/model/deleteUsersV1Output.ts +47 -0
  154. package/model/deleteWarehouse200Response.ts +36 -0
  155. package/model/deleteWarehouseV1Output.ts +47 -0
  156. package/model/deliveryMetricsSummary.ts +60 -0
  157. package/model/deliveryMetricsSummaryBeta.ts +60 -0
  158. package/model/destination.ts +84 -0
  159. package/model/destination1.ts +84 -0
  160. package/model/destination2.ts +84 -0
  161. package/model/destinationFilterActionV1.ts +77 -0
  162. package/model/destinationFilterV1.ts +123 -0
  163. package/model/destinationMetadata.ts +203 -0
  164. package/model/destinationMetadataActionFieldV1.ts +163 -0
  165. package/model/destinationMetadataActionV1.ts +113 -0
  166. package/model/destinationMetadataComponentV1.ts +72 -0
  167. package/model/destinationMetadataFeaturesV1.ts +93 -0
  168. package/model/destinationMetadataMethodsV1.ts +77 -0
  169. package/model/destinationMetadataPlatformsV1.ts +59 -0
  170. package/model/destinationMetadataSubscriptionPresetV1.ts +68 -0
  171. package/model/destinationMetadataV1.ts +203 -0
  172. package/model/destinationStatusV1.ts +74 -0
  173. package/model/destinationSubscription.ts +104 -0
  174. package/model/destinationSubscriptionUpdateInput.ts +68 -0
  175. package/model/destinationV1.ts +84 -0
  176. package/model/disableEdgeFunctions200Response.ts +36 -0
  177. package/model/disableEdgeFunctionsAlphaOutput.ts +39 -0
  178. package/model/echo200Response.ts +36 -0
  179. package/model/echo200Response1.ts +36 -0
  180. package/model/echoAlphaOutput.ts +66 -0
  181. package/model/echoV1Output.ts +66 -0
  182. package/model/edgeFunctions.ts +86 -0
  183. package/model/edgeFunctions1.ts +86 -0
  184. package/model/edgeFunctionsAlpha.ts +86 -0
  185. package/model/eventSourceV1.ts +59 -0
  186. package/model/filter.ts +51 -0
  187. package/model/filter1.ts +123 -0
  188. package/model/filter2.ts +123 -0
  189. package/model/filter3.ts +123 -0
  190. package/model/function.ts +166 -0
  191. package/model/function1.ts +166 -0
  192. package/model/function2.ts +166 -0
  193. package/model/functionDeployment.ts +44 -0
  194. package/model/functionSettingV1.ts +92 -0
  195. package/model/functionV1.ts +166 -0
  196. package/model/generateUploadURLForEdgeFunctions200Response.ts +36 -0
  197. package/model/generateUploadURLForEdgeFunctionsAlphaOutput.ts +41 -0
  198. package/model/getAdvancedSyncScheduleFromWarehouse200Response.ts +36 -0
  199. package/model/getAdvancedSyncScheduleFromWarehouseV1Output.ts +48 -0
  200. package/model/getConnectionStateFromWarehouse200Response.ts +36 -0
  201. package/model/getConnectionStateFromWarehouseV1Output.ts +48 -0
  202. package/model/getDailyPerSourceAPICallsUsage200Response.ts +36 -0
  203. package/model/getDailyPerSourceAPICallsUsageV1Output.ts +49 -0
  204. package/model/getDailyPerSourceMTUUsage200Response.ts +36 -0
  205. package/model/getDailyPerSourceMTUUsageV1Output.ts +49 -0
  206. package/model/getDailyWorkspaceAPICallsUsage200Response.ts +36 -0
  207. package/model/getDailyWorkspaceAPICallsUsageV1Output.ts +49 -0
  208. package/model/getDailyWorkspaceMTUUsage200Response.ts +36 -0
  209. package/model/getDailyWorkspaceMTUUsageV1Output.ts +49 -0
  210. package/model/getDestination200Response.ts +36 -0
  211. package/model/getDestinationMetadata200Response.ts +36 -0
  212. package/model/getDestinationMetadataV1Output.ts +39 -0
  213. package/model/getDestinationV1Output.ts +39 -0
  214. package/model/getDestinationsCatalog200Response.ts +36 -0
  215. package/model/getDestinationsCatalogV1Output.ts +49 -0
  216. package/model/getEventsVolumeFromWorkspace200Response.ts +36 -0
  217. package/model/getEventsVolumeFromWorkspaceV1Output.ts +49 -0
  218. package/model/getFilterInDestination200Response.ts +36 -0
  219. package/model/getFilterInDestinationV1Output.ts +39 -0
  220. package/model/getFunction200Response.ts +36 -0
  221. package/model/getFunctionV1Output.ts +39 -0
  222. package/model/getLatestFromEdgeFunctions200Response.ts +36 -0
  223. package/model/getLatestFromEdgeFunctionsAlphaOutput.ts +39 -0
  224. package/model/getMessagingSubscriptionFailureResponse.ts +57 -0
  225. package/model/getMessagingSubscriptionSuccessResponse.ts +68 -0
  226. package/model/getRegulation200Response.ts +36 -0
  227. package/model/getRegulationV1Output.ts +39 -0
  228. package/model/getSource200Response.ts +36 -0
  229. package/model/getSource200Response1.ts +36 -0
  230. package/model/getSourceAlphaOutput.ts +39 -0
  231. package/model/getSourceMetadata200Response.ts +36 -0
  232. package/model/getSourceMetadataV1Output.ts +39 -0
  233. package/model/getSourceV1Output.ts +39 -0
  234. package/model/getSourcesCatalog200Response.ts +36 -0
  235. package/model/getSourcesCatalogV1Output.ts +49 -0
  236. package/model/getSpace200Response.ts +36 -0
  237. package/model/getSpaceAlphaOutput.ts +39 -0
  238. package/model/getSubscriptionFromDestination200Response.ts +36 -0
  239. package/model/getSubscriptionFromDestinationAlphaOutput.ts +39 -0
  240. package/model/getSubscriptionRequest.ts +54 -0
  241. package/model/getTrackingPlan200Response.ts +36 -0
  242. package/model/getTrackingPlanV1Output.ts +39 -0
  243. package/model/getTransformation200Response.ts +36 -0
  244. package/model/getTransformationBetaOutput.ts +39 -0
  245. package/model/getUser200Response.ts +36 -0
  246. package/model/getUserGroup200Response.ts +36 -0
  247. package/model/getUserGroupV1Output.ts +39 -0
  248. package/model/getUserV1Output.ts +39 -0
  249. package/model/getWarehouse200Response.ts +36 -0
  250. package/model/getWarehouseMetadata200Response.ts +36 -0
  251. package/model/getWarehouseMetadataV1Output.ts +39 -0
  252. package/model/getWarehouseV1Output.ts +39 -0
  253. package/model/getWarehousesCatalog200Response.ts +36 -0
  254. package/model/getWarehousesCatalogV1Output.ts +49 -0
  255. package/model/getWorkspace200Response.ts +36 -0
  256. package/model/getWorkspaceV1Output.ts +39 -0
  257. package/model/group.ts +67 -0
  258. package/model/groupSourceSettingsV1.ts +64 -0
  259. package/model/identify.ts +67 -0
  260. package/model/identifySourceSettingsV1.ts +64 -0
  261. package/model/input.ts +68 -0
  262. package/model/integrationOptionBeta.ts +86 -0
  263. package/model/invitePermissionV1.ts +61 -0
  264. package/model/inviteV1.ts +51 -0
  265. package/model/label.ts +59 -0
  266. package/model/label1.ts +59 -0
  267. package/model/label2.ts +59 -0
  268. package/model/labelAlpha.ts +59 -0
  269. package/model/labelV1.ts +59 -0
  270. package/model/listAuditEvents200Response.ts +36 -0
  271. package/model/listAuditEventsV1Output.ts +49 -0
  272. package/model/listConnectedDestinationsFromSource200Response.ts +36 -0
  273. package/model/listConnectedDestinationsFromSource200Response1.ts +36 -0
  274. package/model/listConnectedDestinationsFromSourceAlphaOutput.ts +49 -0
  275. package/model/listConnectedDestinationsFromSourceV1Output.ts +49 -0
  276. package/model/listConnectedSourcesFromWarehouse200Response.ts +36 -0
  277. package/model/listConnectedSourcesFromWarehouseV1Output.ts +49 -0
  278. package/model/listConnectedWarehousesFromSource200Response.ts +36 -0
  279. package/model/listConnectedWarehousesFromSource200Response1.ts +36 -0
  280. package/model/listConnectedWarehousesFromSourceAlphaOutput.ts +49 -0
  281. package/model/listConnectedWarehousesFromSourceV1Output.ts +49 -0
  282. package/model/listDeliveryMetricsSummaryFromDestination200Response.ts +36 -0
  283. package/model/listDeliveryMetricsSummaryFromDestinationBetaOutput.ts +39 -0
  284. package/model/listDestinations200Response.ts +36 -0
  285. package/model/listDestinationsV1Output.ts +49 -0
  286. package/model/listFiltersFromDestination200Response.ts +36 -0
  287. package/model/listFiltersFromDestinationV1Output.ts +49 -0
  288. package/model/listFunctionItemV1.ts +111 -0
  289. package/model/listFunctions200Response.ts +36 -0
  290. package/model/listFunctionsV1Output.ts +49 -0
  291. package/model/listInvites200Response.ts +36 -0
  292. package/model/listInvitesFromUserGroup200Response.ts +36 -0
  293. package/model/listInvitesFromUserGroupV1Output.ts +48 -0
  294. package/model/listInvitesV1Output.ts +48 -0
  295. package/model/listLabels200Response.ts +36 -0
  296. package/model/listLabels200Response1.ts +36 -0
  297. package/model/listLabelsAlphaOutput.ts +42 -0
  298. package/model/listLabelsV1Output.ts +42 -0
  299. package/model/listRegulationsFromSource200Response.ts +36 -0
  300. package/model/listRegulationsFromSourceV1Output.ts +42 -0
  301. package/model/listRoles200Response.ts +36 -0
  302. package/model/listRolesV1Output.ts +49 -0
  303. package/model/listRulesFromTrackingPlan200Response.ts +36 -0
  304. package/model/listRulesFromTrackingPlanV1Output.ts +49 -0
  305. package/model/listSchemaSettingsInSource200Response.ts +36 -0
  306. package/model/listSchemaSettingsInSourceV1Output.ts +48 -0
  307. package/model/listSelectiveSyncsFromWarehouseAndSource200Response.ts +36 -0
  308. package/model/listSelectiveSyncsFromWarehouseAndSourceV1Output.ts +49 -0
  309. package/model/listSources200Response.ts +36 -0
  310. package/model/listSources200Response1.ts +36 -0
  311. package/model/listSourcesAlphaOutput.ts +49 -0
  312. package/model/listSourcesFromTrackingPlan200Response.ts +36 -0
  313. package/model/listSourcesFromTrackingPlanV1Output.ts +49 -0
  314. package/model/listSourcesV1Output.ts +49 -0
  315. package/model/listSubscriptionsFromDestination200Response.ts +36 -0
  316. package/model/listSubscriptionsFromDestinationAlphaOutput.ts +49 -0
  317. package/model/listSuppressions200Response.ts +36 -0
  318. package/model/listSuppressionsV1Output.ts +49 -0
  319. package/model/listSyncsFromWarehouse200Response.ts +36 -0
  320. package/model/listSyncsFromWarehouseAndSource200Response.ts +36 -0
  321. package/model/listSyncsFromWarehouseAndSourceV1Output.ts +49 -0
  322. package/model/listSyncsFromWarehouseV1Output.ts +49 -0
  323. package/model/listTrackingPlans200Response.ts +36 -0
  324. package/model/listTrackingPlansV1Output.ts +49 -0
  325. package/model/listTransformations200Response.ts +36 -0
  326. package/model/listTransformationsBetaOutput.ts +49 -0
  327. package/model/listUserGroups200Response.ts +36 -0
  328. package/model/listUserGroupsFromUser200Response.ts +36 -0
  329. package/model/listUserGroupsFromUserV1Output.ts +49 -0
  330. package/model/listUserGroupsV1Output.ts +49 -0
  331. package/model/listUsers200Response.ts +36 -0
  332. package/model/listUsersFromUserGroup200Response.ts +36 -0
  333. package/model/listUsersFromUserGroupV1Output.ts +49 -0
  334. package/model/listUsersV1Output.ts +49 -0
  335. package/model/listWarehouses200Response.ts +36 -0
  336. package/model/listWarehousesV1Output.ts +49 -0
  337. package/model/listWorkspaceRegulations200Response.ts +36 -0
  338. package/model/listWorkspaceRegulationsV1Output.ts +49 -0
  339. package/model/logos.ts +59 -0
  340. package/model/logos1.ts +59 -0
  341. package/model/logos2.ts +59 -0
  342. package/model/logosBeta.ts +59 -0
  343. package/model/messageSubscriptionResponse.ts +78 -0
  344. package/model/messageSubscriptionResponseError.ts +47 -0
  345. package/model/messagesSubscriptionRequest.ts +68 -0
  346. package/model/metadata.ts +203 -0
  347. package/model/metadata1.ts +103 -0
  348. package/model/metadata2.ts +85 -0
  349. package/model/metricBeta.ts +60 -0
  350. package/model/minimalUserGroupV1.ts +50 -0
  351. package/model/minimalUserV1.ts +59 -0
  352. package/model/models.ts +1838 -0
  353. package/model/mtuSnapshotV1.ts +95 -0
  354. package/model/pagination.ts +68 -0
  355. package/model/paginationInput.ts +50 -0
  356. package/model/paginationOutput.ts +68 -0
  357. package/model/permissionInputV1.ts +51 -0
  358. package/model/permissionResourceV1.ts +70 -0
  359. package/model/permissionV1.ts +70 -0
  360. package/model/previewDestinationFilter200Response.ts +36 -0
  361. package/model/previewDestinationFilterV1.ts +51 -0
  362. package/model/previewDestinationFilterV1Input.ts +48 -0
  363. package/model/previewDestinationFilterV1Output.ts +50 -0
  364. package/model/propertyRenameBeta.ts +47 -0
  365. package/model/regulation.ts +99 -0
  366. package/model/regulationListEntryV1.ts +77 -0
  367. package/model/removeFilterFromDestination200Response.ts +36 -0
  368. package/model/removeFilterFromDestinationV1Output.ts +47 -0
  369. package/model/removeRuleV1.ts +61 -0
  370. package/model/removeRulesFromTrackingPlan200Response.ts +36 -0
  371. package/model/removeRulesFromTrackingPlanV1Output.ts +47 -0
  372. package/model/removeSourceConnectionFromWarehouse200Response.ts +36 -0
  373. package/model/removeSourceConnectionFromWarehouseV1Output.ts +47 -0
  374. package/model/removeSourceFromTrackingPlan200Response.ts +36 -0
  375. package/model/removeSourceFromTrackingPlanV1Output.ts +47 -0
  376. package/model/removeSubscriptionFromDestination200Response.ts +36 -0
  377. package/model/removeSubscriptionFromDestinationAlphaOutput.ts +47 -0
  378. package/model/removeUsersFromUserGroup200Response.ts +36 -0
  379. package/model/removeUsersFromUserGroupV1Output.ts +47 -0
  380. package/model/replaceAdvancedSyncScheduleForWarehouse200Response.ts +36 -0
  381. package/model/replaceAdvancedSyncScheduleForWarehouseV1Input.ts +48 -0
  382. package/model/replaceAdvancedSyncScheduleForWarehouseV1Output.ts +48 -0
  383. package/model/replaceLabelsInSource200Response.ts +36 -0
  384. package/model/replaceLabelsInSource200Response1.ts +36 -0
  385. package/model/replaceLabelsInSourceAlphaInput.ts +42 -0
  386. package/model/replaceLabelsInSourceAlphaOutput.ts +42 -0
  387. package/model/replaceLabelsInSourceV1Input.ts +42 -0
  388. package/model/replaceLabelsInSourceV1Output.ts +42 -0
  389. package/model/replaceMessagingSubscriptionsInSpaces200Response.ts +36 -0
  390. package/model/replaceMessagingSubscriptionsInSpacesAlphaInput.ts +42 -0
  391. package/model/replaceMessagingSubscriptionsInSpacesAlphaOutput.ts +58 -0
  392. package/model/replacePermissionsForUser200Response.ts +36 -0
  393. package/model/replacePermissionsForUserGroup200Response.ts +36 -0
  394. package/model/replacePermissionsForUserGroupV1Input.ts +42 -0
  395. package/model/replacePermissionsForUserGroupV1Output.ts +42 -0
  396. package/model/replacePermissionsForUserV1Input.ts +42 -0
  397. package/model/replacePermissionsForUserV1Output.ts +42 -0
  398. package/model/replaceRulesInTrackingPlan200Response.ts +36 -0
  399. package/model/replaceRulesInTrackingPlanV1Input.ts +42 -0
  400. package/model/replaceRulesInTrackingPlanV1Output.ts +47 -0
  401. package/model/replaceUsersInUserGroup200Response.ts +36 -0
  402. package/model/replaceUsersInUserGroupV1Input.ts +41 -0
  403. package/model/replaceUsersInUserGroupV1Output.ts +39 -0
  404. package/model/requestError.ts +77 -0
  405. package/model/requestErrorEnvelope.ts +39 -0
  406. package/model/resourceV1.ts +60 -0
  407. package/model/roleV1.ts +59 -0
  408. package/model/ruleV1.ts +106 -0
  409. package/model/schedule.ts +51 -0
  410. package/model/schedule1.ts +51 -0
  411. package/model/schedule2.ts +51 -0
  412. package/model/settings.ts +71 -0
  413. package/model/settings1.ts +71 -0
  414. package/model/source.ts +59 -0
  415. package/model/source1.ts +112 -0
  416. package/model/source2.ts +112 -0
  417. package/model/source3.ts +112 -0
  418. package/model/source4.ts +112 -0
  419. package/model/source5.ts +112 -0
  420. package/model/source6.ts +112 -0
  421. package/model/sourceAPICallSnapshotV1.ts +59 -0
  422. package/model/sourceAlpha.ts +112 -0
  423. package/model/sourceEventVolumeDatapointV1.ts +50 -0
  424. package/model/sourceEventVolumeV1.ts +76 -0
  425. package/model/sourceMetadata.ts +103 -0
  426. package/model/sourceMetadataV1.ts +103 -0
  427. package/model/sourceSettingsOutputV1.ts +71 -0
  428. package/model/sourceV1.ts +112 -0
  429. package/model/space.ts +50 -0
  430. package/model/streamStatusV1.ts +45 -0
  431. package/model/subscription.ts +104 -0
  432. package/model/supportedFeatures.ts +93 -0
  433. package/model/supportedMethods.ts +77 -0
  434. package/model/supportedPlatforms.ts +59 -0
  435. package/model/suppressedInner.ts +41 -0
  436. package/model/syncNoticeV1.ts +59 -0
  437. package/model/syncV1.ts +105 -0
  438. package/model/track.ts +85 -0
  439. package/model/trackSourceSettingsV1.ts +82 -0
  440. package/model/trackingPlan.ts +104 -0
  441. package/model/trackingPlan1.ts +104 -0
  442. package/model/trackingPlanV1.ts +104 -0
  443. package/model/transformation.ts +105 -0
  444. package/model/transformation1.ts +105 -0
  445. package/model/transformation2.ts +105 -0
  446. package/model/transformationBeta.ts +105 -0
  447. package/model/updateDestination200Response.ts +36 -0
  448. package/model/updateDestinationV1Input.ts +59 -0
  449. package/model/updateDestinationV1Output.ts +39 -0
  450. package/model/updateFilterForDestination200Response.ts +36 -0
  451. package/model/updateFilterForDestinationV1Input.ts +78 -0
  452. package/model/updateFilterForDestinationV1Output.ts +39 -0
  453. package/model/updateFunction200Response.ts +36 -0
  454. package/model/updateFunctionV1Input.ts +78 -0
  455. package/model/updateFunctionV1Output.ts +39 -0
  456. package/model/updateRulesInTrackingPlan200Response.ts +36 -0
  457. package/model/updateRulesInTrackingPlanV1Input.ts +42 -0
  458. package/model/updateRulesInTrackingPlanV1Output.ts +47 -0
  459. package/model/updateSchemaSettingsInSource200Response.ts +36 -0
  460. package/model/updateSchemaSettingsInSourceV1Input.ts +71 -0
  461. package/model/updateSchemaSettingsInSourceV1Output.ts +48 -0
  462. package/model/updateSelectiveSyncForWarehouse200Response.ts +36 -0
  463. package/model/updateSelectiveSyncForWarehouseV1Input.ts +42 -0
  464. package/model/updateSelectiveSyncForWarehouseV1Output.ts +57 -0
  465. package/model/updateSource200Response.ts +36 -0
  466. package/model/updateSource200Response1.ts +36 -0
  467. package/model/updateSourceAlphaInput.ts +68 -0
  468. package/model/updateSourceAlphaOutput.ts +39 -0
  469. package/model/updateSourceV1Input.ts +68 -0
  470. package/model/updateSourceV1Output.ts +39 -0
  471. package/model/updateSubscriptionForDestination200Response.ts +36 -0
  472. package/model/updateSubscriptionForDestinationAlphaInput.ts +39 -0
  473. package/model/updateSubscriptionForDestinationAlphaOutput.ts +39 -0
  474. package/model/updateTrackingPlan200Response.ts +36 -0
  475. package/model/updateTrackingPlanV1Input.ts +50 -0
  476. package/model/updateTrackingPlanV1Output.ts +47 -0
  477. package/model/updateTransformation200Response.ts +36 -0
  478. package/model/updateTransformationBetaInput.ts +96 -0
  479. package/model/updateTransformationBetaOutput.ts +39 -0
  480. package/model/updateUserGroup200Response.ts +36 -0
  481. package/model/updateUserGroupV1Input.ts +41 -0
  482. package/model/updateUserGroupV1Output.ts +39 -0
  483. package/model/updateWarehouse200Response.ts +36 -0
  484. package/model/updateWarehouseV1Input.ts +59 -0
  485. package/model/updateWarehouseV1Output.ts +39 -0
  486. package/model/upsertRuleV1.ts +112 -0
  487. package/model/user.ts +69 -0
  488. package/model/userGroup.ts +69 -0
  489. package/model/userGroup1.ts +69 -0
  490. package/model/userGroup2.ts +69 -0
  491. package/model/userGroup3.ts +69 -0
  492. package/model/userGroupV1.ts +69 -0
  493. package/model/userV1.ts +69 -0
  494. package/model/usersPerSourceSnapshotV1.ts +104 -0
  495. package/model/warehouse.ts +75 -0
  496. package/model/warehouse1.ts +75 -0
  497. package/model/warehouse2.ts +75 -0
  498. package/model/warehouseAdvancedSyncV1.ts +50 -0
  499. package/model/warehouseMetadata.ts +85 -0
  500. package/model/warehouseMetadataV1.ts +85 -0
  501. package/model/warehouseSelectiveSyncItemV1.ts +68 -0
  502. package/model/warehouseSyncOverrideV1.ts +68 -0
  503. package/model/warehouseV1.ts +75 -0
  504. package/model/workspace.ts +59 -0
  505. package/model/workspaceV1.ts +59 -0
  506. package/package.json +1 -2
  507. package/tests/__snapshots__/smoke.test.ts.snap +889 -0
  508. package/tests/smoke.test.ts +267 -0
  509. package/tsconfig.json +20 -0
@@ -0,0 +1,568 @@
1
+ /**
2
+ * Segment Public API
3
+ * The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. See the next sections for more information on how to use the Segment Public API.
4
+ *
5
+ * The version of the OpenAPI document: 32.0.2
6
+ * Contact: friends@segment.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
+ import localVarRequest from 'request';
14
+ import http from 'http';
15
+
16
+ /* tslint:disable:no-unused-locals */
17
+ import { Echo200Response } from '../model/echo200Response';
18
+ import { Echo200Response1 } from '../model/echo200Response1';
19
+ import { RequestErrorEnvelope } from '../model/requestErrorEnvelope';
20
+
21
+ import {
22
+ ObjectSerializer,
23
+ Authentication,
24
+ VoidAuth,
25
+ Interceptor,
26
+ } from '../model/models';
27
+ import {
28
+ HttpBasicAuth,
29
+ HttpBearerAuth,
30
+ ApiKeyAuth,
31
+ OAuth,
32
+ } from '../model/models';
33
+
34
+ import { HttpError, RequestFile } from './apis';
35
+
36
+ let defaultBasePath = 'https://api.segmentapis.com';
37
+
38
+ // ===============================================
39
+ // This file is autogenerated - Please do not edit
40
+ // ===============================================
41
+
42
+ export enum TestingApiApiKeys {}
43
+
44
+ export class TestingApi {
45
+ protected _basePath = defaultBasePath;
46
+ protected _defaultHeaders: any = {};
47
+ protected _useQuerystring: boolean = false;
48
+
49
+ protected authentications = {
50
+ default: <Authentication>new VoidAuth(),
51
+ token: new HttpBearerAuth(),
52
+ };
53
+
54
+ protected interceptors: Interceptor[] = [];
55
+
56
+ constructor(basePath?: string);
57
+ constructor(
58
+ basePathOrUsername: string,
59
+ password?: string,
60
+ basePath?: string
61
+ ) {
62
+ if (password) {
63
+ if (basePath) {
64
+ this.basePath = basePath;
65
+ }
66
+ } else {
67
+ if (basePathOrUsername) {
68
+ this.basePath = basePathOrUsername;
69
+ }
70
+ }
71
+ }
72
+
73
+ set useQuerystring(value: boolean) {
74
+ this._useQuerystring = value;
75
+ }
76
+
77
+ set basePath(basePath: string) {
78
+ this._basePath = basePath;
79
+ }
80
+
81
+ set defaultHeaders(defaultHeaders: any) {
82
+ this._defaultHeaders = defaultHeaders;
83
+ }
84
+
85
+ get defaultHeaders() {
86
+ return this._defaultHeaders;
87
+ }
88
+
89
+ get basePath() {
90
+ return this._basePath;
91
+ }
92
+
93
+ public setDefaultAuthentication(auth: Authentication) {
94
+ this.authentications.default = auth;
95
+ }
96
+
97
+ public setApiKey(key: TestingApiApiKeys, value: string) {
98
+ (this.authentications as any)[TestingApiApiKeys[key]].apiKey = value;
99
+ }
100
+
101
+ set accessToken(accessToken: string | (() => string)) {
102
+ this.authentications.token.accessToken = accessToken;
103
+ }
104
+
105
+ public addInterceptor(interceptor: Interceptor) {
106
+ this.interceptors.push(interceptor);
107
+ }
108
+
109
+ /**
110
+ * Public Echo endpoint.
111
+ * @summary Echo
112
+ * @param message Sets the response &#x60;message&#x60; field. The response contains this field\&#39;s entry. This parameter exists in v1.
113
+ * @param delay The desired response delay, in milliseconds. This parameter exists in v1.
114
+ * @param triggerError If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the string in &#x60;message&#x60;. This parameter exists in v1.
115
+ * @param triggerMultipleErrors If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the value of the &#x60;message&#x60; field in the error message array. This has no effect if the request sets &#x60;triggerError&#x60;. This parameter exists in v1.
116
+ * @param triggerUnexpectedError If &#x60;true&#x60;, triggers a &#x60;500&#x60; error. This has no effect if the request sets either &#x60;triggerError&#x60; or &#x60;triggerMultipleErrors&#x60;. This parameter exists in v1.
117
+ * @param statusCode Sets the HTTP status code to return. This parameter exists in v1.
118
+ */
119
+ public async echoAlpha(
120
+ message: string,
121
+ delay?: number,
122
+ triggerError?: boolean,
123
+ triggerMultipleErrors?: boolean,
124
+ triggerUnexpectedError?: boolean,
125
+ statusCode?: number,
126
+ options: { headers: { [name: string]: string } } = { headers: {} }
127
+ ): Promise<{ response: http.IncomingMessage; body: Echo200Response }> {
128
+ const localVarPath = this.basePath + '/echo';
129
+ let localVarQueryParameters: any = {};
130
+ let localVarHeaderParams: any = (<any>Object).assign(
131
+ {},
132
+ this._defaultHeaders
133
+ );
134
+ const produces = [
135
+ 'application/vnd.segment.v1alpha+json',
136
+ 'application/json',
137
+ ];
138
+ if (produces.indexOf('application/json') >= 0) {
139
+ localVarHeaderParams.Accept = produces[0];
140
+ } else {
141
+ localVarHeaderParams.Accept = 'application/json';
142
+ }
143
+ let localVarFormParams: any = {};
144
+
145
+ // verify required parameter 'message' is not null or undefined
146
+ if (message === null || message === undefined) {
147
+ throw new Error(
148
+ 'Required parameter message was null or undefined when calling echoAlpha.'
149
+ );
150
+ }
151
+
152
+ if (message !== undefined) {
153
+ localVarQueryParameters['message'] = ObjectSerializer.serialize(
154
+ message,
155
+ 'string'
156
+ );
157
+ }
158
+
159
+ if (delay !== undefined) {
160
+ localVarQueryParameters['delay'] = ObjectSerializer.serialize(
161
+ delay,
162
+ 'number'
163
+ );
164
+ }
165
+
166
+ if (triggerError !== undefined) {
167
+ localVarQueryParameters['triggerError'] =
168
+ ObjectSerializer.serialize(triggerError, 'boolean');
169
+ }
170
+
171
+ if (triggerMultipleErrors !== undefined) {
172
+ localVarQueryParameters['triggerMultipleErrors'] =
173
+ ObjectSerializer.serialize(triggerMultipleErrors, 'boolean');
174
+ }
175
+
176
+ if (triggerUnexpectedError !== undefined) {
177
+ localVarQueryParameters['triggerUnexpectedError'] =
178
+ ObjectSerializer.serialize(triggerUnexpectedError, 'boolean');
179
+ }
180
+
181
+ if (statusCode !== undefined) {
182
+ localVarQueryParameters['statusCode'] = ObjectSerializer.serialize(
183
+ statusCode,
184
+ 'number'
185
+ );
186
+ }
187
+
188
+ (<any>Object).assign(localVarHeaderParams, options.headers);
189
+
190
+ let localVarUseFormData = false;
191
+
192
+ let localVarRequestOptions: localVarRequest.Options = {
193
+ method: 'GET',
194
+ qs: localVarQueryParameters,
195
+ headers: localVarHeaderParams,
196
+ uri: localVarPath,
197
+ useQuerystring: this._useQuerystring,
198
+ json: true,
199
+ };
200
+
201
+ let authenticationPromise = Promise.resolve();
202
+ if (this.authentications.token.accessToken) {
203
+ authenticationPromise = authenticationPromise.then(() =>
204
+ this.authentications.token.applyToRequest(
205
+ localVarRequestOptions
206
+ )
207
+ );
208
+ }
209
+ authenticationPromise = authenticationPromise.then(() =>
210
+ this.authentications.default.applyToRequest(localVarRequestOptions)
211
+ );
212
+
213
+ let interceptorPromise = authenticationPromise;
214
+ for (const interceptor of this.interceptors) {
215
+ interceptorPromise = interceptorPromise.then(() =>
216
+ interceptor(localVarRequestOptions)
217
+ );
218
+ }
219
+
220
+ return interceptorPromise.then(() => {
221
+ if (Object.keys(localVarFormParams).length) {
222
+ if (localVarUseFormData) {
223
+ (<any>localVarRequestOptions).formData = localVarFormParams;
224
+ } else {
225
+ localVarRequestOptions.form = localVarFormParams;
226
+ }
227
+ }
228
+ return new Promise<{
229
+ response: http.IncomingMessage;
230
+ body: Echo200Response;
231
+ }>((resolve, reject) => {
232
+ localVarRequest(
233
+ localVarRequestOptions,
234
+ (error, response, body) => {
235
+ if (error) {
236
+ reject(error);
237
+ } else {
238
+ if (
239
+ response.statusCode &&
240
+ response.statusCode >= 200 &&
241
+ response.statusCode <= 299
242
+ ) {
243
+ body = ObjectSerializer.deserialize(
244
+ body,
245
+ 'Echo200Response'
246
+ );
247
+ resolve({ response: response, body: body });
248
+ } else {
249
+ reject(
250
+ new HttpError(
251
+ response,
252
+ body,
253
+ response.statusCode
254
+ )
255
+ );
256
+ }
257
+ }
258
+ }
259
+ );
260
+ });
261
+ });
262
+ }
263
+ /**
264
+ * Public Echo endpoint.
265
+ * @summary Echo
266
+ * @param message Sets the response &#x60;message&#x60; field. The response contains this field\&#39;s entry. This parameter exists in v1.
267
+ * @param delay The desired response delay, in milliseconds. This parameter exists in v1.
268
+ * @param triggerError If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the string in &#x60;message&#x60;. This parameter exists in v1.
269
+ * @param triggerMultipleErrors If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the value of the &#x60;message&#x60; field in the error message array. This has no effect if the request sets &#x60;triggerError&#x60;. This parameter exists in v1.
270
+ * @param triggerUnexpectedError If &#x60;true&#x60;, triggers a &#x60;500&#x60; error. This has no effect if the request sets either &#x60;triggerError&#x60; or &#x60;triggerMultipleErrors&#x60;. This parameter exists in v1.
271
+ * @param statusCode Sets the HTTP status code to return. This parameter exists in v1.
272
+ */
273
+ public async echoCurrent(
274
+ message: string,
275
+ delay?: number,
276
+ triggerError?: boolean,
277
+ triggerMultipleErrors?: boolean,
278
+ triggerUnexpectedError?: boolean,
279
+ statusCode?: number,
280
+ options: { headers: { [name: string]: string } } = { headers: {} }
281
+ ): Promise<{ response: http.IncomingMessage; body: Echo200Response1 }> {
282
+ const localVarPath = this.basePath + '/echo';
283
+ let localVarQueryParameters: any = {};
284
+ let localVarHeaderParams: any = (<any>Object).assign(
285
+ {},
286
+ this._defaultHeaders
287
+ );
288
+ const produces = ['application/json'];
289
+ if (produces.indexOf('application/json') >= 0) {
290
+ localVarHeaderParams.Accept = produces[0];
291
+ } else {
292
+ localVarHeaderParams.Accept = 'application/json';
293
+ }
294
+ let localVarFormParams: any = {};
295
+
296
+ // verify required parameter 'message' is not null or undefined
297
+ if (message === null || message === undefined) {
298
+ throw new Error(
299
+ 'Required parameter message was null or undefined when calling echoCurrent.'
300
+ );
301
+ }
302
+
303
+ if (message !== undefined) {
304
+ localVarQueryParameters['message'] = ObjectSerializer.serialize(
305
+ message,
306
+ 'string'
307
+ );
308
+ }
309
+
310
+ if (delay !== undefined) {
311
+ localVarQueryParameters['delay'] = ObjectSerializer.serialize(
312
+ delay,
313
+ 'number'
314
+ );
315
+ }
316
+
317
+ if (triggerError !== undefined) {
318
+ localVarQueryParameters['triggerError'] =
319
+ ObjectSerializer.serialize(triggerError, 'boolean');
320
+ }
321
+
322
+ if (triggerMultipleErrors !== undefined) {
323
+ localVarQueryParameters['triggerMultipleErrors'] =
324
+ ObjectSerializer.serialize(triggerMultipleErrors, 'boolean');
325
+ }
326
+
327
+ if (triggerUnexpectedError !== undefined) {
328
+ localVarQueryParameters['triggerUnexpectedError'] =
329
+ ObjectSerializer.serialize(triggerUnexpectedError, 'boolean');
330
+ }
331
+
332
+ if (statusCode !== undefined) {
333
+ localVarQueryParameters['statusCode'] = ObjectSerializer.serialize(
334
+ statusCode,
335
+ 'number'
336
+ );
337
+ }
338
+
339
+ (<any>Object).assign(localVarHeaderParams, options.headers);
340
+
341
+ let localVarUseFormData = false;
342
+
343
+ let localVarRequestOptions: localVarRequest.Options = {
344
+ method: 'GET',
345
+ qs: localVarQueryParameters,
346
+ headers: localVarHeaderParams,
347
+ uri: localVarPath,
348
+ useQuerystring: this._useQuerystring,
349
+ json: true,
350
+ };
351
+
352
+ let authenticationPromise = Promise.resolve();
353
+ if (this.authentications.token.accessToken) {
354
+ authenticationPromise = authenticationPromise.then(() =>
355
+ this.authentications.token.applyToRequest(
356
+ localVarRequestOptions
357
+ )
358
+ );
359
+ }
360
+ authenticationPromise = authenticationPromise.then(() =>
361
+ this.authentications.default.applyToRequest(localVarRequestOptions)
362
+ );
363
+
364
+ let interceptorPromise = authenticationPromise;
365
+ for (const interceptor of this.interceptors) {
366
+ interceptorPromise = interceptorPromise.then(() =>
367
+ interceptor(localVarRequestOptions)
368
+ );
369
+ }
370
+
371
+ return interceptorPromise.then(() => {
372
+ if (Object.keys(localVarFormParams).length) {
373
+ if (localVarUseFormData) {
374
+ (<any>localVarRequestOptions).formData = localVarFormParams;
375
+ } else {
376
+ localVarRequestOptions.form = localVarFormParams;
377
+ }
378
+ }
379
+ return new Promise<{
380
+ response: http.IncomingMessage;
381
+ body: Echo200Response1;
382
+ }>((resolve, reject) => {
383
+ localVarRequest(
384
+ localVarRequestOptions,
385
+ (error, response, body) => {
386
+ if (error) {
387
+ reject(error);
388
+ } else {
389
+ if (
390
+ response.statusCode &&
391
+ response.statusCode >= 200 &&
392
+ response.statusCode <= 299
393
+ ) {
394
+ body = ObjectSerializer.deserialize(
395
+ body,
396
+ 'Echo200Response1'
397
+ );
398
+ resolve({ response: response, body: body });
399
+ } else {
400
+ reject(
401
+ new HttpError(
402
+ response,
403
+ body,
404
+ response.statusCode
405
+ )
406
+ );
407
+ }
408
+ }
409
+ }
410
+ );
411
+ });
412
+ });
413
+ }
414
+ /**
415
+ * Public Echo endpoint.
416
+ * @summary Echo
417
+ * @param message Sets the response &#x60;message&#x60; field. The response contains this field\&#39;s entry. This parameter exists in v1.
418
+ * @param delay The desired response delay, in milliseconds. This parameter exists in v1.
419
+ * @param triggerError If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the string in &#x60;message&#x60;. This parameter exists in v1.
420
+ * @param triggerMultipleErrors If &#x60;true&#x60;, returns an HTTP &#x60;4xx&#x60; error that contains the value of the &#x60;message&#x60; field in the error message array. This has no effect if the request sets &#x60;triggerError&#x60;. This parameter exists in v1.
421
+ * @param triggerUnexpectedError If &#x60;true&#x60;, triggers a &#x60;500&#x60; error. This has no effect if the request sets either &#x60;triggerError&#x60; or &#x60;triggerMultipleErrors&#x60;. This parameter exists in v1.
422
+ * @param statusCode Sets the HTTP status code to return. This parameter exists in v1.
423
+ */
424
+ public async echoV1(
425
+ message: string,
426
+ delay?: number,
427
+ triggerError?: boolean,
428
+ triggerMultipleErrors?: boolean,
429
+ triggerUnexpectedError?: boolean,
430
+ statusCode?: number,
431
+ options: { headers: { [name: string]: string } } = { headers: {} }
432
+ ): Promise<{ response: http.IncomingMessage; body: Echo200Response1 }> {
433
+ const localVarPath = this.basePath + '/echo';
434
+ let localVarQueryParameters: any = {};
435
+ let localVarHeaderParams: any = (<any>Object).assign(
436
+ {},
437
+ this._defaultHeaders
438
+ );
439
+ const produces = [
440
+ 'application/vnd.segment.v1+json',
441
+ 'application/json',
442
+ ];
443
+ if (produces.indexOf('application/json') >= 0) {
444
+ localVarHeaderParams.Accept = produces[0];
445
+ } else {
446
+ localVarHeaderParams.Accept = 'application/json';
447
+ }
448
+ let localVarFormParams: any = {};
449
+
450
+ // verify required parameter 'message' is not null or undefined
451
+ if (message === null || message === undefined) {
452
+ throw new Error(
453
+ 'Required parameter message was null or undefined when calling echoV1.'
454
+ );
455
+ }
456
+
457
+ if (message !== undefined) {
458
+ localVarQueryParameters['message'] = ObjectSerializer.serialize(
459
+ message,
460
+ 'string'
461
+ );
462
+ }
463
+
464
+ if (delay !== undefined) {
465
+ localVarQueryParameters['delay'] = ObjectSerializer.serialize(
466
+ delay,
467
+ 'number'
468
+ );
469
+ }
470
+
471
+ if (triggerError !== undefined) {
472
+ localVarQueryParameters['triggerError'] =
473
+ ObjectSerializer.serialize(triggerError, 'boolean');
474
+ }
475
+
476
+ if (triggerMultipleErrors !== undefined) {
477
+ localVarQueryParameters['triggerMultipleErrors'] =
478
+ ObjectSerializer.serialize(triggerMultipleErrors, 'boolean');
479
+ }
480
+
481
+ if (triggerUnexpectedError !== undefined) {
482
+ localVarQueryParameters['triggerUnexpectedError'] =
483
+ ObjectSerializer.serialize(triggerUnexpectedError, 'boolean');
484
+ }
485
+
486
+ if (statusCode !== undefined) {
487
+ localVarQueryParameters['statusCode'] = ObjectSerializer.serialize(
488
+ statusCode,
489
+ 'number'
490
+ );
491
+ }
492
+
493
+ (<any>Object).assign(localVarHeaderParams, options.headers);
494
+
495
+ let localVarUseFormData = false;
496
+
497
+ let localVarRequestOptions: localVarRequest.Options = {
498
+ method: 'GET',
499
+ qs: localVarQueryParameters,
500
+ headers: localVarHeaderParams,
501
+ uri: localVarPath,
502
+ useQuerystring: this._useQuerystring,
503
+ json: true,
504
+ };
505
+
506
+ let authenticationPromise = Promise.resolve();
507
+ if (this.authentications.token.accessToken) {
508
+ authenticationPromise = authenticationPromise.then(() =>
509
+ this.authentications.token.applyToRequest(
510
+ localVarRequestOptions
511
+ )
512
+ );
513
+ }
514
+ authenticationPromise = authenticationPromise.then(() =>
515
+ this.authentications.default.applyToRequest(localVarRequestOptions)
516
+ );
517
+
518
+ let interceptorPromise = authenticationPromise;
519
+ for (const interceptor of this.interceptors) {
520
+ interceptorPromise = interceptorPromise.then(() =>
521
+ interceptor(localVarRequestOptions)
522
+ );
523
+ }
524
+
525
+ return interceptorPromise.then(() => {
526
+ if (Object.keys(localVarFormParams).length) {
527
+ if (localVarUseFormData) {
528
+ (<any>localVarRequestOptions).formData = localVarFormParams;
529
+ } else {
530
+ localVarRequestOptions.form = localVarFormParams;
531
+ }
532
+ }
533
+ return new Promise<{
534
+ response: http.IncomingMessage;
535
+ body: Echo200Response1;
536
+ }>((resolve, reject) => {
537
+ localVarRequest(
538
+ localVarRequestOptions,
539
+ (error, response, body) => {
540
+ if (error) {
541
+ reject(error);
542
+ } else {
543
+ if (
544
+ response.statusCode &&
545
+ response.statusCode >= 200 &&
546
+ response.statusCode <= 299
547
+ ) {
548
+ body = ObjectSerializer.deserialize(
549
+ body,
550
+ 'Echo200Response1'
551
+ );
552
+ resolve({ response: response, body: body });
553
+ } else {
554
+ reject(
555
+ new HttpError(
556
+ response,
557
+ body,
558
+ response.statusCode
559
+ )
560
+ );
561
+ }
562
+ }
563
+ }
564
+ );
565
+ });
566
+ });
567
+ }
568
+ }