talon_one 3.0.2 → 4.0.0

data/docs/NotificationListItem.md

@@ -0,0 +1,23 @@
+# TalonOne::NotificationListItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_id** | **Integer** | The ID of the notification. | 
+**notification_name** | **String** | The name of the notification. | 
+**entity_id** | **Integer** | The ID of the entity to which this notification belongs. For example, in case of a loyalty notification, this value is the ID of the loyalty program.  | 
+**enabled** | **Boolean** | Indicates whether the notification is activated. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NotificationListItem.new(notification_id: 1,
+                                 notification_name: My campaign notification,
+                                 entity_id: 1,
+                                 enabled: true)
+```
+
+

data/docs/NotificationTest.md

@@ -0,0 +1,27 @@
+# TalonOne::NotificationTest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**http_response** | **String** | The returned http response. | 
+**http_status** | **Integer** | The returned http status code. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NotificationTest.new(http_response: HTTP/1.1 200 OK
+Content-Type: application/json
+Content-Length: 256
+
+{
+  "message": "Hello, world!",
+  "status": "success"
+}
+,
+                                 http_status: 200)
+```
+
+

data/docs/OneTimeCode.md

@@ -0,0 +1,23 @@
+# TalonOne::OneTimeCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | The ID of the user. | 
+**account_id** | **Integer** | The ID of the account. | 
+**token** | **String** | The two-factor authentication token created during sign-in. This token is used to ensure that the correct user is trying to sign in with a given one-time security code. | 
+**code** | **String** | The one-time security code used for signing in. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OneTimeCode.new(user_id: 109,
+                                 account_id: 31,
+                                 token: dy_Fa_lQ4iDAnqldJFvV,
+                                 code: 552917)
+```
+
+

data/docs/OutgoingIntegrationCleverTapPolicy.md

@@ -0,0 +1,21 @@
+# TalonOne::OutgoingIntegrationCleverTapPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_url** | **String** | The base URL that is based on the region key of your CleverTap account. | 
+**account_id** | **String** | The CleverTap Project ID. | 
+**passcode** | **String** | The CleverTap Project passcode. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationCleverTapPolicy.new(base_url: your-clevertap-url.com,
+                                 account_id: A9X-7A6-4A6B,
+                                 passcode: ABB-BAF-AWZP)
+```
+
+

data/docs/OutgoingIntegrationConfiguration.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **Integer** | Unique ID for this entity. | 
 **account_id** | **Integer** | The ID of the account to which this configuration belongs. | 
 **type_id** | **Integer** | The outgoing integration type ID. | 
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | The outgoing integration policy specific to each integration type. | 
 
 ## Code Sample
 

data/docs/OutgoingIntegrationIterablePolicy.md

@@ -0,0 +1,19 @@
+# TalonOne::OutgoingIntegrationIterablePolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_url** | **String** | The base URL that is based on the region key of your Iterable account. | 
+**api_key** | **String** | The API key generated from your Iterable account. See [Iterable API Key Guide](https://support.iterable.com/hc/en-us/articles/360043464871-API-Keys-) | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationIterablePolicy.new(base_url: https://api.iterable.com,
+                                 api_key: 1234df4ba16940ca59c9352936d080a8)
+```
+
+

data/docs/OutgoingIntegrationMoEngagePolicy.md

@@ -0,0 +1,23 @@
+# TalonOne::OutgoingIntegrationMoEngagePolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_url** | **String** | The base URL of your MoEngage deployment, containing the MoEngage data center number (represented by `0X`). | 
+**app_id** | **String** | MoEngage APP ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | 
+**data_api_id** | **String** | MoEngage DATA API ID. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | 
+**data_api_key** | **String** | MoEngage DATA API Key. See [MoEngage Developer Guide](https://developers.moengage.com/hc/en-us/articles/4404674776724-Overview). | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationMoEngagePolicy.new(base_url: https://api-01.moengage.com,
+                                 app_id: LDUBEU9PLTPYXV30SMTYAAAA,
+                                 data_api_id: LDUBEU9PLTPYXV30SMTYAAAA,
+                                 data_api_key: R95crrAAdZ747QLXe8LwnGLX)
+```
+
+

data/docs/OutgoingIntegrationTemplate.md

@@ -0,0 +1,33 @@
+# TalonOne::OutgoingIntegrationTemplate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**integration_type** | **Integer** | Unique ID of outgoing integration type. | 
+**title** | **String** | The title of the integration template. | 
+**description** | **String** | The description of the specific outgoing integration template. | 
+**payload** | **String** | The API payload (supports templating using parameters) for this integration template. | 
+**method** | **String** | API method for this webhook. | 
+**relative_url** | **String** | The relative URL corresponding to each integration template. | 
+**headers** | **Array<String>** | The list of HTTP headers for this integration template. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationTemplate.new(id: 6,
+                                 integration_type: 2,
+                                 title: Email coupon codes,
+                                 description: This template sends a coupon code to the specified audience by email.,
+                                 payload: {
+	"message": "${message}"
+},
+                                 method: POST,
+                                 relative_url: /campaigns/trigger/send,
+                                 headers: [{"Content-Type": "application/json"}])
+```
+
+

data/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md

@@ -0,0 +1,35 @@
+# TalonOne::OutgoingIntegrationTemplateWithConfigurationDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**integration_type** | **Integer** | Unique ID of outgoing integration type. | 
+**title** | **String** | The title of the integration template. | 
+**description** | **String** | The description of the specific outgoing integration template. | 
+**payload** | **String** | The API payload (supports templating using parameters) for this integration template. | 
+**method** | **String** | API method for this webhook. | 
+**relative_url** | **String** | The relative URL corresponding to each integration template. | 
+**headers** | **Array<String>** | The list of HTTP headers for this integration template. | 
+**policy** | [**Object**](.md) | The outgoing integration policy specific to each integration type. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationTemplateWithConfigurationDetails.new(id: 6,
+                                 integration_type: 2,
+                                 title: Email coupon codes,
+                                 description: This template sends a coupon code to the specified audience by email.,
+                                 payload: {
+	"message": "${message}"
+},
+                                 method: POST,
+                                 relative_url: /campaigns/trigger/send,
+                                 headers: [{"Content-Type": "application/json"}],
+                                 policy: null)
+```
+
+

data/docs/OutgoingIntegrationTemplates.md

@@ -0,0 +1,17 @@
+# TalonOne::OutgoingIntegrationTemplates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<OutgoingIntegrationTemplate>**](OutgoingIntegrationTemplate.md) | The list of templates for a given outgoing integration type. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OutgoingIntegrationTemplates.new(data: null)
+```
+
+

data/docs/OutgoingIntegrationType.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::OutgoingIntegrationType.new(id: 6,
-                                 name: braze,
+                                 name: Braze,
                                  description: Braze is a customer data platform,
                                  category: customer engagement platform,
                                  documentation_link: https://docs.talon.one/docs/dev/technology-partners/braze)

data/docs/PatchItemCatalogAction.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **sku** | **String** | The unique SKU of the item to patch. | 
 **price** | **Float** | Price of the item. | [optional] 
 **attributes** | [**Object**](.md) | The attributes of the item to patch. | [optional] 
+**product** | [**Product**](Product.md) |  | [optional] 
 **create_if_not_exists** | **Boolean** | Indicates whether to create an item if the SKU does not exist. | [optional] [default to false]
 
 ## Code Sample
@@ -17,6 +18,7 @@ require 'TalonOne'
 instance = TalonOne::PatchItemCatalogAction.new(sku: null,
                                  price: 99.99,
                                  attributes: null,
+                                 product: null,
                                  create_if_not_exists: null)
 ```
 

data/docs/PendingPointsNotificationPolicy.md

@@ -0,0 +1,19 @@
+# TalonOne::PendingPointsNotificationPolicy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Notification name. | 
+**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::PendingPointsNotificationPolicy.new(name: Christmas Sale,
+                                 batching_enabled: false)
+```
+
+

data/docs/Picklist.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
-**type** | **String** | The type of allowed values in the picklist. If type time is chosen, it must be an RFC3339 timestamp string. | 
+**type** | **String** | The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. | 
 **values** | **Array<String>** | The list of allowed values provided by this picklist. | 
 **modified_by** | **Integer** | ID of the user who last updated this effect if available. | [optional] 
 **created_by** | **Integer** | ID of the user who created this effect. | 

data/docs/Product.md

@@ -0,0 +1,17 @@
+# TalonOne::Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the product. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Product.new(name: sample_product)
+```
+
+

data/docs/RemoveFromAudienceEffectProps.md

@@ -0,0 +1,23 @@
+# TalonOne::RemoveFromAudienceEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**audience_id** | **Integer** | The internal ID of the audience. | [optional] 
+**audience_name** | **String** | The name of the audience. | [optional] 
+**profile_integration_id** | **String** | The ID of the customer profile in the third-party integration platform. | [optional] 
+**profile_id** | **Integer** | The internal ID of the customer profile. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RemoveFromAudienceEffectProps.new(audience_id: 10,
+                                 audience_name: My audience,
+                                 profile_integration_id: URNGV8294NV,
+                                 profile_id: 150)
+```
+
+

data/docs/ReturnedCartItem.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **position** | **Integer** | The index of the cart item in the provided customer session's `cartItems` property. | 
-**quantity** | **Integer** | Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety.  | [optional] 
+**quantity** | **Integer** | Number of cart items to return.  | [optional] 
 
 ## Code Sample
 

data/docs/Role.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
-**campaign_group_id** | **Integer** | The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups) this role was created for.  | [optional] 
+**campaign_group_id** | **Integer** | The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this role was created for.  | [optional] 
 **name** | **String** | Name of the role. | 
 **description** | **String** | Description of the role. | [optional] 
 **members** | **Array<Integer>** | A list of user identifiers assigned to this role. | [optional] 

data/docs/RoleAssign.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**users** | **Array<Integer>** | An array of userIDs. | 
-**roles** | **Array<Integer>** | An array of roleIDs. | 
+**users** | **Array<Integer>** | An array of user IDs. | 
+**roles** | **Array<Integer>** | An array of role IDs. | 
 
 ## Code Sample
 

data/docs/RoleV2.md

@@ -4,22 +4,28 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**modified** | **DateTime** | The time this entity was last modified. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
 **name** | **String** | Name of the role. | [optional] 
 **description** | **String** | Description of the role. | [optional] 
-**is_admin** | **Boolean** | Indicates whether the role grants admin permissions. | [optional] 
 **permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) |  | [optional] 
-**members** | **Array<Integer>** | An array of user identifiers. | [optional] 
+**members** | **Array<Integer>** | A list of user IDs the role is assigned to. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::RoleV2.new(name: Campaign manager,
-                                 description: Manages the campaigns,
-                                 is_admin: true,
+instance = TalonOne::RoleV2.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 modified: 2021-09-12T10:12:42Z,
+                                 account_id: 3886,
+                                 name: Campaign and campaign access group manager,
+                                 description: Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.,
                                  permissions: null,
-                                 members: [48, 562, 475, 18])
+                                 members: [10, 12])
 ```
 
 

data/docs/RoleV2ApplicationDetails.md

@@ -4,9 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**application** | **String** | Name of the Application-level permission set. | [optional] 
-**campaign** | **String** | Name of the campaign-level permission set. | [optional] 
-**draft_campaign** | **String** | Name of the draft campaign-level permission set. | [optional] 
+**application** | **String** | Name of the Application-related permission set for the given Application. | [optional] 
+**campaign** | **String** | Name of the campaign-related permission set for the given Application. | [optional] 
+**draft_campaign** | **String** | Name of the draft campaign-related permission set for the given Application. | [optional] 
+**tools** | **String** | Name of the tools-related permission set. | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TalonOne'
 
 instance = TalonOne::RoleV2ApplicationDetails.new(application: null,
                                  campaign: null,
-                                 draft_campaign: null)
+                                 draft_campaign: null,
+                                 tools: Tools permission set)
 ```
 
 

data/docs/RoleV2Base.md

@@ -0,0 +1,23 @@
+# TalonOne::RoleV2Base
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the role. | [optional] 
+**description** | **String** | Description of the role. | [optional] 
+**permissions** | [**RoleV2Permissions**](RoleV2Permissions.md) |  | [optional] 
+**members** | **Array<Integer>** | A list of user IDs the role is assigned to. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RoleV2Base.new(name: Campaign and campaign access group manager,
+                                 description: Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.,
+                                 permissions: null,
+                                 members: [10, 12])
+```
+
+

data/docs/RoleV2PermissionSet.md

@@ -5,15 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the permission set. | 
-**operation_ids** | **Array<String>** |  | 
+**logical_operations** | **Array<String>** | List of logical operations in the permission set. Each logical operation must be shown under the `x-permission` tag on an endpoint level.  | 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::RoleV2PermissionSet.new(name: null,
-                                 operation_ids: null)
+instance = TalonOne::RoleV2PermissionSet.new(name: Campaign manager permission set,
+                                 logical_operations: [createCampaignOperations, getCampaignOperations, deleteCampaignOperations])
 ```
 
 

data/docs/RoleV2Permissions.md

@@ -4,15 +4,15 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**permission_sets** | [**Array<RoleV2PermissionSet>**](RoleV2PermissionSet.md) | List of grouped operation IDs to use as a reference in the roles section. Each group of operation IDs has a name. | [optional] 
-**roles** | [**RoleV2PermissionsRoles**](RoleV2PermissionsRoles.md) |  | [optional] 
+**permission_sets** | [**Array<RoleV2PermissionSet>**](RoleV2PermissionSet.md) | List of grouped logical operations referenced by roles. | [optional] 
+**roles** | [**RoleV2RolesGroup**](RoleV2RolesGroup.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::RoleV2Permissions.new(permission_sets: null,
+instance = TalonOne::RoleV2Permissions.new(permission_sets: [{name=Application permission set, logicalOperations=[getApplicationOperations, editApplicationOperations]}, {name=Campaign manager permission set, logicalOperations=[getCampaignOperations, createCampaignOperations, updateCampaignOperations]}, {name=Campaign read-only permission set, logicalOperations=[getCampaignOperations]}, {name=Loyalty program read-only permission set, logicalOperations=[getLoyaltyProgramOperations]}, {name=Campaign access group manager permission set, logicalOperations=[getCampaignAccessGroupOperations, updateCampaignAccessGroupOperations, deleteCampaignAccessGroupOperations]}],
                                  roles: null)
 ```
 

data/docs/RoleV2RolesGroup.md

@@ -0,0 +1,21 @@
+# TalonOne::RoleV2RolesGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**applications** | [**Hash<String, RoleV2ApplicationDetails>**](RoleV2ApplicationDetails.md) | A map of the link between the Application, campaign, or draft campaign-related permission set and the Application ID the permissions apply to. | [optional] 
+**loyalty_programs** | **Hash<String, String>** | A map of the link between the loyalty program-related permission set and the Application ID the permissions apply to. | [optional] 
+**campaign_access_groups** | **Hash<String, String>** | A map of the link between the campaign access group-related permission set and the Application ID the permissions apply to. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RoleV2RolesGroup.new(applications: {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}},
+                                 loyalty_programs: {10=Loyalty program manager permission set},
+                                 campaign_access_groups: {5=Campaign access group manager permission set})
+```
+
+

data/docs/RollbackAddedLoyaltyPointsEffectProps.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **recipient_integration_id** | **String** | The user for whom these points were originally added. | 
 **transaction_uuid** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. | 
 **cart_item_position** | **Float** | The index of the item in the cart items for which the loyalty points were rolled back. | [optional] 
-**cart_item_sub_position** | **Float** | The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1.  | [optional] 
+**cart_item_sub_position** | **Float** | For cart items with `quantity` > 1, the sub-position indicates to which item the loyalty points were rolled back.  | [optional] 
 **card_identifier** | **String** | The alphanumeric identifier of the loyalty card.  | [optional] 
 
 ## Code Sample

data/docs/RollbackDiscountEffectProps.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The name of the \"setDiscount\" effect that was rolled back. | 
 **value** | **Float** | The value of the discount that was rolled back. | 
 **cart_item_position** | **Float** | The index of the item in the cart items for which the discount was rolled back. | [optional] 
-**cart_item_sub_position** | **Float** | The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled.  | [optional] 
+**cart_item_sub_position** | **Float** | For cart items with `quantity` > 1, the subposition returns the index of the item unit in its line item.  | [optional] 
 **additional_cost_id** | **Integer** | The ID of the additional cost that was rolled back. | [optional] 
 **additional_cost** | **String** | The name of the additional cost that was rolled back. | [optional] 
 **scope** | **String** | The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal`  | [optional] 

data/docs/SSOConfig.md

@@ -0,0 +1,17 @@
+# TalonOne::SSOConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enforced** | **Boolean** | An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`.  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SSOConfig.new(enforced: true)
+```
+
+

data/docs/SamlConnectionInternal.md

@@ -0,0 +1,19 @@
+# TalonOne::SamlConnectionInternal
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | ID of the SAML service. | 
+**metadata_document** | **String** | Identity Provider metadata XML document. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SamlConnectionInternal.new(name: null,
+                                 metadata_document: null)
+```
+
+

data/docs/SamlLoginEndpoint.md

@@ -4,15 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the SAML login endpoint. | 
 **name** | **String** | ID of the SAML service. | 
-**login_url** | **String** | Single Sign-On URL. | 
+**login_url** | **String** | The single sign-on URL. | 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::SamlLoginEndpoint.new(name: null,
+instance = TalonOne::SamlLoginEndpoint.new(id: 2,
+                                 name: null,
                                  login_url: null)
 ```
 

data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **additional_cost_id** | **Integer** | The ID of the additional cost. | 
 **value** | **Float** | The total monetary value of the discount. | 
 **position** | **Float** | The index of the item in the cart item list containing the additional cost to be discounted. | 
-**sub_position** | **Float** | Only used when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. Indicates which item the discount applies to for cart items with `quantity` > 1.  | [optional] 
+**sub_position** | **Float** | For cart items with `quantity` > 1, the sub position indicates which item the discount applies to.  | [optional] 
 **additional_cost** | **String** | The name of the additional cost. | 
 **desired_value** | **Float** | Only with [partial discounts enabled](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#partial-discounts). Represents the monetary value of the discount to be applied to additional discount without considering budget limitations.  | [optional]