talon_one 3.0.0 → 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/docs/AddLoyaltyPoints.md +2 -2
  4. data/docs/CustomEffect.md +1 -1
  5. data/docs/InlineResponse2001.md +1 -1
  6. data/docs/InlineResponse20010.md +3 -3
  7. data/docs/InlineResponse20011.md +3 -3
  8. data/docs/InlineResponse20012.md +1 -1
  9. data/docs/InlineResponse20013.md +2 -2
  10. data/docs/InlineResponse20014.md +3 -5
  11. data/docs/InlineResponse20015.md +4 -2
  12. data/docs/InlineResponse20016.md +2 -4
  13. data/docs/InlineResponse20017.md +4 -2
  14. data/docs/InlineResponse20018.md +2 -2
  15. data/docs/InlineResponse20019.md +1 -1
  16. data/docs/InlineResponse2002.md +3 -3
  17. data/docs/InlineResponse20020.md +2 -4
  18. data/docs/InlineResponse20021.md +3 -3
  19. data/docs/InlineResponse20022.md +1 -1
  20. data/docs/InlineResponse20023.md +3 -1
  21. data/docs/InlineResponse20024.md +1 -1
  22. data/docs/InlineResponse20025.md +2 -2
  23. data/docs/InlineResponse20026.md +2 -2
  24. data/docs/InlineResponse20027.md +3 -3
  25. data/docs/InlineResponse20028.md +3 -5
  26. data/docs/InlineResponse20029.md +1 -1
  27. data/docs/InlineResponse2003.md +1 -1
  28. data/docs/InlineResponse20030.md +5 -3
  29. data/docs/InlineResponse20031.md +1 -1
  30. data/docs/InlineResponse20032.md +1 -1
  31. data/docs/InlineResponse20033.md +1 -1
  32. data/docs/InlineResponse20034.md +1 -1
  33. data/docs/InlineResponse20035.md +1 -1
  34. data/docs/InlineResponse20036.md +1 -1
  35. data/docs/InlineResponse20037.md +2 -4
  36. data/docs/InlineResponse20038.md +4 -2
  37. data/docs/InlineResponse20039.md +1 -1
  38. data/docs/InlineResponse2004.md +1 -1
  39. data/docs/InlineResponse20040.md +19 -0
  40. data/docs/InlineResponse2005.md +1 -1
  41. data/docs/InlineResponse2006.md +1 -1
  42. data/docs/InlineResponse2007.md +2 -2
  43. data/docs/InlineResponse2008.md +1 -1
  44. data/docs/InlineResponse2009.md +1 -1
  45. data/docs/IntegrationApi.md +26 -26
  46. data/docs/ManagementApi.md +141 -141
  47. data/docs/MultiApplicationEntity.md +1 -1
  48. data/docs/NewCustomEffect.md +1 -1
  49. data/docs/NewOutgoingIntegrationWebhook.md +19 -0
  50. data/docs/NewWebhook.md +3 -3
  51. data/docs/OutgoingIntegrationConfiguration.md +3 -1
  52. data/docs/OutgoingIntegrationWebhookTemplate.md +3 -1
  53. data/docs/ReopenSessionResponse.md +17 -0
  54. data/docs/StrikethroughCustomEffectPerItemProps.md +21 -0
  55. data/docs/UpdateCustomEffect.md +1 -1
  56. data/docs/Webhook.md +3 -3
  57. data/lib/talon_one/api/integration_api.rb +48 -48
  58. data/lib/talon_one/api/management_api.rb +234 -234
  59. data/lib/talon_one/models/add_loyalty_points.rb +2 -2
  60. data/lib/talon_one/models/custom_effect.rb +1 -1
  61. data/lib/talon_one/models/inline_response2001.rb +1 -1
  62. data/lib/talon_one/models/inline_response20010.rb +11 -11
  63. data/lib/talon_one/models/inline_response20011.rb +11 -11
  64. data/lib/talon_one/models/inline_response20012.rb +1 -1
  65. data/lib/talon_one/models/inline_response20013.rb +1 -3
  66. data/lib/talon_one/models/inline_response20014.rb +9 -11
  67. data/lib/talon_one/models/inline_response20015.rb +11 -7
  68. data/lib/talon_one/models/inline_response20016.rb +7 -11
  69. data/lib/talon_one/models/inline_response20017.rb +11 -7
  70. data/lib/talon_one/models/inline_response20018.rb +10 -10
  71. data/lib/talon_one/models/inline_response20019.rb +1 -1
  72. data/lib/talon_one/models/inline_response2002.rb +11 -11
  73. data/lib/talon_one/models/inline_response20020.rb +7 -11
  74. data/lib/talon_one/models/inline_response20021.rb +10 -10
  75. data/lib/talon_one/models/inline_response20022.rb +1 -1
  76. data/lib/talon_one/models/inline_response20023.rb +10 -6
  77. data/lib/talon_one/models/inline_response20024.rb +1 -1
  78. data/lib/talon_one/models/inline_response20025.rb +6 -1
  79. data/lib/talon_one/models/inline_response20026.rb +1 -6
  80. data/lib/talon_one/models/inline_response20027.rb +11 -11
  81. data/lib/talon_one/models/inline_response20028.rb +7 -11
  82. data/lib/talon_one/models/inline_response20029.rb +1 -1
  83. data/lib/talon_one/models/inline_response2003.rb +1 -1
  84. data/lib/talon_one/models/inline_response20030.rb +11 -7
  85. data/lib/talon_one/models/inline_response20031.rb +1 -1
  86. data/lib/talon_one/models/inline_response20032.rb +1 -1
  87. data/lib/talon_one/models/inline_response20033.rb +1 -1
  88. data/lib/talon_one/models/inline_response20034.rb +1 -1
  89. data/lib/talon_one/models/inline_response20035.rb +1 -1
  90. data/lib/talon_one/models/inline_response20036.rb +1 -1
  91. data/lib/talon_one/models/inline_response20037.rb +7 -11
  92. data/lib/talon_one/models/inline_response20038.rb +11 -7
  93. data/lib/talon_one/models/inline_response20039.rb +1 -1
  94. data/lib/talon_one/models/inline_response2004.rb +1 -1
  95. data/lib/talon_one/models/inline_response20040.rb +227 -0
  96. data/lib/talon_one/models/inline_response2005.rb +1 -1
  97. data/lib/talon_one/models/inline_response2006.rb +1 -1
  98. data/lib/talon_one/models/inline_response2007.rb +10 -10
  99. data/lib/talon_one/models/inline_response2008.rb +1 -1
  100. data/lib/talon_one/models/inline_response2009.rb +1 -1
  101. data/lib/talon_one/models/multi_application_entity.rb +1 -1
  102. data/lib/talon_one/models/new_custom_effect.rb +1 -1
  103. data/lib/talon_one/models/new_outgoing_integration_webhook.rb +229 -0
  104. data/lib/talon_one/models/new_webhook.rb +3 -3
  105. data/lib/talon_one/models/outgoing_integration_configuration.rb +16 -1
  106. data/lib/talon_one/models/outgoing_integration_webhook_template.rb +53 -4
  107. data/lib/talon_one/models/reopen_session_response.rb +215 -0
  108. data/lib/talon_one/models/strikethrough_custom_effect_per_item_props.rb +243 -0
  109. data/lib/talon_one/models/update_custom_effect.rb +1 -1
  110. data/lib/talon_one/models/webhook.rb +3 -3
  111. data/lib/talon_one/version.rb +1 -1
  112. data/lib/talon_one.rb +4 -0
  113. data/spec/api/integration_api_spec.rb +9 -9
  114. data/spec/api/management_api_spec.rb +59 -59
  115. data/spec/models/inline_response20010_spec.rb +1 -1
  116. data/spec/models/inline_response20011_spec.rb +1 -1
  117. data/spec/models/inline_response20014_spec.rb +0 -6
  118. data/spec/models/inline_response20015_spec.rb +6 -0
  119. data/spec/models/inline_response20016_spec.rb +0 -6
  120. data/spec/models/inline_response20017_spec.rb +6 -0
  121. data/spec/models/inline_response20018_spec.rb +1 -1
  122. data/spec/models/inline_response20020_spec.rb +0 -6
  123. data/spec/models/inline_response20021_spec.rb +2 -2
  124. data/spec/models/inline_response20023_spec.rb +6 -0
  125. data/spec/models/inline_response20027_spec.rb +1 -1
  126. data/spec/models/inline_response20028_spec.rb +0 -6
  127. data/spec/models/inline_response2002_spec.rb +1 -1
  128. data/spec/models/inline_response20030_spec.rb +6 -0
  129. data/spec/models/inline_response20037_spec.rb +0 -6
  130. data/spec/models/inline_response20038_spec.rb +6 -0
  131. data/spec/models/inline_response20040_spec.rb +47 -0
  132. data/spec/models/inline_response2007_spec.rb +1 -1
  133. data/spec/models/new_outgoing_integration_webhook_spec.rb +47 -0
  134. data/spec/models/outgoing_integration_configuration_spec.rb +6 -0
  135. data/spec/models/outgoing_integration_webhook_template_spec.rb +10 -0
  136. data/spec/models/reopen_session_response_spec.rb +41 -0
  137. data/spec/models/strikethrough_custom_effect_per_item_props_spec.rb +53 -0
  138. metadata +18 -2
@@ -24,7 +24,7 @@ module TalonOne
24
24
  # The time this entity was last modified.
25
25
  attr_accessor :modified
26
26
 
27
- # The IDs of the applications that are related to this entity. The IDs of the applications that are related to this entity.
27
+ # The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity.
28
28
  attr_accessor :application_ids
29
29
 
30
30
  # Name or title for this webhook.
@@ -33,7 +33,7 @@ module TalonOne
33
33
  # API method for this webhook.
34
34
  attr_accessor :verb
35
35
 
36
- # API url (supports templating using parameters) for this webhook.
36
+ # API URL (supports templating using parameters) for this webhook.
37
37
  attr_accessor :url
38
38
 
39
39
  # List of API HTTP headers for this webhook.
@@ -45,7 +45,7 @@ module TalonOne
45
45
  # Array of template argument definitions.
46
46
  attr_accessor :params
47
47
 
48
- # Enables or disables webhook from showing in rule builder.
48
+ # Enables or disables webhook from showing in the Rule Builder.
49
49
  attr_accessor :enabled
50
50
 
51
51
  class EnumAttributeValidator
@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
11
11
  =end
12
12
 
13
13
  module TalonOne
14
- VERSION = '3.0.0'
14
+ VERSION = '3.0.1'
15
15
  end
data/lib/talon_one.rb CHANGED
@@ -204,6 +204,7 @@ require 'talon_one/models/inline_response20037'
204
204
  require 'talon_one/models/inline_response20038'
205
205
  require 'talon_one/models/inline_response20039'
206
206
  require 'talon_one/models/inline_response2004'
207
+ require 'talon_one/models/inline_response20040'
207
208
  require 'talon_one/models/inline_response2005'
208
209
  require 'talon_one/models/inline_response2006'
209
210
  require 'talon_one/models/inline_response2007'
@@ -297,6 +298,7 @@ require 'talon_one/models/new_loyalty_tier'
297
298
  require 'talon_one/models/new_management_key'
298
299
  require 'talon_one/models/new_multiple_audiences_item'
299
300
  require 'talon_one/models/new_notification_webhook'
301
+ require 'talon_one/models/new_outgoing_integration_webhook'
300
302
  require 'talon_one/models/new_password'
301
303
  require 'talon_one/models/new_password_email'
302
304
  require 'talon_one/models/new_picklist'
@@ -331,6 +333,7 @@ require 'talon_one/models/reject_coupon_effect_props'
331
333
  require 'talon_one/models/reject_referral_effect_props'
332
334
  require 'talon_one/models/remove_item_catalog_action'
333
335
  require 'talon_one/models/remove_many_items_catalog_action'
336
+ require 'talon_one/models/reopen_session_response'
334
337
  require 'talon_one/models/reserve_coupon_effect_props'
335
338
  require 'talon_one/models/return_integration_request'
336
339
  require 'talon_one/models/returned_cart_item'
@@ -362,6 +365,7 @@ require 'talon_one/models/show_bundle_metadata_effect_props'
362
365
  require 'talon_one/models/show_notification_effect_props'
363
366
  require 'talon_one/models/slot_def'
364
367
  require 'talon_one/models/strikethrough_changed_item'
368
+ require 'talon_one/models/strikethrough_custom_effect_per_item_props'
365
369
  require 'talon_one/models/strikethrough_effect'
366
370
  require 'talon_one/models/strikethrough_labeling_notification'
367
371
  require 'talon_one/models/strikethrough_set_discount_per_item_effect_props'
@@ -175,10 +175,10 @@ describe 'IntegrationApi' do
175
175
  end
176
176
 
177
177
  # unit tests for get_loyalty_card_balances
178
- # Get loyalty balances for a loyalty card
178
+ # Get card's point balances
179
179
  # Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
180
180
  # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
181
- # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
181
+ # @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
182
182
  # @param [Hash] opts the optional parameters
183
183
  # @option opts [DateTime] :end_date Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
184
184
  # @return [LoyaltyBalances]
@@ -189,17 +189,17 @@ describe 'IntegrationApi' do
189
189
  end
190
190
 
191
191
  # unit tests for get_loyalty_card_transactions
192
- # Get loyalty card transaction logs
192
+ # List card's transactions
193
193
  # Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
194
194
  # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
195
- # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
195
+ # @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
196
196
  # @param [Hash] opts the optional parameters
197
197
  # @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
198
198
  # @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
199
199
  # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
200
200
  # @option opts [Integer] :page_size The number of items in this response.
201
201
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
202
- # @return [CardLedgerTransactionLogEntryIntegrationAPI]
202
+ # @return [InlineResponse2001]
203
203
  describe 'get_loyalty_card_transactions test' do
204
204
  it 'should work' do
205
205
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -217,7 +217,7 @@ describe 'IntegrationApi' do
217
217
  # @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
218
218
  # @option opts [Integer] :page_size The number of items in this response.
219
219
  # @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
220
- # @return [InlineResponse2001]
220
+ # @return [InlineResponse2002]
221
221
  describe 'get_loyalty_program_profile_transactions test' do
222
222
  it 'should work' do
223
223
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -237,10 +237,10 @@ describe 'IntegrationApi' do
237
237
  end
238
238
 
239
239
  # unit tests for link_loyalty_card_to_profile
240
- # Link customer profile to loyalty card
240
+ # Link customer profile to card
241
241
  # [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows.
242
242
  # @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
243
- # @param loyalty_card_identifier Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
243
+ # @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
244
244
  # @param body body
245
245
  # @param [Hash] opts the optional parameters
246
246
  # @return [LoyaltyCard]
@@ -255,7 +255,7 @@ describe 'IntegrationApi' do
255
255
  # Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>not pending</strong> pending loyalty points.</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial</a>.</p> </details> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
256
256
  # @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
257
257
  # @param [Hash] opts the optional parameters
258
- # @return [IntegrationStateV2]
258
+ # @return [ReopenSessionResponse]
259
259
  describe 'reopen_customer_session test' do
260
260
  it 'should work' do
261
261
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers