@smartico/public-api 0.0.363 → 0.0.365

package/docs/api/interfaces/TMissionClaimRewardResult.md

@@ -6,14 +6,14 @@ TMissionClaimRewardResult describes the response of call to _smartico.api.reques
 
 ### err\_code
 
-• **err\_code**: `number`
+> **err\_code**: `number`
 
 Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0
 
-___
+***
 
 ### err\_message
 
-• **err\_message**: `string`
+> **err\_message**: `string`
 
 Optional error message

package/docs/api/interfaces/TMissionOptInResult.md

@@ -6,14 +6,14 @@ TMissionOptInResult describes the response of call to _smartico.api.requestMissi
 
 ### err\_code
 
-• **err\_code**: `number`
+> **err\_code**: `number`
 
 Error code that represents outcome of the opt-in request. Successful opt-in in case err_code is 0
 
-___
+***
 
 ### err\_message
 
-• **err\_message**: `string`
+> **err\_message**: `string`
 
 Optional error message

package/docs/api/interfaces/TMissionOrBadge.md

@@ -6,363 +6,363 @@ TMissionOrBadge describes the information of mission or badge defined in the sys
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the mission or badge
 
-___
+***
 
 ### type
 
-• **type**: ``"mission"`` \| ``"badge"``
+> **type**: `"mission"` \| `"badge"`
 
 Type of entity. Can be 'mission' or 'badge'
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the mission or badge, translated to the user language
 
-___
+***
 
 ### sub\_header
 
-• **sub\_header**: `string`
+> **sub\_header**: `string`
 
 Sub-header of the mission, translated to the user language
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
 Description of the mission or badge, translated to the user language
 
-___
+***
 
 ### reward
 
-• **reward**: `string`
+> **reward**: `string`
 
 Description of the mission reward if defined
 
-___
+***
 
 ### image
 
-• **image**: `string`
+> **image**: `string`
 
 URL of the image of the mission or badge, 256x256px
 
-___
+***
 
 ### is\_completed
 
-• **is\_completed**: `boolean`
+> **is\_completed**: `boolean`
 
 Indicator if the mission is completed or badge is granted
 
-___
+***
 
 ### is\_locked
 
-• **is\_locked**: `boolean`
+> **is\_locked**: `boolean`
 
 Indicator if the mission is locked. Means that it's visible to the user, but he cannot progress in it until it's unlocked.
 Mission may optionally contain the explanation of what should be done to unlock it in the unlock_mission_description property
 
-___
+***
 
 ### unlock\_mission\_description
 
-• **unlock\_mission\_description**: `string`
+> **unlock\_mission\_description**: `string`
 
 Optional explaination of what should be done to unlock the mission
 
-___
+***
 
 ### is\_requires\_optin
 
-• **is\_requires\_optin**: `boolean`
+> **is\_requires\_optin**: `boolean`
 
 Indicator if the mission requires opt-in. Means that user should explicitly opt-in to the mission in order to start progressing in it
 
-___
+***
 
 ### is\_opted\_in
 
-• **is\_opted\_in**: `boolean`
+> **is\_opted\_in**: `boolean`
 
 Indicator if the user opted-in to the mission
 
-___
+***
 
 ### time\_limit\_ms
 
-• **time\_limit\_ms**: `number`
+> **time\_limit\_ms**: `number`
 
 The amount of time in milliseconds that user has to complete the mission
 
-___
+***
 
 ### active\_from\_ts
 
-• **active\_from\_ts**: `number`
+> **active\_from\_ts**: `number`
 
 Holds time from which mission will become available, for the missions that are targeted to be available from specific date/time
 
-___
+***
 
 ### active\_till\_ts
 
-• **active\_till\_ts**: `number`
+> **active\_till\_ts**: `number`
 
 Holds time till mission will become unavailable, for the missions that are targeted to be available from specific date/time
 
-___
+***
 
 ### dt\_start
 
-• **dt\_start**: `number`
+> **dt\_start**: `number`
 
 The date when the mission was started, relevant for the time limited missions, also indicating opt-it date for mission that requires opt-in and unlock date for Locked mission.
 
-___
+***
 
 ### progress
 
-• **progress**: `number`
+> **progress**: `number`
 
 The progress of the mission in percents calculated as the aggregated relative percentage of all tasks
 
-___
+***
 
 ### cta\_action
 
-• **cta\_action**: `string`
+> **cta\_action**: `string`
 
 The action that should be performed when user clicks on the mission or badge
 Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
 The 'dp' function will handle the CTA and will execute it in the most safe way
 
-___
+***
 
 ### cta\_text
 
-• **cta\_text**: `string`
+> **cta\_text**: `string`
 
 The text of the CTA button, e.g. 'Make a deposit'
 
-___
+***
 
 ### custom\_section\_id
 
-• **custom\_section\_id**: `number`
+> **custom\_section\_id**: `number`
 
 The ID of the custom section where the mission or badge is assigned
 The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
 
-___
+***
 
 ### only\_in\_custom\_section
 
-• **only\_in\_custom\_section**: `boolean`
+> **only\_in\_custom\_section**: `boolean`
 
 The indicator if the mission or badge is visible only in the custom section and should be hidden from the main overview of missions/badges
 
-___
+***
 
 ### custom\_data
 
-• **custom\_data**: `any`
+> **custom\_data**: `any`
 
 The custom data of the mission or badge defined by operator. Can be a JSON object, string or number
 
-___
+***
 
 ### tasks
 
-• **tasks**: [`TMissionOrBadgeTask`](TMissionOrBadgeTask.md)[]
+> **tasks**: [`TMissionOrBadgeTask`](TMissionOrBadgeTask.md)[]
 
 The list of tasks of the mission or badge
 
-___
+***
 
-### related\_games
+### related\_games?
 
-• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame-1.md)[]
+> `optional` **related\_games?**: [`AchRelatedGame`](AchRelatedGame-1.md)[]
 
 List of casino games (or other types of entities) related to the mission or badge
 
-___
+***
 
 ### category\_ids
 
-• **category\_ids**: `number`[]
+> **category\_ids**: `number`[]
 
 The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method
 
-___
+***
 
-### hint\_text
+### hint\_text?
 
-• `Optional` **hint\_text**: `string`
+> `optional` **hint\_text?**: `string`
 
 The T&C text for the missions
 
-___
+***
 
-### position
+### position?
 
-• `Optional` **position**: `number`
+> `optional` **position?**: `number`
 
 Priority (or position) of the mission in the UI. Low value indicates higher position in the UI
 
-___
+***
 
-### ribbon
+### ribbon?
 
-• `Optional` **ribbon**: `string`
+> `optional` **ribbon?**: `string`
 
 The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon, 250x300px
 
-___
+***
 
-### ach\_completed\_id
+### ach\_completed\_id?
 
-• `Optional` **ach\_completed\_id**: `number`
+> `optional` **ach\_completed\_id?**: `number`
 
 ID of the completion fact from ach_completed or ach_completed_recurring tables
 
-___
+***
 
-### requires\_prize\_claim
+### requires\_prize\_claim?
 
-• `Optional` **requires\_prize\_claim**: `boolean`
+> `optional` **requires\_prize\_claim?**: `boolean`
 
 Flag from achievement if the mission prize will be given only after user claims it
 
-___
+***
 
-### prize\_claimed\_date\_ts
+### prize\_claimed\_date\_ts?
 
-• `Optional` **prize\_claimed\_date\_ts**: `number`
+> `optional` **prize\_claimed\_date\_ts?**: `number`
 
 The date/timestamp indicating when the prize was claimed by the user
 
-___
+***
 
-### complete\_date
+### complete\_date?
 
-• `Optional` **complete\_date**: `string`
+> `optional` **complete\_date?**: `string`
 
 Time in hours that took this player to complete mission
 
-___
+***
 
-### complete\_date\_ts
+### complete\_date\_ts?
 
-• `Optional` **complete\_date\_ts**: `number`
+> `optional` **complete\_date\_ts?**: `number`
 
 Time of mission/badge being completed, this property shows the epoch time in UTC
 
-___
+***
 
-### completed\_today
+### completed\_today?
 
-• `Optional` **completed\_today**: `boolean`
+> `optional` **completed\_today?**: `boolean`
 
 Flag for mission/badge indicating that mission/badge completed today
 
-___
+***
 
-### completed\_this\_week
+### completed\_this\_week?
 
-• `Optional` **completed\_this\_week**: `boolean`
+> `optional` **completed\_this\_week?**: `boolean`
 
 Flag for mission/badge indicating that mission/badge completed this week
 
-___
+***
 
-### completed\_this\_month
+### completed\_this\_month?
 
-• `Optional` **completed\_this\_month**: `boolean`
+> `optional` **completed\_this\_month?**: `boolean`
 
 Flag for mission/badge indicating that mission/badge completed this month
 
-___
+***
 
-### custom\_section\_type\_id
+### custom\_section\_type\_id?
 
-• `Optional` **custom\_section\_type\_id**: `number`
+> `optional` **custom\_section\_type\_id?**: `number`
 
 ID of specific Custom Section type
 
-___
+***
 
-### max\_completion\_count
+### max\_completion\_count?
 
-• `Optional` **max\_completion\_count**: `number`
+> `optional` **max\_completion\_count?**: `number`
 
 Max number of times the user can complete a mission in case if mission type is Recurring upon completion. NULL equals infinite.
 
-___
+***
 
-### completion\_count
+### completion\_count?
 
-• `Optional` **completion\_count**: `number`
+> `optional` **completion\_count?**: `number`
 
 Current completion count for Recurring upon completion missions
 
-___
+***
 
-### next\_recurrence\_date\_ts
+### next\_recurrence\_date\_ts?
 
-• `Optional` **next\_recurrence\_date\_ts**: `number`
+> `optional` **next\_recurrence\_date\_ts?**: `number`
 
 The date/timestamp for recurring missions, which indicating the time remaining until the next recurrence of the mission.
 Note that if a mission has an "Active till" date defined, this field is not relevant after that date.
 
-___
+***
 
-### availability\_status
+### availability\_status?
 
-• `Optional` **availability\_status**: [`AchievementAvailabilityStatus`](../enums/AchievementAvailabilityStatus.md)
+> `optional` **availability\_status?**: [`AchievementAvailabilityStatus`](../enumerations/AchievementAvailabilityStatus.md)
 
 Availability status of the mission depends on the defined time limits
 
-___
+***
 
-### claim\_button\_title
+### claim\_button\_title?
 
-• `Optional` **claim\_button\_title**: `string`
+> `optional` **claim\_button\_title?**: `string`
 
 Title for the claim reward button
 
-___
+***
 
-### claim\_button\_action
+### claim\_button\_action?
 
-• `Optional` **claim\_button\_action**: `string`
+> `optional` **claim\_button\_action?**: `string`
 
 Action for the claim reward button
 
-___
+***
 
-### badgeTimeLimitState
+### badgeTimeLimitState?
 
-• `Optional` **badgeTimeLimitState**: [`BadgesTimeLimitStates`](../enums/BadgesTimeLimitStates.md)
+> `optional` **badgeTimeLimitState?**: [`BadgesTimeLimitStates`](../enumerations/BadgesTimeLimitStates.md)
 
 Badge time limit state for badges with time restrictions
 
-___
+***
 
-### hide\_locked\_mission
+### hide\_locked\_mission?
 
-• `Optional` **hide\_locked\_mission**: `boolean`
+> `optional` **hide\_locked\_mission?**: `boolean`
 
 Flag from achievement if the mission should be hidden when it is locked, until it's unlocked

package/docs/api/interfaces/TMissionOrBadgeTask.md

@@ -6,54 +6,54 @@ TMissionOrBadgeTask describes the information of tasks that belings to mission o
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the task
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the task, translated to the user language
 
-___
+***
 
 ### is\_completed
 
-• **is\_completed**: `boolean`
+> **is\_completed**: `boolean`
 
 Indicator if the task is completed
 
-___
+***
 
 ### progress
 
-• **progress**: `number`
+> **progress**: `number`
 
 The progress of the task in percents
 
-___
+***
 
 ### points\_reward
 
-• **points\_reward**: `number`
+> **points\_reward**: `number`
 
 Reward for completing the task in points
 
-___
+***
 
-### execution\_count\_expected
+### execution\_count\_expected?
 
-• `Optional` **execution\_count\_expected**: `number`
+> `optional` **execution\_count\_expected?**: `number`
 
 This is the total number of times the user needs to execute to complete task. e.g. he needs to bet 100 times. Here will be 100
 
-___
+***
 
-### execution\_count\_actual
+### execution\_count\_actual?
 
-• `Optional` **execution\_count\_actual**: `number`
+> `optional` **execution\_count\_actual?**: `number`
 
 This is the number of times the user has executed 'activity' of the task. e.g. he bet 5 times out of 100. Here will be 5