talon_one_sdk 26.01

data/docs/ManagementKey.md

@@ -0,0 +1,36 @@
+# TalonOne::ManagementKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for management key. |  |
+| **expiry_date** | **Time** | The date the management key expires. |  |
+| **endpoints** | [**Array<Endpoint>**](Endpoint.md) | The list of endpoints that can be accessed with the key |  |
+| **allowed_application_ids** | **Array<Integer>** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account.  | [optional] |
+| **id** | **Integer** | ID of the management key. |  |
+| **created_by** | **Integer** | ID of the user who created it. |  |
+| **account_id** | **Integer** | ID of account the key is used for. |  |
+| **created** | **Time** | The date the management key was created. |  |
+| **disabled** | **Boolean** | The management key is disabled (this property is set to `true`) when the user who created the key is disabled or deleted. | [optional] |
+| **last_used** | **Time** | The last time the management key was used. | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::ManagementKey.new(
+  name: My generated key,
+  expiry_date: 2023-08-24T14:00:00Z,
+  endpoints: null,
+  allowed_application_ids: [1, 2, 3],
+  id: 34,
+  created_by: 280,
+  account_id: 13,
+  created: 2022-03-02T16:46:17.758585Z,
+  disabled: true,
+  last_used: 2022-03-02T16:46:17.758585Z
+)
+```
+

data/docs/ManagerConfig.md

@@ -0,0 +1,18 @@
+# TalonOne::ManagerConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schema_version** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::ManagerConfig.new(
+  schema_version: null
+)
+```
+

data/docs/MessageLogEntries.md

@@ -0,0 +1,20 @@
+# TalonOne::MessageLogEntries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_cursor** | **String** | The next value in the database.  **Note:** If this value is not present, it means that there are no more values in the database for this combination of request parameters.  | [optional] |
+| **data** | [**Array<MessageLogEntry>**](MessageLogEntry.md) | List of message logs. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MessageLogEntries.new(
+  next_cursor: SmJlNERRMHdyNWFsTmRDZDVYU0c=,
+  data: null
+)
+```
+

data/docs/MessageLogEntry.md

@@ -0,0 +1,46 @@
+# TalonOne::MessageLogEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the message. |  |
+| **service** | **String** | Name of the service that generated the log entry. |  |
+| **change_type** | **String** | Type of change that triggered the notification. | [optional] |
+| **notification_id** | **Integer** | ID of the notification. | [optional] |
+| **notification_name** | **String** | The name of the notification. | [optional] |
+| **webhook_id** | **Integer** | ID of the webhook. | [optional] |
+| **webhook_name** | **String** | The name of the webhook. | [optional] |
+| **request** | [**MessageLogRequest**](MessageLogRequest.md) |  | [optional] |
+| **response** | [**MessageLogResponse**](MessageLogResponse.md) |  | [optional] |
+| **created_at** | **Time** | Timestamp when the log entry was created. |  |
+| **entity_type** | **String** | The entity type the log is related to.  |  |
+| **url** | **String** | The target URL of the request. | [optional] |
+| **application_id** | **Integer** | Identifier of the Application. | [optional] |
+| **loyalty_program_id** | **Integer** | Identifier of the loyalty program. | [optional] |
+| **campaign_id** | **Integer** | Identifier of the campaign. | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MessageLogEntry.new(
+  id: 123e4567-e89b-12d3-a456-426614174000,
+  service: NotificationService,
+  change_type: Update,
+  notification_id: 101,
+  notification_name: My campaign notification,
+  webhook_id: 101,
+  webhook_name: My webhook,
+  request: null,
+  response: null,
+  created_at: 2021-07-20T22:00:00Z,
+  entity_type: loyalty_program,
+  url: www.my-company.com/my-endpoint-name,
+  application_id: 5,
+  loyalty_program_id: 2,
+  campaign_id: 2
+)
+```
+

data/docs/MessageLogRequest.md

@@ -0,0 +1,20 @@
+# TalonOne::MessageLogRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | Timestamp when the request was made. |  |
+| **request** | **String** | Raw request data. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MessageLogRequest.new(
+  created_at: 2021-07-20T21:59:00Z,
+  request: SGVsbG8sIHdvcmxkIQ==
+)
+```
+

data/docs/MessageLogResponse.md

@@ -0,0 +1,22 @@
+# TalonOne::MessageLogResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | Timestamp when the response was received. | [optional] |
+| **response** | **String** | Raw response data. | [optional] |
+| **status** | **Integer** | HTTP status code of the response. | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MessageLogResponse.new(
+  created_at: 2021-07-20T22:00:50Z,
+  response: UmVzcG9uc2UgY29udGVudA==,
+  status: 200
+)
+```
+

data/docs/MessageTest.md

@@ -0,0 +1,28 @@
+# TalonOne::MessageTest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **http_response** | **String** | The returned http response. |  |
+| **http_status** | **Integer** | The returned http status code. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MessageTest.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/Meta.md

@@ -0,0 +1,26 @@
+# TalonOne::Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaigns** | **Object** | Maps each evaluated campaign ID to a key-value list of that campaigns attributes. Campaigns without attributes will be omitted. | [optional] |
+| **coupons** | **Object** | Maps the coupon value to a key-value list of that coupons attributes. | [optional] |
+| **coupon_rejection_reason** | [**CouponRejectionReason**](CouponRejectionReason.md) |  | [optional] |
+| **referral_rejection_reason** | [**ReferralRejectionReason**](ReferralRejectionReason.md) |  | [optional] |
+| **warnings** | **Object** | Contains warnings about possible misuse. | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::Meta.new(
+  campaigns: null,
+  coupons: null,
+  coupon_rejection_reason: null,
+  referral_rejection_reason: null,
+  warnings: null
+)
+```
+

data/docs/ModelReturn.md

@@ -0,0 +1,38 @@
+# TalonOne::ModelReturn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The internal ID of this entity. |  |
+| **created** | **Time** | The time this entity was created. |  |
+| **application_id** | **Integer** | The ID of the Application that owns this entity. |  |
+| **account_id** | **Integer** | The ID of the account that owns this entity. |  |
+| **returned_cart_items** | [**Array<ReturnedCartItem>**](ReturnedCartItem.md) | List of cart items to be returned. |  |
+| **event_id** | **Integer** | The event ID of that was generated for this return. |  |
+| **session_id** | **Integer** | The internal ID of the session this return was requested on. |  |
+| **session_integration_id** | **String** | The integration ID of the session this return was requested on. |  |
+| **profile_id** | **Integer** | The internal ID of the profile this return was requested on. | [optional] |
+| **profile_integration_id** | **String** | The integration ID of the profile this return was requested on. | [optional] |
+| **created_by** | **Integer** | ID of the user who requested this return. | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::ModelReturn.new(
+  id: 6,
+  created: 2020-06-10T09:05:27.993483Z,
+  application_id: 322,
+  account_id: 3886,
+  returned_cart_items: null,
+  event_id: 123,
+  session_id: 123,
+  session_integration_id: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c,
+  profile_id: 123,
+  profile_integration_id: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c,
+  created_by: 123
+)
+```
+

data/docs/MultiApplicationEntity.md

@@ -0,0 +1,18 @@
+# TalonOne::MultiApplicationEntity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultiApplicationEntity.new(
+  application_ids: null
+)
+```
+

data/docs/MultipleAttribute.md

@@ -0,0 +1,18 @@
+# TalonOne::MultipleAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<Attribute>**](Attribute.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleAttribute.new(
+  attributes: null
+)
+```
+

data/docs/MultipleAudiences.md

@@ -0,0 +1,20 @@
+# TalonOne::MultipleAudiences
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** | The ID of the account that owns this entity. |  |
+| **audiences** | [**Array<MultipleAudiencesItem>**](MultipleAudiencesItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleAudiences.new(
+  account_id: 3886,
+  audiences: null
+)
+```
+

data/docs/MultipleAudiencesItem.md

@@ -0,0 +1,26 @@
+# TalonOne::MultipleAudiencesItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The internal ID of this entity. |  |
+| **created** | **Time** | The time this entity was created. |  |
+| **name** | **String** | The human-friendly display name for this audience. |  |
+| **integration_id** | **String** | The ID of this audience in the third-party integration. | [optional] |
+| **status** | **String** | Indicates whether the audience is new, updated or unmodified by the request.  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleAudiencesItem.new(
+  id: 6,
+  created: 2020-06-10T09:05:27.993483Z,
+  name: Travel audience,
+  integration_id: 382370BKDB946,
+  status: new
+)
+```
+

data/docs/MultipleCustomerProfileIntegrationRequest.md

@@ -0,0 +1,18 @@
+# TalonOne::MultipleCustomerProfileIntegrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_profiles** | [**Array<MultipleCustomerProfileIntegrationRequestItem>**](MultipleCustomerProfileIntegrationRequestItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationRequest.new(
+  customer_profiles: null
+)
+```
+

data/docs/MultipleCustomerProfileIntegrationRequestItem.md

@@ -0,0 +1,20 @@
+# TalonOne::MultipleCustomerProfileIntegrationRequestItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | **Object** | Arbitrary properties associated with this item. | [optional] |
+| **integration_id** | **String** | The identifier of this profile, set by your integration layer. It must be unique within the account.  To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2).  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationRequestItem.new(
+  attributes: {Language=english, ShippingCountry=DE},
+  integration_id: R195412
+)
+```
+

data/docs/MultipleCustomerProfileIntegrationResponseV2.md

@@ -0,0 +1,18 @@
+# TalonOne::MultipleCustomerProfileIntegrationResponseV2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_states** | [**Array<CustomerProfileUpdateV2Response>**](CustomerProfileUpdateV2Response.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationResponseV2.new(
+  integration_states: null
+)
+```
+

data/docs/MultipleNewAttribute.md

@@ -0,0 +1,18 @@
+# TalonOne::MultipleNewAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attributes** | [**Array<NewAttribute>**](NewAttribute.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleNewAttribute.new(
+  attributes: null
+)
+```
+

data/docs/MultipleNewAudiences.md

@@ -0,0 +1,18 @@
+# TalonOne::MultipleNewAudiences
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **audiences** | [**Array<NewMultipleAudiencesItem>**](NewMultipleAudiencesItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MultipleNewAudiences.new(
+  audiences: null
+)
+```
+

data/docs/MutableEntity.md

@@ -0,0 +1,18 @@
+# TalonOne::MutableEntity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **modified** | **Time** | The time this entity was last modified. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::MutableEntity.new(
+  modified: 2021-09-12T10:12:42Z
+)
+```
+

data/docs/NewAccount.md

@@ -0,0 +1,18 @@
+# TalonOne::NewAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewAccount.new(
+  company_name: null
+)
+```
+

data/docs/NewAccountSignUp.md

@@ -0,0 +1,22 @@
+# TalonOne::NewAccountSignUp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The email address associated with the user profile. |  |
+| **password** | **String** | The password for your account. |  |
+| **company_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewAccountSignUp.new(
+  email: john.doe@example.com,
+  password: admin123456,
+  company_name: null
+)
+```
+

data/docs/NewAdditionalCost.md

@@ -0,0 +1,26 @@
+# TalonOne::NewAdditionalCost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The internal name used in API requests. |  |
+| **title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. |  |
+| **description** | **String** | A description of this additional cost. |  |
+| **subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional] |
+| **type** | **String** | The type of additional cost. Possible value: - `session`: Additional cost will be added per session. - `item`: Additional cost will be added per item. - `both`: Additional cost will be added per item and session.  | [optional][default to 'session'] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewAdditionalCost.new(
+  name: shippingFee,
+  title: Shipping fee,
+  description: A shipping fee,
+  subscribed_applications_ids: [3, 13],
+  type: session
+)
+```
+

data/docs/NewAppWideCouponDeletionJob.md

@@ -0,0 +1,20 @@
+# TalonOne::NewAppWideCouponDeletionJob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) |  |  |
+| **campaignids** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewAppWideCouponDeletionJob.new(
+  filters: null,
+  campaignids: null
+)
+```
+

data/docs/NewApplication.md

@@ -0,0 +1,48 @@
+# TalonOne::NewApplication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of this application. |  |
+| **description** | **String** | A longer description of the application. | [optional] |
+| **timezone** | **String** | A string containing an IANA timezone descriptor. |  |
+| **currency** | **String** | The default currency for new customer sessions. |  |
+| **case_sensitivity** | **String** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] |
+| **attributes** | **Object** | Arbitrary properties associated with this campaign. | [optional] |
+| **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] |
+| **default_discount_scope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect.  | [optional] |
+| **enable_cascading_discounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional] |
+| **enable_flattened_cart_items** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one.  | [optional] |
+| **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] |
+| **sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional] |
+| **enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] |
+| **default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect.  | [optional] |
+| **key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits). | [optional] |
+| **enable_campaign_state_management** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewApplication.new(
+  name: My Application,
+  description: A test Application,
+  timezone: Europe/Berlin,
+  currency: EUR,
+  case_sensitivity: sensitive,
+  attributes: null,
+  limits: null,
+  default_discount_scope: null,
+  enable_cascading_discounts: null,
+  enable_flattened_cart_items: null,
+  attributes_settings: null,
+  sandbox: null,
+  enable_partial_discounts: false,
+  default_discount_additional_cost_per_item_scope: null,
+  key: null,
+  enable_campaign_state_management: false
+)
+```
+

data/docs/NewApplicationAPIKey.md

@@ -0,0 +1,38 @@
+# TalonOne::NewApplicationAPIKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Title of the API key. |  |
+| **expires** | **Time** | The date the API key expires. |  |
+| **platform** | **String** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer.  | [optional] |
+| **type** | **String** | The API key type. Can be empty or `staging`.  Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.  When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`.  | [optional] |
+| **time_offset** | **Integer** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.  | [optional] |
+| **id** | **Integer** | ID of the API Key. |  |
+| **created_by** | **Integer** | ID of user who created. |  |
+| **account_id** | **Integer** | ID of account the key is used for. |  |
+| **application_id** | **Integer** | ID of application the key is used for. |  |
+| **created** | **Time** | The date the API key was created. |  |
+| **key** | **String** | The API key. |  |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewApplicationAPIKey.new(
+  title: My generated key,
+  expires: 2023-08-24T14:00:00Z,
+  platform: none,
+  type: staging,
+  time_offset: 100000,
+  id: 34,
+  created_by: 280,
+  account_id: 13,
+  application_id: 54,
+  created: 2022-03-02T16:46:17.758585Z,
+  key: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01
+)
+```
+