talon_one 8.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -8
  3. data/docs/Account.md +1 -1
  4. data/docs/AccountAdditionalCost.md +1 -1
  5. data/docs/Achievement.md +2 -2
  6. data/docs/AchievementBase.md +35 -0
  7. data/docs/AchievementProgressWithDefinition.md +45 -0
  8. data/docs/AchievementStatusEntry.md +45 -0
  9. data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
  10. data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
  11. data/docs/AnalyticsSKU.md +23 -0
  12. data/docs/Application.md +1 -1
  13. data/docs/ApplicationCIF.md +1 -1
  14. data/docs/ApplicationCIFExpression.md +1 -1
  15. data/docs/ApplicationCIFReferences.md +19 -0
  16. data/docs/ApplicationCustomer.md +2 -2
  17. data/docs/ApplicationEvent.md +1 -1
  18. data/docs/ApplicationSession.md +1 -1
  19. data/docs/Attribute.md +1 -1
  20. data/docs/Audience.md +1 -1
  21. data/docs/AudienceCustomer.md +2 -2
  22. data/docs/BaseNotificationWebhook.md +1 -1
  23. data/docs/Binding.md +9 -1
  24. data/docs/CampaignCollection.md +1 -1
  25. data/docs/CampaignCollectionWithoutPayload.md +1 -1
  26. data/docs/CampaignDeactivationRequest.md +17 -0
  27. data/docs/CampaignDetail.md +19 -0
  28. data/docs/CampaignGroup.md +1 -1
  29. data/docs/CampaignSet.md +1 -1
  30. data/docs/CampaignStoreBudget.md +1 -1
  31. data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
  32. data/docs/CampaignTemplate.md +4 -2
  33. data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
  34. data/docs/CartItem.md +12 -2
  35. data/docs/Catalog.md +1 -1
  36. data/docs/CatalogItem.md +1 -1
  37. data/docs/Change.md +1 -1
  38. data/docs/Collection.md +1 -1
  39. data/docs/CollectionWithoutPayload.md +1 -1
  40. data/docs/Coupon.md +2 -2
  41. data/docs/CouponCreationJob.md +1 -1
  42. data/docs/CouponDeletionJob.md +1 -1
  43. data/docs/CouponEntity.md +19 -0
  44. data/docs/CreateAchievement.md +1 -1
  45. data/docs/CustomEffect.md +1 -1
  46. data/docs/CustomerProfile.md +2 -2
  47. data/docs/CustomerProfileEntity.md +19 -0
  48. data/docs/CustomerSessionV2.md +1 -1
  49. data/docs/Effect.md +6 -0
  50. data/docs/EffectEntity.md +7 -1
  51. data/docs/Entity.md +1 -1
  52. data/docs/Environment.md +4 -2
  53. data/docs/Event.md +1 -1
  54. data/docs/EventType.md +1 -1
  55. data/docs/Export.md +1 -1
  56. data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
  57. data/docs/Giveaway.md +1 -1
  58. data/docs/GiveawaysPool.md +1 -1
  59. data/docs/HiddenConditionsEffects.md +23 -0
  60. data/docs/Import.md +1 -1
  61. data/docs/InlineResponse20048.md +17 -0
  62. data/docs/InlineResponse20049.md +17 -0
  63. data/docs/InlineResponse20050.md +19 -0
  64. data/docs/InlineResponse20051.md +19 -0
  65. data/docs/IntegrationApi.md +6 -4
  66. data/docs/IntegrationCoupon.md +2 -2
  67. data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
  68. data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
  69. data/docs/IntegrationEventV2Request.md +2 -0
  70. data/docs/InventoryCoupon.md +2 -2
  71. data/docs/InventoryReferral.md +1 -1
  72. data/docs/LedgerEntry.md +1 -1
  73. data/docs/LedgerInfo.md +2 -2
  74. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
  75. data/docs/LoyaltyCard.md +1 -1
  76. data/docs/LoyaltyLedgerEntryFlags.md +17 -0
  77. data/docs/LoyaltyProgramBalance.md +2 -2
  78. data/docs/LoyaltyProgramTransaction.md +3 -1
  79. data/docs/LoyaltyTier.md +1 -1
  80. data/docs/ManagementApi.md +824 -220
  81. data/docs/MessageTest.md +27 -0
  82. data/docs/ModelReturn.md +1 -1
  83. data/docs/MultipleAudiencesItem.md +1 -1
  84. data/docs/NewMessageTest.md +29 -0
  85. data/docs/NewPriceAdjustment.md +27 -0
  86. data/docs/NewPriceType.md +23 -0
  87. data/docs/NewWebhook.md +2 -0
  88. data/docs/Picklist.md +1 -1
  89. data/docs/PriceDetail.md +23 -0
  90. data/docs/PriceType.md +33 -0
  91. data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
  92. data/docs/ProductUnitAnalyticsTotals.md +17 -0
  93. data/docs/Referral.md +1 -1
  94. data/docs/RevisionActivationRequest.md +19 -0
  95. data/docs/Role.md +1 -1
  96. data/docs/RoleV2.md +1 -1
  97. data/docs/Ruleset.md +1 -1
  98. data/docs/SamlConnection.md +1 -1
  99. data/docs/ScimBaseGroup.md +19 -0
  100. data/docs/ScimGroup.md +21 -0
  101. data/docs/ScimGroupMember.md +19 -0
  102. data/docs/ScimGroupsListResponse.md +21 -0
  103. data/docs/SkuUnitAnalytics.md +19 -0
  104. data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
  105. data/docs/Store.md +1 -1
  106. data/docs/StrikethroughLabelingNotification.md +2 -0
  107. data/docs/TemplateDef.md +1 -1
  108. data/docs/UpdateAchievement.md +1 -1
  109. data/docs/User.md +1 -1
  110. data/docs/Webhook.md +3 -1
  111. data/docs/WebhookAuthentication.md +33 -0
  112. data/docs/WebhookAuthenticationBase.md +21 -0
  113. data/docs/WebhookAuthenticationDataBasic.md +19 -0
  114. data/docs/WebhookAuthenticationDataCustom.md +17 -0
  115. data/docs/WebhookAuthenticationWebhookRef.md +21 -0
  116. data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
  117. data/lib/talon_one/api/integration_api.rb +9 -6
  118. data/lib/talon_one/api/management_api.rb +1009 -304
  119. data/lib/talon_one/models/account.rb +1 -1
  120. data/lib/talon_one/models/account_additional_cost.rb +1 -1
  121. data/lib/talon_one/models/achievement.rb +4 -4
  122. data/lib/talon_one/models/achievement_base.rb +377 -0
  123. data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
  124. data/lib/talon_one/models/achievement_status_entry.rb +472 -0
  125. data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
  126. data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
  127. data/lib/talon_one/models/analytics_sku.rb +246 -0
  128. data/lib/talon_one/models/application.rb +1 -1
  129. data/lib/talon_one/models/application_cif.rb +1 -1
  130. data/lib/talon_one/models/application_cif_expression.rb +1 -1
  131. data/lib/talon_one/models/application_cif_references.rb +219 -0
  132. data/lib/talon_one/models/application_customer.rb +2 -2
  133. data/lib/talon_one/models/application_event.rb +1 -1
  134. data/lib/talon_one/models/application_session.rb +1 -1
  135. data/lib/talon_one/models/attribute.rb +1 -1
  136. data/lib/talon_one/models/audience.rb +1 -1
  137. data/lib/talon_one/models/audience_customer.rb +2 -2
  138. data/lib/talon_one/models/base_notification.rb +2 -2
  139. data/lib/talon_one/models/base_notification_webhook.rb +1 -1
  140. data/lib/talon_one/models/binding.rb +44 -4
  141. data/lib/talon_one/models/campaign_collection.rb +1 -1
  142. data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
  143. data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
  144. data/lib/talon_one/models/campaign_detail.rb +232 -0
  145. data/lib/talon_one/models/campaign_group.rb +1 -1
  146. data/lib/talon_one/models/campaign_set.rb +1 -1
  147. data/lib/talon_one/models/campaign_store_budget.rb +1 -1
  148. data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
  149. data/lib/talon_one/models/campaign_template.rb +17 -5
  150. data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
  151. data/lib/talon_one/models/cart_item.rb +57 -5
  152. data/lib/talon_one/models/catalog.rb +1 -1
  153. data/lib/talon_one/models/catalog_action.rb +2 -2
  154. data/lib/talon_one/models/catalog_item.rb +1 -1
  155. data/lib/talon_one/models/change.rb +1 -1
  156. data/lib/talon_one/models/collection.rb +1 -1
  157. data/lib/talon_one/models/collection_without_payload.rb +1 -1
  158. data/lib/talon_one/models/coupon.rb +7 -7
  159. data/lib/talon_one/models/coupon_constraints.rb +5 -5
  160. data/lib/talon_one/models/coupon_creation_job.rb +6 -6
  161. data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
  162. data/lib/talon_one/models/coupon_entity.rb +227 -0
  163. data/lib/talon_one/models/create_achievement.rb +3 -3
  164. data/lib/talon_one/models/custom_effect.rb +1 -1
  165. data/lib/talon_one/models/customer_profile.rb +2 -2
  166. data/lib/talon_one/models/customer_profile_entity.rb +227 -0
  167. data/lib/talon_one/models/customer_session_v2.rb +1 -1
  168. data/lib/talon_one/models/delete_user_request.rb +0 -1
  169. data/lib/talon_one/models/effect.rb +31 -1
  170. data/lib/talon_one/models/effect_entity.rb +34 -4
  171. data/lib/talon_one/models/entity.rb +1 -1
  172. data/lib/talon_one/models/environment.rb +17 -5
  173. data/lib/talon_one/models/event.rb +1 -1
  174. data/lib/talon_one/models/event_type.rb +1 -1
  175. data/lib/talon_one/models/export.rb +1 -1
  176. data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -0
  177. data/lib/talon_one/models/giveaway.rb +1 -1
  178. data/lib/talon_one/models/giveaways_pool.rb +1 -1
  179. data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
  180. data/lib/talon_one/models/import.rb +1 -1
  181. data/lib/talon_one/models/inline_response20048.rb +208 -0
  182. data/lib/talon_one/models/inline_response20049.rb +208 -0
  183. data/lib/talon_one/models/inline_response20050.rb +222 -0
  184. data/lib/talon_one/models/inline_response20051.rb +227 -0
  185. data/lib/talon_one/models/integration_coupon.rb +7 -7
  186. data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
  187. data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
  188. data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
  189. data/lib/talon_one/models/inventory_coupon.rb +7 -7
  190. data/lib/talon_one/models/inventory_referral.rb +1 -1
  191. data/lib/talon_one/models/ledger_entry.rb +1 -1
  192. data/lib/talon_one/models/ledger_info.rb +0 -10
  193. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
  194. data/lib/talon_one/models/loyalty_card.rb +1 -1
  195. data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
  196. data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
  197. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
  198. data/lib/talon_one/models/loyalty_tier.rb +1 -1
  199. data/lib/talon_one/models/message_test.rb +227 -0
  200. data/lib/talon_one/models/model_return.rb +1 -1
  201. data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
  202. data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
  203. data/lib/talon_one/models/new_coupons.rb +5 -5
  204. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
  205. data/lib/talon_one/models/new_message_test.rb +322 -0
  206. data/lib/talon_one/models/new_price_adjustment.rb +268 -0
  207. data/lib/talon_one/models/new_price_type.rb +270 -0
  208. data/lib/talon_one/models/new_webhook.rb +16 -1
  209. data/lib/talon_one/models/picklist.rb +1 -1
  210. data/lib/talon_one/models/price_detail.rb +237 -0
  211. data/lib/talon_one/models/price_type.rb +347 -0
  212. data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
  213. data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
  214. data/lib/talon_one/models/referral.rb +1 -1
  215. data/lib/talon_one/models/revision_activation_request.rb +224 -0
  216. data/lib/talon_one/models/role.rb +1 -1
  217. data/lib/talon_one/models/role_v2.rb +1 -1
  218. data/lib/talon_one/models/ruleset.rb +1 -1
  219. data/lib/talon_one/models/saml_connection.rb +1 -1
  220. data/lib/talon_one/models/scim_base_group.rb +220 -0
  221. data/lib/talon_one/models/scim_group.rb +235 -0
  222. data/lib/talon_one/models/scim_group_member.rb +218 -0
  223. data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
  224. data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
  225. data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
  226. data/lib/talon_one/models/store.rb +1 -1
  227. data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
  228. data/lib/talon_one/models/template_def.rb +1 -1
  229. data/lib/talon_one/models/update_achievement.rb +3 -3
  230. data/lib/talon_one/models/update_coupon.rb +5 -5
  231. data/lib/talon_one/models/update_coupon_batch.rb +5 -5
  232. data/lib/talon_one/models/user.rb +1 -1
  233. data/lib/talon_one/models/webhook.rb +17 -2
  234. data/lib/talon_one/models/webhook_authentication.rb +365 -0
  235. data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
  236. data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
  237. data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
  238. data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
  239. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +17 -2
  240. data/lib/talon_one/version.rb +1 -1
  241. data/lib/talon_one.rb +26 -1
  242. data/spec/api/integration_api_spec.rb +4 -3
  243. data/spec/api/management_api_spec.rb +227 -90
  244. data/spec/models/achievement_base_spec.rb +1 -1
  245. data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
  246. data/spec/models/achievement_spec.rb +1 -1
  247. data/spec/models/achievement_status_entry_spec.rb +1 -1
  248. data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
  249. data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
  250. data/spec/models/base_notification_spec.rb +1 -1
  251. data/spec/models/binding_spec.rb +24 -0
  252. data/spec/models/campaign_deactivation_request_spec.rb +41 -0
  253. data/spec/models/campaign_template_spec.rb +6 -0
  254. data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
  255. data/spec/models/cart_item_spec.rb +30 -0
  256. data/spec/models/catalog_action_spec.rb +1 -1
  257. data/spec/models/coupon_entity_spec.rb +47 -0
  258. data/spec/models/create_achievement_spec.rb +1 -1
  259. data/spec/models/customer_profile_entity_spec.rb +47 -0
  260. data/spec/models/effect_entity_spec.rb +18 -0
  261. data/spec/models/effect_spec.rb +18 -0
  262. data/spec/models/environment_spec.rb +6 -0
  263. data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
  264. data/spec/models/inline_response20048_spec.rb +0 -6
  265. data/spec/models/inline_response20049_spec.rb +0 -6
  266. data/spec/models/inline_response20050_spec.rb +47 -0
  267. data/spec/models/inline_response20051_spec.rb +47 -0
  268. data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
  269. data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
  270. data/spec/models/integration_event_v2_request_spec.rb +6 -0
  271. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
  272. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  273. data/spec/models/new_message_test_spec.rb +1 -1
  274. data/spec/models/new_price_adjustment_spec.rb +71 -0
  275. data/spec/models/new_price_type_spec.rb +59 -0
  276. data/spec/models/new_webhook_spec.rb +6 -0
  277. data/spec/models/price_detail_spec.rb +59 -0
  278. data/spec/models/price_type_spec.rb +89 -0
  279. data/spec/models/revision_activation_request_spec.rb +47 -0
  280. data/spec/models/scim_base_group_spec.rb +47 -0
  281. data/spec/models/scim_group_member_spec.rb +47 -0
  282. data/spec/models/scim_group_spec.rb +53 -0
  283. data/spec/models/scim_groups_list_response_spec.rb +53 -0
  284. data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
  285. data/spec/models/update_achievement_spec.rb +1 -1
  286. data/spec/models/webhook_authentication_base_spec.rb +57 -0
  287. data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
  288. data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
  289. data/spec/models/webhook_authentication_spec.rb +93 -0
  290. data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
  291. data/spec/models/webhook_spec.rb +6 -0
  292. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  293. metadata +661 -527
@@ -0,0 +1,27 @@
1
+ # TalonOne::MessageTest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **http_response** | **String** | The returned http response. |
8
+ **http_status** | **Integer** | The returned http status code. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::MessageTest.new(http_response: HTTP/1.1 200 OK
16
+ Content-Type: application/json
17
+ Content-Length: 256
18
+
19
+ {
20
+ "message": "Hello, world!",
21
+ "status": "success"
22
+ }
23
+ ,
24
+ http_status: 200)
25
+ ```
26
+
27
+
data/docs/ModelReturn.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **application_id** | **Integer** | The ID of the Application that owns this entity. |
10
10
  **account_id** | **Integer** | The ID of the account that owns this entity. |
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **name** | **String** | The human-friendly display name for this audience. |
10
10
  **integration_id** | **String** | The ID of this audience in the third-party integration. |
@@ -0,0 +1,29 @@
1
+ # TalonOne::NewMessageTest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | The message type. |
8
+ **_query_params** | **Hash<String, String>** | Array of query parameters. | [optional]
9
+ **headers** | **Hash<String, String>** | List of API HTTP headers for the given message. | [optional]
10
+ **verb** | **String** | API method for this message. |
11
+ **url** | **String** | API URL for the given message. |
12
+ **payload** | **String** | API payload of this message. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::NewMessageTest.new(type: loyalty_added_deducted_points,
20
+ _query_params: {"param1":"value1","param2":"value2"},
21
+ headers: {"content-type":"application/json"},
22
+ verb: POST,
23
+ url: www.my-company.com/my-endpoint-name,
24
+ payload: {
25
+ "integrationId": "${$Profile.IntegrationId}"
26
+ })
27
+ ```
28
+
29
+
@@ -0,0 +1,27 @@
1
+ # TalonOne::NewPriceAdjustment
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **price_type** | **String** | The price type (e.g. the price for members only) to apply to a given SKU. |
8
+ **price** | **Float** | The value of the price type applied to the SKU. When set to `null`, the defined price type no longer applies to the SKU. | [optional]
9
+ **reference_id** | **String** | A unique reference identifier, e.g. a UUID. |
10
+ **calculated_at** | **DateTime** | The time at which this price was calculated. If provided, this is used to determine the most recent price adjustment to choose if price adjustments overlap. Defaults to internal creation time if not provided. | [optional]
11
+ **effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional]
12
+ **effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'TalonOne'
18
+
19
+ instance = TalonOne::NewPriceAdjustment.new(price_type: member,
20
+ price: 100.0,
21
+ reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
22
+ calculated_at: 2021-09-12T10:12:42Z,
23
+ effective_from: 2021-09-12T10:12:42Z,
24
+ effective_until: 2021-09-12T10:12:42Z)
25
+ ```
26
+
27
+
@@ -0,0 +1,23 @@
1
+ # TalonOne::NewPriceType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The API name of the price type. This is an immutable value. |
8
+ **title** | **String** | The title of the price type. |
9
+ **description** | **String** | The description of the price type. | [optional]
10
+ **targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences that are targeted by this price type. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::NewPriceType.new(name: member,
18
+ title: Member Price,
19
+ description: Price available exclusively to members.,
20
+ targeted_audiences_ids: [1, 2, 3])
21
+ ```
22
+
23
+
data/docs/NewWebhook.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. |
8
8
  **title** | **String** | Name or title for this webhook. |
9
9
  **description** | **String** | A description of the webhook. | [optional]
10
+ **draft** | **Boolean** | Indicates if the webhook is a draft. |
10
11
  **verb** | **String** | API method for this webhook. |
11
12
  **url** | **String** | API URL (supports templating using parameters) for this webhook. |
12
13
  **headers** | **Array<String>** | List of API HTTP headers for this webhook. |
@@ -22,6 +23,7 @@ require 'TalonOne'
22
23
  instance = TalonOne::NewWebhook.new(application_ids: null,
23
24
  title: Send message,
24
25
  description: A webhook to send a coupon to the user.,
26
+ draft: false,
25
27
  verb: POST,
26
28
  url: www.my-company.com/my-endpoint-name,
27
29
  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],
data/docs/Picklist.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **type** | **String** | The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. |
10
10
  **values** | **Array<String>** | The list of allowed values provided by this picklist. |
@@ -0,0 +1,23 @@
1
+ # TalonOne::PriceDetail
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **price** | **Float** | The value of this price type. | [optional]
8
+ **adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. | [optional]
9
+ **adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional]
10
+ **adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::PriceDetail.new(price: 90.0,
18
+ adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
19
+ adjustment_effective_from: 2025-05-25T00:00Z,
20
+ adjustment_effective_until: 2025-05-30T00:00Z)
21
+ ```
22
+
23
+
data/docs/PriceType.md ADDED
@@ -0,0 +1,33 @@
1
+ # TalonOne::PriceType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **Integer** | The internal ID of this entity. |
8
+ **created** | **DateTime** | The time this entity was created. |
9
+ **account_id** | **Integer** | The ID of the account that owns this price type. | [optional]
10
+ **name** | **String** | The API name of the price type. This is an immutable value. |
11
+ **title** | **String** | The title of the price type. |
12
+ **description** | **String** | The description of the price type. | [optional]
13
+ **modified** | **DateTime** | The date and time when the price type was last modified. |
14
+ **subscribed_catalogs_ids** | **Array<Integer>** | A list of the IDs of the catalogs that are subscribed to this price type. |
15
+ **targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences that are targeted by this price type. |
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'TalonOne'
21
+
22
+ instance = TalonOne::PriceType.new(id: 6,
23
+ created: 2020-06-10T09:05:27.993483Z,
24
+ account_id: 1,
25
+ name: member,
26
+ title: Member Price,
27
+ description: Price available exclusively to members.,
28
+ modified: 2021-09-12T10:12:42Z,
29
+ subscribed_catalogs_ids: [1, 2, 3],
30
+ targeted_audiences_ids: [1, 2, 3])
31
+ ```
32
+
33
+
@@ -0,0 +1,25 @@
1
+ # TalonOne::ProductUnitAnalyticsDataPoint
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
8
+ **end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
9
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | |
10
+ **product_id** | **Integer** | The ID of the product. |
11
+ **product_name** | **String** | The name of the product. |
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'TalonOne'
17
+
18
+ instance = TalonOne::ProductUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
19
+ end_time: null,
20
+ units_sold: null,
21
+ product_id: 1,
22
+ product_name: MyProduct)
23
+ ```
24
+
25
+
@@ -0,0 +1,17 @@
1
+ # TalonOne::ProductUnitAnalyticsTotals
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TalonOne'
13
+
14
+ instance = TalonOne::ProductUnitAnalyticsTotals.new(units_sold: null)
15
+ ```
16
+
17
+
data/docs/Referral.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
10
10
  **expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional]
@@ -0,0 +1,19 @@
1
+ # TalonOne::RevisionActivationRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **user_ids** | **Array<Integer>** | The list of IDs of the users who will receive the activation request. |
8
+ **activate_at** | **DateTime** | Time when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::RevisionActivationRequest.new(user_ids: [1, 2, 3],
16
+ activate_at: null)
17
+ ```
18
+
19
+
data/docs/Role.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **modified** | **DateTime** | The time this entity was last modified. |
10
10
  **account_id** | **Integer** | The ID of the account that owns this entity. |
data/docs/RoleV2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **modified** | **DateTime** | The time this entity was last modified. |
10
10
  **account_id** | **Integer** | The ID of the account that owns this entity. |
data/docs/Ruleset.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **user_id** | **Integer** | The ID of the user associated with this entity. |
10
10
  **rules** | [**Array<Rule>**](Rule.md) | Set of rules to apply. |
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **sign_out_url** | **String** | Single Sign-Out URL. | [optional]
14
14
  **metadata_url** | **String** | Metadata URL. | [optional]
15
15
  **audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used. |
16
- **id** | **Integer** | Internal ID of this entity. |
16
+ **id** | **Integer** | The internal ID of this entity. |
17
17
  **created** | **DateTime** | The time this entity was created. |
18
18
 
19
19
  ## Code Sample
@@ -0,0 +1,19 @@
1
+ # TalonOne::ScimBaseGroup
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **display_name** | **String** | Display name of the group (Talon.One role). | [optional]
8
+ **members** | [**Array<ScimGroupMember>**](ScimGroupMember.md) | List of members to assign to the new Talon.One role. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::ScimBaseGroup.new(display_name: Manager,
16
+ members: null)
17
+ ```
18
+
19
+
data/docs/ScimGroup.md ADDED
@@ -0,0 +1,21 @@
1
+ # TalonOne::ScimGroup
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **display_name** | **String** | Display name of the group (Talon.One role). | [optional]
8
+ **members** | [**Array<ScimGroupMember>**](ScimGroupMember.md) | List of members to assign to the new Talon.One role. | [optional]
9
+ **id** | **String** | ID of the group. |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'TalonOne'
15
+
16
+ instance = TalonOne::ScimGroup.new(display_name: Manager,
17
+ members: null,
18
+ id: 359)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::ScimGroupMember
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **value** | **String** | Unique identifier of the member. | [optional]
8
+ **display** | **String** | Identifier of the user. This is usually an email address. | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::ScimGroupMember.new(value: 258,
16
+ display: john.doe@example.com)
17
+ ```
18
+
19
+
@@ -0,0 +1,21 @@
1
+ # TalonOne::ScimGroupsListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **resources** | [**Array<ScimGroup>**](ScimGroup.md) | |
8
+ **schemas** | **Array<String>** | SCIM schema for the given resource. | [optional]
9
+ **total_results** | **Integer** | Number of results in the response. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'TalonOne'
15
+
16
+ instance = TalonOne::ScimGroupsListResponse.new(resources: null,
17
+ schemas: null,
18
+ total_results: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::SkuUnitAnalytics
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **data** | [**Array<SkuUnitAnalyticsDataPoint>**](SkuUnitAnalyticsDataPoint.md) | |
8
+ **totals** | [**ProductUnitAnalyticsTotals**](ProductUnitAnalyticsTotals.md) | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::SkuUnitAnalytics.new(data: null,
16
+ totals: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,23 @@
1
+ # TalonOne::SkuUnitAnalyticsDataPoint
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
8
+ **end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
9
+ **units_sold** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | |
10
+ **sku** | **String** | The SKU linked to the application. |
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'TalonOne'
16
+
17
+ instance = TalonOne::SkuUnitAnalyticsDataPoint.new(start_time: 2024-02-01T00:00Z,
18
+ end_time: null,
19
+ units_sold: null,
20
+ sku: SKU-123)
21
+ ```
22
+
23
+
data/docs/Store.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **name** | **String** | The name of the store. |
10
10
  **description** | **String** | The description of the store. |
@@ -5,6 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **version** | **String** | The version of the strikethrough pricing notification. | [optional]
8
+ **valid_from** | **DateTime** | Timestamp at which the strikethrough pricing update becomes valid. Set for **scheduled** strikethrough pricing updates (version: v2) only. | [optional]
8
9
  **application_id** | **Integer** | The ID of the Application to which the catalog items labels belongs. |
9
10
  **current_batch** | **Integer** | The batch number of the notification. Notifications might be sent in different batches. |
10
11
  **total_batches** | **Integer** | The total number of batches for the notification. |
@@ -17,6 +18,7 @@ Name | Type | Description | Notes
17
18
  require 'TalonOne'
18
19
 
19
20
  instance = TalonOne::StrikethroughLabelingNotification.new(version: null,
21
+ valid_from: 2021-07-20T22:00Z,
20
22
  application_id: 322,
21
23
  current_batch: 1,
22
24
  total_batches: 10,
data/docs/TemplateDef.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **application_id** | **Integer** | The ID of the Application that owns this entity. |
10
10
  **title** | **String** | Campaigner-friendly name for the template that will be shown in the rule editor. |
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
11
11
  **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
12
12
  **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
13
- **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
13
+ **recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
14
14
  **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
15
15
  **fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
16
16
  **end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
data/docs/User.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **modified** | **DateTime** | The time this entity was last modified. |
10
10
  **email** | **String** | The email address associated with the user profile. |
data/docs/Webhook.md CHANGED
@@ -4,12 +4,13 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **id** | **Integer** | Internal ID of this entity. |
7
+ **id** | **Integer** | The internal ID of this entity. |
8
8
  **created** | **DateTime** | The time this entity was created. |
9
9
  **modified** | **DateTime** | The time this entity was last modified. |
10
10
  **application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. |
11
11
  **title** | **String** | Name or title for this webhook. |
12
12
  **description** | **String** | A description of the webhook. | [optional]
13
+ **draft** | **Boolean** | Indicates if the webhook is a draft. |
13
14
  **verb** | **String** | API method for this webhook. |
14
15
  **url** | **String** | API URL (supports templating using parameters) for this webhook. |
15
16
  **headers** | **Array<String>** | List of API HTTP headers for this webhook. |
@@ -28,6 +29,7 @@ instance = TalonOne::Webhook.new(id: 6,
28
29
  application_ids: null,
29
30
  title: Send message,
30
31
  description: A webhook to send a coupon to the user.,
32
+ draft: false,
31
33
  verb: POST,
32
34
  url: www.my-company.com/my-endpoint-name,
33
35
  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],
@@ -0,0 +1,33 @@
1
+ # TalonOne::WebhookAuthentication
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **created_by** | **String** | The name of the user who created the webhook authentication. |
8
+ **modified_by** | **String** | The name of the user who last modified the webhook authentication. |
9
+ **webhooks** | [**Array<WebhookAuthenticationWebhookRef>**](WebhookAuthenticationWebhookRef.md) | |
10
+ **name** | **String** | The name of the webhook authentication. |
11
+ **type** | **String** | |
12
+ **data** | [**Object**](.md) | |
13
+ **id** | **Integer** | The internal ID of this entity. |
14
+ **created** | **DateTime** | The time this entity was created. |
15
+ **modified** | **DateTime** | The time this entity was last modified. |
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'TalonOne'
21
+
22
+ instance = TalonOne::WebhookAuthentication.new(created_by: null,
23
+ modified_by: null,
24
+ webhooks: null,
25
+ name: My basic auth,
26
+ type: null,
27
+ data: null,
28
+ id: 6,
29
+ created: 2020-06-10T09:05:27.993483Z,
30
+ modified: 2021-09-12T10:12:42Z)
31
+ ```
32
+
33
+
@@ -0,0 +1,21 @@
1
+ # TalonOne::WebhookAuthenticationBase
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | The name of the webhook authentication. |
8
+ **type** | **String** | |
9
+ **data** | [**Object**](.md) | |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'TalonOne'
15
+
16
+ instance = TalonOne::WebhookAuthenticationBase.new(name: My basic auth,
17
+ type: null,
18
+ data: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # TalonOne::WebhookAuthenticationDataBasic
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **username** | **String** | The Basic HTTP username. |
8
+ **password** | **String** | The Basic HTTP password. |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'TalonOne'
14
+
15
+ instance = TalonOne::WebhookAuthenticationDataBasic.new(username: null,
16
+ password: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,17 @@
1
+ # TalonOne::WebhookAuthenticationDataCustom
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **headers** | **Hash<String, String>** | |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'TalonOne'
13
+
14
+ instance = TalonOne::WebhookAuthenticationDataCustom.new(headers: null)
15
+ ```
16
+
17
+