Skip to content

Commit a114cc0

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 45e6e74 commit a114cc0

12 files changed

Lines changed: 177 additions & 12 deletions

‎.lastupdated‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2025-12-11T07:32:25
1+
2025-12-18T23:03:43

‎docs/AutoCompleteType.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# AutoCompleteType
2+
3+
4+
# AutoCompleteType
5+
6+
## Enum
7+
8+
9+
* `ADDRESSLINE1` (value: `"Addressline1"`)
10+
11+
* `ADDRESSLINE2` (value: `"Addressline2"`)
12+
13+
* `BIRTHDATE` (value: `"Birthdate"`)
14+
15+
* `BIRTHDATEDAY` (value: `"BirthdateDay"`)
16+
17+
* `BIRTHDATEMONTH` (value: `"BirthdateMonth"`)
18+
19+
* `BIRTHDATEYEAR` (value: `"BirthdateYear"`)
20+
21+
* `CITY` (value: `"City"`)
22+
23+
* `COUNTRY` (value: `"Country"`)
24+
25+
* `DATETIME` (value: `"DateTime"`)
26+
27+
* `EMAIL` (value: `"Email"`)
28+
29+
* `FAMILYNAME` (value: `"FamilyName"`)
30+
31+
* `FLIGHTNUMBER` (value: `"FlightNumber"`)
32+
33+
* `GIVENNAME` (value: `"GivenName"`)
34+
35+
* `LOCATION` (value: `"Location"`)
36+
37+
* `MIDDLENAME` (value: `"MiddleName"`)
38+
39+
* `NAME` (value: `"Name"`)
40+
41+
* `NICKNAME` (value: `"Nickname"`)
42+
43+
* `ONETIMECODE` (value: `"OneTimeCode"`)
44+
45+
* `ORGANIZATION` (value: `"Organization"`)
46+
47+
* `PAYMENTCARDEXPIRATION` (value: `"PaymentCardExpiration"`)
48+
49+
* `PAYMENTCARDEXPIRATIONMONTH` (value: `"PaymentCardExpirationMonth"`)
50+
51+
* `PAYMENTCARDEXPIRATIONYEAR` (value: `"PaymentCardExpirationYear"`)
52+
53+
* `PAYMENTCARDFAMILYNAME` (value: `"PaymentCardFamilyName"`)
54+
55+
* `PAYMENTCARDGIVENNAME` (value: `"PaymentCardGivenName"`)
56+
57+
* `PAYMENTCARDMIDDLENAME` (value: `"PaymentCardMiddleName"`)
58+
59+
* `PAYMENTCARDNAME` (value: `"PaymentCardName"`)
60+
61+
* `PAYMENTCARDNUMBER` (value: `"PaymentCardNumber"`)
62+
63+
* `PAYMENTCARDSECURITYCODE` (value: `"PaymentCardSecurityCode"`)
64+
65+
* `PAYMENTCARDTYPE` (value: `"PaymentCardType"`)
66+
67+
* `PHONE` (value: `"Phone"`)
68+
69+
* `POSTALCODE` (value: `"PostalCode"`)
70+
71+
* `PREFIX` (value: `"Prefix"`)
72+
73+
* `STATE` (value: `"State"`)
74+
75+
* `STREETADDRESS` (value: `"StreetAddress"`)
76+
77+
* `SUFFIX` (value: `"Suffix"`)
78+
79+
* `TITLE` (value: `"Title"`)
80+
81+
* `URL` (value: `"Url"`)
82+
83+
* `USERNAME` (value: `"Username"`)
84+
85+
86+
87+
88+
_cloud.genesys.webmessaging.sdk:web-messaging-sdk:15.2.0_

‎docs/ContentInput.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55

66
| Name | Type | Description | Notes |
77
| ------------ | ------------- | ------------- | ------------- |
8+
| **autoCompleteType** | [**AutoCompleteType**](AutoCompleteType) | A string value representing the keyboard and system information about the expected semantic meaning for the content that users enter. | [optional] |
89
| **id** | **String** | Unique identifier for the input | |
910
| **isMultipleLine** | **Boolean** | Whether the input should allow multiple lines of text. | |
1011
| **isRequired** | **Boolean** | Whether the input field(s) are required to be filled in. | |
12+
| **keyboardType** | [**KeyboardType**](KeyboardType) | Type of keyboard to be shown. | [optional] |
1113
| **placeholderText** | **String** | Placeholder text for input field(s). | [optional] |
1214
| **subtitle** | **String** | Additional text providing more details about the input field(s). | [optional] |
1315
| **title** | **String** | The main text displayed for the input field(s). | [optional] |

‎docs/ContentNotificationTemplate.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
| ------------ | ------------- | ------------- | ------------- |
88
| **body** | [**NotificationTemplateBody**](NotificationTemplateBody) | The template body. | |
99
| **buttons** | [**List<NotificationTemplateButton>**](NotificationTemplateButton) | Template buttons | [optional] |
10+
| **carousel** | [**NotificationTemplateCarousel**](NotificationTemplateCarousel) | The template carousel. | [optional] |
1011
| **footer** | [**NotificationTemplateFooter**](NotificationTemplateFooter) | The template footer. | [optional] |
1112
| **header** | [**NotificationTemplateHeader**](NotificationTemplateHeader) | The template header. | [optional] |
1213
| **id** | **String** | The messaging provider template ID. For WhatsApp, 'namespace@name'. | [optional] |

‎docs/KeyboardType.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# KeyboardType
2+
3+
4+
# KeyboardType
5+
6+
## Enum
7+
8+
9+
* `DECIMAL` (value: `"Decimal"`)
10+
11+
* `DEFAULT` (value: `"Default"`)
12+
13+
* `EMAIL` (value: `"Email"`)
14+
15+
* `NUMBER` (value: `"Number"`)
16+
17+
* `NUMBERPUNCTUATION` (value: `"NumberPunctuation"`)
18+
19+
* `PHONE` (value: `"Phone"`)
20+
21+
* `URL` (value: `"URL"`)
22+
23+
* `WEBSEARCH` (value: `"Websearch"`)
24+
25+
26+
27+
28+
_cloud.genesys.webmessaging.sdk:web-messaging-sdk:15.2.0_

‎docs/Limit.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
| Name | Value |
1616
| ---- | ----- |
1717
| OUTDATEDSDKVERSION | "OutdatedSdkVersion" |
18-
| WORKFORCE_MANAGEMENT | "workforce.management" |
18+
| WORKFORCE_MANAGEMENT_FORECAST | "workforce.management.forecast" |
1919
| AGENT_ASSISTANT | "agent.assistant" |
20+
| AGENTIC_VIRTUAL_AGENTS | "agentic.virtual.agents" |
2021
| ANALYTICS_AGENTS | "analytics.agents" |
2122
| ANALYTICS_ALERTING | "analytics.alerting" |
2223
| ANALYTICS_DATA_EXTRACTION | "analytics.data.extraction" |
@@ -95,7 +96,8 @@
9596
| WEBCHAT | "webchat" |
9697
| WEBHOOKS | "webhooks" |
9798
| WORKFORCE_MANAGEMENT_AGENT_AVAILABILITY | "workforce.management.agent.availability" |
98-
| WORKFORCE_MANAGEMENT_FORECAST | "workforce.management.forecast" |
99+
| WORKFORCE_MANAGEMENT | "workforce.management" |
100+
| WORKFORCE_MANAGEMENT_SHIFT_TRADING | "workforce.management.shift.trading" |
99101
| SYSTEM | "system" |
100102

101103

‎docs/MessagingRecipient.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
| ------------ | ------------- | ------------- | ------------- |
88
| **additionalIds** | [**List<RecipientAdditionalIdentifier>**](RecipientAdditionalIdentifier) | List of recipient additional identifiers | [optional] |
99
| **email** | **String** | E-mail address of the recipient. | [optional] |
10+
| **externalContactDivisionId** | **String** | The ID of the division the external contact is a member of. Must be set to '*' for the Unassigned division. | [optional] |
1011
| **externalContactId** | **String** | The identifier of the external contact. | [optional] |
12+
| **externalOrganizationId** | **String** | The identifier of the external organization the external contact is associated to. | [optional] |
1113
| **firstName** | **String** | First name of the recipient. | [optional] |
1214
| **id** | **String** | The recipient ID specific to the provider. | |
1315
| **idType** | [**IDType**](IDType) | The recipient ID type. This is used to indicate the format used for the ID. | [optional] |

‎docs/NotificationTemplateButton.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
| ------------ | ------------- | ------------- | ------------- |
88
| **index** | **Double** | index of the button in the list. | |
99
| **parameters** | [**List<NotificationTemplateParameter>**](NotificationTemplateParameter) | Template parameters for placeholders in the button. | [optional] |
10+
| **payload** | **String** | Content of the payload to be included in the quick reply response when the button is pressed. | [optional] |
1011
| **phoneNumber** | **String** | Button phone number. | [optional] |
1112
| **text** | **String** | Button text message. | |
1213
| **type** | [**TemplateButtonType**](TemplateButtonType) | Specifies the type of the button. | |

‎docs/NotificationTemplateCard.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# NotificationTemplateCard
2+
3+
4+
## Properties
5+
6+
| Name | Type | Description | Notes |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
| **body** | [**NotificationTemplateBody**](NotificationTemplateBody) | The template body. | [optional] |
9+
| **buttons** | **List<Object>** | Template buttons (max 2 for WhatsApp carousel cards) | |
10+
| **header** | [**NotificationTemplateHeader**](NotificationTemplateHeader) | The template header. | |
11+
12+
13+
14+
15+
_cloud.genesys.webmessaging.sdk:web-messaging-sdk:15.2.0_

‎docs/NotificationTemplateCarousel.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# NotificationTemplateCarousel
2+
3+
4+
## Properties
5+
6+
| Name | Type | Description | Notes |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
| **cards** | [**List<NotificationTemplateCard>**](NotificationTemplateCard) | An array of template card objects. | |
9+
10+
11+
12+
13+
_cloud.genesys.webmessaging.sdk:web-messaging-sdk:15.2.0_

0 commit comments

Comments
 (0)