talon_one 4.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (347) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +83 -18
  3. data/docs/AchievementProgress.md +2 -0
  4. data/docs/ActivateUserRequest.md +17 -0
  5. data/docs/AdditionalCampaignProperties.md +3 -1
  6. data/docs/AnalyticsDataPoint.md +19 -0
  7. data/docs/AnalyticsDataPointWithTrend.md +19 -0
  8. data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
  9. data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
  10. data/docs/Application.md +4 -0
  11. data/docs/ApplicationAnalyticsDataPoint.md +6 -6
  12. data/docs/ApplicationCIF.md +33 -0
  13. data/docs/ApplicationCIFExpression.md +27 -0
  14. data/docs/ApplicationCampaignAnalytics.md +13 -19
  15. data/docs/ApplicationCampaignStats.md +1 -3
  16. data/docs/AsyncCouponDeletionJobResponse.md +17 -0
  17. data/docs/BaseLoyaltyProgram.md +8 -4
  18. data/docs/BaseNotification.md +1 -1
  19. data/docs/BaseNotificationEntity.md +1 -1
  20. data/docs/Campaign.md +15 -1
  21. data/docs/CampaignCollectionEditedNotification.md +21 -0
  22. data/docs/CampaignNotificationPolicy.md +3 -1
  23. data/docs/CampaignStateChangedNotification.md +2 -2
  24. data/docs/CampaignStoreBudget.md +25 -0
  25. data/docs/CampaignVersions.md +27 -0
  26. data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
  27. data/docs/CartItem.md +1 -1
  28. data/docs/CodeGeneratorSettings.md +1 -1
  29. data/docs/Coupon.md +3 -3
  30. data/docs/CouponConstraints.md +1 -1
  31. data/docs/CouponCreationJob.md +1 -1
  32. data/docs/CouponDeletionFilters.md +43 -0
  33. data/docs/CouponDeletionJob.md +39 -0
  34. data/docs/CustomerInventory.md +1 -1
  35. data/docs/CustomerSessionV2.md +2 -2
  36. data/docs/Effect.md +8 -0
  37. data/docs/EffectEntity.md +9 -1
  38. data/docs/Environment.md +3 -1
  39. data/docs/Event.md +1 -1
  40. data/docs/GenerateCampaignDescription.md +19 -0
  41. data/docs/GenerateCampaignTags.md +17 -0
  42. data/docs/GenerateItemFilterDescription.md +17 -0
  43. data/docs/GenerateLoyaltyCard.md +19 -0
  44. data/docs/GenerateRuleTitle.md +19 -0
  45. data/docs/GenerateRuleTitleRule.md +19 -0
  46. data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
  47. data/docs/InlineResponse20044.md +1 -1
  48. data/docs/IntegrationApi.md +77 -16
  49. data/docs/IntegrationCoupon.md +3 -3
  50. data/docs/InventoryCoupon.md +3 -3
  51. data/docs/InventoryReferral.md +1 -1
  52. data/docs/LoyaltyBalanceWithTier.md +31 -0
  53. data/docs/LoyaltyBalancesWithTiers.md +19 -0
  54. data/docs/LoyaltyCard.md +6 -2
  55. data/docs/LoyaltyCardBalances.md +21 -0
  56. data/docs/LoyaltyCardBatch.md +21 -0
  57. data/docs/LoyaltyCardBatchResponse.md +19 -0
  58. data/docs/LoyaltyCardProfileRegistration.md +1 -1
  59. data/docs/LoyaltyProgram.md +14 -6
  60. data/docs/ManagementApi.md +1269 -176
  61. data/docs/MessageLogEntry.md +1 -3
  62. data/docs/MessageLogResponse.md +3 -3
  63. data/docs/NewAppWideCouponDeletionJob.md +19 -0
  64. data/docs/NewApplication.md +3 -1
  65. data/docs/NewApplicationCIF.md +27 -0
  66. data/docs/NewApplicationCIFExpression.md +21 -0
  67. data/docs/NewBaseNotification.md +1 -1
  68. data/docs/NewCouponCreationJob.md +1 -1
  69. data/docs/NewCouponDeletionJob.md +17 -0
  70. data/docs/NewCoupons.md +2 -2
  71. data/docs/NewCouponsForMultipleRecipients.md +1 -1
  72. data/docs/NewCustomerSessionV2.md +2 -2
  73. data/docs/NewExternalInvitation.md +21 -0
  74. data/docs/NewLoyaltyProgram.md +8 -4
  75. data/docs/NewOutgoingIntegrationWebhook.md +2 -0
  76. data/docs/NewReferral.md +1 -1
  77. data/docs/NewReferralsForMultipleAdvocates.md +1 -1
  78. data/docs/NewRevisionVersion.md +37 -0
  79. data/docs/NewWebhook.md +2 -0
  80. data/docs/OktaEvent.md +19 -0
  81. data/docs/OktaEventPayload.md +17 -0
  82. data/docs/OktaEventPayloadData.md +17 -0
  83. data/docs/OktaEventTarget.md +21 -0
  84. data/docs/ProjectedTier.md +21 -0
  85. data/docs/Referral.md +1 -1
  86. data/docs/ReferralConstraints.md +1 -1
  87. data/docs/RejectCouponEffectProps.md +3 -1
  88. data/docs/RejectReferralEffectProps.md +3 -1
  89. data/docs/Revision.md +35 -0
  90. data/docs/RevisionActivation.md +17 -0
  91. data/docs/RevisionVersion.md +53 -0
  92. data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
  93. data/docs/RuleFailureReason.md +5 -1
  94. data/docs/SSOConfig.md +3 -1
  95. data/docs/ScimBaseUser.md +23 -0
  96. data/docs/ScimBaseUserName.md +17 -0
  97. data/docs/ScimNewUser.md +23 -0
  98. data/docs/ScimPatchOperation.md +21 -0
  99. data/docs/ScimPatchRequest.md +19 -0
  100. data/docs/ScimResource.md +21 -0
  101. data/docs/ScimResourceTypesListResponse.md +17 -0
  102. data/docs/ScimSchemaResource.md +23 -0
  103. data/docs/ScimSchemasListResponse.md +21 -0
  104. data/docs/ScimServiceProviderConfigResponse.md +27 -0
  105. data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
  106. data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
  107. data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
  108. data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
  109. data/docs/ScimUser.md +25 -0
  110. data/docs/ScimUsersListResponse.md +21 -0
  111. data/docs/Tier.md +3 -1
  112. data/docs/TransferLoyaltyCard.md +3 -1
  113. data/docs/UpdateApplication.md +5 -1
  114. data/docs/UpdateApplicationCIF.md +23 -0
  115. data/docs/UpdateCampaign.md +1 -1
  116. data/docs/UpdateCoupon.md +2 -2
  117. data/docs/UpdateCouponBatch.md +1 -1
  118. data/docs/UpdateLoyaltyCard.md +4 -2
  119. data/docs/UpdateLoyaltyProgram.md +8 -4
  120. data/docs/UpdateReferral.md +1 -1
  121. data/docs/UpdateReferralBatch.md +1 -1
  122. data/docs/UpdateUser.md +1 -1
  123. data/docs/User.md +3 -1
  124. data/docs/Webhook.md +2 -0
  125. data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
  126. data/lib/talon_one/api/integration_api.rb +101 -25
  127. data/lib/talon_one/api/management_api.rb +1362 -189
  128. data/lib/talon_one/models/achievement_progress.rb +16 -1
  129. data/lib/talon_one/models/activate_user_request.rb +213 -0
  130. data/lib/talon_one/models/additional_campaign_properties.rb +21 -6
  131. data/lib/talon_one/models/analytics_data_point.rb +225 -0
  132. data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
  133. data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
  134. data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
  135. data/lib/talon_one/models/application.rb +21 -1
  136. data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
  137. data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
  138. data/lib/talon_one/models/application_campaign_stats.rb +1 -16
  139. data/lib/talon_one/models/application_cif.rb +308 -0
  140. data/lib/talon_one/models/application_cif_expression.rb +275 -0
  141. data/lib/talon_one/models/async_coupon_deletion_job_response.rb +213 -0
  142. data/lib/talon_one/models/attribute.rb +2 -2
  143. data/lib/talon_one/models/base_loyalty_program.rb +44 -25
  144. data/lib/talon_one/models/base_notification.rb +3 -2
  145. data/lib/talon_one/models/base_notification_entity.rb +1 -0
  146. data/lib/talon_one/models/campaign.rb +83 -6
  147. data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
  148. data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
  149. data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
  150. data/lib/talon_one/models/campaign_store_budget.rb +275 -0
  151. data/lib/talon_one/models/campaign_versions.rb +259 -0
  152. data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
  153. data/lib/talon_one/models/cart_item.rb +1 -1
  154. data/lib/talon_one/models/code_generator_settings.rb +1 -1
  155. data/lib/talon_one/models/coupon.rb +3 -3
  156. data/lib/talon_one/models/coupon_constraints.rb +1 -1
  157. data/lib/talon_one/models/coupon_creation_job.rb +1 -1
  158. data/lib/talon_one/models/coupon_deletion_filters.rb +375 -0
  159. data/lib/talon_one/models/coupon_deletion_job.rb +370 -0
  160. data/lib/talon_one/models/customer_inventory.rb +1 -1
  161. data/lib/talon_one/models/customer_session_v2.rb +2 -2
  162. data/lib/talon_one/models/effect.rb +41 -1
  163. data/lib/talon_one/models/effect_entity.rb +44 -4
  164. data/lib/talon_one/models/environment.rb +16 -4
  165. data/lib/talon_one/models/event.rb +0 -5
  166. data/lib/talon_one/models/generate_campaign_description.rb +227 -0
  167. data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
  168. data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
  169. data/lib/talon_one/models/generate_loyalty_card.rb +256 -0
  170. data/lib/talon_one/models/generate_rule_title.rb +226 -0
  171. data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
  172. data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
  173. data/lib/talon_one/models/inline_response20044.rb +1 -1
  174. data/lib/talon_one/models/integration_coupon.rb +3 -3
  175. data/lib/talon_one/models/inventory_coupon.rb +3 -3
  176. data/lib/talon_one/models/inventory_referral.rb +1 -1
  177. data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
  178. data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
  179. data/lib/talon_one/models/loyalty_card.rb +25 -5
  180. data/lib/talon_one/models/loyalty_card_balances.rb +231 -0
  181. data/lib/talon_one/models/loyalty_card_batch.rb +304 -0
  182. data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
  183. data/lib/talon_one/models/loyalty_card_profile_registration.rb +1 -1
  184. data/lib/talon_one/models/loyalty_program.rb +70 -29
  185. data/lib/talon_one/models/message_log_entry.rb +4 -14
  186. data/lib/talon_one/models/message_log_response.rb +3 -22
  187. data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
  188. data/lib/talon_one/models/new_application.rb +14 -4
  189. data/lib/talon_one/models/new_application_cif.rb +262 -0
  190. data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
  191. data/lib/talon_one/models/new_attribute.rb +2 -2
  192. data/lib/talon_one/models/new_base_notification.rb +1 -0
  193. data/lib/talon_one/models/new_coupon_creation_job.rb +1 -1
  194. data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
  195. data/lib/talon_one/models/new_coupons.rb +2 -2
  196. data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -1
  197. data/lib/talon_one/models/new_customer_session_v2.rb +2 -2
  198. data/lib/talon_one/models/new_external_invitation.rb +235 -0
  199. data/lib/talon_one/models/new_loyalty_program.rb +44 -25
  200. data/lib/talon_one/models/new_notification_test.rb +2 -2
  201. data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
  202. data/lib/talon_one/models/new_referral.rb +1 -1
  203. data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -1
  204. data/lib/talon_one/models/new_revision_version.rb +352 -0
  205. data/lib/talon_one/models/new_webhook.rb +11 -1
  206. data/lib/talon_one/models/okta_event.rb +229 -0
  207. data/lib/talon_one/models/okta_event_payload.rb +212 -0
  208. data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
  209. data/lib/talon_one/models/okta_event_target.rb +243 -0
  210. data/lib/talon_one/models/projected_tier.rb +232 -0
  211. data/lib/talon_one/models/referral.rb +1 -1
  212. data/lib/talon_one/models/referral_constraints.rb +1 -1
  213. data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
  214. data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
  215. data/lib/talon_one/models/revision.rb +319 -0
  216. data/lib/talon_one/models/revision_activation.rb +206 -0
  217. data/lib/talon_one/models/revision_version.rb +466 -0
  218. data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
  219. data/lib/talon_one/models/rule_failure_reason.rb +24 -4
  220. data/lib/talon_one/models/scim_base_user.rb +237 -0
  221. data/lib/talon_one/models/scim_base_user_name.rb +208 -0
  222. data/lib/talon_one/models/scim_new_user.rb +237 -0
  223. data/lib/talon_one/models/scim_patch_operation.rb +267 -0
  224. data/lib/talon_one/models/scim_patch_request.rb +226 -0
  225. data/lib/talon_one/models/scim_resource.rb +228 -0
  226. data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
  227. data/lib/talon_one/models/scim_schema_resource.rb +239 -0
  228. data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
  229. data/lib/talon_one/models/scim_service_provider_config_response.rb +256 -0
  230. data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
  231. data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
  232. data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
  233. data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
  234. data/lib/talon_one/models/scim_user.rb +252 -0
  235. data/lib/talon_one/models/scim_users_list_response.rb +236 -0
  236. data/lib/talon_one/models/sso_config.rb +14 -4
  237. data/lib/talon_one/models/tier.rb +12 -2
  238. data/lib/talon_one/models/transfer_loyalty_card.rb +14 -4
  239. data/lib/talon_one/models/update_application.rb +24 -4
  240. data/lib/talon_one/models/update_application_cif.rb +237 -0
  241. data/lib/talon_one/models/update_campaign.rb +1 -1
  242. data/lib/talon_one/models/update_coupon.rb +2 -2
  243. data/lib/talon_one/models/update_coupon_batch.rb +1 -1
  244. data/lib/talon_one/models/update_loyalty_card.rb +15 -5
  245. data/lib/talon_one/models/update_loyalty_program.rb +44 -25
  246. data/lib/talon_one/models/update_referral.rb +1 -1
  247. data/lib/talon_one/models/update_referral_batch.rb +1 -1
  248. data/lib/talon_one/models/update_user.rb +1 -1
  249. data/lib/talon_one/models/user.rb +14 -4
  250. data/lib/talon_one/models/webhook.rb +11 -1
  251. data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
  252. data/lib/talon_one/version.rb +1 -1
  253. data/lib/talon_one.rb +57 -11
  254. data/spec/api/integration_api_spec.rb +25 -10
  255. data/spec/api/management_api_spec.rb +267 -39
  256. data/spec/models/achievement_progress_spec.rb +6 -0
  257. data/spec/models/activate_user_request_spec.rb +41 -0
  258. data/spec/models/additional_campaign_properties_spec.rb +7 -1
  259. data/spec/models/analytics_data_point_spec.rb +47 -0
  260. data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
  261. data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
  262. data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
  263. data/spec/models/application_campaign_analytics_spec.rb +1 -19
  264. data/spec/models/application_campaign_stats_spec.rb +0 -6
  265. data/spec/models/application_cif_expression_spec.rb +71 -0
  266. data/spec/models/application_cif_spec.rb +89 -0
  267. data/spec/models/application_spec.rb +12 -0
  268. data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
  269. data/spec/models/attribute_spec.rb +1 -1
  270. data/spec/models/base_loyalty_program_spec.rb +18 -6
  271. data/spec/models/base_notification_spec.rb +1 -1
  272. data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
  273. data/spec/models/campaign_notification_policy_spec.rb +6 -0
  274. data/spec/models/campaign_spec.rb +43 -1
  275. data/spec/models/campaign_store_budget_spec.rb +65 -0
  276. data/spec/models/campaign_versions_spec.rb +71 -0
  277. data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
  278. data/spec/models/coupon_deletion_filters_spec.rb +123 -0
  279. data/spec/models/coupon_deletion_job_spec.rb +107 -0
  280. data/spec/models/effect_entity_spec.rb +24 -0
  281. data/spec/models/effect_spec.rb +24 -0
  282. data/spec/models/environment_spec.rb +6 -0
  283. data/spec/models/generate_campaign_description_spec.rb +47 -0
  284. data/spec/models/generate_campaign_tags_spec.rb +41 -0
  285. data/spec/models/generate_item_filter_description_spec.rb +41 -0
  286. data/spec/models/generate_loyalty_card_spec.rb +51 -0
  287. data/spec/models/generate_rule_title_rule_spec.rb +47 -0
  288. data/spec/models/generate_rule_title_spec.rb +47 -0
  289. data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
  290. data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
  291. data/spec/models/loyalty_card_balances_spec.rb +53 -0
  292. data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
  293. data/spec/models/loyalty_card_batch_spec.rb +57 -0
  294. data/spec/models/loyalty_card_spec.rb +12 -0
  295. data/spec/models/loyalty_program_spec.rb +30 -6
  296. data/spec/models/message_log_entry_spec.rb +1 -7
  297. data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
  298. data/spec/models/new_application_cif_expression_spec.rb +53 -0
  299. data/spec/models/new_application_cif_spec.rb +71 -0
  300. data/spec/models/new_application_spec.rb +6 -0
  301. data/spec/models/new_attribute_spec.rb +1 -1
  302. data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
  303. data/spec/models/new_external_invitation_spec.rb +53 -0
  304. data/spec/models/new_loyalty_program_spec.rb +18 -6
  305. data/spec/models/new_notification_test_spec.rb +1 -1
  306. data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
  307. data/spec/models/new_revision_version_spec.rb +105 -0
  308. data/spec/models/new_webhook_spec.rb +6 -0
  309. data/spec/models/okta_event_payload_data_spec.rb +41 -0
  310. data/spec/models/okta_event_payload_spec.rb +41 -0
  311. data/spec/models/okta_event_spec.rb +47 -0
  312. data/spec/models/okta_event_target_spec.rb +53 -0
  313. data/spec/models/projected_tier_spec.rb +53 -0
  314. data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
  315. data/spec/models/reject_referral_effect_props_spec.rb +6 -0
  316. data/spec/models/revision_activation_spec.rb +41 -0
  317. data/spec/models/revision_spec.rb +95 -0
  318. data/spec/models/revision_version_spec.rb +153 -0
  319. data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
  320. data/spec/models/rule_failure_reason_spec.rb +12 -0
  321. data/spec/models/scim_base_user_name_spec.rb +41 -0
  322. data/spec/models/scim_base_user_spec.rb +59 -0
  323. data/spec/models/scim_new_user_spec.rb +59 -0
  324. data/spec/models/scim_patch_operation_spec.rb +57 -0
  325. data/spec/models/scim_patch_request_spec.rb +47 -0
  326. data/spec/models/scim_resource_spec.rb +53 -0
  327. data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
  328. data/spec/models/scim_schema_resource_spec.rb +59 -0
  329. data/spec/models/scim_schemas_list_response_spec.rb +53 -0
  330. data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
  331. data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
  332. data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
  333. data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
  334. data/spec/models/scim_service_provider_config_response_spec.rb +71 -0
  335. data/spec/models/scim_user_spec.rb +65 -0
  336. data/spec/models/scim_users_list_response_spec.rb +53 -0
  337. data/spec/models/sso_config_spec.rb +6 -0
  338. data/spec/models/tier_spec.rb +6 -0
  339. data/spec/models/transfer_loyalty_card_spec.rb +6 -0
  340. data/spec/models/update_application_cif_spec.rb +59 -0
  341. data/spec/models/update_application_spec.rb +12 -0
  342. data/spec/models/update_loyalty_card_spec.rb +6 -0
  343. data/spec/models/update_loyalty_program_spec.rb +18 -6
  344. data/spec/models/user_spec.rb +6 -0
  345. data/spec/models/webhook_spec.rb +6 -0
  346. data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
  347. metadata +246 -18
@@ -0,0 +1,237 @@
1
+ =begin
2
+ #Talon.One API
3
+
4
+ #Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
5
+
6
+ The version of the OpenAPI document:
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module TalonOne
16
+ class UpdateApplicationCIF
17
+ # A short description of the Application cart item filter.
18
+ attr_accessor :description
19
+
20
+ # The ID of the expression that the Application cart item filter uses.
21
+ attr_accessor :active_expression_id
22
+
23
+ # The ID of the user who last updated the Application cart item filter.
24
+ attr_accessor :modified_by
25
+
26
+ # Timestamp of the most recent update to the Application cart item filter.
27
+ attr_accessor :modified
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'description' => :'description',
33
+ :'active_expression_id' => :'activeExpressionId',
34
+ :'modified_by' => :'modifiedBy',
35
+ :'modified' => :'modified'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.openapi_types
41
+ {
42
+ :'description' => :'String',
43
+ :'active_expression_id' => :'Integer',
44
+ :'modified_by' => :'Integer',
45
+ :'modified' => :'DateTime'
46
+ }
47
+ end
48
+
49
+ # List of attributes with nullable: true
50
+ def self.openapi_nullable
51
+ Set.new([
52
+ ])
53
+ end
54
+
55
+ # Initializes the object
56
+ # @param [Hash] attributes Model attributes in the form of hash
57
+ def initialize(attributes = {})
58
+ if (!attributes.is_a?(Hash))
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::UpdateApplicationCIF` initialize method"
60
+ end
61
+
62
+ # check to see if the attribute exists and convert string to symbol for hash key
63
+ attributes = attributes.each_with_object({}) { |(k, v), h|
64
+ if (!self.class.attribute_map.key?(k.to_sym))
65
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::UpdateApplicationCIF`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
66
+ end
67
+ h[k.to_sym] = v
68
+ }
69
+
70
+ if attributes.key?(:'description')
71
+ self.description = attributes[:'description']
72
+ end
73
+
74
+ if attributes.key?(:'active_expression_id')
75
+ self.active_expression_id = attributes[:'active_expression_id']
76
+ end
77
+
78
+ if attributes.key?(:'modified_by')
79
+ self.modified_by = attributes[:'modified_by']
80
+ end
81
+
82
+ if attributes.key?(:'modified')
83
+ self.modified = attributes[:'modified']
84
+ end
85
+ end
86
+
87
+ # Show invalid properties with the reasons. Usually used together with valid?
88
+ # @return Array for valid properties with the reasons
89
+ def list_invalid_properties
90
+ invalid_properties = Array.new
91
+ invalid_properties
92
+ end
93
+
94
+ # Check to see if the all the properties in the model are valid
95
+ # @return true if the model is valid
96
+ def valid?
97
+ true
98
+ end
99
+
100
+ # Checks equality by comparing each attribute.
101
+ # @param [Object] Object to be compared
102
+ def ==(o)
103
+ return true if self.equal?(o)
104
+ self.class == o.class &&
105
+ description == o.description &&
106
+ active_expression_id == o.active_expression_id &&
107
+ modified_by == o.modified_by &&
108
+ modified == o.modified
109
+ end
110
+
111
+ # @see the `==` method
112
+ # @param [Object] Object to be compared
113
+ def eql?(o)
114
+ self == o
115
+ end
116
+
117
+ # Calculates hash code according to all attributes.
118
+ # @return [Integer] Hash code
119
+ def hash
120
+ [description, active_expression_id, modified_by, modified].hash
121
+ end
122
+
123
+ # Builds the object from hash
124
+ # @param [Hash] attributes Model attributes in the form of hash
125
+ # @return [Object] Returns the model itself
126
+ def self.build_from_hash(attributes)
127
+ new.build_from_hash(attributes)
128
+ end
129
+
130
+ # Builds the object from hash
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ # @return [Object] Returns the model itself
133
+ def build_from_hash(attributes)
134
+ return nil unless attributes.is_a?(Hash)
135
+ self.class.openapi_types.each_pair do |key, type|
136
+ if type =~ /\AArray<(.*)>/i
137
+ # check to ensure the input is an array given that the attribute
138
+ # is documented as an array but the input is not
139
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
140
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
141
+ end
142
+ elsif !attributes[self.class.attribute_map[key]].nil?
143
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
144
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
145
+ end
146
+
147
+ self
148
+ end
149
+
150
+ # Deserializes the data based on type
151
+ # @param string type Data type
152
+ # @param string value Value to be deserialized
153
+ # @return [Object] Deserialized data
154
+ def _deserialize(type, value)
155
+ case type.to_sym
156
+ when :DateTime
157
+ DateTime.parse(value)
158
+ when :Date
159
+ Date.parse(value)
160
+ when :String
161
+ value.to_s
162
+ when :Integer
163
+ value.to_i
164
+ when :Float
165
+ value.to_f
166
+ when :Boolean
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ TalonOne.const_get(type).build_from_hash(value)
188
+ end
189
+ end
190
+
191
+ # Returns the string representation of the object
192
+ # @return [String] String presentation of the object
193
+ def to_s
194
+ to_hash.to_s
195
+ end
196
+
197
+ # to_body is an alias to to_hash (backward compatibility)
198
+ # @return [Hash] Returns the object in the form of hash
199
+ def to_body
200
+ to_hash
201
+ end
202
+
203
+ # Returns the object in the form of hash
204
+ # @return [Hash] Returns the object in the form of hash
205
+ def to_hash
206
+ hash = {}
207
+ self.class.attribute_map.each_pair do |attr, param|
208
+ value = self.send(attr)
209
+ if value.nil?
210
+ is_nullable = self.class.openapi_nullable.include?(attr)
211
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
212
+ end
213
+
214
+ hash[param] = _to_hash(value)
215
+ end
216
+ hash
217
+ end
218
+
219
+ # Outputs non-array value in the form of hash
220
+ # For object, use to_hash. Otherwise, just return the value
221
+ # @param [Object] value Any valid value
222
+ # @return [Hash] Returns the value in the form of hash
223
+ def _to_hash(value)
224
+ if value.is_a?(Array)
225
+ value.compact.map { |v| _to_hash(v) }
226
+ elsif value.is_a?(Hash)
227
+ {}.tap do |hash|
228
+ value.each { |k, v| hash[k] = _to_hash(v) }
229
+ end
230
+ elsif value.respond_to? :to_hash
231
+ value.to_hash
232
+ else
233
+ value
234
+ end
235
+ end
236
+ end
237
+ end
@@ -57,7 +57,7 @@ module TalonOne
57
57
  # The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.
58
58
  attr_accessor :type
59
59
 
60
- # A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.
60
+ # A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file.
61
61
  attr_accessor :linked_store_ids
62
62
 
63
63
  class EnumAttributeValidator
@@ -27,7 +27,7 @@ module TalonOne
27
27
  # Timestamp at which point the coupon becomes valid.
28
28
  attr_accessor :start_date
29
29
 
30
- # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
30
+ # Expiration date of the coupon. Coupon never expires if this is omitted.
31
31
  attr_accessor :expiry_date
32
32
 
33
33
  # Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.
@@ -39,7 +39,7 @@ module TalonOne
39
39
  # Arbitrary properties associated with this item.
40
40
  attr_accessor :attributes
41
41
 
42
- # Whether the reservation effect actually created a new reservation.
42
+ # An indication of whether the code can be redeemed only if it has been reserved first.
43
43
  attr_accessor :is_reservation_mandatory
44
44
 
45
45
  # An indication of whether the coupon is implicitly reserved for all customers.
@@ -27,7 +27,7 @@ module TalonOne
27
27
  # Timestamp at which point the coupon becomes valid.
28
28
  attr_accessor :start_date
29
29
 
30
- # Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative.
30
+ # Expiration date of the coupon. Coupon never expires if this is omitted.
31
31
  attr_accessor :expiry_date
32
32
 
33
33
  # Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value.
@@ -14,20 +14,25 @@ require 'date'
14
14
 
15
15
  module TalonOne
16
16
  class UpdateLoyaltyCard
17
- # Status of the loyalty card. Can be one of: ['active', 'inactive']
17
+ # Status of the loyalty card. Can be `active` or `inactive`.
18
18
  attr_accessor :status
19
19
 
20
+ # Reason for transferring and blocking the loyalty card.
21
+ attr_accessor :block_reason
22
+
20
23
  # Attribute mapping from ruby-style variable name to JSON key.
21
24
  def self.attribute_map
22
25
  {
23
- :'status' => :'status'
26
+ :'status' => :'status',
27
+ :'block_reason' => :'blockReason'
24
28
  }
25
29
  end
26
30
 
27
31
  # Attribute type mapping.
28
32
  def self.openapi_types
29
33
  {
30
- :'status' => :'String'
34
+ :'status' => :'String',
35
+ :'block_reason' => :'String'
31
36
  }
32
37
  end
33
38
 
@@ -55,6 +60,10 @@ module TalonOne
55
60
  if attributes.key?(:'status')
56
61
  self.status = attributes[:'status']
57
62
  end
63
+
64
+ if attributes.key?(:'block_reason')
65
+ self.block_reason = attributes[:'block_reason']
66
+ end
58
67
  end
59
68
 
60
69
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -80,7 +89,8 @@ module TalonOne
80
89
  def ==(o)
81
90
  return true if self.equal?(o)
82
91
  self.class == o.class &&
83
- status == o.status
92
+ status == o.status &&
93
+ block_reason == o.block_reason
84
94
  end
85
95
 
86
96
  # @see the `==` method
@@ -92,7 +102,7 @@ module TalonOne
92
102
  # Calculates hash code according to all attributes.
93
103
  # @return [Integer] Hash code
94
104
  def hash
95
- [status].hash
105
+ [status, block_reason].hash
96
106
  end
97
107
 
98
108
  # Builds the object from hash
@@ -39,17 +39,22 @@ module TalonOne
39
39
  # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
40
40
  attr_accessor :sandbox
41
41
 
42
- # The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.
42
+ # The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
43
+ attr_accessor :program_join_policy
44
+
45
+ # The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.
43
46
  attr_accessor :tiers_expiration_policy
44
47
 
45
- # The amount of time after which the tier expires. The time format is an **integer** 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.
48
+ # Timestamp at which the tier cycle starts for all customers in the loyalty program. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.
49
+ attr_accessor :tier_cycle_start_date
50
+
51
+ # The amount of time after which the tier expires and is reevaluated. The time format is an **integer** 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.
46
52
  attr_accessor :tiers_expire_in
47
53
 
48
- # Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.
54
+ # The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.
49
55
  attr_accessor :tiers_downgrade_policy
50
56
 
51
- # The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.
52
- attr_accessor :program_join_policy
57
+ attr_accessor :card_code_settings
53
58
 
54
59
  # The tiers in this loyalty program.
55
60
  attr_accessor :tiers
@@ -87,10 +92,12 @@ module TalonOne
87
92
  :'allow_subledger' => :'allowSubledger',
88
93
  :'users_per_card_limit' => :'usersPerCardLimit',
89
94
  :'sandbox' => :'sandbox',
95
+ :'program_join_policy' => :'programJoinPolicy',
90
96
  :'tiers_expiration_policy' => :'tiersExpirationPolicy',
97
+ :'tier_cycle_start_date' => :'tierCycleStartDate',
91
98
  :'tiers_expire_in' => :'tiersExpireIn',
92
99
  :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
93
- :'program_join_policy' => :'programJoinPolicy',
100
+ :'card_code_settings' => :'cardCodeSettings',
94
101
  :'tiers' => :'tiers'
95
102
  }
96
103
  end
@@ -106,10 +113,12 @@ module TalonOne
106
113
  :'allow_subledger' => :'Boolean',
107
114
  :'users_per_card_limit' => :'Integer',
108
115
  :'sandbox' => :'Boolean',
116
+ :'program_join_policy' => :'String',
109
117
  :'tiers_expiration_policy' => :'String',
118
+ :'tier_cycle_start_date' => :'DateTime',
110
119
  :'tiers_expire_in' => :'String',
111
120
  :'tiers_downgrade_policy' => :'String',
112
- :'program_join_policy' => :'String',
121
+ :'card_code_settings' => :'CodeGeneratorSettings',
113
122
  :'tiers' => :'Array<NewLoyaltyTier>'
114
123
  }
115
124
  end
@@ -169,10 +178,18 @@ module TalonOne
169
178
  self.sandbox = attributes[:'sandbox']
170
179
  end
171
180
 
181
+ if attributes.key?(:'program_join_policy')
182
+ self.program_join_policy = attributes[:'program_join_policy']
183
+ end
184
+
172
185
  if attributes.key?(:'tiers_expiration_policy')
173
186
  self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
174
187
  end
175
188
 
189
+ if attributes.key?(:'tier_cycle_start_date')
190
+ self.tier_cycle_start_date = attributes[:'tier_cycle_start_date']
191
+ end
192
+
176
193
  if attributes.key?(:'tiers_expire_in')
177
194
  self.tiers_expire_in = attributes[:'tiers_expire_in']
178
195
  end
@@ -181,8 +198,8 @@ module TalonOne
181
198
  self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
182
199
  end
183
200
 
184
- if attributes.key?(:'program_join_policy')
185
- self.program_join_policy = attributes[:'program_join_policy']
201
+ if attributes.key?(:'card_code_settings')
202
+ self.card_code_settings = attributes[:'card_code_settings']
186
203
  end
187
204
 
188
205
  if attributes.key?(:'tiers')
@@ -207,12 +224,12 @@ module TalonOne
207
224
  # @return true if the model is valid
208
225
  def valid?
209
226
  return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
210
- tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
227
+ program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
228
+ return false unless program_join_policy_validator.valid?(@program_join_policy)
229
+ tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
211
230
  return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
212
231
  tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
213
232
  return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
214
- program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
215
- return false unless program_join_policy_validator.valid?(@program_join_policy)
216
233
  true
217
234
  end
218
235
 
@@ -226,10 +243,20 @@ module TalonOne
226
243
  @users_per_card_limit = users_per_card_limit
227
244
  end
228
245
 
246
+ # Custom attribute writer method checking allowed values (enum).
247
+ # @param [Object] program_join_policy Object to be assigned
248
+ def program_join_policy=(program_join_policy)
249
+ validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
250
+ unless validator.valid?(program_join_policy)
251
+ fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
252
+ end
253
+ @program_join_policy = program_join_policy
254
+ end
255
+
229
256
  # Custom attribute writer method checking allowed values (enum).
230
257
  # @param [Object] tiers_expiration_policy Object to be assigned
231
258
  def tiers_expiration_policy=(tiers_expiration_policy)
232
- validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
259
+ validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
233
260
  unless validator.valid?(tiers_expiration_policy)
234
261
  fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
235
262
  end
@@ -246,16 +273,6 @@ module TalonOne
246
273
  @tiers_downgrade_policy = tiers_downgrade_policy
247
274
  end
248
275
 
249
- # Custom attribute writer method checking allowed values (enum).
250
- # @param [Object] program_join_policy Object to be assigned
251
- def program_join_policy=(program_join_policy)
252
- validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
253
- unless validator.valid?(program_join_policy)
254
- fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
255
- end
256
- @program_join_policy = program_join_policy
257
- end
258
-
259
276
  # Checks equality by comparing each attribute.
260
277
  # @param [Object] Object to be compared
261
278
  def ==(o)
@@ -269,10 +286,12 @@ module TalonOne
269
286
  allow_subledger == o.allow_subledger &&
270
287
  users_per_card_limit == o.users_per_card_limit &&
271
288
  sandbox == o.sandbox &&
289
+ program_join_policy == o.program_join_policy &&
272
290
  tiers_expiration_policy == o.tiers_expiration_policy &&
291
+ tier_cycle_start_date == o.tier_cycle_start_date &&
273
292
  tiers_expire_in == o.tiers_expire_in &&
274
293
  tiers_downgrade_policy == o.tiers_downgrade_policy &&
275
- program_join_policy == o.program_join_policy &&
294
+ card_code_settings == o.card_code_settings &&
276
295
  tiers == o.tiers
277
296
  end
278
297
 
@@ -285,7 +304,7 @@ module TalonOne
285
304
  # Calculates hash code according to all attributes.
286
305
  # @return [Integer] Hash code
287
306
  def hash
288
- [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, tiers].hash
307
+ [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, tiers].hash
289
308
  end
290
309
 
291
310
  # Builds the object from hash
@@ -20,7 +20,7 @@ module TalonOne
20
20
  # Timestamp at which point the referral code becomes valid.
21
21
  attr_accessor :start_date
22
22
 
23
- # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
23
+ # Expiration date of the referral code. Referral never expires if this is omitted.
24
24
  attr_accessor :expiry_date
25
25
 
26
26
  # The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.
@@ -23,7 +23,7 @@ module TalonOne
23
23
  # Timestamp at which point the referral code becomes valid.
24
24
  attr_accessor :start_date
25
25
 
26
- # Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative.
26
+ # Expiration date of the referral code. Referral never expires if this is omitted.
27
27
  attr_accessor :expiry_date
28
28
 
29
29
  # The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.
@@ -26,7 +26,7 @@ module TalonOne
26
26
  # Indicates the access level of the user.
27
27
  attr_accessor :policy
28
28
 
29
- # A list of the IDs of the roles assigned to the user. **Note**: Use the [List roles](https://docs.talon.one/management-api#tag/Roles/operation/getAllRoles) endpoint to find the ID of a role.
29
+ # A list of the IDs of the roles assigned to the user. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
30
30
  attr_accessor :roles
31
31
 
32
32
  # Application notifications that the user is subscribed to.
@@ -63,6 +63,9 @@ module TalonOne
63
63
  # Timestamp when the user was notified for feed.
64
64
  attr_accessor :latest_feed_timestamp
65
65
 
66
+ # Additional user attributes, created and used by external identity providers.
67
+ attr_accessor :additional_attributes
68
+
66
69
  class EnumAttributeValidator
67
70
  attr_reader :datatype
68
71
  attr_reader :allowable_values
@@ -103,7 +106,8 @@ module TalonOne
103
106
  :'application_notification_subscriptions' => :'applicationNotificationSubscriptions',
104
107
  :'last_signed_in' => :'lastSignedIn',
105
108
  :'last_accessed' => :'lastAccessed',
106
- :'latest_feed_timestamp' => :'latestFeedTimestamp'
109
+ :'latest_feed_timestamp' => :'latestFeedTimestamp',
110
+ :'additional_attributes' => :'additionalAttributes'
107
111
  }
108
112
  end
109
113
 
@@ -125,7 +129,8 @@ module TalonOne
125
129
  :'application_notification_subscriptions' => :'Object',
126
130
  :'last_signed_in' => :'DateTime',
127
131
  :'last_accessed' => :'DateTime',
128
- :'latest_feed_timestamp' => :'DateTime'
132
+ :'latest_feed_timestamp' => :'DateTime',
133
+ :'additional_attributes' => :'Object'
129
134
  }
130
135
  end
131
136
 
@@ -215,6 +220,10 @@ module TalonOne
215
220
  if attributes.key?(:'latest_feed_timestamp')
216
221
  self.latest_feed_timestamp = attributes[:'latest_feed_timestamp']
217
222
  end
223
+
224
+ if attributes.key?(:'additional_attributes')
225
+ self.additional_attributes = attributes[:'additional_attributes']
226
+ end
218
227
  end
219
228
 
220
229
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -307,7 +316,8 @@ module TalonOne
307
316
  application_notification_subscriptions == o.application_notification_subscriptions &&
308
317
  last_signed_in == o.last_signed_in &&
309
318
  last_accessed == o.last_accessed &&
310
- latest_feed_timestamp == o.latest_feed_timestamp
319
+ latest_feed_timestamp == o.latest_feed_timestamp &&
320
+ additional_attributes == o.additional_attributes
311
321
  end
312
322
 
313
323
  # @see the `==` method
@@ -319,7 +329,7 @@ module TalonOne
319
329
  # Calculates hash code according to all attributes.
320
330
  # @return [Integer] Hash code
321
331
  def hash
322
- [id, created, modified, email, account_id, name, state, invite_token, is_admin, policy, roles, auth_method, application_notification_subscriptions, last_signed_in, last_accessed, latest_feed_timestamp].hash
332
+ [id, created, modified, email, account_id, name, state, invite_token, is_admin, policy, roles, auth_method, application_notification_subscriptions, last_signed_in, last_accessed, latest_feed_timestamp, additional_attributes].hash
323
333
  end
324
334
 
325
335
  # Builds the object from hash
@@ -30,6 +30,9 @@ module TalonOne
30
30
  # Name or title for this webhook.
31
31
  attr_accessor :title
32
32
 
33
+ # A description of the webhook.
34
+ attr_accessor :description
35
+
33
36
  # API method for this webhook.
34
37
  attr_accessor :verb
35
38
 
@@ -78,6 +81,7 @@ module TalonOne
78
81
  :'modified' => :'modified',
79
82
  :'application_ids' => :'applicationIds',
80
83
  :'title' => :'title',
84
+ :'description' => :'description',
81
85
  :'verb' => :'verb',
82
86
  :'url' => :'url',
83
87
  :'headers' => :'headers',
@@ -95,6 +99,7 @@ module TalonOne
95
99
  :'modified' => :'DateTime',
96
100
  :'application_ids' => :'Array<Integer>',
97
101
  :'title' => :'String',
102
+ :'description' => :'String',
98
103
  :'verb' => :'String',
99
104
  :'url' => :'String',
100
105
  :'headers' => :'Array<String>',
@@ -147,6 +152,10 @@ module TalonOne
147
152
  self.title = attributes[:'title']
148
153
  end
149
154
 
155
+ if attributes.key?(:'description')
156
+ self.description = attributes[:'description']
157
+ end
158
+
150
159
  if attributes.key?(:'verb')
151
160
  self.verb = attributes[:'verb']
152
161
  end
@@ -282,6 +291,7 @@ module TalonOne
282
291
  modified == o.modified &&
283
292
  application_ids == o.application_ids &&
284
293
  title == o.title &&
294
+ description == o.description &&
285
295
  verb == o.verb &&
286
296
  url == o.url &&
287
297
  headers == o.headers &&
@@ -299,7 +309,7 @@ module TalonOne
299
309
  # Calculates hash code according to all attributes.
300
310
  # @return [Integer] Hash code
301
311
  def hash
302
- [id, created, modified, application_ids, title, verb, url, headers, payload, params, enabled].hash
312
+ [id, created, modified, application_ids, title, description, verb, url, headers, payload, params, enabled].hash
303
313
  end
304
314
 
305
315
  # Builds the object from hash