algolia 3.0.0.alpha.15 → 3.0.0.alpha.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (198) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +10 -167
  3. data/CHANGELOG.md +14 -0
  4. data/Gemfile.lock +1 -1
  5. data/lib/algolia/api/analytics_client.rb +76 -76
  6. data/lib/algolia/api/ingestion_client.rb +267 -196
  7. data/lib/algolia/api/monitoring_client.rb +49 -49
  8. data/lib/algolia/api/query_suggestions_client.rb +14 -14
  9. data/lib/algolia/api/recommend_client.rb +22 -22
  10. data/lib/algolia/api/search_client.rb +8 -8
  11. data/lib/algolia/api/usage_client.rb +329 -0
  12. data/lib/algolia/models/analytics/get_status_response.rb +1 -1
  13. data/lib/algolia/models/ingestion/auth_algolia.rb +3 -2
  14. data/lib/algolia/models/ingestion/auth_algolia_insights.rb +212 -0
  15. data/lib/algolia/models/{recommend/consequence_query_object.rb → ingestion/auth_algolia_insights_partial.rb} +21 -24
  16. data/lib/algolia/models/ingestion/auth_algolia_partial.rb +3 -2
  17. data/lib/algolia/models/ingestion/auth_api_key.rb +2 -1
  18. data/lib/algolia/models/ingestion/auth_api_key_partial.rb +2 -1
  19. data/lib/algolia/models/ingestion/auth_basic.rb +3 -1
  20. data/lib/algolia/models/ingestion/auth_basic_partial.rb +3 -1
  21. data/lib/algolia/models/ingestion/auth_google_service_account.rb +3 -3
  22. data/lib/algolia/models/ingestion/auth_google_service_account_partial.rb +3 -3
  23. data/lib/algolia/models/ingestion/auth_input.rb +1 -0
  24. data/lib/algolia/models/ingestion/auth_input_partial.rb +1 -0
  25. data/lib/algolia/models/ingestion/auth_o_auth.rb +18 -8
  26. data/lib/algolia/models/ingestion/auth_o_auth_partial.rb +18 -8
  27. data/lib/algolia/models/ingestion/authentication.rb +5 -5
  28. data/lib/algolia/models/ingestion/authentication_create.rb +2 -2
  29. data/lib/algolia/models/ingestion/authentication_create_response.rb +4 -4
  30. data/lib/algolia/models/ingestion/authentication_search.rb +1 -1
  31. data/lib/algolia/models/ingestion/authentication_type.rb +2 -1
  32. data/lib/algolia/models/ingestion/authentication_update.rb +2 -2
  33. data/lib/algolia/models/ingestion/authentication_update_response.rb +4 -4
  34. data/lib/algolia/models/ingestion/big_commerce_channel.rb +2 -2
  35. data/lib/algolia/models/ingestion/big_commerce_metafield.rb +2 -2
  36. data/lib/algolia/models/ingestion/commercetools_custom_fields.rb +1 -1
  37. data/lib/algolia/models/ingestion/delete_response.rb +1 -1
  38. data/lib/algolia/models/ingestion/destination.rb +6 -6
  39. data/lib/algolia/models/ingestion/destination_create.rb +3 -3
  40. data/lib/algolia/models/ingestion/destination_create_response.rb +4 -4
  41. data/lib/algolia/models/ingestion/destination_index_name.rb +2 -2
  42. data/lib/algolia/models/ingestion/destination_index_prefix.rb +1 -1
  43. data/lib/algolia/models/ingestion/destination_search.rb +1 -1
  44. data/lib/algolia/models/ingestion/destination_type.rb +1 -2
  45. data/lib/algolia/models/ingestion/destination_update.rb +3 -3
  46. data/lib/algolia/models/ingestion/destination_update_response.rb +4 -4
  47. data/lib/algolia/models/ingestion/docker_source_discover.rb +2 -2
  48. data/lib/algolia/models/ingestion/event.rb +3 -3
  49. data/lib/algolia/models/ingestion/list_tasks_response.rb +1 -1
  50. data/lib/algolia/models/ingestion/mapping_format_schema.rb +32 -0
  51. data/lib/algolia/models/ingestion/mapping_input.rb +24 -3
  52. data/lib/algolia/models/ingestion/on_demand_date_utils_input.rb +3 -3
  53. data/lib/algolia/models/ingestion/on_demand_trigger.rb +2 -2
  54. data/lib/algolia/models/ingestion/on_demand_trigger_input.rb +1 -1
  55. data/lib/algolia/models/ingestion/pagination.rb +65 -0
  56. data/lib/algolia/models/ingestion/platform.rb +2 -1
  57. data/lib/algolia/models/ingestion/run.rb +7 -7
  58. data/lib/algolia/models/ingestion/run_response.rb +3 -3
  59. data/lib/algolia/models/ingestion/schedule_date_utils_input.rb +2 -2
  60. data/lib/algolia/models/ingestion/schedule_trigger.rb +4 -4
  61. data/lib/algolia/models/ingestion/schedule_trigger_input.rb +2 -2
  62. data/lib/algolia/models/ingestion/source.rb +4 -4
  63. data/lib/algolia/models/ingestion/source_big_commerce.rb +1 -1
  64. data/lib/algolia/models/ingestion/source_big_query.rb +5 -5
  65. data/lib/algolia/models/ingestion/source_commercetools.rb +2 -2
  66. data/lib/algolia/models/ingestion/source_create.rb +2 -1
  67. data/lib/algolia/models/ingestion/source_create_response.rb +3 -2
  68. data/lib/algolia/models/ingestion/source_csv.rb +3 -3
  69. data/lib/algolia/models/ingestion/source_docker.rb +3 -3
  70. data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb +3 -3
  71. data/lib/algolia/models/ingestion/source_json.rb +2 -2
  72. data/lib/algolia/models/ingestion/source_type.rb +5 -3
  73. data/lib/algolia/models/ingestion/source_update.rb +2 -1
  74. data/lib/algolia/models/ingestion/source_update_commercetools.rb +2 -3
  75. data/lib/algolia/models/ingestion/source_update_docker.rb +3 -3
  76. data/lib/algolia/models/ingestion/source_update_response.rb +3 -2
  77. data/lib/algolia/models/ingestion/streaming_trigger.rb +1 -1
  78. data/lib/algolia/models/ingestion/streaming_utils_input.rb +1 -1
  79. data/lib/algolia/models/ingestion/subscription_trigger.rb +1 -1
  80. data/lib/algolia/models/ingestion/task.rb +7 -7
  81. data/lib/algolia/models/ingestion/task_create.rb +5 -5
  82. data/lib/algolia/models/ingestion/task_create_response.rb +3 -3
  83. data/lib/algolia/models/ingestion/task_input.rb +1 -0
  84. data/lib/algolia/models/ingestion/task_update.rb +4 -4
  85. data/lib/algolia/models/ingestion/task_update_response.rb +3 -3
  86. data/lib/algolia/models/ingestion/trigger.rb +1 -0
  87. data/lib/algolia/models/ingestion/trigger_update_input.rb +2 -2
  88. data/lib/algolia/models/ingestion/window.rb +3 -3
  89. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +1 -1
  90. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +1 -1
  91. data/lib/algolia/models/insights/clicked_filters.rb +1 -1
  92. data/lib/algolia/models/insights/clicked_object_ids.rb +1 -1
  93. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +1 -1
  94. data/lib/algolia/models/insights/converted_filters.rb +1 -1
  95. data/lib/algolia/models/insights/converted_object_ids.rb +1 -1
  96. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +1 -1
  97. data/lib/algolia/models/insights/purchased_object_ids.rb +1 -1
  98. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +3 -1
  99. data/lib/algolia/models/insights/viewed_filters.rb +1 -1
  100. data/lib/algolia/models/insights/viewed_object_ids.rb +1 -1
  101. data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb} +3 -3
  102. data/lib/algolia/models/monitoring/incidents_inner.rb +1 -1
  103. data/lib/algolia/models/monitoring/probes_metric.rb +1 -1
  104. data/lib/algolia/models/monitoring/server.rb +2 -2
  105. data/lib/algolia/models/monitoring/time_inner.rb +1 -1
  106. data/lib/algolia/models/query-suggestions/app_id.rb +197 -0
  107. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +4 -4
  108. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +2 -2
  109. data/lib/algolia/models/query-suggestions/languages.rb +1 -1
  110. data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +2 -3
  111. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +23 -34
  112. data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +18 -20
  113. data/lib/algolia/models/query-suggestions/source_index.rb +3 -5
  114. data/lib/algolia/models/recommend/auto_facet_filter.rb +208 -0
  115. data/lib/algolia/models/recommend/base_recommend_request.rb +36 -7
  116. data/lib/algolia/models/recommend/base_search_params.rb +1 -1
  117. data/lib/algolia/models/recommend/base_search_params_without_query.rb +1 -1
  118. data/lib/algolia/models/recommend/bought_together_query.rb +319 -0
  119. data/lib/algolia/models/recommend/condition.rb +12 -62
  120. data/lib/algolia/models/recommend/consequence.rb +32 -54
  121. data/lib/algolia/models/recommend/deleted_at_response.rb +1 -1
  122. data/lib/algolia/models/recommend/{recommended_for_you_query_parameters.rb → fallback_params.rb} +9 -12
  123. data/lib/algolia/models/recommend/{edit_type.rb → fbt_model.rb} +5 -6
  124. data/lib/algolia/models/recommend/{base_trending_facets_query.rb → frequently_bought_together.rb} +20 -18
  125. data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -2
  126. data/lib/algolia/models/recommend/{consequence_hide.rb → hide_consequence_object.rb} +4 -6
  127. data/lib/algolia/models/recommend/index_settings_as_search_params.rb +5 -5
  128. data/lib/algolia/models/recommend/{base_recommendations_query.rb → looking_similar.rb} +6 -15
  129. data/lib/algolia/models/recommend/{anchoring.rb → looking_similar_model.rb} +5 -8
  130. data/lib/algolia/models/recommend/looking_similar_query.rb +328 -0
  131. data/lib/algolia/models/recommend/{params.rb → params_consequence.rb} +26 -28
  132. data/lib/algolia/models/recommend/{promote_object_id.rb → promote_consequence_object.rb} +19 -9
  133. data/lib/algolia/models/recommend/{rule_response.rb → recommend_rule.rb} +13 -18
  134. data/lib/algolia/models/recommend/{rule_response_metadata.rb → recommend_rule_metadata.rb} +5 -4
  135. data/lib/algolia/models/recommend/recommendations_hits.rb +4 -24
  136. data/lib/algolia/models/recommend/recommendations_request.rb +3 -1
  137. data/lib/algolia/models/recommend/recommendations_results.rb +4 -24
  138. data/lib/algolia/models/recommend/{base_recommended_for_you_query.rb → recommended_for_you.rb} +5 -14
  139. data/lib/algolia/models/recommend/recommended_for_you_query.rb +35 -15
  140. data/lib/algolia/models/recommend/{recommendation_models.rb → related_model.rb} +4 -5
  141. data/lib/algolia/models/recommend/{edit.rb → related_products.rb} +27 -24
  142. data/lib/algolia/models/recommend/{recommendations_query.rb → related_query.rb} +39 -19
  143. data/lib/algolia/models/recommend/{consequence_params.rb → search_params.rb} +25 -44
  144. data/lib/algolia/models/recommend/search_params_object.rb +6 -6
  145. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +58 -10
  146. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -2
  147. data/lib/algolia/models/recommend/trending_facet_hit.rb +2 -2
  148. data/lib/algolia/models/recommend/trending_facets.rb +243 -0
  149. data/lib/algolia/models/recommend/trending_facets_query.rb +50 -10
  150. data/lib/algolia/models/recommend/{base_trending_items_query.rb → trending_items.rb} +12 -15
  151. data/lib/algolia/models/recommend/trending_items_query.rb +42 -16
  152. data/lib/algolia/models/search/add_api_key_response.rb +1 -1
  153. data/lib/algolia/models/search/base_get_api_key_response.rb +1 -1
  154. data/lib/algolia/models/search/base_index_settings.rb +4 -4
  155. data/lib/algolia/models/search/base_search_params.rb +1 -1
  156. data/lib/algolia/models/search/base_search_params_without_query.rb +1 -1
  157. data/lib/algolia/models/search/browse_params_object.rb +6 -6
  158. data/lib/algolia/models/search/consequence_params.rb +6 -6
  159. data/lib/algolia/models/search/created_at_response.rb +1 -1
  160. data/lib/algolia/models/search/delete_api_key_response.rb +1 -1
  161. data/lib/algolia/models/search/delete_by_params.rb +1 -1
  162. data/lib/algolia/models/search/delete_source_response.rb +1 -1
  163. data/lib/algolia/models/search/deleted_at_response.rb +1 -1
  164. data/lib/algolia/models/search/fetched_index.rb +1 -1
  165. data/lib/algolia/models/search/get_api_key_response.rb +1 -1
  166. data/lib/algolia/models/search/index_settings.rb +9 -9
  167. data/lib/algolia/models/search/index_settings_as_search_params.rb +5 -5
  168. data/lib/algolia/models/search/log.rb +1 -1
  169. data/lib/algolia/models/search/remove_user_id_response.rb +1 -1
  170. data/lib/algolia/models/search/replace_source_response.rb +1 -1
  171. data/lib/algolia/models/search/save_object_response.rb +1 -1
  172. data/lib/algolia/models/search/save_synonym_response.rb +1 -1
  173. data/lib/algolia/models/search/search_for_facets.rb +6 -6
  174. data/lib/algolia/models/search/search_for_hits.rb +6 -6
  175. data/lib/algolia/models/search/search_params_object.rb +6 -6
  176. data/lib/algolia/models/search/search_user_ids_response.rb +1 -1
  177. data/lib/algolia/models/search/secured_api_key_restrictions.rb +1 -1
  178. data/lib/algolia/models/search/update_api_key_response.rb +1 -1
  179. data/lib/algolia/models/search/updated_at_response.rb +1 -1
  180. data/lib/algolia/models/search/updated_at_with_object_id_response.rb +1 -1
  181. data/lib/algolia/models/search/updated_rule_response.rb +1 -1
  182. data/lib/algolia/models/search/user_hit.rb +1 -1
  183. data/lib/algolia/models/search/user_id.rb +1 -1
  184. data/lib/algolia/models/usage/error_base.rb +205 -0
  185. data/lib/algolia/models/usage/get_usage200_response.rb +198 -0
  186. data/lib/algolia/models/usage/get_usage200_response_statistics_inner.rb +206 -0
  187. data/lib/algolia/models/{recommend/base_recommended_for_you_query_parameters.rb → usage/get_usage400_response.rb} +13 -14
  188. data/lib/algolia/models/usage/get_usage400_response_error.rb +216 -0
  189. data/lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb +225 -0
  190. data/lib/algolia/models/usage/granularity.rb +33 -0
  191. data/lib/algolia/models/usage/statistic.rb +116 -0
  192. data/lib/algolia/models/{recommend/promote.rb → usage/statistic_value.rb} +5 -5
  193. data/lib/algolia/version.rb +1 -1
  194. metadata +37 -26
  195. data/lib/algolia/models/recommend/automatic_facet_filter.rb +0 -220
  196. data/lib/algolia/models/recommend/automatic_facet_filters.rb +0 -97
  197. data/lib/algolia/models/recommend/consequence_query.rb +0 -97
  198. data/lib/algolia/models/recommend/promote_object_ids.rb +0 -228
@@ -6,7 +6,7 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class Source
9
- # The source UUID.
9
+ # Universally uniqud identifier (UUID) of a source.
10
10
  attr_accessor :source_id
11
11
 
12
12
  attr_accessor :type
@@ -15,13 +15,13 @@ module Algolia
15
15
 
16
16
  attr_accessor :input
17
17
 
18
- # The authentication UUID.
18
+ # Universally unique identifier (UUID) of an authentication resource.
19
19
  attr_accessor :authentication_id
20
20
 
21
- # Date of creation (RFC3339 format).
21
+ # Date of creation in RFC3339 format.
22
22
  attr_accessor :created_at
23
23
 
24
- # Date of last update (RFC3339 format).
24
+ # Date of last update in RFC3339 format.
25
25
  attr_accessor :updated_at
26
26
 
27
27
  class EnumAttributeValidator
@@ -6,7 +6,7 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceBigCommerce
9
- # The store hash identifying the store the shopper is signing in to.
9
+ # Store hash identifying your BigCommerce store.
10
10
  attr_accessor :store_hash
11
11
 
12
12
  attr_accessor :channel
@@ -6,24 +6,24 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceBigQuery
9
- # Project ID of the BigQuery Source.
9
+ # Project ID of the BigQuery source.
10
10
  attr_accessor :project_id
11
11
 
12
- # Dataset ID of the BigQuery Source.
12
+ # Dataset ID of the BigQuery source.
13
13
  attr_accessor :dataset_id
14
14
 
15
15
  attr_accessor :data_type
16
16
 
17
- # Table name (for default BQ).
17
+ # Table name for the BigQuery export.
18
18
  attr_accessor :table
19
19
 
20
- # Table prefix (for Google Analytics).
20
+ # Table prefix for a Google Analytics 4 data export to BigQuery.
21
21
  attr_accessor :table_prefix
22
22
 
23
23
  # Custom SQL request to extract data from the BigQuery table.
24
24
  attr_accessor :custom_sql_request
25
25
 
26
- # The name of the column that contains the unique ID, used as `objectID` in Algolia.
26
+ # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
27
27
  attr_accessor :unique_id_column
28
28
 
29
29
  class EnumAttributeValidator
@@ -8,14 +8,14 @@ module Algolia
8
8
  class SourceCommercetools
9
9
  attr_accessor :store_keys
10
10
 
11
- # Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
11
+ # Locales for your commercetools stores.
12
12
  attr_accessor :locales
13
13
 
14
14
  attr_accessor :url
15
15
 
16
16
  attr_accessor :project_key
17
17
 
18
- # Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
18
+ # Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.
19
19
  attr_accessor :fallback_is_in_stock_value
20
20
 
21
21
  attr_accessor :custom_fields
@@ -8,11 +8,12 @@ module Algolia
8
8
  class SourceCreate
9
9
  attr_accessor :type
10
10
 
11
+ # Descriptive name of the source.
11
12
  attr_accessor :name
12
13
 
13
14
  attr_accessor :input
14
15
 
15
- # The authentication UUID.
16
+ # Universally unique identifier (UUID) of an authentication resource.
16
17
  attr_accessor :authentication_id
17
18
 
18
19
  class EnumAttributeValidator
@@ -6,12 +6,13 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceCreateResponse
9
- # The source UUID.
9
+ # Universally uniqud identifier (UUID) of a source.
10
10
  attr_accessor :source_id
11
11
 
12
+ # Descriptive name of the source.
12
13
  attr_accessor :name
13
14
 
14
- # Date of creation (RFC3339 format).
15
+ # Date of creation in RFC3339 format.
15
16
  attr_accessor :created_at
16
17
 
17
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -6,13 +6,13 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceCSV
9
- # The URL of the file.
9
+ # URL of the file.
10
10
  attr_accessor :url
11
11
 
12
- # The name of the column that contains the unique ID, used as `objectID` in Algolia.
12
+ # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
13
13
  attr_accessor :unique_id_column
14
14
 
15
- # Mapping of type for every column. For example {\"myColumn\": \"boolean\", \"myOtherColumn\": \"json\"}.
15
+ # Key-value pairs of column names and their expected types.
16
16
  attr_accessor :mapping
17
17
 
18
18
  attr_accessor :method
@@ -10,13 +10,13 @@ module Algolia
10
10
 
11
11
  attr_accessor :registry
12
12
 
13
- # The name of the image to pull.
13
+ # Docker image name.
14
14
  attr_accessor :image
15
15
 
16
- # The version of the image, defaults to `latest`.
16
+ # Docker image version.
17
17
  attr_accessor :version
18
18
 
19
- # The configuration of the spec.
19
+ # Configuration of the spec.
20
20
  attr_accessor :configuration
21
21
 
22
22
  class EnumAttributeValidator
@@ -6,13 +6,13 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceGA4BigQueryExport
9
- # GCP project ID that the BigQuery Export writes to.
9
+ # GCP project ID that the BigQuery export writes to.
10
10
  attr_accessor :project_id
11
11
 
12
- # BigQuery dataset ID that the BigQuery Export writes to.
12
+ # BigQuery dataset ID that the BigQuery export writes to.
13
13
  attr_accessor :dataset_id
14
14
 
15
- # Prefix of the tables that the BigQuery Export writes to (i.e. events_intraday_ for streaming, events_ for daily).
15
+ # Prefix of the tables that the BigQuery Export writes to.
16
16
  attr_accessor :table_prefix
17
17
 
18
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -6,10 +6,10 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceJSON
9
- # The URL of the file.
9
+ # URL of the file.
10
10
  attr_accessor :url
11
11
 
12
- # The name of the column that contains the unique ID, used as `objectID` in Algolia.
12
+ # Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
13
13
  attr_accessor :unique_id_column
14
14
 
15
15
  attr_accessor :method
@@ -7,15 +7,17 @@ module Algolia
7
7
  module Ingestion
8
8
  class SourceType
9
9
  BIGCOMMERCE = "bigcommerce".freeze
10
+ BIGQUERY = "bigquery".freeze
10
11
  COMMERCETOOLS = "commercetools".freeze
11
- JSON = "json".freeze
12
12
  CSV = "csv".freeze
13
- BIGQUERY = "bigquery".freeze
14
13
  DOCKER = "docker".freeze
15
14
  GA4_BIGQUERY_EXPORT = "ga4BigqueryExport".freeze
15
+ JSON = "json".freeze
16
+ SHOPIFY = "shopify".freeze
17
+ SFCC = "sfcc".freeze
16
18
 
17
19
  def self.all_vars
18
- @all_vars ||= [BIGCOMMERCE, COMMERCETOOLS, JSON, CSV, BIGQUERY, DOCKER, GA4_BIGQUERY_EXPORT].freeze
20
+ @all_vars ||= [BIGCOMMERCE, BIGQUERY, COMMERCETOOLS, CSV, DOCKER, GA4_BIGQUERY_EXPORT, JSON, SHOPIFY, SFCC].freeze
19
21
  end
20
22
 
21
23
  # Builds the enum from string
@@ -6,11 +6,12 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceUpdate
9
+ # Descriptive name of the source.
9
10
  attr_accessor :name
10
11
 
11
12
  attr_accessor :input
12
13
 
13
- # The authentication UUID.
14
+ # Universally unique identifier (UUID) of an authentication resource.
14
15
  attr_accessor :authentication_id
15
16
 
16
17
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -6,15 +6,14 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceUpdateCommercetools
9
- # Unique and immutable key of the referenced Store.
10
9
  attr_accessor :store_keys
11
10
 
12
- # Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example [\"fr-FR\", \"en\"].
11
+ # Locales for your commercetools stores.
13
12
  attr_accessor :locales
14
13
 
15
14
  attr_accessor :url
16
15
 
17
- # Determines the value that will be stored in the Algolia record if there's no inventory information on the product.
16
+ # Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.
18
17
  attr_accessor :fallback_is_in_stock_value
19
18
 
20
19
  attr_accessor :custom_fields
@@ -8,13 +8,13 @@ module Algolia
8
8
  class SourceUpdateDocker
9
9
  attr_accessor :registry
10
10
 
11
- # The name of the image to pull.
11
+ # Docker image name.
12
12
  attr_accessor :image
13
13
 
14
- # The version of the image, defaults to `latest`.
14
+ # Docker image version.
15
15
  attr_accessor :version
16
16
 
17
- # The configuration of the spec.
17
+ # Configuration of the spec.
18
18
  attr_accessor :configuration
19
19
 
20
20
  class EnumAttributeValidator
@@ -6,12 +6,13 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class SourceUpdateResponse
9
- # The source UUID.
9
+ # Universally uniqud identifier (UUID) of a source.
10
10
  attr_accessor :source_id
11
11
 
12
+ # Descriptive name of the source.
12
13
  attr_accessor :name
13
14
 
14
- # Date of last update (RFC3339 format).
15
+ # Date of last update in RFC3339 format.
15
16
  attr_accessor :updated_at
16
17
 
17
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,7 +5,7 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The trigger input for a task of type 'streaming'.
8
+ # Trigger input for continuously running tasks.
9
9
  class StreamingTrigger
10
10
  attr_accessor :type
11
11
 
@@ -5,7 +5,7 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
8
+ # Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
9
9
  class StreamingUtilsInput
10
10
  attr_accessor :mapping
11
11
 
@@ -5,7 +5,7 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The trigger input for a task of type 'subscription'.
8
+ # Trigger input for subscription tasks.
9
9
  class SubscriptionTrigger
10
10
  attr_accessor :type
11
11
 
@@ -6,31 +6,31 @@ require 'time'
6
6
  module Algolia
7
7
  module Ingestion
8
8
  class Task
9
- # The task UUID.
9
+ # Universally unique identifier (UUID) of a task.
10
10
  attr_accessor :task_id
11
11
 
12
- # The source UUID.
12
+ # Universally uniqud identifier (UUID) of a source.
13
13
  attr_accessor :source_id
14
14
 
15
- # The destination UUID.
15
+ # Universally unique identifier (UUID) of a destination resource.
16
16
  attr_accessor :destination_id
17
17
 
18
18
  attr_accessor :trigger
19
19
 
20
20
  attr_accessor :input
21
21
 
22
- # Whether the task is enabled or not.
22
+ # Whether the task is enabled.
23
23
  attr_accessor :enabled
24
24
 
25
- # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
25
+ # Maximum accepted percentage of failures for a task run to finish successfully.
26
26
  attr_accessor :failure_threshold
27
27
 
28
28
  attr_accessor :action
29
29
 
30
- # Date of creation (RFC3339 format).
30
+ # Date of creation in RFC3339 format.
31
31
  attr_accessor :created_at
32
32
 
33
- # Date of last update (RFC3339 format).
33
+ # Date of last update in RFC3339 format.
34
34
  attr_accessor :updated_at
35
35
 
36
36
  class EnumAttributeValidator
@@ -5,22 +5,22 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The payload for a task creation.
8
+ # API request body for creating a task.
9
9
  class TaskCreate
10
- # The source UUID.
10
+ # Universally uniqud identifier (UUID) of a source.
11
11
  attr_accessor :source_id
12
12
 
13
- # The destination UUID.
13
+ # Universally unique identifier (UUID) of a destination resource.
14
14
  attr_accessor :destination_id
15
15
 
16
16
  attr_accessor :trigger
17
17
 
18
18
  attr_accessor :action
19
19
 
20
- # Whether the task is enabled or not.
20
+ # Whether the task is enabled.
21
21
  attr_accessor :enabled
22
22
 
23
- # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
23
+ # Maximum accepted percentage of failures for a task run to finish successfully.
24
24
  attr_accessor :failure_threshold
25
25
 
26
26
  attr_accessor :input
@@ -5,12 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The response from the API after a task creation.
8
+ # API response for creating a task.
9
9
  class TaskCreateResponse
10
- # The task UUID.
10
+ # Universally unique identifier (UUID) of a task.
11
11
  attr_accessor :task_id
12
12
 
13
- # Date of creation (RFC3339 format).
13
+ # Date of creation in RFC3339 format.
14
14
  attr_accessor :created_at
15
15
 
16
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,6 +5,7 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
+ # Configuration of the task, depending on its type.
8
9
  module TaskInput
9
10
  class << self
10
11
  # List of class defined in oneOf (OpenAPI v3)
@@ -5,19 +5,19 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The payload for a task update.
8
+ # API request body for updating a task.
9
9
  class TaskUpdate
10
- # The destination UUID.
10
+ # Universally unique identifier (UUID) of a destination resource.
11
11
  attr_accessor :destination_id
12
12
 
13
13
  attr_accessor :trigger
14
14
 
15
15
  attr_accessor :input
16
16
 
17
- # Whether the task is enabled or not.
17
+ # Whether the task is enabled.
18
18
  attr_accessor :enabled
19
19
 
20
- # A percentage representing the accepted failure threshold to determine if a `run` succeeded or not.
20
+ # Maximum accepted percentage of failures for a task run to finish successfully.
21
21
  attr_accessor :failure_threshold
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,12 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The response from the API after a task update.
8
+ # API response for updating a task.
9
9
  class TaskUpdateResponse
10
- # The task UUID.
10
+ # Universally unique identifier (UUID) of a task.
11
11
  attr_accessor :task_id
12
12
 
13
- # Date of last update (RFC3339 format).
13
+ # Date of last update in RFC3339 format.
14
14
  attr_accessor :updated_at
15
15
 
16
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,6 +5,7 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
+ # Trigger that runs the task.
8
9
  module Trigger
9
10
  class << self
10
11
  # List of class defined in oneOf (OpenAPI v3)
@@ -5,9 +5,9 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The trigger input for a task update.
8
+ # Trigger for a task update.
9
9
  class TriggerUpdateInput
10
- # A cron expression that represent at which regularity the task should run.
10
+ # Cron expression for the task's schedule.
11
11
  attr_accessor :cron
12
12
 
13
13
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -5,12 +5,12 @@ require 'time'
5
5
 
6
6
  module Algolia
7
7
  module Ingestion
8
- # The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
8
+ # Time window by which to filter the observability data.
9
9
  class Window
10
- # A date in format RFC3339 representing the oldest possible data in query window.
10
+ # Date in RFC3339 format representing the oldest data in the time window.
11
11
  attr_accessor :start_date
12
12
 
13
- # A date in format RFC3339 representing the newest possible data in query window.
13
+ # Date in RFC3339 format representing the newest data in the time window.
14
14
  attr_accessor :end_date
15
15
 
16
16
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -32,7 +32,7 @@ module Algolia
32
32
  # Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as `objectIDs`.
33
33
  attr_accessor :object_data
34
34
 
35
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
35
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
36
36
  attr_accessor :timestamp
37
37
 
38
38
  attr_accessor :value
@@ -35,7 +35,7 @@ module Algolia
35
35
  # Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`.
36
36
  attr_accessor :object_data
37
37
 
38
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
38
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
39
39
  attr_accessor :timestamp
40
40
 
41
41
  attr_accessor :value
@@ -24,7 +24,7 @@ module Algolia
24
24
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
25
25
  attr_accessor :authenticated_user_token
26
26
 
27
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
27
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
28
28
  attr_accessor :timestamp
29
29
 
30
30
  class EnumAttributeValidator
@@ -24,7 +24,7 @@ module Algolia
24
24
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
25
25
  attr_accessor :authenticated_user_token
26
26
 
27
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
27
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
28
28
  attr_accessor :timestamp
29
29
 
30
30
  class EnumAttributeValidator
@@ -30,7 +30,7 @@ module Algolia
30
30
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
31
31
  attr_accessor :authenticated_user_token
32
32
 
33
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
33
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
34
34
  attr_accessor :timestamp
35
35
 
36
36
  class EnumAttributeValidator
@@ -23,7 +23,7 @@ module Algolia
23
23
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
24
24
  attr_accessor :authenticated_user_token
25
25
 
26
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
26
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
27
27
  attr_accessor :timestamp
28
28
 
29
29
  class EnumAttributeValidator
@@ -24,7 +24,7 @@ module Algolia
24
24
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
25
25
  attr_accessor :authenticated_user_token
26
26
 
27
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
27
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
28
28
  attr_accessor :timestamp
29
29
 
30
30
  class EnumAttributeValidator
@@ -27,7 +27,7 @@ module Algolia
27
27
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
28
28
  attr_accessor :authenticated_user_token
29
29
 
30
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
30
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
31
31
  attr_accessor :timestamp
32
32
 
33
33
  class EnumAttributeValidator
@@ -32,7 +32,7 @@ module Algolia
32
32
  # Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as `objectIDs`.
33
33
  attr_accessor :object_data
34
34
 
35
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
35
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
36
36
  attr_accessor :timestamp
37
37
 
38
38
  attr_accessor :value
@@ -32,7 +32,7 @@ module Algolia
32
32
  # Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`.
33
33
  attr_accessor :object_data
34
34
 
35
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
35
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
36
36
  attr_accessor :timestamp
37
37
 
38
38
  attr_accessor :value
@@ -170,6 +170,8 @@ module Algolia
170
170
  if (value = attributes[:object_data]).is_a?(Array)
171
171
  self.object_data = value
172
172
  end
173
+ else
174
+ self.object_data = nil
173
175
  end
174
176
 
175
177
  if attributes.key?(:timestamp)
@@ -24,7 +24,7 @@ module Algolia
24
24
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
25
25
  attr_accessor :authenticated_user_token
26
26
 
27
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
27
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
28
28
  attr_accessor :timestamp
29
29
 
30
30
  class EnumAttributeValidator
@@ -24,7 +24,7 @@ module Algolia
24
24
  # Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
25
25
  attr_accessor :authenticated_user_token
26
26
 
27
- # Timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
27
+ # Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
28
28
  attr_accessor :timestamp
29
29
 
30
30
  class EnumAttributeValidator