Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
60 changes: 52 additions & 8 deletions README.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ services:
restart: "on-failure:10"

database-service:
image: docker.io/bitnami/postgresql:15
image: docker.io/bitnamilegacy/postgresql:15
volumes:
- 'postgresql_master_data:/bitnami/postgresql'
- "postgresql_master_data:/bitnami/postgresql"
ports:
- "5433:5432"
environment:
Expand All @@ -44,4 +44,4 @@ services:
restart: "on-failure:10"

volumes:
postgresql_master_data:
postgresql_master_data:
2 changes: 1 addition & 1 deletion docs/AccessLogEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Log of application accesses.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uuid** | **string** | UUID reference of request. |
**Status** | **int** | HTTP status code of response. |
**Status** | **long** | HTTP status code of response. |
**Method** | **string** | HTTP method of request. |
**RequestUri** | **string** | target URI of request |
**Time** | **DateTime** | timestamp of request |
Expand Down
18 changes: 9 additions & 9 deletions docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The internal ID of this entity. |
**Id** | **long** | The internal ID of this entity. |
**Created** | **DateTime** | The time this entity was created. |
**Modified** | **DateTime** | The time this entity was last modified. |
**CompanyName** | **string** | |
Expand All @@ -12,14 +12,14 @@ Name | Type | Description | Notes
**BillingEmail** | **string** | The billing email address associated with your company account. |
**PlanName** | **string** | The name of your booked plan. | [optional]
**PlanExpires** | **DateTime** | The point in time at which your current plan expires. | [optional]
**ApplicationLimit** | **int** | The maximum number of Applications covered by your plan. | [optional]
**UserLimit** | **int** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
**CampaignLimit** | **int** | The maximum number of Campaigns covered by your plan. | [optional]
**ApiLimit** | **int** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
**ApplicationCount** | **int** | The current number of Applications in your account. |
**UserCount** | **int** | The current number of Campaign Manager Users in your account. |
**CampaignsActiveCount** | **int** | The current number of active Campaigns in your account. |
**CampaignsInactiveCount** | **int** | The current number of inactive Campaigns in your account. |
**ApplicationLimit** | **long** | The maximum number of Applications covered by your plan. | [optional]
**UserLimit** | **long** | The maximum number of Campaign Manager Users covered by your plan. | [optional]
**CampaignLimit** | **long** | The maximum number of Campaigns covered by your plan. | [optional]
**ApiLimit** | **long** | The maximum number of Integration API calls covered by your plan per billing period. | [optional]
**ApplicationCount** | **long** | The current number of Applications in your account. |
**UserCount** | **long** | The current number of Campaign Manager Users in your account. |
**CampaignsActiveCount** | **long** | The current number of active Campaigns in your account. |
**CampaignsInactiveCount** | **long** | The current number of inactive Campaigns in your account. |
**Attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/AccountAdditionalCost.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The internal ID of this entity. |
**Id** | **long** | The internal ID of this entity. |
**Created** | **DateTime** | The time this entity was created. |
**AccountId** | **int** | The ID of the account that owns this entity. |
**AccountId** | **long** | The ID of the account that owns this entity. |
**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. |
**SubscribedApplicationsIds** | **List<int>** | A list of the IDs of the applications that are subscribed to this additional cost. | [optional]
**SubscribedApplicationsIds** | **List<long>** | 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 TypeEnum.Session]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
38 changes: 19 additions & 19 deletions docs/AccountAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Applications** | **int** | Total number of applications in the account. |
**LiveApplications** | **int** | Total number of live applications in the account. |
**SandboxApplications** | **int** | Total number of sandbox applications in the account. |
**Campaigns** | **int** | Total number of campaigns in the account. |
**ActiveCampaigns** | **int** | Total number of active campaigns in the account. |
**LiveActiveCampaigns** | **int** | Total number of active campaigns in live applications in the account. |
**Coupons** | **int** | Total number of coupons in the account. |
**ActiveCoupons** | **int** | Total number of active coupons in the account. |
**ExpiredCoupons** | **int** | Total number of expired coupons in the account. |
**ReferralCodes** | **int** | Total number of referral codes in the account. |
**ActiveReferralCodes** | **int** | Total number of active referral codes in the account. |
**ExpiredReferralCodes** | **int** | Total number of expired referral codes in the account. |
**ActiveRules** | **int** | Total number of active rules in the account. |
**Users** | **int** | Total number of users in the account. |
**Roles** | **int** | Total number of roles in the account. |
**CustomAttributes** | **int** | Total number of custom attributes in the account. |
**Webhooks** | **int** | Total number of webhooks in the account. |
**LoyaltyPrograms** | **int** | Total number of all loyalty programs in the account. |
**LiveLoyaltyPrograms** | **int** | Total number of live loyalty programs in the account. |
**Applications** | **long** | Total number of applications in the account. |
**LiveApplications** | **long** | Total number of live applications in the account. |
**SandboxApplications** | **long** | Total number of sandbox applications in the account. |
**Campaigns** | **long** | Total number of campaigns in the account. |
**ActiveCampaigns** | **long** | Total number of active campaigns in the account. |
**LiveActiveCampaigns** | **long** | Total number of active campaigns in live applications in the account. |
**Coupons** | **long** | Total number of coupons in the account. |
**ActiveCoupons** | **long** | Total number of active coupons in the account. |
**ExpiredCoupons** | **long** | Total number of expired coupons in the account. |
**ReferralCodes** | **long** | Total number of referral codes in the account. |
**ActiveReferralCodes** | **long** | Total number of active referral codes in the account. |
**ExpiredReferralCodes** | **long** | Total number of expired referral codes in the account. |
**ActiveRules** | **long** | Total number of active rules in the account. |
**Users** | **long** | Total number of users in the account. |
**Roles** | **long** | Total number of roles in the account. |
**CustomAttributes** | **long** | Total number of custom attributes in the account. |
**Webhooks** | **long** | Total number of webhooks in the account. |
**LoyaltyPrograms** | **long** | Total number of all loyalty programs in the account. |
**LiveLoyaltyPrograms** | **long** | Total number of live loyalty programs in the account. |
**LastUpdatedAt** | **DateTime** | The point in time when the analytics numbers were updated last. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/AccountDashboardStatisticCampaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Live** | **int** | Number of campaigns that are active and live (across all Applications). |
**EndingSoon** | **int** | Campaigns scheduled to expire sometime in the next 7 days. |
**LowOnBudget** | **int** | Campaigns with less than 10% of budget left. |
**Live** | **long** | Number of campaigns that are active and live (across all Applications). |
**EndingSoon** | **long** | Campaigns scheduled to expire sometime in the next 7 days. |
**LowOnBudget** | **long** | Campaigns with less than 10% of budget left. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/AccountEntity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **int** | The ID of the account that owns this entity. |
**AccountId** | **long** | The ID of the account that owns this entity. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

24 changes: 13 additions & 11 deletions docs/AccountLimits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LiveApplications** | **int** | Total number of allowed live applications in the account. |
**SandboxApplications** | **int** | Total number of allowed sandbox applications in the account. |
**ActiveCampaigns** | **int** | Total number of allowed active campaigns in live applications in the account. |
**Coupons** | **int** | Total number of allowed coupons in the account. |
**ReferralCodes** | **int** | Total number of allowed referral codes in the account. |
**ActiveRules** | **int** | Total number of allowed active rulesets in the account. |
**LiveLoyaltyPrograms** | **int** | Total number of allowed live loyalty programs in the account. |
**SandboxLoyaltyPrograms** | **int** | Total number of allowed sandbox loyalty programs in the account. |
**Webhooks** | **int** | Total number of allowed webhooks in the account. |
**Users** | **int** | Total number of allowed users in the account. |
**ApiVolume** | **int** | Allowed volume of API requests to the account. |
**LiveApplications** | **long** | Total number of allowed live applications in the account. |
**SandboxApplications** | **long** | Total number of allowed sandbox applications in the account. |
**ActiveCampaigns** | **long** | Total number of allowed active campaigns in live applications in the account. |
**Coupons** | **long** | Total number of allowed coupons in the account. |
**ReferralCodes** | **long** | Total number of allowed referral codes in the account. |
**ActiveRules** | **long** | Total number of allowed active rulesets in the account. |
**LiveLoyaltyPrograms** | **long** | Total number of allowed live loyalty programs in the account. |
**SandboxLoyaltyPrograms** | **long** | Total number of allowed sandbox loyalty programs in the account. |
**Webhooks** | **long** | Total number of allowed webhooks in the account. |
**Users** | **long** | Total number of allowed users in the account. |
**ApiVolume** | **long** | Allowed volume of API requests to the account. |
**PromotionTypes** | **List<string>** | Array of promotion types that are employed in the account. |
**SecondaryDeploymentPrice** | **long** | The price for a secondary deployment according to contractual agreements. |
**CurrencyCode** | **string** | The currency of the contract. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

7 changes: 4 additions & 3 deletions docs/Achievement.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | The internal ID of this entity. |
**Id** | **long** | The internal ID of this entity. |
**Created** | **DateTime** | The time this entity was created. |
**Name** | **string** | The internal name of the achievement used in API requests. **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. |
**Title** | **string** | The display name for the achievement in the Campaign Manager. |
Expand All @@ -15,8 +15,9 @@ Name | Type | Description | Notes
**ActivationPolicy** | **string** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**FixedStartDate** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**EndDate** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
**CampaignId** | **int** | The ID of the campaign the achievement belongs to. |
**UserId** | **int** | ID of the user that created this achievement. |
**AllowRollbackAfterCompletion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
**CampaignId** | **long** | The ID of the campaign the achievement belongs to. |
**UserId** | **long** | ID of the user that created this achievement. |
**CreatedBy** | **string** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
**HasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [optional]
**Status** | **string** | The status of the achievement. | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/AchievementAdditionalProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CampaignId** | **int** | The ID of the campaign the achievement belongs to. |
**UserId** | **int** | ID of the user that created this achievement. |
**CampaignId** | **long** | The ID of the campaign the achievement belongs to. |
**UserId** | **long** | ID of the user that created this achievement. |
**CreatedBy** | **string** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional]
**HasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [optional]
**Status** | **string** | The status of the achievement. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/AchievementBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**ActivationPolicy** | **string** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
**FixedStartDate** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
**EndDate** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
**AllowRollbackAfterCompletion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

5 changes: 3 additions & 2 deletions docs/AchievementProgressWithDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@ Name | Type | Description | Notes
**StartDate** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
**CompletionDate** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
**EndDate** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
**AchievementId** | **int** | The internal ID of the achievement. |
**AchievementId** | **long** | The internal ID of the achievement. |
**Name** | **string** | The internal name of the achievement used in API requests. |
**Title** | **string** | The display name of the achievement in the Campaign Manager. |
**Description** | **string** | The description of the achievement in the Campaign Manager. |
**CampaignId** | **int** | The ID of the campaign the achievement belongs to. |
**CampaignId** | **long** | The ID of the campaign the achievement belongs to. |
**Target** | **decimal** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
**AchievementRecurrencePolicy** | **string** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. |
**AchievementActivationPolicy** | **string** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. |
**AchievementFixedStartDate** | **DateTime** | The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. **Note:** It is an RFC3339 timestamp string. | [optional]
**AchievementEndDate** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It is an RFC3339 timestamp string. | [optional]
**AchievementAllowRollbackAfterCompletion** | **bool** | When `true`, customer progress can be rolled back in completed achievements. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading