@algolia/ingestion 5.2.4-beta.5 → 5.10.0-beta.1

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 (173) hide show
  1. package/README.md +15 -7
  2. package/dist/browser.d.ts +1266 -634
  3. package/dist/builds/browser.js +223 -322
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +6 -6
  8. package/dist/builds/fetch.js +1943 -0
  9. package/dist/builds/fetch.js.map +1 -0
  10. package/dist/builds/node.cjs +220 -320
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +221 -320
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +3001 -0
  15. package/dist/node.d.cts +1267 -634
  16. package/dist/node.d.ts +1267 -634
  17. package/dist/src/ingestionClient.cjs +218 -319
  18. package/dist/src/ingestionClient.cjs.map +1 -1
  19. package/dist/src/ingestionClient.js +218 -319
  20. package/dist/src/ingestionClient.js.map +1 -1
  21. package/index.d.ts +0 -1
  22. package/index.js +1 -2
  23. package/package.json +16 -11
  24. package/model/action.ts +0 -13
  25. package/model/actionType.ts +0 -6
  26. package/model/authAPIKey.ts +0 -11
  27. package/model/authAPIKeyPartial.ts +0 -11
  28. package/model/authAlgolia.ts +0 -16
  29. package/model/authAlgoliaInsights.ts +0 -16
  30. package/model/authAlgoliaInsightsPartial.ts +0 -16
  31. package/model/authAlgoliaPartial.ts +0 -16
  32. package/model/authBasic.ts +0 -16
  33. package/model/authBasicPartial.ts +0 -16
  34. package/model/authGoogleServiceAccount.ts +0 -16
  35. package/model/authGoogleServiceAccountPartial.ts +0 -16
  36. package/model/authInput.ts +0 -16
  37. package/model/authInputPartial.ts +0 -16
  38. package/model/authOAuth.ts +0 -26
  39. package/model/authOAuthPartial.ts +0 -26
  40. package/model/authentication.ts +0 -36
  41. package/model/authenticationCreate.ts +0 -21
  42. package/model/authenticationCreateResponse.ts +0 -21
  43. package/model/authenticationSearch.ts +0 -8
  44. package/model/authenticationSortKeys.ts +0 -6
  45. package/model/authenticationType.ts +0 -6
  46. package/model/authenticationUpdate.ts +0 -21
  47. package/model/authenticationUpdateResponse.ts +0 -21
  48. package/model/bigCommerceChannel.ts +0 -13
  49. package/model/bigCommerceMetafield.ts +0 -13
  50. package/model/bigQueryDataType.ts +0 -3
  51. package/model/clientMethodProps.ts +0 -703
  52. package/model/commercetoolsCustomFields.ts +0 -21
  53. package/model/deleteResponse.ts +0 -8
  54. package/model/destination.ts +0 -40
  55. package/model/destinationCreate.ts +0 -25
  56. package/model/destinationCreateResponse.ts +0 -21
  57. package/model/destinationIndexName.ts +0 -17
  58. package/model/destinationInput.ts +0 -5
  59. package/model/destinationSearch.ts +0 -8
  60. package/model/destinationSortKeys.ts +0 -6
  61. package/model/destinationType.ts +0 -6
  62. package/model/destinationUpdate.ts +0 -25
  63. package/model/destinationUpdateResponse.ts +0 -21
  64. package/model/dockerImageType.ts +0 -6
  65. package/model/dockerRegistry.ts +0 -6
  66. package/model/dockerStreams.ts +0 -17
  67. package/model/dockerStreamsInput.ts +0 -10
  68. package/model/dockerStreamsSyncMode.ts +0 -6
  69. package/model/entityType.ts +0 -6
  70. package/model/errorBase.ts +0 -8
  71. package/model/event.ts +0 -40
  72. package/model/eventSortKeys.ts +0 -6
  73. package/model/eventStatus.ts +0 -3
  74. package/model/eventType.ts +0 -3
  75. package/model/generateTransformationCodePayload.ts +0 -9
  76. package/model/generateTransformationCodeResponse.ts +0 -5
  77. package/model/index.ts +0 -151
  78. package/model/listAuthenticationsResponse.ts +0 -10
  79. package/model/listDestinationsResponse.ts +0 -10
  80. package/model/listEventsResponse.ts +0 -13
  81. package/model/listSourcesResponse.ts +0 -10
  82. package/model/listTasksResponse.ts +0 -13
  83. package/model/listTasksResponseV1.ts +0 -13
  84. package/model/listTransformationsResponse.ts +0 -13
  85. package/model/mappingFieldDirective.ts +0 -16
  86. package/model/mappingFormatSchema.ts +0 -6
  87. package/model/mappingInput.ts +0 -13
  88. package/model/mappingKitAction.ts +0 -25
  89. package/model/mappingTypeCSV.ts +0 -3
  90. package/model/methodType.ts +0 -6
  91. package/model/model.ts +0 -13
  92. package/model/onDemandTrigger.ts +0 -15
  93. package/model/onDemandTriggerInput.ts +0 -10
  94. package/model/onDemandTriggerType.ts +0 -6
  95. package/model/orderKeys.ts +0 -6
  96. package/model/pagination.ts +0 -26
  97. package/model/platform.ts +0 -6
  98. package/model/platformNone.ts +0 -6
  99. package/model/platformWithNone.ts +0 -6
  100. package/model/pushTaskPayload.ts +0 -10
  101. package/model/pushTaskRecords.ts +0 -8
  102. package/model/recordType.ts +0 -6
  103. package/model/run.ts +0 -56
  104. package/model/runListResponse.ts +0 -13
  105. package/model/runOutcome.ts +0 -6
  106. package/model/runProgress.ts +0 -7
  107. package/model/runReasonCode.ts +0 -6
  108. package/model/runResponse.ts +0 -16
  109. package/model/runSortKeys.ts +0 -6
  110. package/model/runSourcePayload.ts +0 -22
  111. package/model/runSourceResponse.ts +0 -13
  112. package/model/runStatus.ts +0 -6
  113. package/model/runType.ts +0 -6
  114. package/model/scheduleTrigger.ts +0 -25
  115. package/model/scheduleTriggerInput.ts +0 -15
  116. package/model/scheduleTriggerType.ts +0 -6
  117. package/model/shopifyInput.ts +0 -13
  118. package/model/shopifyMarket.ts +0 -12
  119. package/model/shopifyMetafield.ts +0 -12
  120. package/model/sortKeys.ts +0 -6
  121. package/model/source.ts +0 -32
  122. package/model/sourceBigCommerce.ts +0 -19
  123. package/model/sourceBigQuery.ts +0 -37
  124. package/model/sourceCSV.ts +0 -28
  125. package/model/sourceCommercetools.ts +0 -23
  126. package/model/sourceCreate.ts +0 -20
  127. package/model/sourceCreateResponse.ts +0 -18
  128. package/model/sourceDocker.ts +0 -25
  129. package/model/sourceGA4BigQueryExport.ts +0 -18
  130. package/model/sourceInput.ts +0 -20
  131. package/model/sourceJSON.ts +0 -17
  132. package/model/sourceSearch.ts +0 -5
  133. package/model/sourceShopify.ts +0 -6
  134. package/model/sourceShopifyBase.ts +0 -8
  135. package/model/sourceSortKeys.ts +0 -6
  136. package/model/sourceType.ts +0 -13
  137. package/model/sourceUpdate.ts +0 -17
  138. package/model/sourceUpdateCommercetools.ts +0 -21
  139. package/model/sourceUpdateDocker.ts +0 -22
  140. package/model/sourceUpdateInput.ts +0 -18
  141. package/model/sourceUpdateResponse.ts +0 -18
  142. package/model/sourceUpdateShopify.ts +0 -8
  143. package/model/sourceWatchResponse.ts +0 -25
  144. package/model/streamingInput.ts +0 -10
  145. package/model/streamingTrigger.ts +0 -10
  146. package/model/streamingTriggerType.ts +0 -6
  147. package/model/subscriptionTrigger.ts +0 -10
  148. package/model/subscriptionTriggerType.ts +0 -6
  149. package/model/task.ts +0 -65
  150. package/model/taskCreate.ts +0 -43
  151. package/model/taskCreateResponse.ts +0 -16
  152. package/model/taskCreateTrigger.ts +0 -8
  153. package/model/taskCreateV1.ts +0 -41
  154. package/model/taskInput.ts +0 -10
  155. package/model/taskSearch.ts +0 -5
  156. package/model/taskSortKeys.ts +0 -6
  157. package/model/taskUpdate.ts +0 -30
  158. package/model/taskUpdateResponse.ts +0 -16
  159. package/model/taskUpdateV1.ts +0 -28
  160. package/model/taskV1.ts +0 -56
  161. package/model/transformation.ts +0 -38
  162. package/model/transformationCreate.ts +0 -26
  163. package/model/transformationCreateResponse.ts +0 -16
  164. package/model/transformationError.ts +0 -16
  165. package/model/transformationModels.ts +0 -10
  166. package/model/transformationSearch.ts +0 -5
  167. package/model/transformationTry.ts +0 -17
  168. package/model/transformationTryResponse.ts +0 -12
  169. package/model/transformationUpdateResponse.ts +0 -16
  170. package/model/trigger.ts +0 -11
  171. package/model/triggerType.ts +0 -6
  172. package/model/triggerUpdateInput.ts +0 -11
  173. package/model/window.ts +0 -16
package/README.md CHANGED
@@ -32,24 +32,32 @@
32
32
 
33
33
  ## 💡 Getting Started
34
34
 
35
- To get started, you first need to install @algolia/ingestion (or any other available API client package).
35
+ > [!TIP]
36
+ > This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/ingestion` if you already have `algoliasearch` installed.
36
37
 
38
+ To get started, you first need to install @algolia/ingestion (or any other available API client package).
37
39
  All of our clients comes with type definition, and are available for both browser and node environments.
38
40
 
41
+ ### With a package manager
42
+
39
43
  ```bash
40
- yarn add @algolia/ingestion
44
+ yarn add @algolia/ingestion@1.10.0
41
45
  # or
42
- npm install @algolia/ingestion
46
+ npm install @algolia/ingestion@1.10.0
47
+ # or
48
+ pnpm add @algolia/ingestion@1.10.0
43
49
  ```
44
50
 
45
- Without a package manager
51
+ ### Without a package manager
46
52
 
47
53
  Add the following JavaScript snippet to the <head> of your website:
48
54
 
49
55
  ```html
50
- <script src="https://cdn.jsdelivr.net/npm/algoliasearch/dist/ingestion.umd.min.js"></script>
56
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.10.0/dist/builds/browser.umd.js"></script>
51
57
  ```
52
58
 
59
+ ### Usage
60
+
53
61
  You can now import the Algolia API client in your project and play with it.
54
62
 
55
63
  ```js
@@ -58,7 +66,7 @@ import { ingestionClient } from '@algolia/ingestion';
58
66
  const client = ingestionClient('YOUR_APP_ID', 'YOUR_API_KEY');
59
67
  ```
60
68
 
61
- For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
69
+ For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/ingestion/)**.
62
70
 
63
71
  ## ❓ Troubleshooting
64
72
 
@@ -66,4 +74,4 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
66
74
 
67
75
  ## 📄 License
68
76
 
69
- The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
77
+ The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).