rcs 2.0.4 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a7dcae7f7b5ad0cbee5a661c6f8e35b33c39bac653f860f469e5427a06282cef
4
- data.tar.gz: 6ea895970d6229ff913d99c4a3526312a983481dbc6ea4134319814718675736
3
+ metadata.gz: a9973f0ac25a667d4fc684411e98de98f3a414ea4c851df38c57cb08ecd48f7c
4
+ data.tar.gz: e33ee21925018bf8472458ce39debdd7324d3522952f2514b0c93d03b91d81de
5
5
  SHA512:
6
- metadata.gz: 3eb05938cd8048c002a1dcfbf043a98add809d60658ceee49c5a57757d7f24135fbdcb780514a1ce1e5f0762b50664a468a079ea2d3b360ca045d783fa17dd9b
7
- data.tar.gz: 392ea41576c9eddaee42db97b378df70d0fae4b1d4f2516239881361d50f016ba2b5a4af0e4ba2fec4a8236d432fec65c23f609a63303209ef4a373028e2dec3
6
+ metadata.gz: 862c3ef24cff2a33b06c8b82acd5f760b23ea2895e653676218b47fd7f010ed9648d6d154cc597ba6fdb1ad8b7de71e87677275642699d169b931f1ddb9d2e29
7
+ data.tar.gz: 1fc9c84cffa9f53caf66be90c4d1aabdc953bb7c2f90bcdfb7ff4673f17bdab89187909f91f4eaabeff3491da5b5892faa0c16a2331a54b8012c6f9d6b6c45ed
@@ -22,7 +22,8 @@ module Pinnacle
22
22
  #
23
23
  # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
24
24
  # `aud_`, for example: `aud_abc123`.
25
- # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
25
+ # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
26
+ # **Limit:** 1 min
26
27
  # @param request_options [Pinnacle::RequestOptions]
27
28
  # @return [Pinnacle::Types::AudienceCountOnly]
28
29
  # @example
@@ -57,7 +58,8 @@ module Pinnacle
57
58
  #
58
59
  # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
59
60
  # `aud_`, for example: `aud_abc123`.
60
- # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
61
+ # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
62
+ # **Limit:** 1 min
61
63
  # @param request_options [Pinnacle::RequestOptions]
62
64
  # @return [Pinnacle::Types::AudienceCountOnly]
63
65
  # @example
@@ -102,7 +104,8 @@ module Pinnacle
102
104
  #
103
105
  # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
104
106
  # `aud_`, for example: `aud_abc123`.
105
- # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
107
+ # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
108
+ # **Limit:** 1 min
106
109
  # @param request_options [Pinnacle::RequestOptions]
107
110
  # @return [Pinnacle::Types::AudienceCountOnly]
108
111
  # @example
@@ -139,7 +142,8 @@ module Pinnacle
139
142
  #
140
143
  # @param id [String] Audience ID. This identifier is a string that always begins with the prefix
141
144
  # `aud_`, for example: `aud_abc123`.
142
- # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
145
+ # @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
146
+ # **Limit:** 1 min
143
147
  # @param request_options [Pinnacle::RequestOptions]
144
148
  # @return [Pinnacle::Types::AudienceCountOnly]
145
149
  # @example
@@ -156,7 +156,8 @@ module Pinnacle
156
156
  # * :embedded_link (String)
157
157
  # * :embedded_phone (Boolean)
158
158
  # * :number_pooling (Boolean)
159
- # @param sample_messages [Array<String>] Example messages for the campaign.
159
+ # @param sample_messages [Array<String>] Example messages for the campaign. <br><br>
160
+ # **Limit:** 1 to 5
160
161
  # @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
161
162
  # * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
162
163
  # * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
@@ -393,7 +394,8 @@ module Pinnacle
393
394
  # * :embedded_link (String)
394
395
  # * :embedded_phone (Boolean)
395
396
  # * :number_pooling (Boolean)
396
- # @param sample_messages [Array<String>] Example messages for the campaign.
397
+ # @param sample_messages [Array<String>] Example messages for the campaign. <br><br>
398
+ # **Limit:** 1 to 5
397
399
  # @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
398
400
  # * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
399
401
  # * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
@@ -139,7 +139,8 @@ module Pinnacle
139
139
  # * :websites (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>)
140
140
  # @param brand [String] Unique identifier for the brand.
141
141
  # @param campaign_id [String] Unique identifier for the campaign.
142
- # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
142
+ # @param expected_agent_responses [Array<String>] List of what the agent might say to users. <br><br>
143
+ # **Limit:** 1 to 5
143
144
  # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::RcsLinks, as a Hash
144
145
  # * :privacy_policy (String)
145
146
  # * :terms_of_service (String)
@@ -412,7 +413,8 @@ module Pinnacle
412
413
  # * :websites (Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>)
413
414
  # @param brand [String] Unique identifier for the brand.
414
415
  # @param campaign_id [String] Unique identifier for the campaign.
415
- # @param expected_agent_responses [Array<String>] List of what the agent might say to users (1-5 required).
416
+ # @param expected_agent_responses [Array<String>] List of what the agent might say to users. <br><br>
417
+ # **Limit:** 1 to 5
416
418
  # @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Rcs::Types::RcsLinks, as a Hash
417
419
  # * :privacy_policy (String)
418
420
  # * :terms_of_service (String)
@@ -19,7 +19,8 @@ module Pinnacle
19
19
  # Be clear, concise, user-focused, and highlight what the agent does and the
20
20
  # benefits it provides for the user.
21
21
  attr_reader :description
22
- # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
22
+ # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails. <br><br>
23
+ # **Limit:** 1 to 3
23
24
  attr_reader :emails
24
25
  # @return [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
25
26
  attr_reader :hero_url
@@ -28,9 +29,11 @@ module Pinnacle
28
29
  # @return [String] Name of the agent. <br>
29
30
  # Recommended format: [Brand Name] - [1-2 word description of purpose]
30
31
  attr_reader :name
31
- # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
32
+ # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers. <br><br>
33
+ # **Limit:** 1 to 3
32
34
  attr_reader :phones
33
- # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls (1-3 required).
35
+ # @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls. <br><br>
36
+ # **Limit:** 1 to 3
34
37
  attr_reader :websites
35
38
  # @return [OpenStruct] Additional properties unmapped to the current class definition
36
39
  attr_reader :additional_properties
@@ -45,13 +48,16 @@ module Pinnacle
45
48
  # @param description [String] Description of the agent. <br>
46
49
  # Be clear, concise, user-focused, and highlight what the agent does and the
47
50
  # benefits it provides for the user.
48
- # @param emails [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
51
+ # @param emails [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails. <br><br>
52
+ # **Limit:** 1 to 3
49
53
  # @param hero_url [String] Link to the agent's hero. Hero must be an image file with dimensions 1440x448px.
50
54
  # @param icon_url [String] Link to the agent's icon. Icon must be an image file with dimensions 224x224px.
51
55
  # @param name [String] Name of the agent. <br>
52
56
  # Recommended format: [Brand Name] - [1-2 word description of purpose]
53
- # @param phones [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
54
- # @param websites [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls (1-3 required).
57
+ # @param phones [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers. <br><br>
58
+ # **Limit:** 1 to 3
59
+ # @param websites [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls. <br><br>
60
+ # **Limit:** 1 to 3
55
61
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
56
62
  # @return [Pinnacle::Campaigns::Rcs::Types::RcsAgent]
57
63
  def initialize(color: OMIT, description: OMIT, emails: OMIT, hero_url: OMIT, icon_url: OMIT, name: OMIT,
@@ -38,6 +38,7 @@ module Pinnacle
38
38
  # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
39
39
  # Messages will be distributed evenly across these senders.
40
40
  # > **Note:** Sandbox numbers cannot be used for blasts.
41
+ # **Limit:** 1 min
41
42
  # @param message [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
42
43
  # * :text (String)
43
44
  # @param options [Hash] Additional settings to customize SMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastSmsOptions, as a Hash
@@ -97,6 +98,7 @@ module Pinnacle
97
98
  # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
98
99
  # Messages will be distributed evenly across these senders.
99
100
  # > **Note:** Sandbox numbers cannot be used for blasts.
101
+ # **Limit:** 1 min
100
102
  # @param message [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
101
103
  # * :media_urls (Array<String>)
102
104
  # * :text (String)
@@ -161,6 +163,7 @@ module Pinnacle
161
163
  # @param senders [Array<String>] Array of RCS agent IDs to send from. Each must be prefixed with `agent_`. <br>
162
164
  # Messages will be evenly distributed across these agents.
163
165
  # > **Note:** Test agents cannot be used for blasts.
166
+ # **Limit:** 1 min
164
167
  # @param message [Pinnacle::Types::RichText, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RichCards]
165
168
  # @param options [Hash] Configure how your RCS blast is sent and tracked.Request of type Pinnacle::Messages::Blast::Types::BlastRcsOptions, as a Hash
166
169
  # * :transcode (Boolean)
@@ -236,6 +239,7 @@ module Pinnacle
236
239
  # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
237
240
  # Messages will be distributed evenly across these senders.
238
241
  # > **Note:** Sandbox numbers cannot be used for blasts.
242
+ # **Limit:** 1 min
239
243
  # @param message [Hash] Request of type Pinnacle::Types::SmsContent, as a Hash
240
244
  # * :text (String)
241
245
  # @param options [Hash] Additional settings to customize SMS blast delivery.Request of type Pinnacle::Messages::Blast::Types::BlastSmsOptions, as a Hash
@@ -297,6 +301,7 @@ module Pinnacle
297
301
  # @param senders [Array<String>] Array of phone numbers to send from in E.164 format. <br>
298
302
  # Messages will be distributed evenly across these senders.
299
303
  # > **Note:** Sandbox numbers cannot be used for blasts.
304
+ # **Limit:** 1 min
300
305
  # @param message [Hash] Request of type Pinnacle::Types::MmsContent, as a Hash
301
306
  # * :media_urls (Array<String>)
302
307
  # * :text (String)
@@ -363,6 +368,7 @@ module Pinnacle
363
368
  # @param senders [Array<String>] Array of RCS agent IDs to send from. Each must be prefixed with `agent_`. <br>
364
369
  # Messages will be evenly distributed across these agents.
365
370
  # > **Note:** Test agents cannot be used for blasts.
371
+ # **Limit:** 1 min
366
372
  # @param message [Pinnacle::Types::RichText, Pinnacle::Types::RcsValidateContentMedia, Pinnacle::Types::RichCards]
367
373
  # @param options [Hash] Configure how your RCS blast is sent and tracked.Request of type Pinnacle::Messages::Blast::Types::BlastRcsOptions, as a Hash
368
374
  # * :transcode (Boolean)
@@ -108,7 +108,7 @@ module Pinnacle
108
108
  to: to,
109
109
  options: options
110
110
  }.compact
111
- req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
111
+ req.url "#{@request_client.get_url(request_options: request_options)}/messages/send/typing"
112
112
  end
113
113
  Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
114
114
  end
@@ -244,7 +244,7 @@ module Pinnacle
244
244
  to: to,
245
245
  options: options
246
246
  }.compact
247
- req.url "#{@request_client.get_url(request_options: request_options)}/messages/typing"
247
+ req.url "#{@request_client.get_url(request_options: request_options)}/messages/send/typing"
248
248
  end
249
249
  Pinnacle::Types::SendTypingIndicatorResponse.from_json(json_object: response.body)
250
250
  end
@@ -21,7 +21,8 @@ module Pinnacle
21
21
  # Link a phone number to a specific campaign. Phone numbers must be linked to a
22
22
  # campaign to send messages.
23
23
  #
24
- # @param phones [Array<String>] List of phone number (E.164 format).
24
+ # @param phones [Array<String>] List of phone number (E.164 format). <br><br>
25
+ # **Limit:** 1 to 10
25
26
  # @param campaign_type [Pinnacle::Types::MessagingProfileEnum]
26
27
  # @param campaign_id [String] Unique identifier for the campaign. <br>
27
28
  # - **TOLL_FREE** campaigns:
@@ -68,7 +69,8 @@ module Pinnacle
68
69
 
69
70
  # Remove the association between a phone number and its attached campaign.
70
71
  #
71
- # @param phones [Array<String>] List of phone numbers (E.164 format).
72
+ # @param phones [Array<String>] List of phone numbers (E.164 format). <br><br>
73
+ # **Limit:** 1 to 10
72
74
  # @param request_options [Pinnacle::RequestOptions]
73
75
  # @return [Pinnacle::Types::DetachedPhoneNumberResult]
74
76
  # @example
@@ -110,7 +112,8 @@ module Pinnacle
110
112
  # Link a phone number to a specific campaign. Phone numbers must be linked to a
111
113
  # campaign to send messages.
112
114
  #
113
- # @param phones [Array<String>] List of phone number (E.164 format).
115
+ # @param phones [Array<String>] List of phone number (E.164 format). <br><br>
116
+ # **Limit:** 1 to 10
114
117
  # @param campaign_type [Pinnacle::Types::MessagingProfileEnum]
115
118
  # @param campaign_id [String] Unique identifier for the campaign. <br>
116
119
  # - **TOLL_FREE** campaigns:
@@ -159,7 +162,8 @@ module Pinnacle
159
162
 
160
163
  # Remove the association between a phone number and its attached campaign.
161
164
  #
162
- # @param phones [Array<String>] List of phone numbers (E.164 format).
165
+ # @param phones [Array<String>] List of phone numbers (E.164 format). <br><br>
166
+ # **Limit:** 1 to 10
163
167
  # @param request_options [Pinnacle::RequestOptions]
164
168
  # @return [Pinnacle::Types::DetachedPhoneNumberResult]
165
169
  # @example
@@ -23,7 +23,8 @@ module Pinnacle
23
23
  # supported
24
24
  # on specific phone numbers before sending RCS messages to them.
25
25
  #
26
- # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format)
26
+ # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format). <br><br>
27
+ # **Limit:** 1 min
27
28
  # @param request_options [Pinnacle::RequestOptions]
28
29
  # @return [Pinnacle::Types::RCS_CAPABILITIES_RESULT]
29
30
  # @example
@@ -180,7 +181,8 @@ module Pinnacle
180
181
  # supported
181
182
  # on specific phone numbers before sending RCS messages to them.
182
183
  #
183
- # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format)
184
+ # @param phone_numbers [Array<String>] List of phone numbers to check RCS capabilities for (E.164 format). <br><br>
185
+ # **Limit:** 1 min
184
186
  # @param request_options [Pinnacle::RequestOptions]
185
187
  # @return [Pinnacle::Types::RCS_CAPABILITIES_RESULT]
186
188
  # @example
@@ -19,9 +19,11 @@ module Pinnacle
19
19
  # To get the message details, use the [GET
20
20
  # /messages/{id}](/api-reference/messages/get) endpoint.
21
21
  attr_reader :id
22
- # @return [Array<Pinnacle::Types::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message.
22
+ # @return [Array<Pinnacle::Types::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message. <br><br>
23
+ # **Limit:** 1 to 10
23
24
  attr_reader :cards
24
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
25
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
26
+ # **Limit:** 10 max
25
27
  attr_reader :quick_replies
26
28
  # @return [OpenStruct] Additional properties unmapped to the current class definition
27
29
  attr_reader :additional_properties
@@ -36,8 +38,10 @@ module Pinnacle
36
38
  # with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
37
39
  # To get the message details, use the [GET
38
40
  # /messages/{id}](/api-reference/messages/get) endpoint.
39
- # @param cards [Array<Pinnacle::Types::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message.
40
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
41
+ # @param cards [Array<Pinnacle::Types::MessageEventRcsCardsContentCardsItem>] Collection of cards attached to the message. <br><br>
42
+ # **Limit:** 1 to 10
43
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
44
+ # **Limit:** 10 max
41
45
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
46
  # @return [Pinnacle::Types::MessageEventRcsCardsContent]
43
47
  def initialize(type:, id:, cards:, quick_replies:, additional_properties: nil)
@@ -9,7 +9,8 @@ module Pinnacle
9
9
  module Types
10
10
  # Individual card containing title, optional media, and action buttons.
11
11
  class MessageEventRcsCardsContentCardsItem
12
- # @return [Array<Pinnacle::Types::RichButton>] Action buttons attached to the card.
12
+ # @return [Array<Pinnacle::Types::RichButton>] Action buttons attached to the card. <br><br>
13
+ # **Limit:** 4 max
13
14
  attr_reader :buttons
14
15
  # @return [Pinnacle::Types::RcsMediaDetailsContent]
15
16
  attr_reader :media
@@ -25,7 +26,8 @@ module Pinnacle
25
26
 
26
27
  OMIT = Object.new
27
28
 
28
- # @param buttons [Array<Pinnacle::Types::RichButton>] Action buttons attached to the card.
29
+ # @param buttons [Array<Pinnacle::Types::RichButton>] Action buttons attached to the card. <br><br>
30
+ # **Limit:** 4 max
29
31
  # @param media [Pinnacle::Types::RcsMediaDetailsContent]
30
32
  # @param subtitle [String] Secondary text displayed below the title for additional context.
31
33
  # @param title [String] Title displayed on the card.
@@ -19,7 +19,8 @@ module Pinnacle
19
19
  attr_reader :id
20
20
  # @return [String] URL of the media file.
21
21
  attr_reader :media
22
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
22
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
23
+ # **Limit:** 10 max
23
24
  attr_reader :quick_replies
24
25
  # @return [OpenStruct] Additional properties unmapped to the current class definition
25
26
  attr_reader :additional_properties
@@ -35,7 +36,8 @@ module Pinnacle
35
36
  # To get the message details, use the [GET
36
37
  # /messages/{id}](/api-reference/messages/get) endpoint.
37
38
  # @param media [String] URL of the media file.
38
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
39
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
40
+ # **Limit:** 10 max
39
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
40
42
  # @return [Pinnacle::Types::MessageEventRcsMediaContent]
41
43
  def initialize(type:, id:, media:, quick_replies:, additional_properties: nil)
@@ -15,7 +15,8 @@ module Pinnacle
15
15
  # To get the message details, use the [GET
16
16
  # /messages/{id}](/api-reference/messages/get) endpoint.
17
17
  attr_reader :id
18
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
18
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
19
+ # **Limit:** 10 max
19
20
  attr_reader :quick_replies
20
21
  # @return [String] Text content of the RCS message.
21
22
  attr_reader :text
@@ -32,7 +33,8 @@ module Pinnacle
32
33
  # with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
33
34
  # To get the message details, use the [GET
34
35
  # /messages/{id}](/api-reference/messages/get) endpoint.
35
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
36
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
37
+ # **Limit:** 10 max
36
38
  # @param text [String] Text content of the RCS message.
37
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
38
40
  # @return [Pinnacle::Types::MessageEventRcsTextContent]
@@ -12,9 +12,11 @@ module Pinnacle
12
12
  # See (supported file
13
13
  # types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
14
14
  class RcsCardsContent
15
- # @return [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
15
+ # @return [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message. <br><br>
16
+ # **Limit:** 1 to 10
16
17
  attr_reader :cards
17
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
18
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
19
+ # **Limit:** 10 max
18
20
  attr_reader :quick_replies
19
21
  # @return [OpenStruct] Additional properties unmapped to the current class definition
20
22
  attr_reader :additional_properties
@@ -24,8 +26,10 @@ module Pinnacle
24
26
 
25
27
  OMIT = Object.new
26
28
 
27
- # @param cards [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message.
28
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
29
+ # @param cards [Array<Pinnacle::Types::RcsCardsContentCardsItem>] Collection of cards attached to the message. <br><br>
30
+ # **Limit:** 1 to 10
31
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
32
+ # **Limit:** 10 max
29
33
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
34
  # @return [Pinnacle::Types::RcsCardsContent]
31
35
  def initialize(cards:, quick_replies:, additional_properties: nil)
@@ -10,7 +10,8 @@ module Pinnacle
10
10
  # Individual card containing title, optional media, and action buttons.
11
11
  class RcsCardsContentCardsItem
12
12
  # @return [Array<Pinnacle::Types::RichButton>] While buttons resemble quick replies, they remain on screen after being clicked
13
- # and are card-specific.
13
+ # and are card-specific. <br><br>
14
+ # **Limit:** 4 max
14
15
  attr_reader :buttons
15
16
  # @return [Pinnacle::Types::RcsMediaDetailsContent]
16
17
  attr_reader :media
@@ -27,7 +28,8 @@ module Pinnacle
27
28
  OMIT = Object.new
28
29
 
29
30
  # @param buttons [Array<Pinnacle::Types::RichButton>] While buttons resemble quick replies, they remain on screen after being clicked
30
- # and are card-specific.
31
+ # and are card-specific. <br><br>
32
+ # **Limit:** 4 max
31
33
  # @param media [Pinnacle::Types::RcsMediaDetailsContent]
32
34
  # @param subtitle [String] Secondary text displayed below the title for additional context.
33
35
  # @param title [String] Title displayed on the card.
@@ -14,7 +14,8 @@ module Pinnacle
14
14
  class RcsMediaContent
15
15
  # @return [Pinnacle::Types::RcsMediaDetailsContent]
16
16
  attr_reader :media
17
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
17
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
18
+ # **Limit:** 10 max
18
19
  attr_reader :quick_replies
19
20
  # @return [OpenStruct] Additional properties unmapped to the current class definition
20
21
  attr_reader :additional_properties
@@ -25,7 +26,8 @@ module Pinnacle
25
26
  OMIT = Object.new
26
27
 
27
28
  # @param media [Pinnacle::Types::RcsMediaDetailsContent]
28
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
29
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
30
+ # **Limit:** 10 max
29
31
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
32
  # @return [Pinnacle::Types::RcsMediaContent]
31
33
  def initialize(media:, quick_replies:, additional_properties: nil)
@@ -9,7 +9,8 @@ module Pinnacle
9
9
  # Individual card containing title, optional media, and action buttons.
10
10
  class RichCard
11
11
  # @return [Array<Pinnacle::Types::RichButton>] While buttons resemble quick replies, they remain on screen after being clicked
12
- # and are card-specific.
12
+ # and are card-specific. <br><br>
13
+ # **Limit:** 4 max
13
14
  attr_reader :buttons
14
15
  # @return [String] Media file URLs to send.
15
16
  attr_reader :media
@@ -26,7 +27,8 @@ module Pinnacle
26
27
  OMIT = Object.new
27
28
 
28
29
  # @param buttons [Array<Pinnacle::Types::RichButton>] While buttons resemble quick replies, they remain on screen after being clicked
29
- # and are card-specific.
30
+ # and are card-specific. <br><br>
31
+ # **Limit:** 4 max
30
32
  # @param media [String] Media file URLs to send.
31
33
  # @param subtitle [String] Secondary text displayed below the title for additional context.
32
34
  # @param title [String] Title displayed on the card.
@@ -12,9 +12,11 @@ module Pinnacle
12
12
  # See (supported file
13
13
  # types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
14
14
  class RichCards
15
- # @return [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message.
15
+ # @return [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message. <br><br>
16
+ # **Limit:** 1 to 10
16
17
  attr_reader :cards
17
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
18
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
19
+ # **Limit:** 10 max
18
20
  attr_reader :quick_replies
19
21
  # @return [OpenStruct] Additional properties unmapped to the current class definition
20
22
  attr_reader :additional_properties
@@ -24,8 +26,10 @@ module Pinnacle
24
26
 
25
27
  OMIT = Object.new
26
28
 
27
- # @param cards [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message.
28
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
29
+ # @param cards [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message. <br><br>
30
+ # **Limit:** 1 to 10
31
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
32
+ # **Limit:** 10 max
29
33
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
34
  # @return [Pinnacle::Types::RichCards]
31
35
  def initialize(cards:, quick_replies:, additional_properties: nil)
@@ -15,9 +15,11 @@ module Pinnacle
15
15
  attr_reader :from
16
16
  # @return [String] Recipient's phone number in E.164 format.
17
17
  attr_reader :to
18
- # @return [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message.
18
+ # @return [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message. <br><br>
19
+ # **Limit:** 1 to 10
19
20
  attr_reader :cards
20
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
21
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
22
+ # **Limit:** 10 max
21
23
  attr_reader :quick_replies
22
24
  # @return [OpenStruct] Additional properties unmapped to the current class definition
23
25
  attr_reader :additional_properties
@@ -30,8 +32,10 @@ module Pinnacle
30
32
  # @param options [Pinnacle::Types::SendRichCardsOptions]
31
33
  # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
32
34
  # @param to [String] Recipient's phone number in E.164 format.
33
- # @param cards [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message.
34
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
35
+ # @param cards [Array<Pinnacle::Types::RichCard>] Collection of cards attached to the message. <br><br>
36
+ # **Limit:** 1 to 10
37
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
38
+ # **Limit:** 10 max
35
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
36
40
  # @return [Pinnacle::Types::RichCardsMessage]
37
41
  def initialize(from:, to:, cards:, quick_replies:, options: OMIT, additional_properties: nil)
@@ -12,7 +12,8 @@ module Pinnacle
12
12
  # See [supported media
13
13
  # types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
14
14
  attr_reader :media
15
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
15
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br>
16
+ # `≤10`
16
17
  attr_reader :quick_replies
17
18
  # @return [String] Your RCS agent ID which must be prefixed with 'agent_'.
18
19
  attr_reader :from
@@ -31,7 +32,8 @@ module Pinnacle
31
32
  # @param media [String] Media file URLs to send. <br>
32
33
  # See [supported media
33
34
  # types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
34
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
35
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br>
36
+ # `≤10`
35
37
  # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
36
38
  # @param options [Pinnacle::Types::SendRichMessageOptions] Configure how your RCS message is sent and tracked.
37
39
  # @param to [String] Recipient's phone number in E.164 format.
@@ -8,7 +8,8 @@ module Pinnacle
8
8
  module Types
9
9
  # Message containing longer text content with optional quick reply buttons.
10
10
  class RichText
11
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
11
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
12
+ # **Limit:** 10 max
12
13
  attr_reader :quick_replies
13
14
  # @return [String] Text content of the RCS message.
14
15
  attr_reader :text
@@ -20,7 +21,8 @@ module Pinnacle
20
21
 
21
22
  OMIT = Object.new
22
23
 
23
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
24
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
25
+ # **Limit:** 10 max
24
26
  # @param text [String] Text content of the RCS message.
25
27
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
26
28
  # @return [Pinnacle::Types::RichText]
@@ -14,7 +14,8 @@ module Pinnacle
14
14
  attr_reader :options
15
15
  # @return [String] Recipient's phone number in E.164 format.
16
16
  attr_reader :to
17
- # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
17
+ # @return [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
18
+ # **Limit:** 10 max
18
19
  attr_reader :quick_replies
19
20
  # @return [String] Text content of the RCS message.
20
21
  attr_reader :text
@@ -29,7 +30,8 @@ module Pinnacle
29
30
  # @param from [String] Your RCS agent ID which must be prefixed with 'agent_'.
30
31
  # @param options [Pinnacle::Types::SendRichMessageOptions] Configure how your RCS message is sent and tracked.
31
32
  # @param to [String] Recipient's phone number in E.164 format.
32
- # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message.
33
+ # @param quick_replies [Array<Pinnacle::Types::RichButton>] List of interactive quick reply buttons in the message. <br><br>
34
+ # **Limit:** 10 max
33
35
  # @param text [String] Text content of the RCS message.
34
36
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
35
37
  # @return [Pinnacle::Types::RichTextMessage]
@@ -19,6 +19,8 @@ module Pinnacle
19
19
  # phone numbers.
20
20
  #
21
21
  # @param identifiers [Array<String>] List of URLs or phone numbers in E.164 format that the webhook is attached to.
22
+ # <br><br>
23
+ # **Limit:** 1 min
22
24
  # @param request_options [Pinnacle::RequestOptions]
23
25
  # @return [Pinnacle::Types::WebhookResult]
24
26
  # @example
@@ -61,6 +63,8 @@ module Pinnacle
61
63
  # phone numbers.
62
64
  #
63
65
  # @param identifiers [Array<String>] List of URLs or phone numbers in E.164 format that the webhook is attached to.
66
+ # <br><br>
67
+ # **Limit:** 1 min
64
68
  # @param request_options [Pinnacle::RequestOptions]
65
69
  # @return [Pinnacle::Types::WebhookResult]
66
70
  # @example
data/lib/requests.rb CHANGED
@@ -43,7 +43,7 @@ module Pinnacle
43
43
 
44
44
  # @return [Hash{String => String}]
45
45
  def get_headers
46
- headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.4" }
46
+ headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.5" }
47
47
  headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
48
48
  headers
49
49
  end
@@ -87,7 +87,7 @@ module Pinnacle
87
87
 
88
88
  # @return [Hash{String => String}]
89
89
  def get_headers
90
- headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.4" }
90
+ headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "2.0.5" }
91
91
  headers["PINNACLE-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
92
92
  headers
93
93
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rcs
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.4
4
+ version: 2.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - ''
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-01-05 00:00:00.000000000 Z
11
+ date: 2026-01-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: async-http-faraday