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,206 @@
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 RevisionActivation
17
+ attr_accessor :activate_at
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'activate_at' => :'activateAt'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.openapi_types
28
+ {
29
+ :'activate_at' => :'DateTime'
30
+ }
31
+ end
32
+
33
+ # List of attributes with nullable: true
34
+ def self.openapi_nullable
35
+ Set.new([
36
+ ])
37
+ end
38
+
39
+ # Initializes the object
40
+ # @param [Hash] attributes Model attributes in the form of hash
41
+ def initialize(attributes = {})
42
+ if (!attributes.is_a?(Hash))
43
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::RevisionActivation` initialize method"
44
+ end
45
+
46
+ # check to see if the attribute exists and convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}) { |(k, v), h|
48
+ if (!self.class.attribute_map.key?(k.to_sym))
49
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::RevisionActivation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
50
+ end
51
+ h[k.to_sym] = v
52
+ }
53
+
54
+ if attributes.key?(:'activate_at')
55
+ self.activate_at = attributes[:'activate_at']
56
+ end
57
+ end
58
+
59
+ # Show invalid properties with the reasons. Usually used together with valid?
60
+ # @return Array for valid properties with the reasons
61
+ def list_invalid_properties
62
+ invalid_properties = Array.new
63
+ invalid_properties
64
+ end
65
+
66
+ # Check to see if the all the properties in the model are valid
67
+ # @return true if the model is valid
68
+ def valid?
69
+ true
70
+ end
71
+
72
+ # Checks equality by comparing each attribute.
73
+ # @param [Object] Object to be compared
74
+ def ==(o)
75
+ return true if self.equal?(o)
76
+ self.class == o.class &&
77
+ activate_at == o.activate_at
78
+ end
79
+
80
+ # @see the `==` method
81
+ # @param [Object] Object to be compared
82
+ def eql?(o)
83
+ self == o
84
+ end
85
+
86
+ # Calculates hash code according to all attributes.
87
+ # @return [Integer] Hash code
88
+ def hash
89
+ [activate_at].hash
90
+ end
91
+
92
+ # Builds the object from hash
93
+ # @param [Hash] attributes Model attributes in the form of hash
94
+ # @return [Object] Returns the model itself
95
+ def self.build_from_hash(attributes)
96
+ new.build_from_hash(attributes)
97
+ end
98
+
99
+ # Builds the object from hash
100
+ # @param [Hash] attributes Model attributes in the form of hash
101
+ # @return [Object] Returns the model itself
102
+ def build_from_hash(attributes)
103
+ return nil unless attributes.is_a?(Hash)
104
+ self.class.openapi_types.each_pair do |key, type|
105
+ if type =~ /\AArray<(.*)>/i
106
+ # check to ensure the input is an array given that the attribute
107
+ # is documented as an array but the input is not
108
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
109
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
110
+ end
111
+ elsif !attributes[self.class.attribute_map[key]].nil?
112
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
113
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
114
+ end
115
+
116
+ self
117
+ end
118
+
119
+ # Deserializes the data based on type
120
+ # @param string type Data type
121
+ # @param string value Value to be deserialized
122
+ # @return [Object] Deserialized data
123
+ def _deserialize(type, value)
124
+ case type.to_sym
125
+ when :DateTime
126
+ DateTime.parse(value)
127
+ when :Date
128
+ Date.parse(value)
129
+ when :String
130
+ value.to_s
131
+ when :Integer
132
+ value.to_i
133
+ when :Float
134
+ value.to_f
135
+ when :Boolean
136
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
137
+ true
138
+ else
139
+ false
140
+ end
141
+ when :Object
142
+ # generic object (usually a Hash), return directly
143
+ value
144
+ when /\AArray<(?<inner_type>.+)>\z/
145
+ inner_type = Regexp.last_match[:inner_type]
146
+ value.map { |v| _deserialize(inner_type, v) }
147
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
148
+ k_type = Regexp.last_match[:k_type]
149
+ v_type = Regexp.last_match[:v_type]
150
+ {}.tap do |hash|
151
+ value.each do |k, v|
152
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
153
+ end
154
+ end
155
+ else # model
156
+ TalonOne.const_get(type).build_from_hash(value)
157
+ end
158
+ end
159
+
160
+ # Returns the string representation of the object
161
+ # @return [String] String presentation of the object
162
+ def to_s
163
+ to_hash.to_s
164
+ end
165
+
166
+ # to_body is an alias to to_hash (backward compatibility)
167
+ # @return [Hash] Returns the object in the form of hash
168
+ def to_body
169
+ to_hash
170
+ end
171
+
172
+ # Returns the object in the form of hash
173
+ # @return [Hash] Returns the object in the form of hash
174
+ def to_hash
175
+ hash = {}
176
+ self.class.attribute_map.each_pair do |attr, param|
177
+ value = self.send(attr)
178
+ if value.nil?
179
+ is_nullable = self.class.openapi_nullable.include?(attr)
180
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
181
+ end
182
+
183
+ hash[param] = _to_hash(value)
184
+ end
185
+ hash
186
+ end
187
+
188
+ # Outputs non-array value in the form of hash
189
+ # For object, use to_hash. Otherwise, just return the value
190
+ # @param [Object] value Any valid value
191
+ # @return [Hash] Returns the value in the form of hash
192
+ def _to_hash(value)
193
+ if value.is_a?(Array)
194
+ value.compact.map { |v| _to_hash(v) }
195
+ elsif value.is_a?(Hash)
196
+ {}.tap do |hash|
197
+ value.each { |k, v| hash[k] = _to_hash(v) }
198
+ end
199
+ elsif value.respond_to? :to_hash
200
+ value.to_hash
201
+ else
202
+ value
203
+ end
204
+ end
205
+ end
206
+ end
@@ -0,0 +1,466 @@
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
+ #
17
+ class RevisionVersion
18
+ # Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints.
19
+ attr_accessor :id
20
+
21
+ attr_accessor :account_id
22
+
23
+ attr_accessor :application_id
24
+
25
+ attr_accessor :campaign_id
26
+
27
+ attr_accessor :created
28
+
29
+ attr_accessor :created_by
30
+
31
+ attr_accessor :revision_id
32
+
33
+ attr_accessor :version
34
+
35
+ # A user-facing name for this campaign.
36
+ attr_accessor :name
37
+
38
+ # Timestamp when the campaign will become active.
39
+ attr_accessor :start_time
40
+
41
+ # Timestamp when the campaign will become inactive.
42
+ attr_accessor :end_time
43
+
44
+ # Arbitrary properties associated with this campaign.
45
+ attr_accessor :attributes
46
+
47
+ # A detailed description of the campaign.
48
+ attr_accessor :description
49
+
50
+ # The ID of the ruleset this campaign template will use.
51
+ attr_accessor :active_ruleset_id
52
+
53
+ # A list of tags for the campaign template.
54
+ attr_accessor :tags
55
+
56
+ attr_accessor :coupon_settings
57
+
58
+ attr_accessor :referral_settings
59
+
60
+ # The set of limits that will operate for this campaign version.
61
+ attr_accessor :limits
62
+
63
+ # A list of features for the campaign template.
64
+ attr_accessor :features
65
+
66
+ class EnumAttributeValidator
67
+ attr_reader :datatype
68
+ attr_reader :allowable_values
69
+
70
+ def initialize(datatype, allowable_values)
71
+ @allowable_values = allowable_values.map do |value|
72
+ case datatype.to_s
73
+ when /Integer/i
74
+ value.to_i
75
+ when /Float/i
76
+ value.to_f
77
+ else
78
+ value
79
+ end
80
+ end
81
+ end
82
+
83
+ def valid?(value)
84
+ !value || allowable_values.include?(value)
85
+ end
86
+ end
87
+
88
+ # Attribute mapping from ruby-style variable name to JSON key.
89
+ def self.attribute_map
90
+ {
91
+ :'id' => :'id',
92
+ :'account_id' => :'accountId',
93
+ :'application_id' => :'applicationId',
94
+ :'campaign_id' => :'campaignId',
95
+ :'created' => :'created',
96
+ :'created_by' => :'createdBy',
97
+ :'revision_id' => :'revisionId',
98
+ :'version' => :'version',
99
+ :'name' => :'name',
100
+ :'start_time' => :'startTime',
101
+ :'end_time' => :'endTime',
102
+ :'attributes' => :'attributes',
103
+ :'description' => :'description',
104
+ :'active_ruleset_id' => :'activeRulesetId',
105
+ :'tags' => :'tags',
106
+ :'coupon_settings' => :'couponSettings',
107
+ :'referral_settings' => :'referralSettings',
108
+ :'limits' => :'limits',
109
+ :'features' => :'features'
110
+ }
111
+ end
112
+
113
+ # Attribute type mapping.
114
+ def self.openapi_types
115
+ {
116
+ :'id' => :'Integer',
117
+ :'account_id' => :'Integer',
118
+ :'application_id' => :'Integer',
119
+ :'campaign_id' => :'Integer',
120
+ :'created' => :'DateTime',
121
+ :'created_by' => :'Integer',
122
+ :'revision_id' => :'Integer',
123
+ :'version' => :'Integer',
124
+ :'name' => :'String',
125
+ :'start_time' => :'DateTime',
126
+ :'end_time' => :'DateTime',
127
+ :'attributes' => :'Object',
128
+ :'description' => :'String',
129
+ :'active_ruleset_id' => :'Integer',
130
+ :'tags' => :'Array<String>',
131
+ :'coupon_settings' => :'CodeGeneratorSettings',
132
+ :'referral_settings' => :'CodeGeneratorSettings',
133
+ :'limits' => :'Array<LimitConfig>',
134
+ :'features' => :'Array<String>'
135
+ }
136
+ end
137
+
138
+ # List of attributes with nullable: true
139
+ def self.openapi_nullable
140
+ Set.new([
141
+ :'start_time',
142
+ :'end_time',
143
+ :'description',
144
+ :'active_ruleset_id',
145
+ ])
146
+ end
147
+
148
+ # Initializes the object
149
+ # @param [Hash] attributes Model attributes in the form of hash
150
+ def initialize(attributes = {})
151
+ if (!attributes.is_a?(Hash))
152
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::RevisionVersion` initialize method"
153
+ end
154
+
155
+ # check to see if the attribute exists and convert string to symbol for hash key
156
+ attributes = attributes.each_with_object({}) { |(k, v), h|
157
+ if (!self.class.attribute_map.key?(k.to_sym))
158
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::RevisionVersion`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
159
+ end
160
+ h[k.to_sym] = v
161
+ }
162
+
163
+ if attributes.key?(:'id')
164
+ self.id = attributes[:'id']
165
+ end
166
+
167
+ if attributes.key?(:'account_id')
168
+ self.account_id = attributes[:'account_id']
169
+ end
170
+
171
+ if attributes.key?(:'application_id')
172
+ self.application_id = attributes[:'application_id']
173
+ end
174
+
175
+ if attributes.key?(:'campaign_id')
176
+ self.campaign_id = attributes[:'campaign_id']
177
+ end
178
+
179
+ if attributes.key?(:'created')
180
+ self.created = attributes[:'created']
181
+ end
182
+
183
+ if attributes.key?(:'created_by')
184
+ self.created_by = attributes[:'created_by']
185
+ end
186
+
187
+ if attributes.key?(:'revision_id')
188
+ self.revision_id = attributes[:'revision_id']
189
+ end
190
+
191
+ if attributes.key?(:'version')
192
+ self.version = attributes[:'version']
193
+ end
194
+
195
+ if attributes.key?(:'name')
196
+ self.name = attributes[:'name']
197
+ end
198
+
199
+ if attributes.key?(:'start_time')
200
+ self.start_time = attributes[:'start_time']
201
+ end
202
+
203
+ if attributes.key?(:'end_time')
204
+ self.end_time = attributes[:'end_time']
205
+ end
206
+
207
+ if attributes.key?(:'attributes')
208
+ self.attributes = attributes[:'attributes']
209
+ end
210
+
211
+ if attributes.key?(:'description')
212
+ self.description = attributes[:'description']
213
+ end
214
+
215
+ if attributes.key?(:'active_ruleset_id')
216
+ self.active_ruleset_id = attributes[:'active_ruleset_id']
217
+ end
218
+
219
+ if attributes.key?(:'tags')
220
+ if (value = attributes[:'tags']).is_a?(Array)
221
+ self.tags = value
222
+ end
223
+ end
224
+
225
+ if attributes.key?(:'coupon_settings')
226
+ self.coupon_settings = attributes[:'coupon_settings']
227
+ end
228
+
229
+ if attributes.key?(:'referral_settings')
230
+ self.referral_settings = attributes[:'referral_settings']
231
+ end
232
+
233
+ if attributes.key?(:'limits')
234
+ if (value = attributes[:'limits']).is_a?(Array)
235
+ self.limits = value
236
+ end
237
+ end
238
+
239
+ if attributes.key?(:'features')
240
+ if (value = attributes[:'features']).is_a?(Array)
241
+ self.features = value
242
+ end
243
+ end
244
+ end
245
+
246
+ # Show invalid properties with the reasons. Usually used together with valid?
247
+ # @return Array for valid properties with the reasons
248
+ def list_invalid_properties
249
+ invalid_properties = Array.new
250
+ if @id.nil?
251
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
252
+ end
253
+
254
+ if @account_id.nil?
255
+ invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
256
+ end
257
+
258
+ if @application_id.nil?
259
+ invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
260
+ end
261
+
262
+ if @campaign_id.nil?
263
+ invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
264
+ end
265
+
266
+ if @created.nil?
267
+ invalid_properties.push('invalid value for "created", created cannot be nil.')
268
+ end
269
+
270
+ if @created_by.nil?
271
+ invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
272
+ end
273
+
274
+ if @revision_id.nil?
275
+ invalid_properties.push('invalid value for "revision_id", revision_id cannot be nil.')
276
+ end
277
+
278
+ if @version.nil?
279
+ invalid_properties.push('invalid value for "version", version cannot be nil.')
280
+ end
281
+
282
+ if !@name.nil? && @name.to_s.length < 1
283
+ invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
284
+ end
285
+
286
+ invalid_properties
287
+ end
288
+
289
+ # Check to see if the all the properties in the model are valid
290
+ # @return true if the model is valid
291
+ def valid?
292
+ return false if @id.nil?
293
+ return false if @account_id.nil?
294
+ return false if @application_id.nil?
295
+ return false if @campaign_id.nil?
296
+ return false if @created.nil?
297
+ return false if @created_by.nil?
298
+ return false if @revision_id.nil?
299
+ return false if @version.nil?
300
+ return false if !@name.nil? && @name.to_s.length < 1
301
+ true
302
+ end
303
+
304
+ # Custom attribute writer method with validation
305
+ # @param [Object] name Value to be assigned
306
+ def name=(name)
307
+ if !name.nil? && name.to_s.length < 1
308
+ fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
309
+ end
310
+
311
+ @name = name
312
+ end
313
+
314
+ # Checks equality by comparing each attribute.
315
+ # @param [Object] Object to be compared
316
+ def ==(o)
317
+ return true if self.equal?(o)
318
+ self.class == o.class &&
319
+ id == o.id &&
320
+ account_id == o.account_id &&
321
+ application_id == o.application_id &&
322
+ campaign_id == o.campaign_id &&
323
+ created == o.created &&
324
+ created_by == o.created_by &&
325
+ revision_id == o.revision_id &&
326
+ version == o.version &&
327
+ name == o.name &&
328
+ start_time == o.start_time &&
329
+ end_time == o.end_time &&
330
+ attributes == o.attributes &&
331
+ description == o.description &&
332
+ active_ruleset_id == o.active_ruleset_id &&
333
+ tags == o.tags &&
334
+ coupon_settings == o.coupon_settings &&
335
+ referral_settings == o.referral_settings &&
336
+ limits == o.limits &&
337
+ features == o.features
338
+ end
339
+
340
+ # @see the `==` method
341
+ # @param [Object] Object to be compared
342
+ def eql?(o)
343
+ self == o
344
+ end
345
+
346
+ # Calculates hash code according to all attributes.
347
+ # @return [Integer] Hash code
348
+ def hash
349
+ [id, account_id, application_id, campaign_id, created, created_by, revision_id, version, name, start_time, end_time, attributes, description, active_ruleset_id, tags, coupon_settings, referral_settings, limits, features].hash
350
+ end
351
+
352
+ # Builds the object from hash
353
+ # @param [Hash] attributes Model attributes in the form of hash
354
+ # @return [Object] Returns the model itself
355
+ def self.build_from_hash(attributes)
356
+ new.build_from_hash(attributes)
357
+ end
358
+
359
+ # Builds the object from hash
360
+ # @param [Hash] attributes Model attributes in the form of hash
361
+ # @return [Object] Returns the model itself
362
+ def build_from_hash(attributes)
363
+ return nil unless attributes.is_a?(Hash)
364
+ self.class.openapi_types.each_pair do |key, type|
365
+ if type =~ /\AArray<(.*)>/i
366
+ # check to ensure the input is an array given that the attribute
367
+ # is documented as an array but the input is not
368
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
369
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
370
+ end
371
+ elsif !attributes[self.class.attribute_map[key]].nil?
372
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
373
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
374
+ end
375
+
376
+ self
377
+ end
378
+
379
+ # Deserializes the data based on type
380
+ # @param string type Data type
381
+ # @param string value Value to be deserialized
382
+ # @return [Object] Deserialized data
383
+ def _deserialize(type, value)
384
+ case type.to_sym
385
+ when :DateTime
386
+ DateTime.parse(value)
387
+ when :Date
388
+ Date.parse(value)
389
+ when :String
390
+ value.to_s
391
+ when :Integer
392
+ value.to_i
393
+ when :Float
394
+ value.to_f
395
+ when :Boolean
396
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
397
+ true
398
+ else
399
+ false
400
+ end
401
+ when :Object
402
+ # generic object (usually a Hash), return directly
403
+ value
404
+ when /\AArray<(?<inner_type>.+)>\z/
405
+ inner_type = Regexp.last_match[:inner_type]
406
+ value.map { |v| _deserialize(inner_type, v) }
407
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
408
+ k_type = Regexp.last_match[:k_type]
409
+ v_type = Regexp.last_match[:v_type]
410
+ {}.tap do |hash|
411
+ value.each do |k, v|
412
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
413
+ end
414
+ end
415
+ else # model
416
+ TalonOne.const_get(type).build_from_hash(value)
417
+ end
418
+ end
419
+
420
+ # Returns the string representation of the object
421
+ # @return [String] String presentation of the object
422
+ def to_s
423
+ to_hash.to_s
424
+ end
425
+
426
+ # to_body is an alias to to_hash (backward compatibility)
427
+ # @return [Hash] Returns the object in the form of hash
428
+ def to_body
429
+ to_hash
430
+ end
431
+
432
+ # Returns the object in the form of hash
433
+ # @return [Hash] Returns the object in the form of hash
434
+ def to_hash
435
+ hash = {}
436
+ self.class.attribute_map.each_pair do |attr, param|
437
+ value = self.send(attr)
438
+ if value.nil?
439
+ is_nullable = self.class.openapi_nullable.include?(attr)
440
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
441
+ end
442
+
443
+ hash[param] = _to_hash(value)
444
+ end
445
+ hash
446
+ end
447
+
448
+ # Outputs non-array value in the form of hash
449
+ # For object, use to_hash. Otherwise, just return the value
450
+ # @param [Object] value Any valid value
451
+ # @return [Hash] Returns the value in the form of hash
452
+ def _to_hash(value)
453
+ if value.is_a?(Array)
454
+ value.compact.map { |v| _to_hash(v) }
455
+ elsif value.is_a?(Hash)
456
+ {}.tap do |hash|
457
+ value.each { |k, v| hash[k] = _to_hash(v) }
458
+ end
459
+ elsif value.respond_to? :to_hash
460
+ value.to_hash
461
+ else
462
+ value
463
+ end
464
+ end
465
+ end
466
+ end